mirror of
https://github.com/saltstack-formulas/sysctl-formula.git
synced 2026-10-02 22:51:44 +02:00
semantic-release-bot
5a1202bfcb
## [0.7.0](https://github.com/saltstack-formulas/sysctl-formula/compare/v0.6.4...v0.7.0) (2026-10-01) ### Features * **map:** adjusted the formula to be more like the template formula ([4a92a91](https://github.com/saltstack-formulas/sysctl-formula/commit/4a92a91c701cb284d08480d93c25ccbe6233d82c)) ### Maintenance * **copier:** apply template `copier-ssf-ci`at v2.10.7 ([bb50197](https://github.com/saltstack-formulas/sysctl-formula/commit/bb50197a2a78abd690a48c2be69432dc183290af)) * **copier:** update template https://github.com/dafyddj/copier-ssf-ci to v2.10.8 ([f59a33e](https://github.com/saltstack-formulas/sysctl-formula/commit/f59a33eb0da9ec5720bd691c514870c7f52f2a27)) * **copier:** update template https://github.com/dafyddj/copier-ssf-ci to v2.11.0 ([13d203a](https://github.com/saltstack-formulas/sysctl-formula/commit/13d203af16c89175eca03089714a227c64ba6e48)) * **copier:** update template https://github.com/dafyddj/copier-ssf-ci to v2.11.13 ([fadd04a](https://github.com/saltstack-formulas/sysctl-formula/commit/fadd04a7bccf4a3783fb6d1a3470e3420e9ba35a)) * **copier:** update template https://github.com/dafyddj/copier-ssf-ci to v2.11.2 ([4d6ae5b](https://github.com/saltstack-formulas/sysctl-formula/commit/4d6ae5bc6daca59c4e12545c2c3e857dff71c3b9)) * **copier:** update template https://github.com/dafyddj/copier-ssf-ci to v2.11.3 ([1a3c116](https://github.com/saltstack-formulas/sysctl-formula/commit/1a3c116c549bdd4a57108c633b7c6d2fa1767dc6)) * **copier:** update template https://github.com/dafyddj/copier-ssf-ci to v2.11.4 ([a8f64d2](https://github.com/saltstack-formulas/sysctl-formula/commit/a8f64d2c854bf7913be74278499249c190d093f6)) * **copier:** update template https://github.com/dafyddj/copier-ssf-ci to v2.11.7 ([1c42e07](https://github.com/saltstack-formulas/sysctl-formula/commit/1c42e0796ae5d4c3f167b657fa66b088bb780b54)) * **style:** fix javascript style in release-rules.js ([956bcfa](https://github.com/saltstack-formulas/sysctl-formula/commit/956bcfaa2f702d6f30527977e462d6ada261f781))
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.