Merge branch 'docs/add-external-url-config-to-sidekiq-nodes' into 'master'

Add external_url config to Sidekiq nodes

See merge request gitlab-org/gitlab!71784

doc/administration/reference_architectures/10k_users.md

@@ -1604,7 +1604,7 @@ To configure the Sidekiq nodes, on each one:
 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
    package of your choice. Be sure to follow _only_ installation steps 1 and 2
    on the page.
-1. Open `/etc/gitlab/gitlab.rb` with your editor:
+1. Create or edit `/etc/gitlab/gitlab.rb` and use the following configuration:
 
    ```ruby
    # Avoid running unnecessary services on the Sidekiq server
@@ -1619,6 +1619,10 @@ To configure the Sidekiq nodes, on each one:
    gitlab_exporter['enable'] = false
    nginx['enable'] = false
 
+   # External URL
+   ## This should match the URL of the external load balancer
+   external_url 'https://gitlab.example.com'
+
    # Redis
    ## Redis connection details
    ## First cluster that will host the cache

doc/administration/reference_architectures/25k_users.md

@@ -1610,7 +1610,7 @@ To configure the Sidekiq nodes, on each one:
 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
    package of your choice. Be sure to follow _only_ installation steps 1 and 2
    on the page.
-1. Open `/etc/gitlab/gitlab.rb` with your editor:
+1. Create or edit `/etc/gitlab/gitlab.rb` and use the following configuration:
 
    ```ruby
    # Avoid running unnecessary services on the Sidekiq server
@@ -1625,6 +1625,10 @@ To configure the Sidekiq nodes, on each one:
    gitlab_exporter['enable'] = false
    nginx['enable'] = false
 
+   # External URL
+   ## This should match the URL of the external load balancer
+   external_url 'https://gitlab.example.com'
+
    # Redis
    ## Redis connection details
    ## First cluster that will host the cache

doc/administration/reference_architectures/3k_users.md

@@ -1565,7 +1565,7 @@ To configure the Sidekiq nodes, one each one:
 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
    package of your choice. Be sure to follow _only_ installation steps 1 and 2
    on the page.
-1. Open `/etc/gitlab/gitlab.rb` with your editor:
+1. Create or edit `/etc/gitlab/gitlab.rb` and use the following configuration:
 
    ```ruby
    # Avoid running unnecessary services on the Sidekiq server
@@ -1580,6 +1580,10 @@ To configure the Sidekiq nodes, one each one:
    gitlab_exporter['enable'] = false
    nginx['enable'] = false
 
+   # External URL
+   ## This should match the URL of the external load balancer
+   external_url 'https://gitlab.example.com'
+
    # Redis
    redis['master_name'] = 'gitlab-redis'
 

doc/administration/reference_architectures/50k_users.md

@@ -1617,7 +1617,7 @@ To configure the Sidekiq nodes, on each one:
 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
    package of your choice. Be sure to follow _only_ installation steps 1 and 2
    on the page.
-1. Open `/etc/gitlab/gitlab.rb` with your editor:
+1. Create or edit `/etc/gitlab/gitlab.rb` and use the following configuration:
 
    ```ruby
    # Avoid running unnecessary services on the Sidekiq server
@@ -1632,6 +1632,10 @@ To configure the Sidekiq nodes, on each one:
    gitlab_exporter['enable'] = false
    nginx['enable'] = false
 
+   # External URL
+   ## This should match the URL of the external load balancer
+   external_url 'https://gitlab.example.com'
+
    # Redis
    ## Redis connection details
    ## First cluster that will host the cache

doc/administration/reference_architectures/5k_users.md

@@ -1555,7 +1555,7 @@ To configure the Sidekiq nodes, one each one:
 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab
    package of your choice. Be sure to follow _only_ installation steps 1 and 2
    on the page.
-1. Open `/etc/gitlab/gitlab.rb` with your editor:
+1. Create or edit `/etc/gitlab/gitlab.rb` and use the following configuration:
 
    ```ruby
    # Avoid running unnecessary services on the Sidekiq server
@@ -1570,6 +1570,10 @@ To configure the Sidekiq nodes, one each one:
    gitlab_exporter['enable'] = false
    nginx['enable'] = false
 
+   # External URL
+   ## This should match the URL of the external load balancer
+   external_url 'https://gitlab.example.com'
+
    # Redis
    ## Must be the same in every sentinel node
    redis['master_name'] = 'gitlab-redis'

doc/administration/sidekiq.md

@@ -104,6 +104,16 @@ you want using steps 1 and 2 from the GitLab downloads page.
   
    You must also copy the `registry.key` file to each Sidekiq node.
 
+1. Define the `external_url`. To maintain uniformity of links across nodes, the
+   `external_url` on the Sidekiq server should point to the external URL that users
+   will use to access GitLab. This will either be the `external_url` set on your
+   application server or the URL of a external load balancer which will route traffic
+   to the GitLab application server:
+
+   ```ruby
+   external_url 'https://gitlab.example.com'
+   ```
+
 1. Run `gitlab-ctl reconfigure`.
 
 You will need to restart the Sidekiq nodes after an update has occurred and database
@@ -194,6 +204,9 @@ gitlab_rails['monitoring_whitelist'] = ['10.10.1.42', '127.0.0.1']
 # Container Registry URL for cleanup jobs
 registry_external_url 'https://registry.example.com'
 gitlab_rails['registry_api_url'] = "https://registry.example.com"
+
+# External URL (this should match the URL used to access your GitLab instance)
+external_url 'https://gitlab.example.com'
 ```
 
 ## Further reading