weareinteractive.users
is an Ansible role which:
- manges users
- manages user's private key
- manages user's authorized keys
Note:
Since Ansible Galaxy switched all role names to the organization name, this role has moved from
franklinkim.users
toweareinteractive.users
!
Using ansible-galaxy
:
$ ansible-galaxy install weareinteractive.users
Using requirements.yml
:
- src: weareinteractive.users
Using git
:
$ git clone https://github.com/weareinteractive/ansible-users.git weareinteractive.users
- Ansible >= 2.4
Here is a list of all the default variables for this role, which are also available in defaults/main.yml
.
---
# This role takes advantage of Ansible's user role.
# All user related properties will fall back to Ansible's default values.
# @see http://docs.ansible.com/ansible/user_module.html
#
# users:
# - username: foobar (required)
# name: Foo Bar
# uid: 1000
# group: staff
# password: xxxxx (a hash created with: mkpasswd)
# groups: ["adm", "www-data"]
# append: no (only append groups, leave others)
# home_mode: "0750"
# home_create: yes
# home: /path/to/user/home
# home_files:
# - "/path/to/user/home/.bashrc"
# - "/path/to/user/home/.bash_profile"
# system: no
# authorized_keys:
# - "xxx"
# - "{{ lookup('file', '/path/to/id_rsa.pub') }}"
# authorized_keys_exclusive: yes
# ssh_key_type: rsa
# ssh_key_bits: 2048
# ssh_key_password: ""
# ssh_key_generate: no
# ssh_key: "xxx" or "{{ lookup('file', '/path/to/id_rsa') }}"
# ssh_keys:
# id_rsa_1: "xxx" or "{{ lookup('file', '/path/to/id_rsa') }}"
# id_rsa_2: "xxx" or "{{ lookup('file', '/path/to/id_rsa') }}"
# shell: /bin/bash
# update_password: always
#
# users_remove:
# - foobar
# - { username: foobar, remove: no }
# list of users to add
users: []
# default user's dotfiles
users_home_files: []
# users home directory
users_home: /home
# create user's home directory
users_home_create: yes
# default user's primary group for users
users_group:
# default user's secondary groups
users_groups: []
# default user's home directory permissions
users_home_mode: "0755"
# default user login shell
#users_shell:
# default user's ssh key type
users_ssh_key_type: rsa
# default user's ssh key bits
users_ssh_key_bits: 2048
# default user's setting for authorized keys exclusive
users_authorized_keys_exclusive: no
# list of users to be removed
users_remove: []
This is an example playbook:
---
- hosts: all
become: yes
roles:
- weareinteractive.users
vars:
users:
- username: foobar
name: Foo Bar 1
- username: foobar_authorized_keys
authorized_keys:
- "{{ lookup('file', 'tests/id_rsa.pub') }}"
home_create: yes
- username: foobar_nohome
home_create: no
- username: foobar_groups
groups:
- users
append: yes
- username: foobar_groups_reset
groups: []
group: foobar_groups_reset
- username: foobar_home_mode
home_mode: "0750"
- username: foobar_key
ssh_key: "{{ lookup('file', 'tests/id_rsa') }}"
- username: foobar_keys
ssh_keys:
id_rsa_1: "{{ lookup('file', 'tests/id_rsa') }}"
id_rsa_2: "{{ lookup('file', 'tests/id_rsa') }}"
- username: foobar_key_generate
ssh_key_generate: yes
ssh_key_password: secret
- username: foobar_system
system: yes
- username: foobar_file
home_files:
- "tests/.bashrc"
users_group: staff
users_groups:
- www-data
users_authorized_keys_exclusive: yes
users_remove:
- foobar
- { username: foobar_key, remove: no }
- { username: foobar_authorized_keys, remove: yes }
$ git clone https://github.com/weareinteractive/ansible-users.git
$ cd ansible-users
$ make test
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests and examples for any new or changed functionality.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Note: To update the README.md
file please install and run ansible-role
:
$ gem install ansible-role
$ ansible-role docgen
Copyright (c) We Are Interactive under the MIT license.