saltstack-formulas/users-formula
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Configure users via pillar https://github.com/saltstack-formulas/users-formula/
415 Commits 3 Branches 13 Tags 690 KiB
SaltStack 55.6%
Ruby 11.9%
Vim Script 11.5%
JavaScript 9.4%
Jinja 7.1%
Other 4.5%
b5aac7797c
Go to file
semantic-release-bot b5aac7797c chore(release): 0.48.5 [skip ci] 
## [0.48.5](https://github.com/saltstack-formulas/users-formula/compare/v0.48.4...v0.48.5) (2020-07-25)

### Bug Fixes

* **macos:** gid must be numeric on macos ([9517e4b](9517e4b069))

### Continuous Integration

* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([40f8e2d](40f8e2d181))
* **gemfile.lock:** add to repo with updated `Gemfile` [skip ci] ([ad7e8f7](ad7e8f7cab))
* **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([4441c59](4441c597bd))
* **kitchen:** use `saltimages` Docker Hub where available [skip ci] ([c12272e](c12272eaae))
* **kitchen+travis:** remove `master-py2-arch-base-latest` [skip ci] ([892868f](892868f3b5))
* **travis:** add notifications => zulip [skip ci] ([628a430](628a430681))
* **travis:** apply changes from build config validation [skip ci] ([9f76672](9f766728d4))
* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([9a983a4](9a983a4c2a))
* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([f9f8f13](f9f8f13693))
* **travis:** run `shellcheck` during lint job [skip ci] ([e09c822](e09c822165))
* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([0afebc6](0afebc6fc3))
* **travis:** use build config validation (beta) [skip ci] ([0ddb90e](0ddb90e6b5))
* **workflows/commitlint:** add to repo [skip ci] ([7419dda](7419dda3a4))
2020-07-25 19:52:23 +00:00
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 2020-05-04 09:33:39 +01:00
bin ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 22:27:59 +01:00
docs chore(release): 0.48.5 [skip ci] 2020-07-25 19:52:23 +00:00
test Merge pull request #216 from myii/add-test-vimrc-generation 2019-11-08 19:53:26 +01:00
users fix(macos): gid must be numeric on macos 2020-07-25 16:37:26 +02:00
.gitignore ci(gemfile.lock): add to repo with updated Gemfile [skip ci] 2020-04-21 22:11:59 +01:00
.rubocop.yml chore(rubocop): use org-wide standard settings for Metrics/BlockLength [skip ci] 2020-04-18 13:47:55 +01:00
.salt-lint ci(travis): update salt-lint config for v0.0.10 [skip ci] 2019-10-23 17:34:28 +01:00
.travis.yml ci(travis): add notifications => zulip [skip ci] 2020-05-21 20:11:58 +01:00
.yamllint ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 22:27:59 +01:00
AUTHORS.md chore(release): 0.48.5 [skip ci] 2020-07-25 19:52:23 +00:00
CHANGELOG.md chore(release): 0.48.5 [skip ci] 2020-07-25 19:52:23 +00:00
CODEOWNERS chore(codeowners): update semantic-release related files [skip ci] 2020-05-04 23:19:22 +01:00
commitlint.config.js feat(semantic-release): implement for this formula 2019-08-07 15:20:26 +01:00
FORMULA chore(release): 0.48.5 [skip ci] 2020-07-25 19:52:23 +00:00
Gemfile ci(gemfile.lock): add to repo with updated Gemfile [skip ci] 2020-04-21 22:11:59 +01:00
Gemfile.lock chore(gemfile.lock): update to latest gem versions (2020-W27) [skip ci] 2020-07-06 14:32:55 +01:00
kitchen.yml ci(kitchen): use saltimages Docker Hub where available [skip ci] 2020-06-15 17:03:16 +01:00
LICENSE Removing extra new line characters 2015-05-07 13:39:04 -04:00
pillar.example fix(pillars): ensure addusers & delusers are lists 2019-11-02 09:14:51 +00:00
pre-commit_semantic-release.sh ci(travis): run shellcheck during lint job [skip ci] 2019-11-27 20:58:37 +00:00
release-rules.js feat(semantic-release): implement for this formula 2019-08-07 15:20:26 +01:00
release.config.js fix(release.config.js): use full commit hash in commit link [skip ci] 2019-10-31 10:30:27 +00:00

docs/README.rst

users

Travis CI Build Status Semantic Release

Formula to configure users via pillar.

Table of Contents

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.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Available states

users

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

users.sudo

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

users.bashrc

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

users.profile ^^^^^^^^^^^^^^^^

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

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.

users.user_files

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

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'

Testing

Linux testing is done with kitchen-salt.

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.

bin/kitchen converge

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

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

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

bin/kitchen login

Gives you SSH access to the instance for manual testing.