# HG changeset patch # User Evan Read <eread@gitlab.com> # Date 1731554342 -36000 # Thu Nov 14 13:19:02 2024 +1000 # Node ID 852d5a6f6afccc5c58f3a717a968e315e8c7e6f7 # Parent 8fedd32c03a68d5cca486e1815b1b02d825b1bc1 Whitespace tweaks to some test plan markdown files diff --git a/doc/development/test-plans/upgrade-gitlab-exporter-testplan.md b/doc/development/test-plans/upgrade-gitlab-exporter-testplan.md --- a/doc/development/test-plans/upgrade-gitlab-exporter-testplan.md +++ b/doc/development/test-plans/upgrade-gitlab-exporter-testplan.md @@ -6,9 +6,7 @@ ## Test plan - [ ] Check [`gitlab-exporter` project repository](https://gitlab.com/gitlab-org/ruby/gems/gitlab-exporter) for potential breaking changes. - - [ ] Green pipeline with `Trigger:ee-package` and `build-package-on-all-os`. - - [ ] `gitlab-exporter` starts. Run `sudo gitlab-ctl status gitlab-exporter` and check output to ensure `gitlab-exporter` started successfully. @@ -32,5 +30,5 @@ ```shell curl --silent "http://localhost:9090/metrics" | grep gitlab_exporter - ``` + ``` ```` diff --git a/doc/development/test-plans/upgrade-golang-testplan.md b/doc/development/test-plans/upgrade-golang-testplan.md --- a/doc/development/test-plans/upgrade-golang-testplan.md +++ b/doc/development/test-plans/upgrade-golang-testplan.md @@ -2,7 +2,7 @@ Copy the following test plan to a comment of the merge request that upgrades the component. -```markdown +````markdown ## Test plan - [ ] QA tests passed for FIPS and non FIPS builds, including triggering the `build-package-on-all-os` job @@ -10,52 +10,52 @@ - [ ] Confirmed Omnibus-built services that are owned by distribution are working - [ ] Prometheus - (is scraping metrics) - ```shell - curl 'localhost:9090/api/v1/query?query=up' - ``` + ```shell + curl 'localhost:9090/api/v1/query?query=up' + ``` - [ ] PgBouncer exporter - (metrics endpoint returns data) - 1. [Configure PgBouncer](https://docs.gitlab.com/ee/administration/postgresql/pgbouncer.html). - 1. Run: + 1. [Configure PgBouncer](https://docs.gitlab.com/ee/administration/postgresql/pgbouncer.html). + 1. Run: - ```shell - curl "http://localhost:9188/metrics" - ``` + ```shell + curl "http://localhost:9188/metrics" + ``` - [ ] `redis-exporter` - (metrics endpoint returns data) - ```shell - curl "http://localhost:9121/metrics" - ``` + ```shell + curl "http://localhost:9121/metrics" + ``` - [ ] `postgres-exporter` - (metrics endpoint returns data) - ```shell - curl "http://localhost:9187/metrics" - ``` + ```shell + curl "http://localhost:9187/metrics" + ``` - [ ] `node-exporter` - (metrics endpoint returns data) - ```shell - curl "http://localhost:9100/metrics" - ``` + ```shell + curl "http://localhost:9100/metrics" + ``` - [ ] `alertmanager` - (test trigger an alert) - 1. Set `prometheus['listen_address'] = '0.0.0.0:9090'` in `/etc/gitlab/gitlab.rb` and run `sudo gitlab-ctl reconfigure`. - 1. Shut down `gitaly` service: + 1. Set `prometheus['listen_address'] = '0.0.0.0:9090'` in `/etc/gitlab/gitlab.rb` and run `sudo gitlab-ctl reconfigure`. + 1. Shut down `gitaly` service: - ```shell - gitlab-ctl stop gitaly - ``` + ```shell + gitlab-ctl stop gitaly + ``` - 1. Wait 5 minutes and check Prometheus console `http://<gitlab host>:9090/alerts?search=` for service down alert. - 1. Start `gitaly` service: + 1. Wait 5 minutes and check Prometheus console `http://<gitlab host>:9090/alerts?search=` for service down alert. + 1. Start `gitaly` service: - ```shell - gitlab-ctl start gitaly - ``` + ```shell + gitlab-ctl start gitaly + ``` - 1. Wait 5 minutes and check Prometheus console `http://<gitlab host>:9090/alerts?search=` for service back up. -``` + 1. Wait 5 minutes and check Prometheus console `http://<gitlab host>:9090/alerts?search=` for service back up. +```` diff --git a/doc/development/test-plans/upgrade-mattermost-testplan.md b/doc/development/test-plans/upgrade-mattermost-testplan.md --- a/doc/development/test-plans/upgrade-mattermost-testplan.md +++ b/doc/development/test-plans/upgrade-mattermost-testplan.md @@ -2,7 +2,7 @@ Copy the following test plan to a comment of the merge request that upgrades the component. -```markdown +````markdown ## Test plan ### Build tests @@ -16,21 +16,18 @@ and ran the following actions, checks, and tests: - [ ] Installed Linux package with the new Mattermost version: - - [ ] Verified that package installation logs/output shows no errors. - [ ] Verified Mattermost version by running `/opt/gitlab/embedded/bin/mattermost version`. - - [ ] Edited `/etc/gitlab/gitlab.rb` and set: - - `external_url` - `mattermost_external_url` Both URLs should point to the same system so that GitLab and Mattermost are co-located. Example: - ```yaml - external_url 'gitlab.example.com' - mattermost_external_url 'mattermost.example.com' - ``` + ```yaml + external_url 'gitlab.example.com' + mattermost_external_url 'mattermost.example.com' + ``` - [ ] Ran `gitlab-ctl reconfigure`. - [ ] Connected to `gitlab.example.com`. @@ -44,13 +41,10 @@ - [ ] Verified that when creating a group in GitLab, checking the box for **Create a Mattermost team for this group** also created a team in Mattermost and the GitLab user is a member of that team. - [ ] Created a test project within the group created in the previous step and initialize with a `README`. - - [ ] Verified Mattermost slash command operation: - [ ] Enabled slash commands using [GitLab documentation](https://docs.gitlab.com/ee/user/project/integrations/mattermost_slash_commands.html#configure-automatically). - [ ] Tested slash commands by creating a new issue from the Mattermost instance. After following the prompt to re-authorize, the issue should have been successfully created in GitLab. - - [ ] Verified GitLab issue notification. - - [ ] Configured incoming web hooks in Mattermost using the [GitLab Documentation](https://docs.gitlab.com/ee/user/project/integrations/mattermost.html). Note that you have to configure both Mattermost and GitLab. - [ ] Using the created web hook, followed the documentation for adding [notification support](https://docs.gitlab.com/ee/user/project/integrations/mattermost.html#configure-mattermost-to-receive-gitlab-notifications). - [ ] Created an issue in the test project. Verified that the notification for the issue appeared in Mattermost for the GitLab user. @@ -61,21 +55,19 @@ fresh OS installation. Run the following actions, checks, and tests: - [ ] Installed Linux package from the previous, latest minor number release: - - [ ] Verified that package installation logs/output showed no errors. - [ ] Verified Mattermost version by running `/opt/gitlab/embedded/bin/mattermost version`. - [ ] Edited `/etc/gitlab/gitlab.rb` and set: - - `external_url` - `mattermost_external_url` Both URLs should point to the same system so that GitLab and Mattermost are co-located. Example: - ```yaml - external_url 'gitlab.example.com' - mattermost_external_url 'mattermost.example.com' - ``` + ```yaml + external_url 'gitlab.example.com' + mattermost_external_url 'mattermost.example.com' + ``` - [ ] Ran `gitlab-ctl reconfigure`. - [ ] Connected to `gitlab.example.com`. @@ -89,14 +81,10 @@ - [ ] Verified that when creating a group in GitLab, checking the box for **Create a Mattermost team for this group** also created a team in Mattermost and the GitLab user is a member of that team. - [ ] Created a test project within the group created in the previous step and initialized with a `README`. - - [ ] Verified Mattermost slash command operation: - - [ ] Enabled slash commands using [GitLab documentation](https://docs.gitlab.com/ee/user/project/integrations/mattermost_slash_commands.html#configure-automatically). - [ ] Tested slash commands by creating a new issue from the Mattermost instance. After following the prompt to re-authorize, the issue should have been successfully created in GitLab. - - [ ] Verified GitLab issue notification. - - [ ] Configured incoming web hooks in Mattermost using the [GitLab Documentation](https://docs.gitlab.com/ee/user/project/integrations/mattermost.html). Note that you have to configure both Mattermost and GitLab. - [ ] Using the created web hook, followed the documentation for adding [notification support](https://docs.gitlab.com/ee/user/project/integrations/mattermost.html#configure-mattermost-to-receive-gitlab-notifications). - [ ] Created an issue in the test project. Verified that the notification for the issue appears in Mattermost for the GitLab user. @@ -105,15 +93,11 @@ following actions, checks, and tests: - [ ] Upgraded to package with new Mattermost version: - - [ ] Verified that package installation logs/output shows no errors. - [ ] Verified Mattermost version by running `/opt/gitlab/embedded/bin/mattermost version`. - [ ] Verified Mattermost slash command operation: - - [ ] Tested slash commands by creating a new issue from the Mattermost instance. After following the prompt to re-authorize, the issue should have been successfully created in GitLab. - - [ ] Verified GitLab issue notification. - - [ ] Created an issue in the test project. Verified that the notification for the issue appeared in Mattermost for the GitLab user. -``` +```` diff --git a/doc/development/test-plans/upgrade-redis-testplan.md b/doc/development/test-plans/upgrade-redis-testplan.md --- a/doc/development/test-plans/upgrade-redis-testplan.md +++ b/doc/development/test-plans/upgrade-redis-testplan.md @@ -2,7 +2,7 @@ Copy the following test plan to a comment of the merge request that upgrades the component. -```markdown +````markdown ## Test plan - [ ] Performed a successful GitLab Enterprise Edition (EE) build on all supported platforms (include `build-package-on-all-os` job). @@ -28,7 +28,6 @@ - [ ] Imported a project (confirms Sidekiq works) - [ ] Checked `gitlab-kas` log for Redis errors - [ ] Performed failover - - [ ] Updates - [ ] Updated on single node: - [ ] Verified that you get the message: @@ -42,7 +41,6 @@ - [ ] Checked `gitlab-kas log` for Redis errors - [ ] Checked `redis-exporter logs` for errors - [ ] Confirmed `gitlab-redis-cli` command connects to Redis - - [ ] Updated [HA Sentinel/Redis nodes](https://docs.gitlab.com/ee/update/zero_downtime.html#redis-ha-using-sentinel) - [ ] Verified that you get the message: @@ -56,4 +54,4 @@ - [ ] Checked `redis-exporter` logs for errors - [ ] Confirmed `gitlab-redis-cli` command connects to Redis on a Redis node - [ ] Performed failover -``` +```` diff --git a/doc/development/test-plans/upgrade-rubygems-testplan.md b/doc/development/test-plans/upgrade-rubygems-testplan.md --- a/doc/development/test-plans/upgrade-rubygems-testplan.md +++ b/doc/development/test-plans/upgrade-rubygems-testplan.md @@ -2,7 +2,7 @@ Copy the following test plan to a comment of the merge request that upgrades the component. -```markdown +````markdown ## Test plan - [ ] Checked rubygems [changelog](https://github.com/rubygems/rubygems/blob/master/CHANGELOG.md) for potential breaking changes. @@ -17,7 +17,6 @@ - [ ] Performed a successful GitLab Community Edition (CE) build on `dev.gitlab.org`. - Checked installed gem versions: - - [ ] `rubygems` ```shell @@ -29,4 +28,4 @@ ```shell gem list bundler ``` -``` +````