1
0
Fork 0
saltstack formula for sudoers
Go to file
Imran Iqbal 242f71956d ci(kitchen): use `saltimages` Docker Hub where available [skip ci]
* Automated using https://github.com/myii/ssf-formula/pull/223
2020-06-15 17:00:53 +01:00
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 2020-05-04 09:32:25 +01:00
bin ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 2019-10-09 03:08:31 +01:00
docs docs(contributing): remove to use org-level file instead [skip ci] 2019-10-14 12:30:39 +01:00
sudoers Fix issue #25 2018-11-07 10:18:05 +13:00
test fix(rubocop): fix remaining errors manually 2019-10-11 21:33:11 +01:00
.gitignore ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 2020-04-21 22:10:46 +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(travis): add notifications => zulip [skip ci] 2020-05-21 20:10:44 +01:00
.yamllint ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 2019-10-09 03:08:31 +01:00
AUTHORS.md chore(release): 0.22.1 [skip ci] 2019-10-11 21:36:48 +00:00
CHANGELOG.md chore(release): 0.22.1 [skip ci] 2019-10-11 21:36:48 +00:00
CODEOWNERS chore(codeowners): update `semantic-release` related files [skip ci] 2020-05-04 23:18:19 +01:00
FORMULA chore(release): 0.22.1 [skip ci] 2019-10-11 21:36:48 +00:00
Gemfile ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 2020-04-21 22:10:46 +01:00
Gemfile.lock chore(gemfile.lock): update to latest gem versions [skip ci] 2020-06-15 15:11:26 +01:00
LICENSE Applied review comments 2014-02-09 19:06:18 +01:00
commitlint.config.js feat: implementing semantic release 2019-05-29 17:41:56 +02:00
kitchen.yml ci(kitchen): use `saltimages` Docker Hub where available [skip ci] 2020-06-15 17:00:53 +01:00
pillar.example feat(yamllint): include for this repo and apply rules throughout 2019-08-16 19:22:11 +01:00
pre-commit_semantic-release.sh ci(travis): run `shellcheck` during lint job [skip ci] 2019-11-27 20:59:12 +00:00
release-rules.js feat: implementing semantic release 2019-05-29 17:41:56 +02:00
release.config.js fix(release.config.js): use full commit hash in commit link [skip ci] 2019-10-31 10:32:31 +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.