sshkeys_core

Table of Contents

1. Description
2. Usage - Configuration options and additional functionality
3. Reference - User documentation
4. Development - Guide for contributing to the module

Description

Manage SSH authorized_keys, and ssh_known_hosts files.

Usage

To manage an authorized key for a user, use the following code:

ssh_authorized_key { 'nick@magpie.example.com':
  ensure => present,
  user   => 'nick',
  type   => 'ssh-rsa',
  key    => 'AAAAB3Nza[...]qXfdaQ==',
}

This would create a key that appears in your ~/.ssh/id_rsa.pub file like this with resource name as comment:

ssh-rsa AAAAB3Nza[...]qXfdaQ== nick@magpie.example.com

To manage a known hosts file entry, use the following code:

sshkey { 'github.com':
  ensure => present,
  type   => 'ssh-rsa',
  key    => 'AAAAB3Nza[...]UFFAaQ==',
}

Reference

Please see REFERENCE.md for the reference documentation.

This module is documented using Puppet Strings.

For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.

To generate documentation locally, run the following command:

bundle install
bundle exec puppet strings generate ./lib/**/*.rb

This command will create a browsable \_index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.

Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.