Documentation by YARD 0.9.36
-Alphabetic Index
- -Puppet Class Listing A-Z
- - -
-
-
-
|
-
File Listing
--
-
-
-
- README - - -
From 82dc4194cec49ff3c4892bb9ffcee20cf46c0dbc Mon Sep 17 00:00:00 2001 From: 12ww1160 <12ww1160@confdroid.com> Date: Sun, 29 Mar 2026 16:03:32 +0200 Subject: [PATCH 1/5] OP#547 remove unwanted things from git --- Jenkinsfile | 2 + doc/_index.html | 143 ----- doc/css/common.css | 8 - doc/css/full_list.css | 58 -- doc/css/style.css | 497 ------------------ doc/file.README.html | 134 ----- doc/frames.html | 22 - doc/index.html | 134 ----- doc/js/app.js | 314 ----------- doc/js/full_list.js | 216 -------- doc/js/jquery.js | 4 - doc/puppet_class_list.html | 92 ---- doc/puppet_classes/confdroid_automatic.html | 121 ----- ...droid_automatic_3A_3Amain_3A_3Aconfig.html | 130 ----- ...nfdroid_automatic_3A_3Amain_3A_3Adirs.html | 130 ----- ...fdroid_automatic_3A_3Amain_3A_3Afiles.html | 158 ------ ...roid_automatic_3A_3Amain_3A_3Ainstall.html | 134 ----- ...roid_automatic_3A_3Amain_3A_3Aservice.html | 144 ----- .../confdroid_automatic_3A_3Aparams.html | 400 -------------- doc/top-level-namespace.html | 98 ---- 20 files changed, 2 insertions(+), 2937 deletions(-) delete mode 100644 doc/_index.html delete mode 100644 doc/css/common.css delete mode 100644 doc/css/full_list.css delete mode 100644 doc/css/style.css delete mode 100644 doc/file.README.html delete mode 100644 doc/frames.html delete mode 100644 doc/index.html delete mode 100644 doc/js/app.js delete mode 100644 doc/js/full_list.js delete mode 100644 doc/js/jquery.js delete mode 100644 doc/puppet_class_list.html delete mode 100644 doc/puppet_classes/confdroid_automatic.html delete mode 100644 doc/puppet_classes/confdroid_automatic_3A_3Amain_3A_3Aconfig.html delete mode 100644 doc/puppet_classes/confdroid_automatic_3A_3Amain_3A_3Adirs.html delete mode 100644 doc/puppet_classes/confdroid_automatic_3A_3Amain_3A_3Afiles.html delete mode 100644 doc/puppet_classes/confdroid_automatic_3A_3Amain_3A_3Ainstall.html delete mode 100644 doc/puppet_classes/confdroid_automatic_3A_3Amain_3A_3Aservice.html delete mode 100644 doc/puppet_classes/confdroid_automatic_3A_3Aparams.html delete mode 100644 doc/top-level-namespace.html diff --git a/Jenkinsfile b/Jenkinsfile index 268d25e..9f2c26f 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -118,6 +118,8 @@ pipeline { git branch -D development git branch -D jenkins-build-$BUILD_NUMBER 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 commit --amend --no-edit --allow-empty git remote add master https://sourcecode.confdroid.com/confdroid/confdroid_automatic.git diff --git a/doc/_index.html b/doc/_index.html deleted file mode 100644 index dff28cb..0000000 --- a/doc/_index.html +++ /dev/null @@ -1,143 +0,0 @@ - - -
- - -
-
-
-
|
-
| t |
- - - -6 -7 -8- |
-
- # File 'manifests/init.pp', line 6
-
-class confdroid_automatic {
- include confdroid_automatic::params
-}
- |
-
confdroid_automatic::main::config.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
- -
- - - -6 -7 -8 -9 -10- |
-
- # File 'manifests/main/config.pp', line 6
-
-class confdroid_automatic::main::config (
-
-) inherits confdroid_automatic::params {
- include confdroid_automatic::main::service
-}
- |
-
confdroid_automatic::main::dirs.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
- -
- - - -6 -7 -8 -9 -10- |
-
- # File 'manifests/main/dirs.pp', line 6
-
-class confdroid_automatic::main::dirs (
-
-) inherits confdroid_automatic::params {
- require confdroid_automatic::main::install
-}
- |
-
confdroid_automatic::main::files.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
- -
- - - -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24- |
-
- # File 'manifests/main/files.pp', line 6
-
-class confdroid_automatic::main::files (
-
-) inherits confdroid_automatic::params {
- require confdroid_automatic::main::dirs
-
- file { $ac_main_config:
- ensure => file,
- path => $ac_main_config,
- owner => 'root',
- group => 'root',
- mode => '0644',
- selrange => s0,
- selrole => object_r,
- seltype => etc_t,
- seluser => system_u,
- content => template($ac_main_config_erb),
- notify => Service[$ac_service],
- }
-}
- |
-
confdroid_automatic::main::install.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
- -
- - - -6 -7 -8 -9 -10 -11 -12- |
-
- # File 'manifests/main/install.pp', line 6
-
-class confdroid_automatic::main::install (
-
-) inherits confdroid_automatic::params {
- package { $ac_reqpackages:
- ensure => $ac_pkg_ensure,
- }
-}
- |
-
confdroid_automatic::main::service.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
- -
- - - -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17- |
-
- # File 'manifests/main/service.pp', line 6
-
-class confdroid_automatic::main::service (
-
-) inherits confdroid_automatic::params {
- require confdroid_automatic::main::files
-
- service { $ac_service:
- ensure => running,
- hasstatus => true,
- hasrestart => true,
- enable => true,
- }
-}
- |
-
confdroid_automatic::params.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
- -
- - - -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49- |
-
- # File 'manifests/params.pp', line 17
-
-class confdroid_automatic::params (
-
- String $ac_reqpackages = 'dnf-automatic',
- String $ac_pkg_ensure = 'latest',
-
- # updates
- String $ac_upgrade_type = 'default',
- String $ac_random_sleep = '0',
- String $ac_network_online_timeout = '60',
- String $ac_download_updates = 'yes',
- String $ac_apply_updates = 'yes',
- String $ac_reboot = 'never',
- String $ac_emit_via = 'email',
- String $ac_email_to = 'root@example.net',
- String $ac_email_host = 'localhost',
-
-) {
-# Facts
- $fqdn = $facts['networking']['fqdn']
- $domain = $facts['networking']['domain']
- $os_name = $facts['os']['name']
- $os_release = $facts['os']['release']['major']
-
-# Service
- $ac_service = 'dnf-automatic.timer'
-
-# Files
- $ac_main_config = '/etc/dnf/automatic.conf'
- $ac_main_config_erb = 'confdroid_automatic/automatic.conf.erb'
-
-# includes must be last
- include confdroid_automatic::main::config
-}
- |
-
+
+
+
|
+
| t |
+ + + +6 +7 +8+ |
+
+ # File 'manifests/init.pp', line 6
+
+class confdroid_automatic {
+ include confdroid_automatic::params
+}
+ |
+
confdroid_automatic::main::config.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10+ |
+
+ # File 'manifests/main/config.pp', line 6
+
+class confdroid_automatic::main::config (
+
+) inherits confdroid_automatic::params {
+ include confdroid_automatic::main::service
+}
+ |
+
confdroid_automatic::main::dirs.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10+ |
+
+ # File 'manifests/main/dirs.pp', line 6
+
+class confdroid_automatic::main::dirs (
+
+) inherits confdroid_automatic::params {
+ require confdroid_automatic::main::install
+}
+ |
+
confdroid_automatic::main::files.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24+ |
+
+ # File 'manifests/main/files.pp', line 6
+
+class confdroid_automatic::main::files (
+
+) inherits confdroid_automatic::params {
+ require confdroid_automatic::main::dirs
+
+ file { $ac_main_config:
+ ensure => file,
+ path => $ac_main_config,
+ owner => 'root',
+ group => 'root',
+ mode => '0644',
+ selrange => s0,
+ selrole => object_r,
+ seltype => etc_t,
+ seluser => system_u,
+ content => template($ac_main_config_erb),
+ notify => Service[$ac_service],
+ }
+}
+ |
+
confdroid_automatic::main::install.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10 +11 +12+ |
+
+ # File 'manifests/main/install.pp', line 6
+
+class confdroid_automatic::main::install (
+
+) inherits confdroid_automatic::params {
+ package { $ac_reqpackages:
+ ensure => $ac_pkg_ensure,
+ }
+}
+ |
+
confdroid_automatic::main::service.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17+ |
+
+ # File 'manifests/main/service.pp', line 6
+
+class confdroid_automatic::main::service (
+
+) inherits confdroid_automatic::params {
+ require confdroid_automatic::main::files
+
+ service { $ac_service:
+ ensure => running,
+ hasstatus => true,
+ hasrestart => true,
+ enable => true,
+ }
+}
+ |
+
confdroid_automatic::params.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49+ |
+
+ # File 'manifests/params.pp', line 17
+
+class confdroid_automatic::params (
+
+ String $ac_reqpackages = 'dnf-automatic',
+ String $ac_pkg_ensure = 'latest',
+
+ # updates
+ String $ac_upgrade_type = 'default',
+ String $ac_random_sleep = '0',
+ String $ac_network_online_timeout = '60',
+ String $ac_download_updates = 'yes',
+ String $ac_apply_updates = 'yes',
+ String $ac_reboot = 'never',
+ String $ac_emit_via = 'email',
+ String $ac_email_to = 'root@example.net',
+ String $ac_email_host = 'localhost',
+
+) {
+# Facts
+ $fqdn = $facts['networking']['fqdn']
+ $domain = $facts['networking']['domain']
+ $os_name = $facts['os']['name']
+ $os_release = $facts['os']['release']['major']
+
+# Service
+ $ac_service = 'dnf-automatic.timer'
+
+# Files
+ $ac_main_config = '/etc/dnf/automatic.conf'
+ $ac_main_config_erb = 'confdroid_automatic/automatic.conf.erb'
+
+# includes must be last
+ include confdroid_automatic::main::config
+}
+ |
+
+
+
+
|
+
| t |
+ + + +6 +7 +8+ |
+
+ # File 'manifests/init.pp', line 6
+
+class confdroid_automatic {
+ include confdroid_automatic::params
+}
+ |
+
confdroid_automatic::main::config.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10+ |
+
+ # File 'manifests/main/config.pp', line 6
+
+class confdroid_automatic::main::config (
+
+) inherits confdroid_automatic::params {
+ include confdroid_automatic::main::service
+}
+ |
+
confdroid_automatic::main::dirs.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10+ |
+
+ # File 'manifests/main/dirs.pp', line 6
+
+class confdroid_automatic::main::dirs (
+
+) inherits confdroid_automatic::params {
+ require confdroid_automatic::main::install
+}
+ |
+
confdroid_automatic::main::files.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24+ |
+
+ # File 'manifests/main/files.pp', line 6
+
+class confdroid_automatic::main::files (
+
+) inherits confdroid_automatic::params {
+ require confdroid_automatic::main::dirs
+
+ file { $ac_main_config:
+ ensure => file,
+ path => $ac_main_config,
+ owner => 'root',
+ group => 'root',
+ mode => '0644',
+ selrange => s0,
+ selrole => object_r,
+ seltype => etc_t,
+ seluser => system_u,
+ content => template($ac_main_config_erb),
+ notify => Service[$ac_service],
+ }
+}
+ |
+
confdroid_automatic::main::install.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10 +11 +12+ |
+
+ # File 'manifests/main/install.pp', line 6
+
+class confdroid_automatic::main::install (
+
+) inherits confdroid_automatic::params {
+ package { $ac_reqpackages:
+ ensure => $ac_pkg_ensure,
+ }
+}
+ |
+
confdroid_automatic::main::service.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17+ |
+
+ # File 'manifests/main/service.pp', line 6
+
+class confdroid_automatic::main::service (
+
+) inherits confdroid_automatic::params {
+ require confdroid_automatic::main::files
+
+ service { $ac_service:
+ ensure => running,
+ hasstatus => true,
+ hasrestart => true,
+ enable => true,
+ }
+}
+ |
+
confdroid_automatic::params.pp Module name: confdroid_automatic Author: 12ww1160 (12ww1160@confdroid.com)
+ +
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50+ |
+
+ # File 'manifests/params.pp', line 18
+
+class confdroid_automatic::params (
+
+ String $ac_reqpackages = 'dnf-automatic',
+ String $ac_pkg_ensure = 'latest',
+
+ # updates
+ String $ac_upgrade_type = 'default',
+ String $ac_random_sleep = '0',
+ String $ac_network_online_timeout = '60',
+ String $ac_download_updates = 'yes',
+ String $ac_apply_updates = 'yes',
+ String $ac_reboot = 'never',
+ String $ac_emit_via = 'email',
+ Array[String] $ac_email_to = ['root@example.net','ops@example.net'],
+ String $ac_email_host = 'localhost',
+
+) {
+# Facts
+ $fqdn = $facts['networking']['fqdn']
+ $domain = $facts['networking']['domain']
+ $os_name = $facts['os']['name']
+ $os_release = $facts['os']['release']['major']
+
+# Service
+ $ac_service = 'dnf-automatic.timer'
+
+# Files
+ $ac_main_config = '/etc/dnf/automatic.conf'
+ $ac_main_config_erb = 'confdroid_automatic/automatic.conf.erb'
+
+# includes must be last
+ include confdroid_automatic::main::config
+}
+ |
+
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.
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
Rocky 9
+Rocky 9 (any RHEL 9-based OS should work)
Puppet 8
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.
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 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.
+ +native Puppet deployment
+via site.pp or nodes.pp
+ +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.
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.
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
Rocky 9
+Rocky 9 (any RHEL 9-based OS should work)
Puppet 8
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.
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 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.
+ +native Puppet deployment
+via site.pp or nodes.pp
+ +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.