OP#563 edit install and README
This commit is contained in:
38
README.md
38
README.md
@@ -1,8 +1,7 @@
|
|||||||
# Readme
|
# Readme
|
||||||
|
|
||||||
[](https://jenkins.confdroid.com/job/confdroid_selinux/)
|
[](https://jenkins.confdroid.com/job/confdroid_selinux/)
|
||||||
|
[](https://sonarqube.confdroid.com/dashboard?id=confdroid_selinux)
|
||||||
[[_TOC_]]
|
|
||||||
|
|
||||||
## Synopsis
|
## Synopsis
|
||||||
|
|
||||||
@@ -18,12 +17,12 @@
|
|||||||
|
|
||||||
Installation:
|
Installation:
|
||||||
|
|
||||||
* install binaries required for selinux and related tools
|
- install binaries required for selinux and related tools
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
|
|
||||||
* manage `/etc/sysconfig/selinux` file (file system permissions, selinux context, content)
|
- manage `/etc/sysconfig/selinux` file (file system permissions, selinux context, content)
|
||||||
* manage current selinux status (permissive,enforcing)
|
- manage current selinux status (permissive,enforcing)
|
||||||
|
|
||||||
## Repo Documentation
|
## 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.
|
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
|
## Deployment
|
||||||
|
|
||||||
* native Puppet deployment
|
- native Puppet deployment
|
||||||
|
|
||||||
via site.pp or nodes.pp
|
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/).
|
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
|
## 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
|
## Support
|
||||||
|
|
||||||
* OS: CentOS 7
|
- OS: Rocky 9 (any RHEL9-based OS should work, but Rocky has been tested)
|
||||||
* Puppet 5,6
|
- Puppet 8
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
* Puppet Lint
|
- Puppet Lint
|
||||||
* excluded tests:
|
- 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.
|
- `--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
|
- Puppet Parser
|
||||||
* ERB Template Parser
|
- ERB Template Parser
|
||||||
* Sonar Quality Gate
|
- Sonar Quality Gate
|
||||||
|
|
||||||
## Contact Us
|
## Contact Us
|
||||||
|
|
||||||
[contact Us](https://confdroid.com/contact/)
|
- [contact Us](https://confdroid.com/contact/)
|
||||||
|
- [Feedback Portal](https://feedback.confdroid.com/)
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user