From e60341b39137353156c84dc9be2889dbe4ec662a Mon Sep 17 00:00:00 2001 From: Hugo Antonio Sepulveda Manriquez Date: Fri, 23 Aug 2024 18:43:09 +0200 Subject: [PATCH] feature/package_hold * Introducing the `package_hold`parameter The `package_hold` parameter allows you to hold the package version in the APT package manager. This is useful when you intend to update the host with 'apt upgrade' (or the bolt task `apt action=upgrade` from puppetlabs-apt) and keep your gitlab instance at the intended version. This prevents unintended upgrading gitlab and perhaps skipping important upgrade path steps. --- README.md | 9 ++++++++- REFERENCE.md | 18 ++++++++++++++++++ manifests/init.pp | 2 ++ manifests/install.pp | 2 ++ spec/classes/init_spec.rb | 9 +++++++++ 5 files changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5ae227f..cac71e58 100644 --- a/README.md +++ b/README.md @@ -222,7 +222,7 @@ Each unique resource provided to the `repository_configuration` setup: You can use these tags to further customize ordering within your own catalogs. -#### Selecting Version, edition, and package name +#### Selecting Version, edition, package name and holding The `package_ensure` parameter is used to control which version of the package installed. It expects either a version string, or one of the `ensure` values for @@ -242,6 +242,13 @@ This approach of package management has the following advantages: * allows you to install custom built packages for gitlab-omnibus that have different package name on your host +The `package_hold` parameter allows you to hold the package version in the APT +package manager. This is useful when you intend to update the host with +'apt upgrade' (or the bolt task `apt action=upgrade` from puppetlabs-apt) and +keep your gitlab instance at the intended version. This prevents unintended +upgrading gitlab and perhaps skipping important upgrade path steps. +To learn more about gitlab upgrading please visit the [upgrade path page.](https://gitlab-com.gitlab.io/support/toolbox/upgrade-path/) + #### Custom Repository & Package configuration example As an expanded example of repository and package configuration, let's assume you're: diff --git a/REFERENCE.md b/REFERENCE.md index d323352f..351abcc7 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -121,6 +121,7 @@ The following parameters are available in the `gitlab` class: * [`backup_cron_minute`](#-gitlab--backup_cron_minute) * [`backup_cron_hour`](#-gitlab--backup_cron_hour) * [`backup_cron_skips`](#-gitlab--backup_cron_skips) +* [`package_hold`](#-gitlab--package_hold) * [`package_name`](#-gitlab--package_name) * [`manage_package`](#-gitlab--manage_package) * [`repository_configuration`](#-gitlab--repository_configuration) @@ -825,6 +826,14 @@ Array of items to skip valid values: db, uploads, repositories, builds, artifact Default value: `[]` +##### `package_hold` + +Data type: `Enum['hold', 'none']` + +Wether to hold the specified package version. Available options are 'hold' or 'none'. Defaults to 'none'. Available only for Debian/Solaris package managers. + +Default value: `'none'` + ##### `package_name` Data type: `Optional[String]` @@ -1029,6 +1038,7 @@ The following parameters are available in the `gitlab::install` class: * [`package_name`](#-gitlab--install--package_name) * [`package_ensure`](#-gitlab--install--package_ensure) +* [`package_hold`](#-gitlab--install--package_hold) * [`manage_package`](#-gitlab--install--manage_package) ##### `package_name` @@ -1047,6 +1057,14 @@ Data type: `Any` Default value: `$gitlab::package_ensure` +##### `package_hold` + +Data type: `Any` + + + +Default value: `$gitlab::package_hold` + ##### `manage_package` Data type: `Any` diff --git a/manifests/init.pp b/manifests/init.pp index 6cac04a8..cdc59a26 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -86,6 +86,7 @@ # @param backup_cron_minute The minute when to run the daily backup cron job # @param backup_cron_hour The hour when to run the daily backup cron job # @param backup_cron_skips Array of items to skip valid values: db, uploads, repositories, builds, artifacts, lfs, registry, pages +# @param package_hold Wether to hold the specified package version. Available options are 'hold' or 'none'. Defaults to 'none'. Available only for Debian/Solaris package managers. # @param package_name The internal packaging system's name for the package. This name will automatically be changed by the gitlab::edition parameter. Can be overridden for the purposes of installing custom compiled version of gitlab-omnibus. # @param manage_package Should the GitLab package be managed? # @param repository_configuration A hash of repository types and attributes for configuraiton the gitlab package repositories. See docs in README.md @@ -158,6 +159,7 @@ Optional[Hash] $pgbouncer_exporter = undef, Optional[Hash] $gitlab_monitor = undef, Optional[Hash] $gitlab_exporter = undef, + Enum['hold', 'none'] $package_hold = 'none', Optional[String] $package_name = undef, Optional[String] $pages_external_url = undef, Optional[Hash] $pages_nginx = undef, diff --git a/manifests/install.pp b/manifests/install.pp index 7cfdfd65..d515cbfa 100644 --- a/manifests/install.pp +++ b/manifests/install.pp @@ -2,6 +2,7 @@ class gitlab::install ( $package_name = $gitlab::package_name, $package_ensure = $gitlab::package_ensure, + $package_hold = $gitlab::package_hold, $manage_package = $gitlab::manage_package, ) { assert_private() @@ -26,6 +27,7 @@ package { 'gitlab-omnibus': ensure => $package_ensure, name => $_package_name, + mark => $package_hold, require => Class['gitlab::omnibus_package_repository'], } } diff --git a/spec/classes/init_spec.rb b/spec/classes/init_spec.rb index d4c96fd4..e5637c4e 100644 --- a/spec/classes/init_spec.rb +++ b/spec/classes/init_spec.rb @@ -502,6 +502,15 @@ with_content(%r{^\s*gitlab_sshd\['enable'\] = true$}) } end + describe 'package_hold' do + let(:params) do + { package_ensure: '16.10.3-ce.0', package_hold: 'hold' } + end + + it { + is_expected.to contain_package('gitlab-omnibus').with('ensure' => '16.10.3-ce.0', 'name' => 'gitlab-ce', 'mark' => 'hold') + } + end end end end