sudoers saltstack formula
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Imran Iqbal 7912f2c8b3
chore(gemfile.lock): update to latest gem versions (2021-W38) [skip ci]
2 days ago
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 1 year ago
bin ci(pre-commit): add to formula [skip ci] 12 months ago
docs chore(release): 0.25.0 [skip ci] 4 weeks ago
sudoers ci(appended): add second test suite 1 month ago
test ci: review #78, fix verification files & standardise structure [skip ci] 3 weeks ago
.gitignore chore: standardise structure (`.gitignore` & `_mapdata.rb`) [skip ci] 7 months ago
.gitlab-ci.yml ci: review #78, fix verification files & standardise structure [skip ci] 3 weeks ago
.pre-commit-config.yaml ci(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] 3 months ago
.rstcheck.cfg chore(pre-commit): use `info` report level for `rstcheck` [skip ci] 4 months ago
.rubocop.yml test: standardise use of `share` suite & `_mapdata` state [skip ci] 6 months ago
.salt-lint ci(travis): update `salt-lint` config for `v0.0.10` [skip ci] 2 years ago
.travis.yml ci: review #78, fix verification files & standardise structure [skip ci] 3 weeks ago
.yamllint ci: add Debian 11 Bullseye & update `yamllint` configuration [skip ci] 2 months ago
AUTHORS.md chore(release): 0.25.0 [skip ci] 4 weeks ago
CHANGELOG.md chore(release): 0.25.0 [skip ci] 4 weeks ago
CODEOWNERS chore: update `CODEOWNERS` & `.yamllint` re: `kitchen-vagrant` [skip ci] 6 months ago
FORMULA chore(release): 0.25.0 [skip ci] 4 weeks ago
Gemfile ci(gemfile+lock): use `ssf` customised `inspec` repo [skip ci] 2 months ago
Gemfile.lock chore(gemfile.lock): update to latest gem versions (2021-W38) [skip ci] 2 days ago
LICENSE Applied review comments 8 years ago
commitlint.config.js chore(commitlint): add `{body,footer,header}-max(-line)-length` [skip ci] 12 months ago
kitchen.yml Merge pull request #78 from noelmcloughlin/append 4 weeks ago
pillar.example feat(ordering): optionally append includefiles to main config 1 month ago
pre-commit_semantic-release.sh ci(gitlab-ci): use GitLab CI as Travis CI replacement 9 months ago
release-rules.js feat: implementing semantic release 2 years ago
release.config.js ci(gitlab-ci): use GitLab CI as Travis CI replacement 9 months ago

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.