From 3f14f44320210e95592803391a578c0e46d9205c Mon Sep 17 00:00:00 2001
From: Evan Read <eread@gitlab.com>
Date: Fri, 19 Jan 2024 11:23:59 +1000
Subject: [PATCH] Add structure to configure authentication for Gitaly section
---
doc/administration/gitaly/configure_gitaly.md | 28 +++++++++----------
1 file changed, 13 insertions(+), 15 deletions(-)
diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md
index eb620ff74133d..d492d3d32b3e9 100644
--- a/doc/administration/gitaly/configure_gitaly.md
+++ b/doc/administration/gitaly/configure_gitaly.md
@@ -136,16 +136,14 @@ To avoid downtime while rotating the Gitaly token, you can temporarily disable a
Gitaly and GitLab use two shared secrets for authentication:
-- _Gitaly token_: used to authenticate gRPC requests to Gitaly
-- _GitLab Shell token_: used for authentication callbacks from GitLab Shell to the GitLab internal API
-
-Configure authentication in one of two ways:
+- _Gitaly token_: used to authenticate gRPC requests to Gitaly.
+- _GitLab Shell token_: used for authentication callbacks from GitLab Shell to the GitLab internal API.
::Tabs
:::TabTitle Linux package (Omnibus)
-To configure the _Gitaly token_, edit `/etc/gitlab/gitlab.rb`:
+1. To configure the _Gitaly token_, edit `/etc/gitlab/gitlab.rb`:
```ruby
gitaly['configuration'] = {
@@ -157,20 +155,20 @@ To configure the _Gitaly token_, edit `/etc/gitlab/gitlab.rb`:
}
```
-Configure the _GitLab Shell token_ in one of two ways.
+1. Configure the _GitLab Shell token_ in one of two ways:
-Method 1 (recommended):
+ - Method 1 (recommended):
-Copy `/etc/gitlab/gitlab-secrets.json` from the Gitaly client to same path on the Gitaly servers
- (and any other Gitaly clients).
+ Copy `/etc/gitlab/gitlab-secrets.json` from the Gitaly client to same path on the Gitaly servers
+ (and any other Gitaly clients).
-Method 2:
+ - Method 2:
-Edit `/etc/gitlab/gitlab.rb`:
+ Edit `/etc/gitlab/gitlab.rb`:
- ```ruby
- gitlab_shell['secret_token'] = 'shellsecret'
- ```
+ ```ruby
+ gitlab_shell['secret_token'] = 'shellsecret'
+ ```
:::TabTitle Self-compiled (source)
@@ -206,7 +204,7 @@ Updates to example must be made at:
- All reference architecture pages
-->
-Configure Gitaly server in one of two ways:
+Configure Gitaly server.
::Tabs
--
GitLab