1
0
Fork 0
sudoers saltstack formula
Go to file
pre-commit-ci[bot] 63fc2dec05
ci(pre-commit.ci): perform `pre-commit` autoupdate
updates:
- [github.com/rubocop-hq/rubocop: v1.30.1 → v1.62.1](https://github.com/rubocop-hq/rubocop/compare/v1.30.1...v1.62.1)
- [github.com/shellcheck-py/shellcheck-py: v0.8.0.4 → v0.10.0.1](https://github.com/shellcheck-py/shellcheck-py/compare/v0.8.0.4...v0.10.0.1)
- [github.com/adrienverge/yamllint: v1.26.3 → v1.35.1](https://github.com/adrienverge/yamllint/compare/v1.26.3...v1.35.1)
- [github.com/warpnet/salt-lint: v0.8.0 → v0.9.2](https://github.com/warpnet/salt-lint/compare/v0.8.0...v0.9.2)
- https://github.com/myint/rstcheckhttps://github.com/rstcheck/rstcheck
- [github.com/rstcheck/rstcheck: 3f929574 → v6.2.0](https://github.com/rstcheck/rstcheck/compare/3f929574...v6.2.0)
- [github.com/saltstack-formulas/mirrors-rst-lint: v1.3.2 → v1.4.0](https://github.com/saltstack-formulas/mirrors-rst-lint/compare/v1.3.2...v1.4.0)
2024-04-01 21:31:21 +00:00
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 2020-05-04 09:32:25 +01:00
bin chore(gemfile.lock): update to latest gem versions (2022-W28) [skip ci] 2022-07-17 19:48:40 +01:00
docs chore(release): 0.25.0 [skip ci] 2021-08-29 00:09:11 +00:00
sudoers ci(appended): add second test suite 2021-08-19 01:24:17 +01:00
test chore(gemfile.lock): update to latest gem versions (2022-W28) [skip ci] 2022-07-17 19:48:40 +01:00
.gitignore ci(kitchen+ci): update with latest CVE pre-salted images [skip ci] 2021-10-05 11:17:35 +01:00
.gitlab-ci.yml ci: update `pre-commit` configuration inc. for pre-commit.ci [skip ci] 2022-06-09 00:06:09 +01:00
.pre-commit-config.yaml ci(pre-commit.ci): perform `pre-commit` autoupdate 2024-04-01 21:31:21 +00:00
.rstcheck.cfg chore(pre-commit): use `info` report level for `rstcheck` [skip ci] 2021-05-20 14:11:06 +01:00
.rubocop.yml ci: update linters to latest versions [skip ci] 2022-02-12 23:24:43 +00:00
.salt-lint ci(travis): update `salt-lint` config for `v0.0.10` [skip ci] 2019-10-23 17:35:46 +01:00
.travis.yml ci: update `pre-commit` configuration inc. for pre-commit.ci [skip ci] 2022-06-09 00:06:09 +01:00
.yamllint ci: add Debian 11 Bullseye & update `yamllint` configuration [skip ci] 2021-07-18 19:05:46 +01:00
AUTHORS.md chore(release): 0.25.0 [skip ci] 2021-08-29 00:09:11 +00:00
CHANGELOG.md chore(release): 0.25.0 [skip ci] 2021-08-29 00:09:11 +00:00
CODEOWNERS ci(kitchen+ci): update with `3004` pre-salted images/boxes [skip ci] 2021-11-23 10:37:54 +00:00
FORMULA chore(release): 0.25.0 [skip ci] 2021-08-29 00:09:11 +00:00
Gemfile chore(gemfile.lock): update to latest gem versions (2022-W22) [skip ci] 2022-05-30 17:29:41 +01:00
Gemfile.lock chore(gemfile.lock): update to latest gem versions (2022-W28) [skip ci] 2022-07-17 19:48:40 +01:00
LICENSE Applied review comments 2014-02-09 19:06:18 +01:00
commitlint.config.js chore(commitlint): add `{body,footer,header}-max(-line)-length` [skip ci] 2020-10-07 09:10:28 +01:00
kitchen.yml ci: update `pre-commit` configuration inc. for pre-commit.ci [skip ci] 2022-06-09 00:06:09 +01:00
pillar.example feat(ordering): optionally append includefiles to main config 2021-08-19 00:36:59 +01:00
pre-commit_semantic-release.sh chore(semantic-release): replace broken `m2r` with `m2r2` [skip ci] 2022-01-17 08:16:42 +00:00
release-rules.js feat: implementing semantic release 2019-05-29 17:41:56 +02:00
release.config.js ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:40:57 +00:00

docs/README.rst

sudoers-formula
===============

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/sudoers-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/sudoers-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

Set up ``sudo`` and the ``sudoers`` included files.

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

``sudoers``
^^^^^^^^^^^

Set up the sudoers file

``sudoers.included``
^^^^^^^^^^^^^^^^^^^^

Set up an additional sudoers included file.


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 ``sudoers`` 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.