From 444f146ce02d57ae6b2946568a23a5abe09a9335 Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Tue, 3 Oct 2023 15:54:43 -0500 Subject: [PATCH 1/4] Replace references to Task Runner with Toolbox As part of https://gitlab.com/groups/gitlab-org/charts/-/epics/25, we've renamed Task Runner to Toolbox. This change ensures that our reference architecture docs and our diaster recovery docs refer to it by its new name. --- doc/administration/geo/disaster_recovery/index.md | 6 +++--- doc/administration/reference_architectures/10k_users.md | 2 +- doc/administration/reference_architectures/25k_users.md | 2 +- doc/administration/reference_architectures/2k_users.md | 2 +- doc/administration/reference_architectures/3k_users.md | 2 +- doc/administration/reference_architectures/50k_users.md | 2 +- doc/administration/reference_architectures/5k_users.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/administration/geo/disaster_recovery/index.md b/doc/administration/geo/disaster_recovery/index.md index 0c160e85570570..2e4ba3d27ffb60 100644 --- a/doc/administration/geo/disaster_recovery/index.md +++ b/doc/administration/geo/disaster_recovery/index.md @@ -732,16 +732,16 @@ If you are running GitLab 14.4 and earlier: After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) on the database node. -1. Find the task runner pod: +1. Find the Toolbox pod: ```shell - kubectl --namespace gitlab get pods -lapp=task-runner + kubectl --namespace gitlab get pods -lapp=toolbox ``` 1. Promote the secondary: ```shell - kubectl --namespace gitlab exec -ti gitlab-geo-task-runner-XXX -- gitlab-rake geo:set_secondary_as_primary + kubectl --namespace gitlab exec -ti gitlab-geo-toolbox-XXX -- gitlab-rake geo:set_secondary_as_primary ``` ### Step 3. Promote the **secondary** cluster diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 83102a6eddaf95..4c547858b2530c 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2213,7 +2213,7 @@ cluster alongside your instance, read how to ## Cloud Native Hybrid reference architecture with Helm Charts (alternative) Run select components of cloud-native GitLab in Kubernetes with the [GitLab Helm chart](https://docs.gitlab.com/charts/). In this setup, you can run the equivalent of GitLab Rails in the Kubernetes cluster called Webservice. You also can run the equivalent of Sidekiq nodes in the Kubernetes cluster called Sidekiq. In addition, -the following other supporting services are supported: NGINX, Task Runner, Migrations, +the following other supporting services are supported: NGINX, Toolbox, Migrations, Prometheus, and Grafana. Hybrid installations leverage the benefits of both cloud native and traditional diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index c47f52992d96f5..5ac7ed330b9ba4 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -2232,7 +2232,7 @@ cluster alongside your instance, read how to ## Cloud Native Hybrid reference architecture with Helm Charts (alternative) Run select components of cloud-native GitLab in Kubernetes with the [GitLab Helm chart](https://docs.gitlab.com/charts/). In this setup, you can run the equivalent of GitLab Rails in the Kubernetes cluster called Webservice. You can also run the equivalent of Sidekiq nodes in the Kubernetes cluster called Sidekiq. In addition, -the following other supporting services are supported: NGINX, Task Runner, Migrations, +the following other supporting services are supported: NGINX, Toolbox, Migrations, Prometheus, and Grafana. Hybrid installations leverage the benefits of both cloud native and traditional diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index c0c73c3a8acb90..b3c57ffefa480e 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -923,7 +923,7 @@ cluster alongside your instance, read how to ## Cloud Native Hybrid reference architecture with Helm Charts (alternative) Run select components of cloud-native GitLab in Kubernetes with the [GitLab Helm chart](https://docs.gitlab.com/charts/). In this setup, you can run the equivalent of GitLab Rails in the Kubernetes cluster called Webservice. You also can run the equivalent of Sidekiq nodes in the Kubernetes cluster called Sidekiq. In addition, -the following other supporting services are supported: NGINX, Task Runner, Migrations, +the following other supporting services are supported: NGINX, Toolbox, Migrations, Prometheus. Hybrid installations leverage the benefits of both cloud native and traditional diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index a147c9ddc8b442..19f6fbd222eb91 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -2219,7 +2219,7 @@ but with smaller performance requirements, several modifications can be consider ## Cloud Native Hybrid reference architecture with Helm Charts (alternative) Run select components of cloud-native GitLab in Kubernetes with the [GitLab Helm chart](https://docs.gitlab.com/charts/). In this setup, you can run the equivalent of GitLab Rails in the Kubernetes cluster called Webservice. You also can run the equivalent of Sidekiq nodes in the Kubernetes cluster called Sidekiq. In addition, -the following other supporting services are supported: NGINX, Task Runner, Migrations, +the following other supporting services are supported: NGINX, Toolbox, Migrations, Prometheus. Hybrid installations leverage the benefits of both cloud native and traditional diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 4dc5d05ad96b4f..644bfbd04f95ae 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -2231,7 +2231,7 @@ cluster alongside your instance, read how to ## Cloud Native Hybrid reference architecture with Helm Charts (alternative) Run select components of cloud-native GitLab in Kubernetes with the [GitLab Helm chart](https://docs.gitlab.com/charts/). In this setup, you can run the equivalent of GitLab Rails in the Kubernetes cluster called Webservice. You also can run the equivalent of Sidekiq nodes in the Kubernetes cluster called Sidekiq. In addition, -the following other supporting services are supported: NGINX, Task Runner, Migrations, +the following other supporting services are supported: NGINX, Toolbox, Migrations, Prometheus. Hybrid installations leverage the benefits of both cloud native and traditional diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index ee77a16ad5ca97..f011f0832f0dac 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -2187,7 +2187,7 @@ cluster alongside your instance, read how to ## Cloud Native Hybrid reference architecture with Helm Charts (alternative) Run select components of cloud-native GitLab in Kubernetes with the [GitLab Helm chart](https://docs.gitlab.com/charts/). In this setup, you can run the equivalent of GitLab Rails in the Kubernetes cluster called Webservice. You can also run the equivalent of Sidekiq nodes in the Kubernetes cluster called Sidekiq. In addition, -the following other supporting services are supported: NGINX, Task Runner, Migrations, +the following other supporting services are supported: NGINX, Toolbox, Migrations, Prometheus. Hybrid installations leverage the benefits of both cloud native and traditional -- GitLab From dbbe791464027bf10f499eba96c1224c8012ca1b Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 4 Oct 2023 11:34:34 +0000 Subject: [PATCH 2/4] Use tabs to differentiate between before and after 14.4 --- doc/administration/geo/disaster_recovery/index.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/administration/geo/disaster_recovery/index.md b/doc/administration/geo/disaster_recovery/index.md index 2e4ba3d27ffb60..8c9623860ea1e3 100644 --- a/doc/administration/geo/disaster_recovery/index.md +++ b/doc/administration/geo/disaster_recovery/index.md @@ -670,7 +670,9 @@ If the secondary site [has been paused](../../geo/index.md#pausing-and-resuming- a point-in-time recovery to the last known state. Data that was created on the primary while the secondary was paused is lost. -If you are running GitLab 14.5 and later: +::Tabs + +::TabTitle For GitLab 14.5 and later 1. For each node (such as PostgreSQL or Gitaly) outside of the **secondary** Kubernetes cluster using the Linux package, SSH into the node and run one of the following commands: @@ -706,7 +708,7 @@ If you are running GitLab 14.5 and later: | ---- | ------------- | ------- | | `ENABLE_SILENT_MODE` | `false` | If `true`, enables [Silent Mode](../../silent_mode/index.md) before promotion (GitLab 16.4 and later) | -If you are running GitLab 14.4 and earlier: +::TabTitle For GitLab 14.4 and earlier 1. SSH in to the database node in the **secondary** site and trigger PostgreSQL to promote to read-write: @@ -744,6 +746,8 @@ If you are running GitLab 14.4 and earlier: kubectl --namespace gitlab exec -ti gitlab-geo-toolbox-XXX -- gitlab-rake geo:set_secondary_as_primary ``` +::EndTabs + ### Step 3. Promote the **secondary** cluster 1. Update the existing cluster configuration. -- GitLab From 438dbd51ba8b1e2a7b6fd65ffc6dbf8f78dce7ca Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 4 Oct 2023 11:37:38 +0000 Subject: [PATCH 3/4] Bring back pre-toolbox commands for 14.4 and earlier --- doc/administration/geo/disaster_recovery/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/administration/geo/disaster_recovery/index.md b/doc/administration/geo/disaster_recovery/index.md index 8c9623860ea1e3..0ee717fe970b46 100644 --- a/doc/administration/geo/disaster_recovery/index.md +++ b/doc/administration/geo/disaster_recovery/index.md @@ -734,16 +734,16 @@ Data that was created on the primary while the secondary was paused is lost. After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) on the database node. -1. Find the Toolbox pod: +1. Find the task runner pod: ```shell - kubectl --namespace gitlab get pods -lapp=toolbox + kubectl --namespace gitlab get pods -lapp=task-runner ``` 1. Promote the secondary: ```shell - kubectl --namespace gitlab exec -ti gitlab-geo-toolbox-XXX -- gitlab-rake geo:set_secondary_as_primary + kubectl --namespace gitlab exec -ti gitlab-geo-task-runner-XXX -- gitlab-rake geo:set_secondary_as_primary ``` ::EndTabs -- GitLab From 313b02d03c73251eb4fcd78809c76c523c6f4b34 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 4 Oct 2023 12:14:00 +0000 Subject: [PATCH 4/4] Apply 2 suggestion(s) to 1 file(s) --- doc/administration/geo/disaster_recovery/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/administration/geo/disaster_recovery/index.md b/doc/administration/geo/disaster_recovery/index.md index 0ee717fe970b46..d6f6211ed4c2cb 100644 --- a/doc/administration/geo/disaster_recovery/index.md +++ b/doc/administration/geo/disaster_recovery/index.md @@ -672,7 +672,7 @@ Data that was created on the primary while the secondary was paused is lost. ::Tabs -::TabTitle For GitLab 14.5 and later +:::TabTitle For GitLab 14.5 and later 1. For each node (such as PostgreSQL or Gitaly) outside of the **secondary** Kubernetes cluster using the Linux package, SSH into the node and run one of the following commands: @@ -708,7 +708,7 @@ Data that was created on the primary while the secondary was paused is lost. | ---- | ------------- | ------- | | `ENABLE_SILENT_MODE` | `false` | If `true`, enables [Silent Mode](../../silent_mode/index.md) before promotion (GitLab 16.4 and later) | -::TabTitle For GitLab 14.4 and earlier +:::TabTitle For GitLab 14.4 and earlier 1. SSH in to the database node in the **secondary** site and trigger PostgreSQL to promote to read-write: -- GitLab