1
0
Fork 0
saltstack formula for sudoers
Go to file
Imran Iqbal cdf0d44053
ci(gitlab-ci): use GitLab CI as Travis CI replacement
* Automated using https://github.com/myii/ssf-formula/pull/275
2020-12-16 06:40:57 +00:00
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 2020-05-04 09:32:25 +01:00
bin ci(pre-commit): add to formula [skip ci] 2020-10-03 10:53:53 +01:00
docs chore(release): 0.22.2 [skip ci] 2020-08-26 14:53:55 +00:00
sudoers fix: permissions on sudoers include dir were wrong 2020-11-24 21:35:09 -06:00
test test: fix mapdata files 2020-11-24 21:54:25 +01:00
.gitignore ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 2020-04-21 22:10:46 +01:00
.gitlab-ci.yml ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:40:57 +00:00
.pre-commit-config.yaml ci(pre-commit): finalise `rstcheck` configuration [skip ci] 2020-10-10 06:52:24 +01:00
.rstcheck.cfg ci(pre-commit): add to formula [skip ci] 2020-10-03 10:53:53 +01:00
.rubocop.yml chore(rubocop): use org-wide standard settings for `Metrics/BlockLength` [skip ci] 2020-04-18 13:46:48 +01: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(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:40:57 +00:00
.yamllint ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:40:57 +00:00
AUTHORS.md chore(release): 0.22.2 [skip ci] 2020-08-26 14:53:55 +00:00
CHANGELOG.md chore(release): 0.22.2 [skip ci] 2020-08-26 14:53:55 +00:00
CODEOWNERS ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:40:57 +00:00
FORMULA chore(release): 0.22.2 [skip ci] 2020-08-26 14:53:55 +00:00
Gemfile chore(gemfile+lock): update to latest gem versions (2020-W44) [skip ci] 2020-10-26 22:54:25 +00:00
Gemfile.lock chore(gemfile+lock): update to latest gem versions (2020-W44) [skip ci] 2020-10-26 22:54:25 +00: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 test(map): verify `map.jinja` dump using `_mapdata` state 2020-08-25 16:06:48 +01:00
pillar.example feat: implement option to purge included files directory 2020-11-24 18:11:36 +01:00
pre-commit_semantic-release.sh ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:40:57 +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

.. _readme:

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.