users-formula/README.rst

70 lines
1.5 KiB
ReStructuredText
Raw Normal View History

=====
2013-06-19 21:49:29 +02:00
users
=====
Formula to configure users via pillar.
.. note::
See the full `Salt Formulas installation and usage instructions
2014-04-24 22:28:36 +02:00
<http://docs.saltstack.com/topics/development/conventions/formulas.html>`_.
Available states
================
.. contents::
:local:
``users``
---------
2016-07-28 18:53:32 +02:00
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.
2015-06-10 23:00:58 +02:00
``users.bashrc``
----------------
2016-07-28 18:53:32 +02:00
Ensures the bashrc file exists in the users home directory. Sets 'manage_bashrc:
True' in pillar per user. Defaults to False.
2015-06-10 23:00:58 +02:00
2015-08-09 18:59:51 +02:00
``users.profile``
----------------
2016-07-28 18:53:32 +02:00
Ensures the profile file exists in the users home directory. Sets 'manage_profile:
True' in pillar per user. Defaults to False.
2015-08-09 18:59:51 +02:00
2015-06-10 23:00:58 +02:00
``users.vimrc``
---------------
2016-07-28 18:53:32 +02:00
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 to be installed.
``users.user_files``
---------------
Permits the abitrary management of files. See pillar.example for configuration details.
2017-07-12 16:56:57 +02:00
Overriding default values
=========================
In order to separate actual user account definitions from configuration the pillar `users-formula` was introduced:
2017-07-12 16:58:53 +02:00
.. code-bock:: yaml
2017-07-12 17:00:13 +02:00
2017-07-12 16:58:53 +02:00
users:
myuser:
# stuff
users-formula:
lookup:
root_group: toor
shell: '/bin/zsh'