Skip to content
Snippets Groups Projects
Commit 852d5a6f6afc authored by Evan Read's avatar Evan Read
Browse files

Whitespace tweaks to some test plan markdown files

parent 8fedd32c03a6
No related branches found
No related tags found
1 merge request!168Merge upstream Omnibus GitLab up to the 17.6 branching point
......@@ -6,5 +6,4 @@
## 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`.
......@@ -10,5 +9,4 @@
- [ ] 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
```
```
````
......@@ -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,9 +10,9 @@
- [ ] 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)
......@@ -16,6 +16,6 @@
- [ ] 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:
......@@ -21,7 +21,7 @@
```shell
curl "http://localhost:9188/metrics"
```
```shell
curl "http://localhost:9188/metrics"
```
- [ ] `redis-exporter` - (metrics endpoint returns data)
......@@ -25,9 +25,9 @@
- [ ] `redis-exporter` - (metrics endpoint returns data)
```shell
curl "http://localhost:9121/metrics"
```
```shell
curl "http://localhost:9121/metrics"
```
- [ ] `postgres-exporter` - (metrics endpoint returns data)
......@@ -31,9 +31,9 @@
- [ ] `postgres-exporter` - (metrics endpoint returns data)
```shell
curl "http://localhost:9187/metrics"
```
```shell
curl "http://localhost:9187/metrics"
```
- [ ] `node-exporter` - (metrics endpoint returns data)
......@@ -37,9 +37,9 @@
- [ ] `node-exporter` - (metrics endpoint returns data)
```shell
curl "http://localhost:9100/metrics"
```
```shell
curl "http://localhost:9100/metrics"
```
- [ ] `alertmanager` - (test trigger an alert)
......@@ -43,6 +43,6 @@
- [ ] `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:
......@@ -48,5 +48,5 @@
```shell
gitlab-ctl stop gitaly
```
```shell
gitlab-ctl stop gitaly
```
......@@ -52,4 +52,4 @@
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:
......@@ -55,5 +55,5 @@
```shell
gitlab-ctl start gitaly
```
```shell
gitlab-ctl start gitaly
```
......@@ -59,3 +59,3 @@
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.
````
......@@ -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,6 +16,5 @@
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`.
......@@ -20,4 +19,3 @@
- [ ] 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:
......@@ -23,7 +21,6 @@
- [ ] 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:
......@@ -25,12 +22,12 @@
- `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,7 +41,6 @@
- [ ] 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.
......@@ -48,5 +44,4 @@
- [ ] 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.
......@@ -52,5 +47,4 @@
- [ ] 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,8 +55,7 @@
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:
......@@ -65,10 +58,9 @@
- [ ] 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:
......@@ -70,12 +62,12 @@
- `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,5 +81,4 @@
- [ ] 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:
......@@ -93,4 +84,3 @@
- [ ] 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.
......@@ -95,4 +85,3 @@
- [ ] 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.
......@@ -98,5 +87,4 @@
- [ ] 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,8 +93,7 @@
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:
......@@ -109,6 +96,5 @@
- [ ] 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.
......@@ -114,3 +100,2 @@
- [ ] 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.
......@@ -116,3 +101,2 @@
- [ ] 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.
......@@ -118,2 +102,2 @@
- [ ] Created an issue in the test project. Verified that the notification for the issue appeared in Mattermost for the GitLab user.
```
````
......@@ -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
```
````
......@@ -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
```
```
````
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment