Salt/sysctl-formula
0
0
Fork 0
mirror of https://github.com/saltstack-formulas/sysctl-formula.git synced 2024-11-27 23:07:54 +01:00
Code Issues Activity
c9fdc8f634
sysctl-formula/docs
History
semantic-release-bot 132804c09a chore(release): 0.6.3 [skip ci] 
## [0.6.3](https://github.com/saltstack-formulas/sysctl-formula/compare/v0.6.2...v0.6.3) (2020-12-16)

### Bug Fixes

* **release.config.js:** use full commit hash in commit link [skip ci] ([2099574](20995746db))

### Continuous Integration

* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([5671b69](5671b6995e))
* **gemfile.lock:** add to repo with updated `Gemfile` [skip ci] ([cf7e8f1](cf7e8f1528))
* **gitlab-ci:** use GitLab CI as Travis CI replacement ([1ad61e6](1ad61e6736))
* **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([62455ed](62455ed3b5))
* **kitchen:** use `debian-10-master-py3` instead of `develop` [skip ci] ([dd28ef7](dd28ef7d51))
* **kitchen:** use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([fba7752](fba7752311))
* **kitchen:** use `saltimages` Docker Hub where available [skip ci] ([d352001](d3520014ff))
* **kitchen+travis:** remove `master-py2-arch-base-latest` [skip ci] ([e37c3c9](e37c3c9c8c))
* **kitchen+travis:** upgrade matrix after `2019.2.2` release [skip ci] ([017ac0b](017ac0b76f))
* **pre-commit:** add to formula [skip ci] ([f76d8ba](f76d8ba57d))
* **pre-commit:** enable/disable `rstcheck` as relevant [skip ci] ([2dac756](2dac7562b5))
* **pre-commit:** finalise `rstcheck` configuration [skip ci] ([ba59cf8](ba59cf8b3c))
* **travis:** add notifications => zulip [skip ci] ([c47c82b](c47c82be74))
* **travis:** apply changes from build config validation [skip ci] ([212a480](212a480d6c))
* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([a3fe460](a3fe460fb9))
* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([d36ef2b](d36ef2bacd))
* **travis:** run `shellcheck` during lint job [skip ci] ([5f2b8d2](5f2b8d2714))
* **workflows/commitlint:** add to repo [skip ci] ([c821d14](c821d1440e))
* workaround issues with newly introduced `amazonlinux-1` [skip ci] ([1ba6ba5](1ba6ba5439))
* **travis:** update `salt-lint` config for `v0.0.10` [skip ci] ([7dd544a](7dd544a764))
* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([8cdbf5f](8cdbf5f257))
* **travis:** use build config validation (beta) [skip ci] ([eb85483](eb854836d7))

### Documentation

* **contributing:** remove to use org-level file instead [skip ci] ([5f1562f](5f1562fd57))
* **readme:** update link to `CONTRIBUTING` [skip ci] ([510899f](510899f858))

### Performance Improvements

* **travis:** improve `salt-lint` invocation [skip ci] ([07511af](07511afe0a))
2020-12-16 06:54:02 +00:00
..
AUTHORS.rst chore(release): 0.6.3 [skip ci] 2020-12-16 06:54:02 +00:00
CHANGELOG.rst chore(release): 0.6.3 [skip ci] 2020-12-16 06:54:02 +00:00
README.rst docs(readme): update link to CONTRIBUTING [skip ci] 2019-10-14 11:38:49 +01:00

README.rst 

.. _readme:

sysctl-formula
==============

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/sysctl-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/sysctl-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

Formula to set up and configure sysctl.

.. 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:

``sysctl``
^^^^^^^^^^
Installs and configures the sysctl package.

``sysctl.package``
^^^^^^^^^^^^^^^^^^
Installs the sysctl package.

``sysctl.param``
^^^^^^^^^^^^^^^
This state manages the file ``sysctl.conf`` under ``/etc/sysctl`` (template found in "sysctl/files"). The configuration is populated by values in "sysctl/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.

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 ``sysctl`` 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.