users-formula

Travis CI Build Status Semantic Release

Formula to configure users via pillar.

1. General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

3. Available states

3.1. users

Configures a user’s home directory, group, the user itself, secondary groups, and associated keys. Also configures sudo access, and absent users.

3.2. users.sudo

Ensures the sudo group exists, the sudo package is installed and the sudo file is configured.

3.3. users.bashrc

Ensures the bashrc file exists in the users home directory. Sets 'manage_bashrc: True' in pillar per user. Defaults to False.

3.4. users.profile

Ensures the profile file exists in the users home directory. Sets 'manage_profile: True' in pillar per user. Defaults to False.

3.5. users.vimrc

Ensures the vimrc file exists in the users home directory. Sets 'manage_vimrc: True' in pillar per user. Defaults to False. This depends on the vim-formula being available and pillar users:use_vim_formula: True.

3.6. users.user_files

Permits the abitrary management of files. See pillar.example for configuration details.

4. Overriding default values

In order to separate actual user account definitions from configuration the pillar users-formula was introduced:

users:
  myuser:
    # stuff

users-formula:
  lookup:
    root_group: toor
    shell: '/bin/zsh'

5. Testing

Linux testing is done with kitchen-salt.

5.1. Requirements

  • Ruby

  • Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

5.2. bin/kitchen converge

Creates the docker instance and runs the template main state, ready for testing.

5.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

5.4. bin/kitchen destroy

Removes the docker instance.

5.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

5.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.