Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cans/user-make
Ansible role to create a bunch of users on target hosts
https://github.com/cans/user-make
Last synced: 9 days ago
JSON representation
Ansible role to create a bunch of users on target hosts
- Host: GitHub
- URL: https://github.com/cans/user-make
- Owner: cans
- License: gpl-2.0
- Created: 2017-04-23T20:26:35.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-24T08:15:05.000Z (over 5 years ago)
- Last Synced: 2024-11-14T20:18:28.915Z (2 months ago)
- Language: Shell
- Size: 45.9 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.rst
- License: LICENSE
Awesome Lists containing this project
README
cans.user-make
==============
[](https://travis-ci.org/cans/user-make)
[](https://galaxy.ansible.com/cans/user-make)
[](LICENSE)
Ansible role to create a bunch of users on target hosts
### How does it work ?
Each user to create has to be defined with an item as follows:
```yaml
usermake_users:
- name: "johndoe" # mandatory
gecos: "John Doe,,," # default: omit
groups: "sudo,adm" # default: omit
passwordless_sudo: true # default: usermake_sudoer_passwordless
ssh_key_create: false # default: true
ssh_key_upload_to_ec2: true # default: usermake_ssh_key_upload_to_ec2
ssh_key_download: true # default: usermake_ssh_key_download
suoder: true # default: usermake_sudoer
system: false # default: false
upload_my_key: false # default: usermake_upload_ssh_key_to_target
remove: false # default: omit or usermake_remove
home_dir: "/home/jdoe" # default: usermake_home_base_dir/name
```
Here is the meaning of each varbiable found in the item:
- `name`: the login name to give to the new user;
- `gecos`: then [GECOS](https://en.wikipedia.org/wiki/Gecos_field) data
to attach to the new user;
- `groups`: the list of groups the user should belong to. Groups listed
here are supposed to exist *a priori* (cf. also the [next section](#cannotdo))
- `passwordless_sudo`: when set to `true` the user will be allowed to assume
other user identy without typing in any password;
- `remove`: when the item *state* value is *'absent'* tells whether to
remove the files owned by the user when its account is deleted (can be slow);
- `ssh_key_create`: whether to generate a SSH key pair for the new user;
- `ssh_key_download`: whether to download the user's generated SSH
public key to a folder on the local machine (see also the
`usermake_ssh_key_download_dir` defined below).
- `ssh_key_upload_to_ec2`: whether to upload the user's generated SSH
public key to AWS EC2 key management system.
- `remove`
- `state`: whether to create ) or delete () the user indicated with the
values *'present'* or *'absent'* respectively (default: *'present'*);
- `sudoer`: if set to true the user will gain sudo privileges (see also
the `usermake_sudoer` variable);
- `system`: whether the user should be a system user (w. a low UID
number and disabled login);
- `upload_my_key`: whether to upload your local ssh key to the target
host.
All these values, if defined, will override the default define in the
[role variables](#role-variables) section below.
### What this role cannot do ?
It cannot append users to new groups, it will override the user's groups
with the given list of group(s).
Requirements
------------
This role has no specific requirement.
All the variable names used in this role are namespaced with the prefix
`usermake_`.
- `usermake_home_base_dir`: let's you override the path of the directory
where users home are created (default: `/home`);
- `usermake_remove`: whether to remove users home directory when they
are deleted (default: *false*);
- `usermake_ssh_key_create`: whether to create an ssh key pair for the
new users by default (default: *true*);
- `usermake_ssh_key_download`: whether to download created users' ssh
keys locally;
- `usermake_ssh_key_download_dir`: the directory where to store downloaded
public SSH keys (default: *`{{ playbook_dir }}/collected-keys`*);
- `usermake_ssh_key_download_dir_mode`: the mode of the directory where
to store downloaded public SSH keys (default: *0750*);
- `usermake_ssh_key_passphrase`: the default passphrases to encrypt ssh
private keys. It is not recommanded to rely on this. You should provide
passphrases by other means. (default: `omit` [no passphrase]);
- `usermake_sudoer`: whether the created users should be sudoers by
default (default: *false*);
Note: before granting elevated privileges to any user with this,
consider distros provide a sudo package that defines a `sudo` or
`sudoers` group that already grants some privileges to its members.
The present mecanism is more intended for pre-setting high privilege
user on disk images to enable easy setup and provisioning. Not to
manage fine grain user or application privileges;
- `usermake_sudoer_dir`: directory on the target machines in which place
the sudoer rule files (default: `/etc/sudoers.d`)
- `usermake_system`: whether the created users should be system users
by default (default: *false*);
- `usermake_upload_ssh_key_to_target`: whether to upload the local user's
SSH public key to the target host. Useful if you plan to perform tasks
as that user in the next tasks or roles of your playbook (default: *true*);
- `usermake_upload_ssh_key_file`: when `usermake_upload_ssh_key_to_target`
or a user's item `upload_my_key` value is `true`, points to the file where
read the public key to upload (default: `~/.ssh/id_rsa.pub`);
- `usermake_user_groups`: the groups to assign the created users to by
default (default: `omit`);
- `usermake_users`: the list of users to create, defined with items as
described above (default: `[]`);
Dependencies
------------
This role has no dependency
Example Playbook
----------------
Creating some users:
```yaml
- hosts: servers
roles:
- role: cans.user-make
usermake_users:
- name: "alice"
groups: "sudo,adm"
system: "no"
ssh_key_create: "yes"
- name: "bob"
gecos: "Bob no sponge,,,"
system: "yes"
ssh_key_create: true
```
Deleting some users:
```yaml
- hosts: servers
roles:
- role: cans.user-make
usermake_users:
- name: "alice"
state: "absent"
remove: true # Remove all users files
- name: "bob"
state: "absent"
```
You might also want to have a look at the tests found in
`tests/test.yml` for many more (hopefully exhaustive) usage
examples of this role.
Todo
----
Implement integration testing for AWS key upload.
License
-------
GPLv2
Author Information
------------------
Copyright © 2017, Nicolas CANIART.