mirror of
https://github.com/saltstack-formulas/sysctl-formula.git
synced 2025-10-29 04:21:06 +01:00
b62df99d54
updates: - [github.com/rubocop-hq/rubocop: v1.30.1 → v1.75.2](https://github.com/rubocop-hq/rubocop/compare/v1.30.1...v1.75.2) - [github.com/shellcheck-py/shellcheck-py: v0.8.0.4 → v0.10.0.1](https://github.com/shellcheck-py/shellcheck-py/compare/v0.8.0.4...v0.10.0.1) - [github.com/adrienverge/yamllint: v1.26.3 → v1.37.0](https://github.com/adrienverge/yamllint/compare/v1.26.3...v1.37.0) - [github.com/warpnet/salt-lint: v0.8.0 → v0.9.2](https://github.com/warpnet/salt-lint/compare/v0.8.0...v0.9.2) - https://github.com/myint/rstcheck → https://github.com/rstcheck/rstcheck - [github.com/rstcheck/rstcheck: 3f929574 → v6.2.4](https://github.com/rstcheck/rstcheck/compare/3f929574...v6.2.4) - [github.com/saltstack-formulas/mirrors-rst-lint: v1.3.2 → v1.4.0](https://github.com/saltstack-formulas/mirrors-rst-lint/compare/v1.3.2...v1.4.0)
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.