summaryrefslogtreecommitdiff
path: root/doc/administration
diff options
context:
space:
mode:
authorMarcel Amirault <mamirault@gitlab.com>2019-07-03 07:12:04 +0000
committerEvan Read <eread@gitlab.com>2019-07-03 07:12:04 +0000
commit1464b1e0004c17ea56808514577233e95bd7fdd2 (patch)
treef5f8ca237389361f11cc2b1c02ab20bb1e9486ad /doc/administration
parentae7a43975805fa9bf7964afa832b71b53e9e0f59 (diff)
downloadgitlab-ce-1464b1e0004c17ea56808514577233e95bd7fdd2.tar.gz
Fix markdown to reduce number of kramdown warnings
Add backticks around square brackets, or fix links, as necessary.
Diffstat (limited to 'doc/administration')
-rw-r--r--doc/administration/auth/ldap.md4
-rw-r--r--doc/administration/geo/replication/updating_the_geo_nodes.md48
-rw-r--r--doc/administration/high_availability/redis.md4
-rw-r--r--doc/administration/monitoring/prometheus/gitlab_metrics.md2
4 files changed, 28 insertions, 30 deletions
diff --git a/doc/administration/auth/ldap.md b/doc/administration/auth/ldap.md
index 1f2961ea39a..79ac7fe0352 100644
--- a/doc/administration/auth/ldap.md
+++ b/doc/administration/auth/ldap.md
@@ -1,6 +1,4 @@
-[//]: # (Do *NOT* modify this file in EE documentation. All changes in this)
-[//]: # (file should happen in CE, too. If the change is EE-specific, put)
-[//]: # (it in `ldap-ee.md`.)
+<!-- If the change is EE-specific, put it in `ldap-ee.md`, NOT here. -->
# LDAP
diff --git a/doc/administration/geo/replication/updating_the_geo_nodes.md b/doc/administration/geo/replication/updating_the_geo_nodes.md
index 348b0e9e7e5..d56a59f4967 100644
--- a/doc/administration/geo/replication/updating_the_geo_nodes.md
+++ b/doc/administration/geo/replication/updating_the_geo_nodes.md
@@ -30,7 +30,7 @@ We now require this change as we use this password to enable the Foreign Data Wr
the Geo Tracking Database. We are also improving security by disabling the use of **trust**
authentication method.
-1. **[primary]** Login to your **primary** node and run:
+1. **(primary)** Login to your **primary** node and run:
```sh
gitlab-ctl pg-password-md5 gitlab
@@ -57,14 +57,14 @@ authentication method.
postgresql['trust_auth_cidr_addresses'] = ['127.0.0.1/32','1.2.3.4/32'] # <- Remove this
```
-1. **[primary]** Reconfigure and restart:
+1. **(primary)** Reconfigure and restart:
```sh
sudo gitlab-ctl reconfigure
sudo gitlab-ctl restart
```
-1. **[secondary]** Login to all **secondary** nodes and edit `/etc/gitlab/gitlab.rb`:
+1. **(secondary)** Login to all **secondary** nodes and edit `/etc/gitlab/gitlab.rb`:
```ruby
# Fill with the hash generated by `gitlab-ctl pg-password-md5 gitlab`
@@ -88,7 +88,7 @@ authentication method.
postgresql['trust_auth_cidr_addresses'] = ['127.0.0.1/32','5.6.7.8/32'] # <- Remove this
```
-1. **[secondary]** Reconfigure and restart:
+1. **(secondary)** Reconfigure and restart:
```sh
sudo gitlab-ctl reconfigure
@@ -169,7 +169,7 @@ After you've verified that HTTP/HTTPS replication is working, you should remove
the now-unused SSH keys from your secondaries, as they may cause problems if the
**secondary** node if ever promoted to a **primary** node:
-1. **[secondary]** Login to **all** your **secondary** nodes and run:
+1. **(secondary)** Login to **all** your **secondary** nodes and run:
```ruby
sudo -u git -H rm ~git/.ssh/id_rsa ~git/.ssh/id_rsa.pub
@@ -260,24 +260,24 @@ Make sure to follow the steps in the exact order as they appear below and pay
extra attention in what node (either **primary** or **secondary**) you execute them! Each step
is prepended with the relevant node for better clarity:
-1. **[secondary]** Login to **all** your **secondary** nodes and stop all services:
+1. **(secondary)** Login to **all** your **secondary** nodes and stop all services:
```ruby
sudo gitlab-ctl stop
```
-1. **[secondary]** Make a backup of the `recovery.conf` file on **all**
+1. **(secondary)** Make a backup of the `recovery.conf` file on **all**
**secondary** nodes to preserve PostgreSQL's credentials:
```sh
sudo cp /var/opt/gitlab/postgresql/data/recovery.conf /var/opt/gitlab/
```
-1. **[primary]** Update the **primary** node to GitLab 9.0 following the
+1. **(primary)** Update the **primary** node to GitLab 9.0 following the
[regular update docs][update]. At the end of the update, the **primary** node
will be running with PostgreSQL 9.6.
-1. **[primary]** To prevent a de-synchronization of the repository replication,
+1. **(primary)** To prevent a de-synchronization of the repository replication,
stop all services except `postgresql` as we will use it to re-initialize the
**secondary** node's database:
@@ -286,55 +286,55 @@ is prepended with the relevant node for better clarity:
sudo gitlab-ctl start postgresql
```
-1. **[secondary]** Run the following steps on each of the **secondary** nodes:
+1. **(secondary)** Run the following steps on each of the **secondary** nodes:
- 1. **[secondary]** Stop all services:
+ 1. **(secondary)** Stop all services:
```sh
sudo gitlab-ctl stop
```
- 1. **[secondary]** Prevent running database migrations:
+ 1. **(secondary)** Prevent running database migrations:
```sh
sudo touch /etc/gitlab/skip-auto-migrations
```
- 1. **[secondary]** Move the old database to another directory:
+ 1. **(secondary)** Move the old database to another directory:
```sh
sudo mv /var/opt/gitlab/postgresql{,.bak}
```
- 1. **[secondary]** Update to GitLab 9.0 following the [regular update docs][update].
+ 1. **(secondary)** Update to GitLab 9.0 following the [regular update docs][update].
At the end of the update, the node will be running with PostgreSQL 9.6.
- 1. **[secondary]** Make sure all services are up:
+ 1. **(secondary)** Make sure all services are up:
```sh
sudo gitlab-ctl start
```
- 1. **[secondary]** Reconfigure GitLab:
+ 1. **(secondary)** Reconfigure GitLab:
```sh
sudo gitlab-ctl reconfigure
```
- 1. **[secondary]** Run the PostgreSQL upgrade command:
+ 1. **(secondary)** Run the PostgreSQL upgrade command:
```sh
sudo gitlab-ctl pg-upgrade
```
- 1. **[secondary]** See the stored credentials for the database that you will
+ 1. **(secondary)** See the stored credentials for the database that you will
need to re-initialize the replication:
```sh
sudo grep -s primary_conninfo /var/opt/gitlab/recovery.conf
```
- 1. **[secondary]** Save the snippet below in a file, let's say `/tmp/replica.sh`. Modify the
+ 1. **(secondary)** Save the snippet below in a file, let's say `/tmp/replica.sh`. Modify the
embedded paths if necessary:
```
@@ -381,28 +381,28 @@ is prepended with the relevant node for better clarity:
sudo service postgresql start
```
- 1. **[secondary]** Run the recovery script using the credentials from the
+ 1. **(secondary)** Run the recovery script using the credentials from the
previous step:
```sh
sudo bash /tmp/replica.sh
```
- 1. **[secondary]** Reconfigure GitLab:
+ 1. **(secondary)** Reconfigure GitLab:
```sh
sudo gitlab-ctl reconfigure
```
- 1. **[secondary]** Start all services:
+ 1. **(secondary)** Start all services:
```sh
sudo gitlab-ctl start
```
- 1. **[secondary]** Repeat the steps for the remaining **secondary** nodes.
+ 1. **(secondary)** Repeat the steps for the remaining **secondary** nodes.
-1. **[primary]** After all **secondary** nodes are updated, start all services in
+1. **(primary)** After all **secondary** nodes are updated, start all services in
**primary** node:
```sh
diff --git a/doc/administration/high_availability/redis.md b/doc/administration/high_availability/redis.md
index cc338725e1b..874525dd836 100644
--- a/doc/administration/high_availability/redis.md
+++ b/doc/administration/high_availability/redis.md
@@ -394,7 +394,7 @@ The prerequisites for a HA Redis setup are the following:
1. [Reconfigure Omnibus GitLab][reconfigure] for the changes to take effect.
> Note: You can specify multiple roles like sentinel and redis as:
-> roles ['redis_sentinel_role', 'redis_master_role']. Read more about high
+> `roles ['redis_sentinel_role', 'redis_master_role']`. Read more about high
> availability roles at <https://docs.gitlab.com/omnibus/roles/>.
### Step 2. Configuring the slave Redis instances
@@ -443,7 +443,7 @@ The prerequisites for a HA Redis setup are the following:
1. Go through the steps again for all the other slave nodes.
> Note: You can specify multiple roles like sentinel and redis as:
-> roles ['redis_sentinel_role', 'redis_slave_role']. Read more about high
+> `roles ['redis_sentinel_role', 'redis_slave_role']`. Read more about high
> availability roles at <https://docs.gitlab.com/omnibus/roles/>.
---
diff --git a/doc/administration/monitoring/prometheus/gitlab_metrics.md b/doc/administration/monitoring/prometheus/gitlab_metrics.md
index 84b71ae6f1c..2d9e3f7f18b 100644
--- a/doc/administration/monitoring/prometheus/gitlab_metrics.md
+++ b/doc/administration/monitoring/prometheus/gitlab_metrics.md
@@ -108,7 +108,7 @@ Some basic Ruby runtime metrics are available:
[GC.stat]: https://ruby-doc.org/core-2.3.0/GC.html#method-c-stat
-## Puma Metrics **[EXPERIMENTAL]**
+## Puma Metrics **(EXPERIMENTAL)**
When Puma is used instead of Unicorn, following metrics are available: