0
0
mirror of https://github.com/saltstack-formulas/users-formula.git synced 2024-11-27 22:38:34 +01:00
Go to file
semantic-release-bot 0e5829bc10 chore(release): 0.48.3 [skip ci]
## [0.48.3](https://github.com/saltstack-formulas/users-formula/compare/v0.48.2...v0.48.3) (2019-11-02)

### Bug Fixes

* **pillars:** ensure `addusers` & `delusers` are lists ([b31c592](b31c592147))
* **release.config.js:** use full commit hash in commit link [skip ci] ([8df4d39](8df4d39060))

### Continuous Integration

* **kitchen:** use `debian-10-master-py3` instead of `develop` [skip ci] ([9ee7636](9ee7636477))
* **kitchen+travis:** upgrade matrix after `2019.2.2` release [skip ci] ([1d9a5ef](1d9a5ef5be))
* **travis:** update `salt-lint` config for `v0.0.10` [skip ci] ([60ee61d](60ee61dd66))

### Documentation

* **contributing:** remove to use org-level file instead [skip ci] ([7c55ef0](7c55ef0c0d))
* **readme:** update link to `CONTRIBUTING` [skip ci] ([2a88765](2a887654fc))

### Performance Improvements

* **travis:** improve `salt-lint` invocation [skip ci] ([b45914e](b45914e063))
2019-11-02 09:48:30 +00: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.3 [skip ci] 2019-11-02 09:48:30 +00:00
test fix(pillars): ensure addusers & delusers are lists 2019-11-02 09:14:51 +00:00
users fix(sudo.sls): fix salt-lint errors 2019-10-09 22:27:59 +01:00
.gitignore feat(semantic-release): implement for this formula 2019-08-07 15:20:26 +01:00
.rubocop.yml ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 22:27:59 +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 perf(travis): improve salt-lint invocation [skip ci] 2019-11-02 08:38:02 +00: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.3 [skip ci] 2019-11-02 09:48:30 +00:00
CHANGELOG.md chore(release): 0.48.3 [skip ci] 2019-11-02 09:48:30 +00:00
commitlint.config.js feat(semantic-release): implement for this formula 2019-08-07 15:20:26 +01:00
FORMULA chore(release): 0.48.3 [skip ci] 2019-11-02 09:48:30 +00:00
Gemfile ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 22:27:59 +01:00
kitchen.yml ci(kitchen+travis): upgrade matrix after 2019.2.2 release [skip ci] 2019-10-30 04:48:35 +00: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 feat(semantic-release): implement for this formula 2019-08-07 15:20:26 +01: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

.. _readme:

users
=====

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/users-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/users-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
   :alt: Semantic Release
   :scale: 100%
   :target: https://github.com/semantic-release/semantic-release

Formula to configure users via pillar.

.. contents:: **Table of Contents**

General notes
-------------

See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.

If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.

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 <http://semver.org/>`_.

See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.

Contributing to this repo
-------------------------

**Commit message formatting is significant!!**

Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.

Available states
----------------

.. contents::
   :local:

``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:

.. code-block:: yaml

    users:
      myuser:
        # stuff

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

Testing
-------

Linux testing is done with ``kitchen-salt``.

Requirements
^^^^^^^^^^^^

* Ruby
* Docker

.. code-block:: bash

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