From 419bcbe71951438b0e4151012592c376846fc1dc Mon Sep 17 00:00:00 2001 From: ebner Date: Tue, 13 Aug 2024 11:21:56 +0200 Subject: [PATCH] moved documentation to code --- .../puppet/profiles/repository.rst | 73 ------------------- .../puppet/profiles/repository_list.rst | 64 ---------------- .../puppet/profiles/rpm_repos.rst | 53 -------------- 3 files changed, 190 deletions(-) delete mode 100644 engineering-guide/puppet/profiles/repository.rst delete mode 100644 engineering-guide/puppet/profiles/repository_list.rst delete mode 100644 engineering-guide/puppet/profiles/rpm_repos.rst diff --git a/engineering-guide/puppet/profiles/repository.rst b/engineering-guide/puppet/profiles/repository.rst deleted file mode 100644 index 9eb06826..00000000 --- a/engineering-guide/puppet/profiles/repository.rst +++ /dev/null @@ -1,73 +0,0 @@ -``profile::repository`` -============================ - -This module configures adds a list of package repositories from hiera -and filters those according to OS version. - -Parameters ----------- - -=============================== =========== ============================================= -**Name** **Type** **Default** -------------------------------- ----------- --------------------------------------------- -descr string -baseurl string -gpgkey string undef -gpgcheck bool false -disable bool true -priority integer undef -exclude string/list '' -=============================== =========== ============================================= - - -``title`` -~~~~~~~~~ - -The repository definition will end up as ``/etc/yum.repos.d/${title}.repo`` on the node - - - -``descr`` -~~~~~~~~~ - -Description of the package repository. - - -``baseurl`` -~~~~~~~~~~~ - -URL where the repository is available from, e.g.:: - - https://repos.psi.ch/rhel8/tags/$pli_repo_tag/epel/ - - -``gpgkey`` -~~~~~~~~~~ - -URL or file path where the signing GPG key is available from, e.g.:: - - https://repos.psi.ch/rhel8/keys/RPM-GPG-KEY-EPEL-8 - - -``gpgcheck`` -~~~~~~~~~~~~ - -Check GPG signature of installed packages. - - -``disable`` -~~~~~~~~~~~ - -If the repository should be checked for package installation/updates or not. - - -``priority`` -~~~~~~~~~~~~ - -What priority do packages from this repositry have? - - -``exclude`` -~~~~~~~~~~~ - -List or comma separated string with packages to be ignored from this repositores. Wildcards are supported. diff --git a/engineering-guide/puppet/profiles/repository_list.rst b/engineering-guide/puppet/profiles/repository_list.rst deleted file mode 100644 index 29b6da15..00000000 --- a/engineering-guide/puppet/profiles/repository_list.rst +++ /dev/null @@ -1,64 +0,0 @@ -``profile::repository_list`` -============================ - -This module configures adds a list of package repositories from hiera -and filters those according to OS version. - -This profile is used from Puppet:: - - profile::repository_list{'rpm_repos::epel':} - -Parameters ----------- - -=============================== ======== ============================================= -**Name** **Type** **Default** -------------------------------- -------- --------------------------------------------- -accept_empty bool false -=============================== ======== ============================================= - - -``title`` -~~~~~~~~~ - -Name of the list of software repositores to be installed. -It will lookup in Hiera for a list ``$title`` and look up the -repository definitons with ``hiera_hash("rpm_repos::repo::${name}")``. - -The repository definitions not suitable for this OS will be filtered away, -then with the rest a repository configuration is writen to the node -using ``profile::repository``. The ``osversion`` key in the repository definition -signals the major RHEL version for which this repository is for. - -Example:: - - rpm_repos::repo::epel_rhel8: - name: 'epel' - descr: "Extra Packages for Enterprise Linux 8" - baseurl: 'https://repos.psi.ch/rhel8/tags/$pli_repo_tag/epel/' - gpgkey: 'https://repos.psi.ch/rhel8/keys/epel.gpg' - disable: false - gpgcheck: true - osversion: 8 - exclude: - - "slurm*" - - rpm_repos::repo::epel_rhel7: - name: 'epel' - descr: "Extra Packages for Enterprise Linux 7" - baseurl: 'https://repos.psi.ch/rhel7/tags/$pli_repo_tag/epel/' - disable: false - gpgcheck: false - osversion: 7 - exclude: - - "slurm*" - - rpm_repos::epel - - epel_rhel7 - - epel_rhel8 - - -``accept_empty`` -~~~~~~~~~~~~~~~~ - -Do not fail when the repository list is empty after filtering away those not suitable for the current OS. diff --git a/engineering-guide/puppet/profiles/rpm_repos.rst b/engineering-guide/puppet/profiles/rpm_repos.rst deleted file mode 100644 index 67f77f3a..00000000 --- a/engineering-guide/puppet/profiles/rpm_repos.rst +++ /dev/null @@ -1,53 +0,0 @@ -``profile::rpm_repos`` -======================= - -This module configures :manpage:`dnf(8)` and sets up the default package repositores. - - -Parameters ----------- - -=============================== ======== ============================================= -**Name** **Type** **Default** -------------------------------- -------- --------------------------------------------- -repo_list string 'rpm_repos::default' -repo_tags hash hiera_hash('rpm_repos::tag') -exclude list hiera('base::package_exclude, []) -purge_repositories bool hiera('rpm_repos::purge_repositories') -=============================== ======== ============================================= - - -``repo_list`` -~~~~~~~~~~~~~ - -Name of the list of default software repositores to be installed. - -``repo_tags`` -~~~~~~~~~~~~~ - -Hash containing the repository tag which should be used per OS. -The key for RHEL 7 is ``redhat7`` and points by default to ``prod``, -whereas for later versions is ``rhel-$MAJOR_VERSION`` (eg. for ``redhat8`` it is ``rhel-8``) - -``exclude`` -~~~~~~~~~~~ - -An array containing entries suitable for the ``exclude`` option in -:manpage:`dnf.conf(5)`. - - -``purge_repositories`` -~~~~~~~~~~~~~~~~~~~~~~ - -A boolean controlling whether files that were not created by Puppet should be -removed from ``/etc/yum.repos.d``. This is useful to prevent repositories to be -configured through other means (e.g. manually). - - -``repos`` -~~~~~~~~~ - -A list of names designating the repositories that are to be configured (not -necessarily enabled) on the system. If ```` is the name of the repository, -then its definition is determined by searching Hiera for the -``rpm_repos::repo::`` key.