Salt/sudoers-formula
0
0
Fork 0
mirror of https://github.com/saltstack-formulas/sudoers-formula.git synced 2024-11-27 22:38:22 +01:00
Code Issues Activity
v0.23.4
sudoers-formula/docs
History
semantic-release-bot 9da1c8cb81 chore(release): 0.23.4 [skip ci] 
## [0.23.4](https://github.com/saltstack-formulas/sudoers-formula/compare/v0.23.3...v0.23.4) (2021-04-30)

### Bug Fixes

* **sudoers/included:** fix idempotence with purge_includedir=True ([a64bf89](a64bf89777))

### Continuous Integration

* **gemfile+lock:** use `ssf` customised `kitchen-docker` repo [skip ci] ([73379d6](73379d6b23))
* **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] ([32e3825](32e3825e63))
* **kitchen+gitlab:** adjust matrix to add `3003` [skip ci] ([285cdaa](285cdaa778))
* **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] ([cfb67f9](cfb67f9545))
* **pre-commit:** update hook for `rubocop` [skip ci] ([7c1b16f](7c1b16f963))

### Tests

* **_mapdata:** add verification file for `fedora-34` [skip ci] ([d90f31b](d90f31bbfa))
* standardise use of `share` suite & `_mapdata` state [skip ci] ([e58973f](e58973f6a7))
* **_mapdata:** add verification files for new platforms ([96a5724](96a5724ffc))
* **share:** standardise with latest changes [skip ci] ([67f85fa](67f85fa218))
2021-04-30 15:57:50 +00:00
..
AUTHORS.rst chore(release): 0.23.4 [skip ci] 2021-04-30 15:57:50 +00:00
CHANGELOG.rst chore(release): 0.23.4 [skip ci] 2021-04-30 15:57:50 +00:00
README.rst docs(readme): update link to CONTRIBUTING [skip ci] 2019-10-14 11:38:42 +01:00

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.