Skip to content

G
gitlab-ce
Commit f351b2b8 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Merge branch 'gy-add-ra-praefect-db-migration-docs' into 'master' 

Update RA docs with Praefect DB migrate guidance

See merge request gitlab-org/gitlab!58885
parents 4f7e8687 b3c5a806
Hide whitespace changes
Inline Side-by-side
Showing with 82 additions and 80 deletions
doc/administration/reference_architectures/10k_users.md
View file @ f351b2b8
...@@ -437,7 +437,7 @@ To configure Consul: ...@@ -437,7 +437,7 @@ To configure Consul:
# Set the network addresses that the exporters will listen on # Set the network addresses that the exporters will listen on
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -561,7 +561,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -561,7 +561,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
# Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691. # Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691.
patroni['postgresql']['max_connections'] = 500 patroni['postgresql']['max_connections'] = 500
# Disable automatic database migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -857,7 +857,7 @@ a node and change its status from primary to replica (and vice versa). ...@@ -857,7 +857,7 @@ a node and change its status from primary to replica (and vice versa).
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Prevent database migrations from running on upgrade # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -924,7 +924,7 @@ You can specify multiple roles, like sentinel and Redis, as: ...@@ -924,7 +924,7 @@ You can specify multiple roles, like sentinel and Redis, as:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Prevent database migrations from running on upgrade # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1056,7 +1056,7 @@ To configure the Sentinel Cache server: ...@@ -1056,7 +1056,7 @@ To configure the Sentinel Cache server:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1121,13 +1121,8 @@ a node and change its status from primary to replica (and vice versa). ...@@ -1121,13 +1121,8 @@ a node and change its status from primary to replica (and vice versa).
# Set the network addresses that the exporters will listen on # Set the network addresses that the exporters will listen on
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
```
1. Only the primary GitLab application server should handle migrations. To
prevent database migrations from running on upgrade, add the following
configuration to your `/etc/gitlab/gitlab.rb` file:
```ruby # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1188,7 +1183,7 @@ You can specify multiple roles, like sentinel and Redis, as: ...@@ -1188,7 +1183,7 @@ You can specify multiple roles, like sentinel and Redis, as:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1320,7 +1315,7 @@ To configure the Sentinel Queues server: ...@@ -1320,7 +1315,7 @@ To configure the Sentinel Queues server:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1405,6 +1400,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -1405,6 +1400,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
postgresql['listen_address'] = '0.0.0.0' postgresql['listen_address'] = '0.0.0.0'
postgresql['max_connections'] = 200 postgresql['max_connections'] = 200
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1550,7 +1546,8 @@ To configure the Praefect nodes, on each one: ...@@ -1550,7 +1546,8 @@ To configure the Praefect nodes, on each one:
praefect['enable'] = true praefect['enable'] = true
praefect['listen_addr'] = '0.0.0.0:2305' praefect['listen_addr'] = '0.0.0.0:2305'
gitlab_rails['rake_cache_clear'] = false # Prevent database migrations from running on upgrade automatically
praefect['auto_migrate'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1674,8 +1671,7 @@ On each node: ...@@ -1674,8 +1671,7 @@ On each node:
alertmanager['enable'] = false alertmanager['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
# Prevent database connections during 'gitlab-ctl reconfigure' # Prevent database migrations from running on upgrade automatically
gitlab_rails['rake_cache_clear'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the gitlab-shell API callback URL. Without this, `git push` will # Configure the gitlab-shell API callback URL. Without this, `git push` will
...@@ -1909,6 +1905,7 @@ To configure the Sidekiq nodes, on each one: ...@@ -1909,6 +1905,7 @@ To configure the Sidekiq nodes, on each one:
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
gitlab_rails['db_adapter'] = 'postgresql' gitlab_rails['db_adapter'] = 'postgresql'
gitlab_rails['db_encoding'] = 'unicode' gitlab_rails['db_encoding'] = 'unicode'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
####################################### #######################################
...@@ -2019,6 +2016,7 @@ On each node perform the following: ...@@ -2019,6 +2016,7 @@ On each node perform the following:
gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP
gitlab_rails['db_port'] = 6432 gitlab_rails['db_port'] = 6432
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
## Redis connection details ## Redis connection details
...@@ -2214,7 +2212,6 @@ To configure the Monitoring node: ...@@ -2214,7 +2212,6 @@ To configure the Monitoring node:
external_url 'http://gitlab.example.com' external_url 'http://gitlab.example.com'
# Disable all other services # Disable all other services
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_exporter['enable'] = false gitlab_exporter['enable'] = false
...@@ -2248,6 +2245,9 @@ To configure the Monitoring node: ...@@ -2248,6 +2245,9 @@ To configure the Monitoring node:
consul['configuration'] = { consul['configuration'] = {
retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13) retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13)
} }
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false
``` ```
1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
......
doc/administration/reference_architectures/25k_users.md
View file @ f351b2b8
...@@ -435,7 +435,7 @@ To configure Consul: ...@@ -435,7 +435,7 @@ To configure Consul:
# Set the network addresses that the exporters will listen on # Set the network addresses that the exporters will listen on
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -559,7 +559,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -559,7 +559,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
# Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691. # Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691.
patroni['postgresql']['max_connections'] = 500 patroni['postgresql']['max_connections'] = 500
# Disable automatic database migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -855,7 +855,7 @@ a node and change its status from primary to replica (and vice versa). ...@@ -855,7 +855,7 @@ a node and change its status from primary to replica (and vice versa).
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Prevent database migrations from running on upgrade # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -922,7 +922,7 @@ You can specify multiple roles, like sentinel and Redis, as: ...@@ -922,7 +922,7 @@ You can specify multiple roles, like sentinel and Redis, as:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Prevent database migrations from running on upgrade # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1054,7 +1054,7 @@ To configure the Sentinel Cache server: ...@@ -1054,7 +1054,7 @@ To configure the Sentinel Cache server:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1119,13 +1119,8 @@ a node and change its status from primary to replica (and vice versa). ...@@ -1119,13 +1119,8 @@ a node and change its status from primary to replica (and vice versa).
# Set the network addresses that the exporters will listen on # Set the network addresses that the exporters will listen on
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
```
1. Only the primary GitLab application server should handle migrations. To
prevent database migrations from running on upgrade, add the following
configuration to your `/etc/gitlab/gitlab.rb` file:
```ruby # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1186,7 +1181,7 @@ You can specify multiple roles, like sentinel and Redis, as: ...@@ -1186,7 +1181,7 @@ You can specify multiple roles, like sentinel and Redis, as:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1318,7 +1313,7 @@ To configure the Sentinel Queues server: ...@@ -1318,7 +1313,7 @@ To configure the Sentinel Queues server:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1403,6 +1398,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -1403,6 +1398,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
postgresql['listen_address'] = '0.0.0.0' postgresql['listen_address'] = '0.0.0.0'
postgresql['max_connections'] = 200 postgresql['max_connections'] = 200
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1548,7 +1544,8 @@ To configure the Praefect nodes, on each one: ...@@ -1548,7 +1544,8 @@ To configure the Praefect nodes, on each one:
praefect['enable'] = true praefect['enable'] = true
praefect['listen_addr'] = '0.0.0.0:2305' praefect['listen_addr'] = '0.0.0.0:2305'
gitlab_rails['rake_cache_clear'] = false # Prevent database migrations from running on upgrade automatically
praefect['auto_migrate'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1672,8 +1669,7 @@ On each node: ...@@ -1672,8 +1669,7 @@ On each node:
alertmanager['enable'] = false alertmanager['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
# Prevent database connections during 'gitlab-ctl reconfigure' # Prevent database migrations from running on upgrade automatically
gitlab_rails['rake_cache_clear'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the gitlab-shell API callback URL. Without this, `git push` will # Configure the gitlab-shell API callback URL. Without this, `git push` will
...@@ -1907,6 +1903,7 @@ To configure the Sidekiq nodes, on each one: ...@@ -1907,6 +1903,7 @@ To configure the Sidekiq nodes, on each one:
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
gitlab_rails['db_adapter'] = 'postgresql' gitlab_rails['db_adapter'] = 'postgresql'
gitlab_rails['db_encoding'] = 'unicode' gitlab_rails['db_encoding'] = 'unicode'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
####################################### #######################################
...@@ -2019,6 +2016,7 @@ On each node perform the following: ...@@ -2019,6 +2016,7 @@ On each node perform the following:
gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP
gitlab_rails['db_port'] = 6432 gitlab_rails['db_port'] = 6432
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
## Redis connection details ## Redis connection details
...@@ -2214,7 +2212,6 @@ To configure the Monitoring node: ...@@ -2214,7 +2212,6 @@ To configure the Monitoring node:
external_url 'http://gitlab.example.com' external_url 'http://gitlab.example.com'
# Disable all other services # Disable all other services
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_exporter['enable'] = false gitlab_exporter['enable'] = false
...@@ -2248,6 +2245,9 @@ To configure the Monitoring node: ...@@ -2248,6 +2245,9 @@ To configure the Monitoring node:
consul['configuration'] = { consul['configuration'] = {
retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13) retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13)
} }
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false
``` ```
1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
......
doc/administration/reference_architectures/2k_users.md
View file @ f351b2b8
...@@ -284,7 +284,7 @@ further configuration steps. ...@@ -284,7 +284,7 @@ further configuration steps.
# Replace APPLICATION_SERVER_IP_BLOCK with the CIDR address of the application node # Replace APPLICATION_SERVER_IP_BLOCK with the CIDR address of the application node
postgresql['trust_auth_cidr_addresses'] = %w(127.0.0.1/32 APPLICATION_SERVER_IP_BLOCK) postgresql['trust_auth_cidr_addresses'] = %w(127.0.0.1/32 APPLICATION_SERVER_IP_BLOCK)
# Disable automatic database migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -385,13 +385,6 @@ are supported and can be added if needed. ...@@ -385,13 +385,6 @@ are supported and can be added if needed.
## Configure Gitaly ## Configure Gitaly
NOTE:
[Gitaly Cluster](../gitaly/praefect.md) support
for the Reference Architectures is being
worked on as a [collaborative effort](https://gitlab.com/gitlab-org/quality/reference-architectures/-/issues/1) between the Quality Engineering and Gitaly teams. When this component has been verified
some Architecture specs will likely change as a result to support the new
and improved designed.
[Gitaly](../gitaly/index.md) server node requirements are dependent on data, [Gitaly](../gitaly/index.md) server node requirements are dependent on data,
specifically the number of projects and those projects' sizes. It's recommended specifically the number of projects and those projects' sizes. It's recommended
that a Gitaly server node stores no more than 5TB of data. Although this that a Gitaly server node stores no more than 5TB of data. Although this
...@@ -466,8 +459,7 @@ To configure the Gitaly server, on the server node you want to use for Gitaly: ...@@ -466,8 +459,7 @@ To configure the Gitaly server, on the server node you want to use for Gitaly:
alertmanager['enable'] = false alertmanager['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
# Prevent database connections during 'gitlab-ctl reconfigure' # Prevent database migrations from running on upgrade automatically
gitlab_rails['rake_cache_clear'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the gitlab-shell API callback URL. Without this, `git push` will # Configure the gitlab-shell API callback URL. Without this, `git push` will
...@@ -779,7 +771,6 @@ running [Prometheus](../monitoring/prometheus/index.md) and ...@@ -779,7 +771,6 @@ running [Prometheus](../monitoring/prometheus/index.md) and
grafana['admin_password'] = 'toomanysecrets' grafana['admin_password'] = 'toomanysecrets'
# Disable all other services # Disable all other services
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_exporter['enable'] = false gitlab_exporter['enable'] = false
...@@ -794,6 +785,9 @@ running [Prometheus](../monitoring/prometheus/index.md) and ...@@ -794,6 +785,9 @@ running [Prometheus](../monitoring/prometheus/index.md) and
unicorn['enable'] = false unicorn['enable'] = false
node_exporter['enable'] = false node_exporter['enable'] = false
gitlab_exporter['enable'] = false gitlab_exporter['enable'] = false
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false
``` ```
1. Prometheus also needs some scrape configurations to pull all the data from the various 1. Prometheus also needs some scrape configurations to pull all the data from the various
......
doc/administration/reference_architectures/3k_users.md
View file @ f351b2b8
...@@ -494,7 +494,7 @@ a node and change its status from primary to replica (and vice versa). ...@@ -494,7 +494,7 @@ a node and change its status from primary to replica (and vice versa).
'redis.password' => 'redis-password-goes-here', 'redis.password' => 'redis-password-goes-here',
} }
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -577,7 +577,7 @@ run: redis-exporter: (pid 30075) 76861s; run: log: (pid 29674) 76896s ...@@ -577,7 +577,7 @@ run: redis-exporter: (pid 30075) 76861s; run: log: (pid 29674) 76896s
'redis.password' => 'redis-password-goes-here', 'redis.password' => 'redis-password-goes-here',
} }
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -706,7 +706,7 @@ To configure the Sentinel: ...@@ -706,7 +706,7 @@ To configure the Sentinel:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -831,7 +831,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -831,7 +831,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
# Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691. # Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691.
patroni['postgresql']['max_connections'] = 500 patroni['postgresql']['max_connections'] = 500
# Disable automatic database migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1095,6 +1095,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -1095,6 +1095,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
postgresql['listen_address'] = '0.0.0.0' postgresql['listen_address'] = '0.0.0.0'
postgresql['max_connections'] = 200 postgresql['max_connections'] = 200
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1240,7 +1241,8 @@ To configure the Praefect nodes, on each one: ...@@ -1240,7 +1241,8 @@ To configure the Praefect nodes, on each one:
praefect['enable'] = true praefect['enable'] = true
praefect['listen_addr'] = '0.0.0.0:2305' praefect['listen_addr'] = '0.0.0.0:2305'
gitlab_rails['rake_cache_clear'] = false # Prevent database migrations from running on upgrade automatically
praefect['auto_migrate'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1364,8 +1366,7 @@ On each node: ...@@ -1364,8 +1366,7 @@ On each node:
alertmanager['enable'] = false alertmanager['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
# Prevent database connections during 'gitlab-ctl reconfigure' # Prevent database migrations from running on upgrade automatically
gitlab_rails['rake_cache_clear'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the gitlab-shell API callback URL. Without this, `git push` will # Configure the gitlab-shell API callback URL. Without this, `git push` will
...@@ -1533,7 +1534,6 @@ To configure the Sidekiq nodes, one each one: ...@@ -1533,7 +1534,6 @@ To configure the Sidekiq nodes, one each one:
nginx['enable'] = false nginx['enable'] = false
grafana['enable'] = false grafana['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_workhorse['enable'] = false gitlab_workhorse['enable'] = false
...@@ -1584,6 +1584,7 @@ To configure the Sidekiq nodes, one each one: ...@@ -1584,6 +1584,7 @@ To configure the Sidekiq nodes, one each one:
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
gitlab_rails['db_adapter'] = 'postgresql' gitlab_rails['db_adapter'] = 'postgresql'
gitlab_rails['db_encoding'] = 'unicode' gitlab_rails['db_encoding'] = 'unicode'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
####################################### #######################################
...@@ -1720,6 +1721,7 @@ On each node perform the following: ...@@ -1720,6 +1721,7 @@ On each node perform the following:
gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP
gitlab_rails['db_port'] = 6432 gitlab_rails['db_port'] = 6432
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
## Redis connection details ## Redis connection details
...@@ -1885,7 +1887,6 @@ running [Prometheus](../monitoring/prometheus/index.md) and ...@@ -1885,7 +1887,6 @@ running [Prometheus](../monitoring/prometheus/index.md) and
external_url 'http://gitlab.example.com' external_url 'http://gitlab.example.com'
# Disable all other services # Disable all other services
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_exporter['enable'] = false gitlab_exporter['enable'] = false
...@@ -1919,6 +1920,9 @@ running [Prometheus](../monitoring/prometheus/index.md) and ...@@ -1919,6 +1920,9 @@ running [Prometheus](../monitoring/prometheus/index.md) and
consul['configuration'] = { consul['configuration'] = {
retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13) retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13)
} }
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false
``` ```
1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
......
doc/administration/reference_architectures/50k_users.md
View file @ f351b2b8
...@@ -442,7 +442,7 @@ To configure Consul: ...@@ -442,7 +442,7 @@ To configure Consul:
# Set the network addresses that the exporters will listen on # Set the network addresses that the exporters will listen on
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -566,7 +566,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -566,7 +566,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
# Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691. # Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691.
patroni['postgresql']['max_connections'] = 500 patroni['postgresql']['max_connections'] = 500
# Disable automatic database migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -862,7 +862,7 @@ a node and change its status from primary to replica (and vice versa). ...@@ -862,7 +862,7 @@ a node and change its status from primary to replica (and vice versa).
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Prevent database migrations from running on upgrade # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -929,7 +929,7 @@ You can specify multiple roles, like sentinel and Redis, as: ...@@ -929,7 +929,7 @@ You can specify multiple roles, like sentinel and Redis, as:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Prevent database migrations from running on upgrade # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1061,7 +1061,7 @@ To configure the Sentinel Cache server: ...@@ -1061,7 +1061,7 @@ To configure the Sentinel Cache server:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1126,13 +1126,8 @@ a node and change its status from primary to replica (and vice versa). ...@@ -1126,13 +1126,8 @@ a node and change its status from primary to replica (and vice versa).
# Set the network addresses that the exporters will listen on # Set the network addresses that the exporters will listen on
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
```
1. Only the primary GitLab application server should handle migrations. To
prevent database migrations from running on upgrade, add the following
configuration to your `/etc/gitlab/gitlab.rb` file:
```ruby # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1193,7 +1188,7 @@ You can specify multiple roles, like sentinel and Redis, as: ...@@ -1193,7 +1188,7 @@ You can specify multiple roles, like sentinel and Redis, as:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1325,7 +1320,7 @@ To configure the Sentinel Queues server: ...@@ -1325,7 +1320,7 @@ To configure the Sentinel Queues server:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -1410,6 +1405,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -1410,6 +1405,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
postgresql['listen_address'] = '0.0.0.0' postgresql['listen_address'] = '0.0.0.0'
postgresql['max_connections'] = 200 postgresql['max_connections'] = 200
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1555,7 +1551,8 @@ To configure the Praefect nodes, on each one: ...@@ -1555,7 +1551,8 @@ To configure the Praefect nodes, on each one:
praefect['enable'] = true praefect['enable'] = true
praefect['listen_addr'] = '0.0.0.0:2305' praefect['listen_addr'] = '0.0.0.0:2305'
gitlab_rails['rake_cache_clear'] = false # Prevent database migrations from running on upgrade automatically
praefect['auto_migrate'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1679,8 +1676,7 @@ On each node: ...@@ -1679,8 +1676,7 @@ On each node:
alertmanager['enable'] = false alertmanager['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
# Prevent database connections during 'gitlab-ctl reconfigure' # Prevent database migrations from running on upgrade automatically
gitlab_rails['rake_cache_clear'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the gitlab-shell API callback URL. Without this, `git push` will # Configure the gitlab-shell API callback URL. Without this, `git push` will
...@@ -1914,6 +1910,7 @@ To configure the Sidekiq nodes, on each one: ...@@ -1914,6 +1910,7 @@ To configure the Sidekiq nodes, on each one:
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
gitlab_rails['db_adapter'] = 'postgresql' gitlab_rails['db_adapter'] = 'postgresql'
gitlab_rails['db_encoding'] = 'unicode' gitlab_rails['db_encoding'] = 'unicode'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
####################################### #######################################
...@@ -2033,6 +2030,7 @@ On each node perform the following: ...@@ -2033,6 +2030,7 @@ On each node perform the following:
gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP
gitlab_rails['db_port'] = 6432 gitlab_rails['db_port'] = 6432
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
## Redis connection details ## Redis connection details
...@@ -2228,7 +2226,6 @@ To configure the Monitoring node: ...@@ -2228,7 +2226,6 @@ To configure the Monitoring node:
external_url 'http://gitlab.example.com' external_url 'http://gitlab.example.com'
# Disable all other services # Disable all other services
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_exporter['enable'] = false gitlab_exporter['enable'] = false
...@@ -2262,6 +2259,9 @@ To configure the Monitoring node: ...@@ -2262,6 +2259,9 @@ To configure the Monitoring node:
consul['configuration'] = { consul['configuration'] = {
retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13) retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13)
} }
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false
``` ```
1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
......
doc/administration/reference_architectures/5k_users.md
View file @ f351b2b8
...@@ -487,7 +487,7 @@ a node and change its status from primary to replica (and vice versa). ...@@ -487,7 +487,7 @@ a node and change its status from primary to replica (and vice versa).
'redis.password' => 'redis-password-goes-here', 'redis.password' => 'redis-password-goes-here',
} }
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -570,7 +570,7 @@ run: redis-exporter: (pid 30075) 76861s; run: log: (pid 29674) 76896s ...@@ -570,7 +570,7 @@ run: redis-exporter: (pid 30075) 76861s; run: log: (pid 29674) 76896s
'redis.password' => 'redis-password-goes-here', 'redis.password' => 'redis-password-goes-here',
} }
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -699,7 +699,7 @@ To configure the Sentinel: ...@@ -699,7 +699,7 @@ To configure the Sentinel:
node_exporter['listen_address'] = '0.0.0.0:9100' node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121' redis_exporter['listen_address'] = '0.0.0.0:9121'
# Disable auto migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
``` ```
...@@ -824,7 +824,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -824,7 +824,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
# Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691. # Incoming recommended value for max connections is 500. See https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5691.
patroni['postgresql']['max_connections'] = 500 patroni['postgresql']['max_connections'] = 500
# Disable automatic database migrations # Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1087,6 +1087,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. ...@@ -1087,6 +1087,7 @@ in the second step, do not supply the `EXTERNAL_URL` value.
postgresql['listen_address'] = '0.0.0.0' postgresql['listen_address'] = '0.0.0.0'
postgresql['max_connections'] = 200 postgresql['max_connections'] = 200
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1232,7 +1233,8 @@ To configure the Praefect nodes, on each one: ...@@ -1232,7 +1233,8 @@ To configure the Praefect nodes, on each one:
praefect['enable'] = true praefect['enable'] = true
praefect['listen_addr'] = '0.0.0.0:2305' praefect['listen_addr'] = '0.0.0.0:2305'
gitlab_rails['rake_cache_clear'] = false # Prevent database migrations from running on upgrade automatically
praefect['auto_migrate'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the Consul agent # Configure the Consul agent
...@@ -1356,8 +1358,7 @@ On each node: ...@@ -1356,8 +1358,7 @@ On each node:
alertmanager['enable'] = false alertmanager['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
# Prevent database connections during 'gitlab-ctl reconfigure' # Prevent database migrations from running on upgrade automatically
gitlab_rails['rake_cache_clear'] = false
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
# Configure the gitlab-shell API callback URL. Without this, `git push` will # Configure the gitlab-shell API callback URL. Without this, `git push` will
...@@ -1523,7 +1524,6 @@ To configure the Sidekiq nodes, one each one: ...@@ -1523,7 +1524,6 @@ To configure the Sidekiq nodes, one each one:
nginx['enable'] = false nginx['enable'] = false
grafana['enable'] = false grafana['enable'] = false
prometheus['enable'] = false prometheus['enable'] = false
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_workhorse['enable'] = false gitlab_workhorse['enable'] = false
...@@ -1574,6 +1574,7 @@ To configure the Sidekiq nodes, one each one: ...@@ -1574,6 +1574,7 @@ To configure the Sidekiq nodes, one each one:
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
gitlab_rails['db_adapter'] = 'postgresql' gitlab_rails['db_adapter'] = 'postgresql'
gitlab_rails['db_encoding'] = 'unicode' gitlab_rails['db_encoding'] = 'unicode'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
####################################### #######################################
...@@ -1709,6 +1710,7 @@ On each node perform the following: ...@@ -1709,6 +1710,7 @@ On each node perform the following:
gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP gitlab_rails['db_host'] = '10.6.0.20' # internal load balancer IP
gitlab_rails['db_port'] = 6432 gitlab_rails['db_port'] = 6432
gitlab_rails['db_password'] = '<postgresql_user_password>' gitlab_rails['db_password'] = '<postgresql_user_password>'
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false gitlab_rails['auto_migrate'] = false
## Redis connection details ## Redis connection details
...@@ -1874,7 +1876,6 @@ running [Prometheus](../monitoring/prometheus/index.md) and ...@@ -1874,7 +1876,6 @@ running [Prometheus](../monitoring/prometheus/index.md) and
external_url 'http://gitlab.example.com' external_url 'http://gitlab.example.com'
# Disable all other services # Disable all other services
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false alertmanager['enable'] = false
gitaly['enable'] = false gitaly['enable'] = false
gitlab_exporter['enable'] = false gitlab_exporter['enable'] = false
...@@ -1908,6 +1909,9 @@ running [Prometheus](../monitoring/prometheus/index.md) and ...@@ -1908,6 +1909,9 @@ running [Prometheus](../monitoring/prometheus/index.md) and
consul['configuration'] = { consul['configuration'] = {
retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13) retry_join: %w(10.6.0.11 10.6.0.12 10.6.0.13)
} }
# Prevent database migrations from running on upgrade automatically
gitlab_rails['auto_migrate'] = false
``` ```
1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7