Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

githubkey

Module to allow importing of github ssh keys to local system
Project URLRSS FeedReport issues

13,717 downloads

9,580 latest version

1.9 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.1.1 (latest)
  • 1.1.0
  • 1.0.0
  • 0.0.2
  • 0.0.1
released Oct 22nd 2015

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'jlondon-githubkey', '1.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jlondon-githubkey
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jlondon-githubkey --version 1.1.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: ssh, github, public-keys, authorized-keys

Documentation

jlondon/githubkey — version 1.1.1 Oct 22nd 2015

githubkey

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with githubkey
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Overview

This module allows you to input an array of github usernames and import their public key entries to the local system. This allows you to do fun things like have development systems which lock down to a specific set of developers without needing to store their public keys locally!

Module Description

Setup of authorized_keys file based upon an array of github usernames.

Setup

puppet module install jlondon/githubkey

What githubkey affects

  • The authorized_keys file for the specified system username will be modified by puppet
  • Don't add usernames if you don't EXPLICITLY want them to be able to login to your servers. They can and potentially WILL login via ssh if you give them access!

Beginning with githubkey

  • Requires the puppet-stdlib module.

Usage

Based upon a list of usernames fed to the class we can import SSH public keys from github to a local authorized_keys file:

class {'githubkey':
  ensure            => present,
  auth_user         => 'root',
  github_auth_user  => 'myuser',
  github_auth_token => '124135213562n246346346',
  usernames         => ['github'],
}

Limitations

Should support any standard Puppet compatible OS as it doesn't really do anything based upon system commands.

Development

Feel free to add or remove features to this module. If you do something great please open a pull request so it can be added to the main module!