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
eac6750f94
sysctl-formula/docs
History
semantic-release-bot eac6750f94 chore(release): 0.6.4 [skip ci] 
## [0.6.4](https://github.com/saltstack-formulas/sysctl-formula/compare/v0.6.3...v0.6.4) (2022-10-20)

### Bug Fixes

* **osfamilymap.yml:** correcting paths to directory ([4a0cc9d](4a0cc9da99))

### Continuous Integration

* update `pre-commit` configuration inc. for pre-commit.ci [skip ci] ([815468f](815468fe83))
* **kitchen+gitlab:** update for new pre-salted images [skip ci] ([8090837](8090837e42))
* update linters to latest versions [skip ci] ([0123ee8](0123ee8c68))
* **3003.1:** update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] ([d7202f9](d7202f9ae6))
* **commitlint:** ensure `upstream/master` uses main repo URL [skip ci] ([ede2ca2](ede2ca268d))
* **gemfile:** allow rubygems proxy to be provided as an env var [skip ci] ([5451879](5451879d87))
* **gemfile+lock:** use `ssf` customised `inspec` repo [skip ci] ([037d57c](037d57cb94))
* **gemfile+lock:** use `ssf` customised `kitchen-docker` repo [skip ci] ([efb56e8](efb56e8a43))
* **gitlab-ci:** add `rubocop` linter (with `allow_failure`) [skip ci] ([26352ff](26352ffede))
* **kitchen:** move `provisioner` block & update `run_command` [skip ci] ([29e808a](29e808a865))
* **kitchen+ci:** update with `3004` pre-salted images/boxes [skip ci] ([4cb9dfb](4cb9dfb18b))
* **kitchen+ci:** update with latest `3003.2` pre-salted images [skip ci] ([e88e412](e88e412ac8))
* **kitchen+ci:** update with latest CVE pre-salted images [skip ci] ([8c7ddb7](8c7ddb7dff))
* **kitchen+gitlab:** update for new pre-salted images [skip ci] ([21d0f1e](21d0f1e892))
* add Debian 11 Bullseye & update `yamllint` configuration [skip ci] ([783d5be](783d5be534))
* **kitchen+gitlab:** remove Ubuntu 16.04 & Fedora 32 (EOL) [skip ci] ([8769ba6](8769ba64c1))
* add `arch-master` to matrix and update `.travis.yml` [skip ci] ([f4b7e31](f4b7e317ff))
* **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] ([63487ad](63487adc4b))
* **kitchen+gitlab:** adjust matrix to add `3003` [skip ci] ([3e85047](3e85047b54))
* **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] ([40ae03f](40ae03f889))
* **pre-commit:** update hook for `rubocop` [skip ci] ([c04dc83](c04dc831e7))

### Documentation

* **pillar.example:** add more detail ([48442fc](48442fcf66))
* **readme:** fix heading [skip ci] ([ca792a2](ca792a234c))

### Tests

* **system:** add `build_platform_codename` [skip ci] ([e92d921](e92d921b3d))
* **system.rb:** add support for `mac_os_x` [skip ci] ([a3895db](a3895db920))
* standardise use of `share` suite & `_mapdata` state [skip ci] ([96039ae](96039ae3a6))
2022-10-20 10:15:27 +00:00
..
AUTHORS.rst chore(release): 0.6.4 [skip ci] 2022-10-20 10:15:27 +00:00
CHANGELOG.rst chore(release): 0.6.4 [skip ci] 2022-10-20 10:15:27 +00:00
README.rst docs(readme): fix heading [skip ci] 2021-05-05 15:34:23 +01:00

README.rst 

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.