diff --git a/README.md b/README.md index 8ca0daf..7798f75 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # Readme [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_selinux)](https://jenkins.confdroid.com/job/confdroid_selinux/) - -[[_TOC_]] +[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_selinux&metric=security_hotspots&token=sqb_cc73d9e100a7cda91c7f45b8a7690bd16498e852)](https://sonarqube.confdroid.com/dashboard?id=confdroid_selinux) ## Synopsis @@ -18,12 +17,12 @@ Installation: -* install binaries required for selinux and related tools +- install binaries required for selinux and related tools Configuration -* manage `/etc/sysconfig/selinux` file (file system permissions, selinux context, content) -* manage current selinux status (permissive,enforcing) +- manage `/etc/sysconfig/selinux` file (file system permissions, selinux context, content) +- manage current selinux status (permissive,enforcing) ## Repo Documentation @@ -33,11 +32,11 @@ See the full Puppet documentation including parameters in `docs/index.html`. All dependencies must be included in the catalogue. -* [cd_resources](https://gitlab.confdroid.com/puppet/cd_resources) for yum repo resources. +- [cd_resources](https://gitlab.confdroid.com/puppet/cd_resources) for yum repo resources. ## Deployment -* native Puppet deployment +- native Puppet deployment via site.pp or nodes.pp @@ -47,9 +46,9 @@ node 'example.example.net' { } ``` -* through Foreman: +- through Foreman: -In order to apply parameters through Foreman, **__confdroid_selinux::params__** must be added to the host or host group in question. +In order to apply parameters through Foreman, **confdroid_selinux::params*- must be added to the host or host group in question. See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/). @@ -59,25 +58,26 @@ All files and directories are configured with correct selinux context. If selinu ## Known Problems -* Systems reconfigured with selinux disabled require once a reboot for selinux to be enabled. This module will **__not__** do the reboot for you to avoid unexpected outages. +- Systems reconfigured with selinux disabled require once a reboot for selinux to be enabled. This module will **__not__*- do the reboot for you to avoid unexpected outages. ## Support -* OS: CentOS 7 -* Puppet 5,6 +- OS: Rocky 9 (any RHEL9-based OS should work, but Rocky has been tested) +- Puppet 8 ## Tests -* Puppet Lint - * excluded tests: - * `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters. -* Puppet Parser -* ERB Template Parser -* Sonar Quality Gate +- Puppet Lint + - excluded tests: + - `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters. +- Puppet Parser +- ERB Template Parser +- Sonar Quality Gate ## Contact Us -[contact Us](https://confdroid.com/contact/) +- [contact Us](https://confdroid.com/contact/) +- [Feedback Portal](https://feedback.confdroid.com/) ## Disclaimer