Skip to content

imtpot/users-formula

 
 

Repository files navigation

users

Travis CI Build Status Semantic Release

Formula to configure users via pillar.

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.

Commit message formatting is significant!!

Please see How to contribute for more details.

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

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

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

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

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.

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

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'

Linux testing is done with kitchen-salt.

  • 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.

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

Runs the inspec tests on the actual instance.

Removes the docker instance.

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

Gives you SSH access to the instance for manual testing.

Packages

No packages published

Languages

  • SaltStack 61.8%
  • Vim Script 13.2%
  • JavaScript 10.1%
  • HTML 7.3%
  • Shell 3.9%
  • Ruby 3.7%