https://github.com/geerlingguy/ansible-role-github-users

Ansible Role - GitHub Users
https://github.com/geerlingguy/ansible-role-github-users

account-management ansible ansible-role authorized-keys github role ssh users

Last synced: about 1 month ago
JSON representation

Ansible Role - GitHub Users

• Host: GitHub
• URL: https://github.com/geerlingguy/ansible-role-github-users
• Owner: geerlingguy
• License: mit
• Created: 2017-10-11T19:39:21.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-09T15:55:30.000Z (2 months ago)
• Last Synced: 2024-09-30T17:41:30.881Z (about 1 month ago)
• Topics: account-management, ansible, ansible-role, authorized-keys, github, role, ssh, users
• Homepage: https://galaxy.ansible.com/geerlingguy/github-users/
• Size: 30.3 KB
• Stars: 58
• Watchers: 4
• Forks: 18
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ansible Role: GitHub Users

[![CI](https://github.com/geerlingguy/ansible-role-github-users/workflows/CI/badge.svg?event=push)](https://github.com/geerlingguy/ansible-role-github-users/actions?query=workflow%3ACI)

Create users based on GitHub accounts.

This role will take a GitHub username and create a system account with the same username, and will add all the pubkeys associated with the GitHub account to the user's `authorized_keys`.

It's kind of a cheap way to do public key management for users on your system... but it works!

## Requirements

None.

## Role Variables

Available variables are listed below, along with default values (see `defaults/main.yml`):

    github_users: []

      # You can specify an object with 'name' (required) and 'groups' (optional):

      # - name: geerlingguy

      #   groups: www-data,sudo

    

      # Or you can specify a GitHub username directly:

      # - geerlingguy

A list of users to add to the server; the username will be the `name` (or the bare list item, if it's a string instead of an object). You can add the user to one or more groups (in addition to the `[username]` group) by adding them as a comma-separated list in `groups`.

    github_users_absent: []

      # You can specify an object with 'name' (required):

      # - name: geerlingguy

    

      # Or you can specify a GitHub username directly:

      # - geerlingguy

A list of users who should _not_ be present on the server. The role will ensure these user accounts are removed.

    github_users_authorized_keys_exclusive: true

Whether the users' `authorized_keys` files should exclusively contain keys from their GitHub account. This should normally be set to `true` if you are only allowing users to log in using keys available in their GitHub accounts.

    github_url: https://github.com

By default, use public GitHub (i.e. https://github.com) as the source for users/keys. Override this to use a different GitHub instance/endpoint (e.g. GitHub Enterprise).

If you need to give the user the ability to self-manage their `authorized_keys` file, then you should set this to `no`, and it will only append new keys, but never remove any additional keys (e.g. old keys removed from their GitHub profile, or keys the end user added manually) from the file.

## Dependencies

None.

## Example Playbook

    - hosts: servers

    

      vars:

        github_users:

          # You can specify the `name`:

          - name: geerlingguy

            groups: sudo,www-data

          - name: GrahamCampbell

          # Or if you don't need to override anything, you can specify the

          # GitHub username directly:

          - fabpot

    

        github_users_absent:

          - johndoe

          - name: josh

    

      roles:

        - geerlingguy.github-users

If you want to make sure users' public keys are in sync, it is best to run the playbook on a cron, e.g. every 5 min, 10 min, or some other interval. That way you don't have to manually add new keys for users.

## License

MIT / BSD

## Author Information

This role was created in 2017 by [Jeff Geerling](https://www.jeffgeerling.com/), author of [Ansible for DevOps](https://www.ansiblefordevops.com/).