mirror of
https://github.com/saltstack-formulas/sysctl-formula.git
synced 2024-11-28 01:18:18 +01:00
0df30a603c
## [0.6.1](https://github.com/saltstack-formulas/sysctl-formula/compare/v0.6.0...v0.6.1) (2019-10-10) ### Bug Fixes * **map.jinja:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/sysctl-formula/commit/6a08317)) * **package.sls:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/sysctl-formula/commit/a8bbd25)) * **param.sls:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/sysctl-formula/commit/50494dc)) ### Continuous Integration * **kitchen:** change `log_level` to `debug` instead of `info` ([](https://github.com/saltstack-formulas/sysctl-formula/commit/519d39b)) * **kitchen:** install required packages to bootstrapped `opensuse` [skip ci] ([](https://github.com/saltstack-formulas/sysctl-formula/commit/10a70f0)) * **kitchen:** use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([](https://github.com/saltstack-formulas/sysctl-formula/commit/1f2f4ce)) * **platform:** add `arch-base-latest` ([](https://github.com/saltstack-formulas/sysctl-formula/commit/d9dfd4b)) * **yamllint:** add rule `empty-values` & use new `yaml-files` setting ([](https://github.com/saltstack-formulas/sysctl-formula/commit/9fd2f1c)) * merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([](https://github.com/saltstack-formulas/sysctl-formula/commit/9d202ba)) * use `dist: bionic` & apply `opensuse-leap-15` SCP error workaround ([](https://github.com/saltstack-formulas/sysctl-formula/commit/c7e34a9)) |
||
|---|---|---|
| .. | ||
| AUTHORS.rst | ||
| CHANGELOG.rst | ||
| CONTRIBUTING.rst | ||
| 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 :ref:`How to contribute <CONTRIBUTING>` 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.