OP#547 update Readme
This commit is contained in:
4
Jenkinsfile
vendored
4
Jenkinsfile
vendored
@@ -88,8 +88,6 @@ pipeline {
|
|||||||
sh '''
|
sh '''
|
||||||
git config user.name "Jenkins Server"
|
git config user.name "Jenkins Server"
|
||||||
git config user.email jenkins@confdroid.com
|
git config user.email jenkins@confdroid.com
|
||||||
git rm -r --cached .scannerwork || echo "No .scannerwork to remove from git"
|
|
||||||
git rm -r --cached .yardoc || echo "No .yardoc to remove from git"
|
|
||||||
git rm -r --cached .vscode || echo "No .vscode to remove from git"
|
git rm -r --cached .vscode || echo "No .vscode to remove from git"
|
||||||
git commit --amend --no-edit --allow-empty
|
git commit --amend --no-edit --allow-empty
|
||||||
git add -A && git commit -am "Recommit for updates in build $BUILD_NUMBER" || echo "No changes to commit"
|
git add -A && git commit -am "Recommit for updates in build $BUILD_NUMBER" || echo "No changes to commit"
|
||||||
@@ -118,8 +116,6 @@ pipeline {
|
|||||||
git branch -D development
|
git branch -D development
|
||||||
git branch -D jenkins-build-$BUILD_NUMBER
|
git branch -D jenkins-build-$BUILD_NUMBER
|
||||||
git rm -f Jenkinsfile
|
git rm -f Jenkinsfile
|
||||||
git rm -r --cached .scannerwork || echo "No .scannerwork to remove from git"
|
|
||||||
git rm -r --cached .yardoc || echo "No .yardoc to remove from git"
|
|
||||||
git rm -r --cached .vscode || echo "No .vscode to remove from git"
|
git rm -r --cached .vscode || echo "No .vscode to remove from git"
|
||||||
git commit --amend --no-edit --allow-empty
|
git commit --amend --no-edit --allow-empty
|
||||||
git remote add master https://sourcecode.confdroid.com/confdroid/confdroid_automatic.git
|
git remote add master https://sourcecode.confdroid.com/confdroid/confdroid_automatic.git
|
||||||
|
|||||||
35
README.md
35
README.md
@@ -10,14 +10,15 @@
|
|||||||
- [Dependencies](#dependencies)
|
- [Dependencies](#dependencies)
|
||||||
- [Support](#support)
|
- [Support](#support)
|
||||||
- [Parameter Inheritance](#parameter-inheritance)
|
- [Parameter Inheritance](#parameter-inheritance)
|
||||||
- [Module Deployment](#module-deployment)
|
- [SELINUX](#selinux)
|
||||||
|
- [Deployment](#deployment)
|
||||||
- [Tests](#tests)
|
- [Tests](#tests)
|
||||||
- [Contact Us](#contact-us)
|
- [Contact Us](#contact-us)
|
||||||
- [Disclaimer](#disclaimer)
|
- [Disclaimer](#disclaimer)
|
||||||
|
|
||||||
## Synopsis
|
## Synopsis
|
||||||
|
|
||||||
dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.
|
dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.
|
||||||
|
|
||||||
`confdroid_automatic` manages dnf-automatic installations and configurations.
|
`confdroid_automatic` manages dnf-automatic installations and configurations.
|
||||||
|
|
||||||
@@ -27,8 +28,8 @@ dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- install required binaries, files and services
|
- install required binaries,
|
||||||
- manage selinux context
|
- mane files and directories with proper selinux context
|
||||||
- manage main configurations files via parameters
|
- manage main configurations files via parameters
|
||||||
- manage service
|
- manage service
|
||||||
|
|
||||||
@@ -36,16 +37,34 @@ dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.
|
|||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
- Rocky 9
|
- Rocky 9 (any RHEL 9-based OS should work)
|
||||||
- Puppet 8
|
- Puppet 8
|
||||||
|
|
||||||
## Parameter Inheritance
|
## Parameter Inheritance
|
||||||
|
|
||||||
All parameters are listed in `params.pp` and inherited from there. Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.
|
All parameters are listed in `params.pp` and inherited from there. Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.
|
||||||
|
|
||||||
## Module Deployment
|
## SELINUX
|
||||||
|
|
||||||
ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes [Foreman][def] as ENC, so the modules just have to be present on the master node and Foreman will take care for it.
|
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
|
||||||
|
- native Puppet deployment
|
||||||
|
|
||||||
|
via site.pp or nodes.pp
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
node 'example.example.net' {
|
||||||
|
include automatic
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- through Foreman:
|
||||||
|
|
||||||
|
In order to apply parameters through Foreman, **confdroid_automatic::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/).
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
@@ -65,5 +84,3 @@ ALmost every puppet setup is done in very custom ways, and hence the way the mod
|
|||||||
|
|
||||||
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
|
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
|
||||||
The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.
|
The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.
|
||||||
|
|
||||||
[def]: https://www.theforeman.org/manuals/3.13/quickstart_guide.html
|
|
||||||
|
|||||||
Reference in New Issue
Block a user