1
0
Fork 0
mirror of synced 2024-06-24 16:21:09 -04:00
sudoers saltstack formula
Go to file
2019-09-22 22:40:35 +01:00
bin feat: implementing semantic release 2019-05-29 17:41:56 +02:00
docs chore(release): 0.22.0 [skip ci] 2019-08-17 09:31:40 +00:00
sudoers Fix issue #25 2018-11-07 10:18:05 +13:00
test ci(platform): add arch-base-latest 2019-09-22 22:40:35 +01:00
.gitignore chore: use semantic-release cross-formula standard structure 2019-07-19 13:38:21 +01:00
.travis.yml ci(platform): add arch-base-latest 2019-09-22 22:40:35 +01:00
.yamllint ci(yamllint): add rule empty-values & use new yaml-files setting 2019-09-10 05:56:12 +01:00
AUTHORS.md chore(release): 0.22.0 [skip ci] 2019-08-17 09:31:40 +00:00
CHANGELOG.md chore(release): 0.22.0 [skip ci] 2019-08-17 09:31:40 +00:00
commitlint.config.js feat: implementing semantic release 2019-05-29 17:41:56 +02:00
FORMULA chore(release): 0.22.0 [skip ci] 2019-08-17 09:31:40 +00:00
Gemfile feat: implementing kitchen tests and activate them on travis 2019-05-27 16:13:58 +02:00
kitchen.yml ci(platform): add arch-base-latest 2019-09-22 22:40:35 +01:00
LICENSE Applied review comments 2014-02-09 19:06:18 +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 feat: implementing semantic release 2019-05-29 17:41:56 +02:00
release-rules.js feat: implementing semantic release 2019-05-29 17:41:56 +02:00
release.config.js feat: implementing semantic release 2019-05-29 17:41:56 +02:00

.. _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 :ref:`How to contribute <CONTRIBUTING>` 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.