Commit 68fc36d8 authored by Evan Read's avatar Evan Read

Merge branch 'docs-lint-rule-md004' into 'master'

Docs: Enforce consistent prefix for bullet lists

See merge request gitlab-org/gitlab-ce!30206
parents 276038c2 20654fb9
...@@ -69,7 +69,7 @@ docs lint: ...@@ -69,7 +69,7 @@ docs lint:
# Lint Markdown # Lint Markdown
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md # https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
- bundle exec mdl content/$DOCS_GITLAB_REPO_SUFFIX/**/*.md --rules \ - bundle exec mdl content/$DOCS_GITLAB_REPO_SUFFIX/**/*.md --rules \
MD032 MD004,MD032
# Build HTML from Markdown # Build HTML from Markdown
- bundle exec nanoc - bundle exec nanoc
# Check the internal links # Check the internal links
......
...@@ -40,16 +40,16 @@ For example, say you have a primary (`db1.gitlab.com`) and two secondaries, ...@@ -40,16 +40,16 @@ For example, say you have a primary (`db1.gitlab.com`) and two secondaries,
`db2.gitlab.com` and `db3.gitlab.com`. For this setup you will need to have 3 `db2.gitlab.com` and `db3.gitlab.com`. For this setup you will need to have 3
load balancers, one for every host. For example: load balancers, one for every host. For example:
* `primary.gitlab.com` forwards to `db1.gitlab.com` - `primary.gitlab.com` forwards to `db1.gitlab.com`
* `secondary1.gitlab.com` forwards to `db2.gitlab.com` - `secondary1.gitlab.com` forwards to `db2.gitlab.com`
* `secondary2.gitlab.com` forwards to `db3.gitlab.com` - `secondary2.gitlab.com` forwards to `db3.gitlab.com`
Now let's say that a failover happens and db2 becomes the new primary. This Now let's say that a failover happens and db2 becomes the new primary. This
means forwarding should now happen as follows: means forwarding should now happen as follows:
* `primary.gitlab.com` forwards to `db2.gitlab.com` - `primary.gitlab.com` forwards to `db2.gitlab.com`
* `secondary1.gitlab.com` forwards to `db1.gitlab.com` - `secondary1.gitlab.com` forwards to `db1.gitlab.com`
* `secondary2.gitlab.com` forwards to `db3.gitlab.com` - `secondary2.gitlab.com` forwards to `db3.gitlab.com`
GitLab does not take care of this for you, so you will need to do so yourself. GitLab does not take care of this for you, so you will need to do so yourself.
...@@ -209,9 +209,9 @@ without it immediately leading to errors being presented to the users. ...@@ -209,9 +209,9 @@ without it immediately leading to errors being presented to the users.
The load balancer logs various messages, such as: The load balancer logs various messages, such as:
* When a host is marked as offline - When a host is marked as offline
* When a host comes back online - When a host comes back online
* When all secondaries are offline - When all secondaries are offline
Each log message contains the tag `[DB-LB]` to make searching/filtering of such Each log message contains the tag `[DB-LB]` to make searching/filtering of such
log entries easier. For example: log entries easier. For example:
......
...@@ -79,9 +79,9 @@ The **primary** database will require modification later, as part of ...@@ -79,9 +79,9 @@ The **primary** database will require modification later, as part of
A **secondary** cluster is similar to any other GitLab HA cluster, with two A **secondary** cluster is similar to any other GitLab HA cluster, with two
major differences: major differences:
* The main PostgreSQL database is a read-only replica of the **primary** node's - The main PostgreSQL database is a read-only replica of the **primary** node's
PostgreSQL database. PostgreSQL database.
* There is also a single PostgreSQL database for the **secondary** cluster, - There is also a single PostgreSQL database for the **secondary** cluster,
called the "tracking database", which tracks the synchronization state of called the "tracking database", which tracks the synchronization state of
various resources. various resources.
...@@ -93,9 +93,9 @@ from the normal HA setup. ...@@ -93,9 +93,9 @@ from the normal HA setup.
Configure the following services, again using the non-Geo high availability Configure the following services, again using the non-Geo high availability
documentation: documentation:
* [Configuring Redis for GitLab HA](../../high_availability/redis.md) for high - [Configuring Redis for GitLab HA](../../high_availability/redis.md) for high
availability. availability.
* [NFS](../../high_availability/nfs.md) which will store data that is - [NFS](../../high_availability/nfs.md) which will store data that is
synchronized from the **primary** node. synchronized from the **primary** node.
### Step 2: Configure the main read-only replica PostgreSQL database on the **secondary** node ### Step 2: Configure the main read-only replica PostgreSQL database on the **secondary** node
...@@ -270,15 +270,15 @@ After making these changes [Reconfigure GitLab][gitlab-reconfigure] so the chang ...@@ -270,15 +270,15 @@ After making these changes [Reconfigure GitLab][gitlab-reconfigure] so the chang
On the secondary the following GitLab frontend services will be enabled: On the secondary the following GitLab frontend services will be enabled:
* geo-logcursor - geo-logcursor
* gitlab-pages - gitlab-pages
* gitlab-workhorse - gitlab-workhorse
* logrotate - logrotate
* nginx - nginx
* registry - registry
* remote-syslog - remote-syslog
* sidekiq - sidekiq
* unicorn - unicorn
Verify these services by running `sudo gitlab-ctl status` on the frontend Verify these services by running `sudo gitlab-ctl status` on the frontend
application servers. application servers.
......
...@@ -116,10 +116,10 @@ graph TB ...@@ -116,10 +116,10 @@ graph TB
### Component legend ### Component legend
* ✅ - Installed by default - ✅ - Installed by default
* ⚙ - Requires additional configuration, or GitLab Managed Apps - ⚙ - Requires additional configuration, or GitLab Managed Apps
* ⤓ - Manual installation required - ⤓ - Manual installation required
* ❌ - Not supported or no instructions available - ❌ - Not supported or no instructions available
Component statuses are linked to configuration documentation for each component. Component statuses are linked to configuration documentation for each component.
......
...@@ -192,20 +192,20 @@ There can be multiple facets of the impact. The below is a guideline. ...@@ -192,20 +192,20 @@ There can be multiple facets of the impact. The below is a guideline.
If a bug seems to fall between two severity labels, assign it to the higher-severity label. If a bug seems to fall between two severity labels, assign it to the higher-severity label.
* Example(s) of ~S1 - Example(s) of ~S1
* Data corruption/loss. - Data corruption/loss.
* Security breach. - Security breach.
* Unable to create an issue or merge request. - Unable to create an issue or merge request.
* Unable to add a comment or discussion to the issue or merge request. - Unable to add a comment or discussion to the issue or merge request.
* Example(s) of ~S2 - Example(s) of ~S2
* Cannot submit changes through the web IDE but the commandline works. - Cannot submit changes through the web IDE but the commandline works.
* A status widget on the merge request page is not working but information can be seen in the test pipeline page. - A status widget on the merge request page is not working but information can be seen in the test pipeline page.
* Example(s) of ~S3 - Example(s) of ~S3
* Can create merge requests only from the Merge Requests list view, not from an Issue page. - Can create merge requests only from the Merge Requests list view, not from an Issue page.
* Status is not updated in real time and needs a page refresh. - Status is not updated in real time and needs a page refresh.
* Example(s) of ~S4 - Example(s) of ~S4
* Label colors are incorrect. - Label colors are incorrect.
* UI elements are not fully aligned. - UI elements are not fully aligned.
## Label for community contributors ## Label for community contributors
......
...@@ -76,8 +76,8 @@ and cross-link between any related content. ...@@ -76,8 +76,8 @@ and cross-link between any related content.
We employ a **docs-first methodology** to help ensure that the docs remain a complete and trusted resource, and to make communicating about the use of GitLab more efficient. We employ a **docs-first methodology** to help ensure that the docs remain a complete and trusted resource, and to make communicating about the use of GitLab more efficient.
* If the answer to a question exists in documentation, share the link to the docs instead of rephrasing the information. - If the answer to a question exists in documentation, share the link to the docs instead of rephrasing the information.
* When you encounter new information not available in GitLab’s documentation (for example, when working on a support case or testing a feature), your first step should be to create a merge request to add this information to the docs. You can then share the MR in order to communicate this information. - When you encounter new information not available in GitLab’s documentation (for example, when working on a support case or testing a feature), your first step should be to create a merge request to add this information to the docs. You can then share the MR in order to communicate this information.
New information that would be useful toward the future usage or troubleshooting of GitLab should not be written directly in a forum or other messaging system, but added to a docs MR and then referenced, as described above. Note that among any other doc changes, you can always add a Troubleshooting section to a doc if none exists, or un-comment and use the placeholder Troubleshooting section included as part of our [doc template](structure.md#template-for-new-docs), if present. New information that would be useful toward the future usage or troubleshooting of GitLab should not be written directly in a forum or other messaging system, but added to a docs MR and then referenced, as described above. Note that among any other doc changes, you can always add a Troubleshooting section to a doc if none exists, or un-comment and use the placeholder Troubleshooting section included as part of our [doc template](structure.md#template-for-new-docs), if present.
......
...@@ -959,10 +959,10 @@ import mixin from 'ee_else_ce/path/mixin'; ...@@ -959,10 +959,10 @@ import mixin from 'ee_else_ce/path/mixin';
#### `template` tag #### `template` tag
* **EE Child components** - **EE Child components**
- Since we are using the async loading to check which component to load, we'd still use the component's name, check [this example](#child-component-only-used-in-ee). - Since we are using the async loading to check which component to load, we'd still use the component's name, check [this example](#child-component-only-used-in-ee).
* **EE extra HTML** - **EE extra HTML**
- For the templates that have extra HTML in EE we should move it into a new component and use the `ee_else_ce` dynamic import - For the templates that have extra HTML in EE we should move it into a new component and use the `ee_else_ce` dynamic import
### Non Vue Files ### Non Vue Files
......
...@@ -88,12 +88,12 @@ Until GitLab has eliminated most of these inefficiencies or the use of ...@@ -88,12 +88,12 @@ Until GitLab has eliminated most of these inefficiencies or the use of
NFS is discontinued for Git data, Rugged implementations of some of the NFS is discontinued for Git data, Rugged implementations of some of the
most commonly-used RPCs can be enabled via feature flags: most commonly-used RPCs can be enabled via feature flags:
* `rugged_find_commit` - `rugged_find_commit`
* `rugged_get_tree_entries` - `rugged_get_tree_entries`
* `rugged_tree_entry` - `rugged_tree_entry`
* `rugged_commit_is_ancestor` - `rugged_commit_is_ancestor`
* `rugged_commit_tree_entry` - `rugged_commit_tree_entry`
* `rugged_list_commits_by_oid` - `rugged_list_commits_by_oid`
A convenience Rake task can be used to enable or disable these flags A convenience Rake task can be used to enable or disable these flags
all together. To enable: all together. To enable:
......
...@@ -257,7 +257,7 @@ find a way to limit it to only us.** ...@@ -257,7 +257,7 @@ find a way to limit it to only us.**
## Other resources ## Other resources
* [Review Apps integration for CE/EE (presentation)](https://docs.google.com/presentation/d/1QPLr6FO4LduROU8pQIPkX1yfGvD13GEJIBOenqoKxR8/edit?usp=sharing) - [Review Apps integration for CE/EE (presentation)](https://docs.google.com/presentation/d/1QPLr6FO4LduROU8pQIPkX1yfGvD13GEJIBOenqoKxR8/edit?usp=sharing)
[charts-1068]: https://gitlab.com/charts/gitlab/issues/1068 [charts-1068]: https://gitlab.com/charts/gitlab/issues/1068
[gitlab-pipeline]: https://gitlab.com/gitlab-org/gitlab-ce/pipelines/44362587 [gitlab-pipeline]: https://gitlab.com/gitlab-org/gitlab-ce/pipelines/44362587
......
...@@ -145,12 +145,12 @@ Login successful. ...@@ -145,12 +145,12 @@ Login successful.
You have access to the following projects and can switch between them with 'oc project <projectname>': You have access to the following projects and can switch between them with 'oc project <projectname>':
* cockpit - cockpit
* default (current) - default (current)
* delete - delete
* openshift - openshift
* openshift-infra - openshift-infra
* sample - sample
Using project "default". Using project "default".
``` ```
......
...@@ -8,13 +8,13 @@ Please use documentation for the new [Jenkins CI service](jenkins.md). ...@@ -8,13 +8,13 @@ Please use documentation for the new [Jenkins CI service](jenkins.md).
Integration includes: Integration includes:
* Trigger Jenkins build after push to repo - Trigger Jenkins build after push to repo
* Show build status on Merge Request page - Show build status on Merge Request page
Requirements: Requirements:
* [Jenkins GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin) - [Jenkins GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
* git clone access for Jenkins from GitLab repo (via ssh key) - git clone access for Jenkins from GitLab repo (via ssh key)
## Jenkins ## Jenkins
......
...@@ -18,16 +18,16 @@ installed on your system. ...@@ -18,16 +18,16 @@ installed on your system.
If you installed GitLab: If you installed GitLab:
- Using the Omnibus package, you're all set. - Using the Omnibus package, you're all set.
- From source, make sure `rsync` is installed: - From source, make sure `rsync` is installed:
```sh ```sh
# Debian/Ubuntu # Debian/Ubuntu
sudo apt-get install rsync sudo apt-get install rsync
# RHEL/CentOS # RHEL/CentOS
sudo yum install rsync sudo yum install rsync
``` ```
### Tar ### Tar
...@@ -269,17 +269,17 @@ For Omnibus GitLab packages: ...@@ -269,17 +269,17 @@ For Omnibus GitLab packages:
1. Add the following to `/etc/gitlab/gitlab.rb`: 1. Add the following to `/etc/gitlab/gitlab.rb`:
```ruby ```ruby
gitlab_rails['backup_upload_connection'] = { gitlab_rails['backup_upload_connection'] = {
'provider' => 'AWS', 'provider' => 'AWS',
'region' => 'eu-west-1', 'region' => 'eu-west-1',
'aws_access_key_id' => 'AKIAKIAKI', 'aws_access_key_id' => 'AKIAKIAKI',
'aws_secret_access_key' => 'secret123' 'aws_secret_access_key' => 'secret123'
# If using an IAM Profile, don't configure aws_access_key_id & aws_secret_access_key # If using an IAM Profile, don't configure aws_access_key_id & aws_secret_access_key
# 'use_iam_profile' => true # 'use_iam_profile' => true
} }
gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket' gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket'
``` ```
1. [Reconfigure GitLab] for the changes to take effect 1. [Reconfigure GitLab] for the changes to take effect
...@@ -289,16 +289,16 @@ This example can be used for a bucket in Amsterdam (AMS3). ...@@ -289,16 +289,16 @@ This example can be used for a bucket in Amsterdam (AMS3).
1. Add the following to `/etc/gitlab/gitlab.rb`: 1. Add the following to `/etc/gitlab/gitlab.rb`:
```ruby ```ruby
gitlab_rails['backup_upload_connection'] = { gitlab_rails['backup_upload_connection'] = {
'provider' => 'AWS', 'provider' => 'AWS',
'region' => 'ams3', 'region' => 'ams3',
'aws_access_key_id' => 'AKIAKIAKI', 'aws_access_key_id' => 'AKIAKIAKI',
'aws_secret_access_key' => 'secret123', 'aws_secret_access_key' => 'secret123',
'endpoint' => 'https://ams3.digitaloceanspaces.com' 'endpoint' => 'https://ams3.digitaloceanspaces.com'
} }
gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket' gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket'
``` ```
1. [Reconfigure GitLab] for the changes to take effect 1. [Reconfigure GitLab] for the changes to take effect
...@@ -321,31 +321,31 @@ For installations from source: ...@@ -321,31 +321,31 @@ For installations from source:
1. Edit `home/git/gitlab/config/gitlab.yml`: 1. Edit `home/git/gitlab/config/gitlab.yml`:
```yaml ```yaml
backup: backup:
# snip # snip
upload: upload:
# Fog storage connection settings, see http://fog.io/storage/ . # Fog storage connection settings, see http://fog.io/storage/ .
connection: connection:
provider: AWS provider: AWS
region: eu-west-1 region: eu-west-1
aws_access_key_id: AKIAKIAKI aws_access_key_id: AKIAKIAKI
aws_secret_access_key: 'secret123' aws_secret_access_key: 'secret123'
# If using an IAM Profile, leave aws_access_key_id & aws_secret_access_key empty # If using an IAM Profile, leave aws_access_key_id & aws_secret_access_key empty
# ie. aws_access_key_id: '' # ie. aws_access_key_id: ''
# use_iam_profile: 'true' # use_iam_profile: 'true'
# The remote 'directory' to store your backups. For S3, this would be the bucket name. # The remote 'directory' to store your backups. For S3, this would be the bucket name.
remote_directory: 'my.s3.bucket' remote_directory: 'my.s3.bucket'
# Turns on AWS Server-Side Encryption with Amazon S3-Managed Keys for backups, this is optional # Turns on AWS Server-Side Encryption with Amazon S3-Managed Keys for backups, this is optional
# encryption: 'AES256' # encryption: 'AES256'
# Turns on AWS Server-Side Encryption with Amazon Customer-Provided Encryption Keys for backups, this is optional # Turns on AWS Server-Side Encryption with Amazon Customer-Provided Encryption Keys for backups, this is optional
# This should be set to the base64-encoded encryption key for Amazon S3 to use to encrypt or decrypt your data. # This should be set to the base64-encoded encryption key for Amazon S3 to use to encrypt or decrypt your data.
# 'encryption' must also be set in order for this to have any effect. # 'encryption' must also be set in order for this to have any effect.
# To avoid storing the key on disk, the key can also be specified via the `GITLAB_BACKUP_ENCRYPTION_KEY` environment variable. # To avoid storing the key on disk, the key can also be specified via the `GITLAB_BACKUP_ENCRYPTION_KEY` environment variable.
# encryption_key: '<base64 key>' # encryption_key: '<base64 key>'
# Specifies Amazon S3 storage class to use for backups, this is optional # Specifies Amazon S3 storage class to use for backups, this is optional
# storage_class: 'STANDARD' # storage_class: 'STANDARD'
``` ```
1. [Restart GitLab] for the changes to take effect 1. [Restart GitLab] for the changes to take effect
...@@ -417,14 +417,14 @@ For Omnibus GitLab packages: ...@@ -417,14 +417,14 @@ For Omnibus GitLab packages:
1. Edit `/etc/gitlab/gitlab.rb`: 1. Edit `/etc/gitlab/gitlab.rb`:
```ruby ```ruby
gitlab_rails['backup_upload_connection'] = { gitlab_rails['backup_upload_connection'] = {
'provider' => 'Google', 'provider' => 'Google',
'google_storage_access_key_id' => 'Access Key', 'google_storage_access_key_id' => 'Access Key',
'google_storage_secret_access_key' => 'Secret' 'google_storage_secret_access_key' => 'Secret'
} }
gitlab_rails['backup_upload_remote_directory'] = 'my.google.bucket' gitlab_rails['backup_upload_remote_directory'] = 'my.google.bucket'
``` ```
1. [Reconfigure GitLab] for the changes to take effect 1. [Reconfigure GitLab] for the changes to take effect
...@@ -434,15 +434,15 @@ For installations from source: ...@@ -434,15 +434,15 @@ For installations from source:
1. Edit `home/git/gitlab/config/gitlab.yml`: 1. Edit `home/git/gitlab/config/gitlab.yml`:
```yaml ```yaml
backup: backup:
upload: upload:
connection: connection:
provider: 'Google' provider: 'Google'
google_storage_access_key_id: 'Access Key' google_storage_access_key_id: 'Access Key'
google_storage_secret_access_key: 'Secret' google_storage_secret_access_key: 'Secret'
remote_directory: 'my.google.bucket' remote_directory: 'my.google.bucket'
``` ```
1. [Restart GitLab] for the changes to take effect 1. [Restart GitLab] for the changes to take effect
...@@ -477,16 +477,16 @@ For Omnibus GitLab packages: ...@@ -477,16 +477,16 @@ For Omnibus GitLab packages:
1. Edit `/etc/gitlab/gitlab.rb`: 1. Edit `/etc/gitlab/gitlab.rb`:
```ruby ```ruby
gitlab_rails['backup_upload_connection'] = { gitlab_rails['backup_upload_connection'] = {
:provider => 'Local', :provider => 'Local',
:local_root => '/mnt/backups' :local_root => '/mnt/backups'
} }
# The directory inside the mounted folder to copy backups to # The directory inside the mounted folder to copy backups to
# Use '.' to store them in the root directory # Use '.' to store them in the root directory
gitlab_rails['backup_upload_remote_directory'] = 'gitlab_backups' gitlab_rails['backup_upload_remote_directory'] = 'gitlab_backups'
``` ```
1. [Reconfigure GitLab] for the changes to take effect. 1. [Reconfigure GitLab] for the changes to take effect.
...@@ -496,17 +496,17 @@ For installations from source: ...@@ -496,17 +496,17 @@ For installations from source:
1. Edit `home/git/gitlab/config/gitlab.yml`: 1. Edit `home/git/gitlab/config/gitlab.yml`:
```yaml ```yaml
backup: backup:
upload: upload:
# Fog storage connection settings, see http://fog.io/storage/ . # Fog storage connection settings, see http://fog.io/storage/ .
connection: connection:
provider: Local provider: Local
local_root: '/mnt/backups' local_root: '/mnt/backups'
# The directory inside the mounted folder to copy backups to # The directory inside the mounted folder to copy backups to
# Use '.' to store them in the root directory # Use '.' to store them in the root directory
remote_directory: 'gitlab_backups' remote_directory: 'gitlab_backups'
``` ```
1. [Restart GitLab] for the changes to take effect. 1. [Restart GitLab] for the changes to take effect.
...@@ -521,9 +521,9 @@ For Omnibus GitLab packages: ...@@ -521,9 +521,9 @@ For Omnibus GitLab packages:
1. Edit `/etc/gitlab/gitlab.rb`: 1. Edit `/etc/gitlab/gitlab.rb`:
```ruby ```ruby
gitlab_rails['backup_archive_permissions'] = 0644 # Makes the backup archives world-readable gitlab_rails['backup_archive_permissions'] = 0644 # Makes the backup archives world-readable
``` ```
1. [Reconfigure GitLab] for the changes to take effect. 1. [Reconfigure GitLab] for the changes to take effect.
...@@ -533,10 +533,10 @@ For installations from source: ...@@ -533,10 +533,10 @@ For installations from source:
1. Edit `/home/git/gitlab/config/gitlab.yml`: 1. Edit `/home/git/gitlab/config/gitlab.yml`:
```yaml ```yaml
backup: backup:
archive_permissions: 0644 # Makes the backup archives world-readable archive_permissions: 0644 # Makes the backup archives world-readable
``` ```
1. [Restart GitLab] for the changes to take effect. 1. [Restart GitLab] for the changes to take effect.
...@@ -550,10 +550,10 @@ For Omnibus GitLab packages: ...@@ -550,10 +550,10 @@ For Omnibus GitLab packages:
1. Edit `/etc/gitlab/gitlab.rb`: 1. Edit `/etc/gitlab/gitlab.rb`:
```ruby ```ruby
## Limit backup lifetime to 7 days - 604800 seconds ## Limit backup lifetime to 7 days - 604800 seconds
gitlab_rails['backup_keep_time'] = 604800 gitlab_rails['backup_keep_time'] = 604800
``` ```
1. [Reconfigure GitLab] for the changes to take effect. 1. [Reconfigure GitLab] for the changes to take effect.
...@@ -586,11 +586,11 @@ For installations from source: ...@@ -586,11 +586,11 @@ For installations from source:
1. Edit `home/git/gitlab/config/gitlab.yml`: 1. Edit `home/git/gitlab/config/gitlab.yml`:
```yaml ```yaml
backup: backup:
## Limit backup lifetime to 7 days - 604800 seconds ## Limit backup lifetime to 7 days - 604800 seconds
keep_time: 604800 keep_time: 604800
``` ```
1. [Restart GitLab] for the changes to take effect. 1. [Restart GitLab] for the changes to take effect.
...@@ -840,13 +840,13 @@ columns containing sensitive information. If the key is lost, GitLab will be ...@@ -840,13 +840,13 @@ columns containing sensitive information. If the key is lost, GitLab will be
unable to decrypt those columns. This will break a wide range of functionality, unable to decrypt those columns. This will break a wide range of functionality,
including (but not restricted to): including (but not restricted to):
* [CI/CD variables](../ci/variables/README.md) - [CI/CD variables](../ci/variables/README.md)
* [Kubernetes / GCP integration](../user/project/clusters/index.md) - [Kubernetes / GCP integration](../user/project/clusters/index.md)
* [Custom Pages domains](../user/project/pages/getting_started_part_three.md) - [Custom Pages domains](../user/project/pages/getting_started_part_three.md)
* [Project error tracking](../user/project/operations/error_tracking.md) - [Project error tracking](../user/project/operations/error_tracking.md)
* [Runner authentication](../ci/runners/README.md) - [Runner authentication](../ci/runners/README.md)
* [Project mirroring](../workflow/repository_mirroring.md) - [Project mirroring](../workflow/repository_mirroring.md)
* [Web hooks](../user/project/integrations/webhooks.md) - [Web hooks](../user/project/integrations/webhooks.md)
In cases like CI/CD variables and Runner authentication, you might In cases like CI/CD variables and Runner authentication, you might
experience some unexpected behavior such as: experience some unexpected behavior such as:
...@@ -865,72 +865,71 @@ backup beforehand. ...@@ -865,72 +865,71 @@ backup beforehand.
#### Reset CI/CD variables #### Reset CI/CD variables
1. Enter the DB console: 1. Enter the DB console:
For Omnibus GitLab packages: For Omnibus GitLab packages:
```sh ```sh
sudo gitlab-rails dbconsole sudo gitlab-rails dbconsole
``` ```
For installations from source: For installations from source:
```sh ```sh
sudo -u git -H bundle exec rails dbconsole RAILS_ENV=production sudo -u git -H bundle exec rails dbconsole RAILS_ENV=production
``` ```
1. Check the `ci_group_variables` and `ci_variables` tables: 1. Check the `ci_group_variables` and `ci_variables` tables:
```sql ```sql
SELECT * FROM public."ci_group_variables"; SELECT * FROM public."ci_group_variables";
SELECT * FROM public."ci_variables"; SELECT * FROM public."ci_variables";
``` ```
Those are the variables that you need to delete. Those are the variables that you need to delete.
1. Drop the table: 1. Drop the table:
```sql ```sql
DELETE FROM ci_group_variables; DELETE FROM ci_group_variables;
DELETE FROM ci_variables; DELETE FROM ci_variables;
``` ```
1. You may need to reconfigure or restart GitLab for the changes to take 1. You may need to reconfigure or restart GitLab for the changes to take
effect. effect.
#### Reset Runner registration tokens #### Reset Runner registration tokens
1. Enter the DB console: 1. Enter the DB console:
For Omnibus GitLab packages: For Omnibus GitLab packages:
```sh ```sh
sudo gitlab-rails dbconsole sudo gitlab-rails dbconsole
``` ```
For installations from source: For installations from source:
```sh ```sh
sudo -u git -H bundle exec rails dbconsole RAILS_ENV=production sudo -u git -H bundle exec rails dbconsole RAILS_ENV=production
``` ```
1. Clear all the tokens for projects, groups, and the whole instance: 1. Clear all the tokens for projects, groups, and the whole instance:
CAUTION: **Caution:** CAUTION: **Caution:**
The last UPDATE operation will stop the runners being able to pick up The last UPDATE operation will stop the runners being able to pick up
new jobs. You must register new runners. new jobs. You must register new runners.
```sql ```sql
-- Clear project tokens -- Clear project tokens
UPDATE projects SET runners_token = null, runners_token_encrypted = null; UPDATE projects SET runners_token = null, runners_token_encrypted = null;
-- Clear group tokens -- Clear group tokens
UPDATE namespaces SET runners_token = null, runners_token_encrypted = null; UPDATE namespaces SET runners_token = null, runners_token_encrypted = null;
-- Clear instance tokens -- Clear instance tokens
UPDATE application_settings SET runners_registration_token_encrypted = null; UPDATE application_settings SET runners_registration_token_encrypted = null;
-- Clear runner tokens -- Clear runner tokens
UPDATE ci_runners SET token = null, token_encrypted = null; UPDATE ci_runners SET token = null, token_encrypted = null;
``` ```
A similar strategy can be employed for the remaining features - by removing the A similar strategy can be employed for the remaining features - by removing the
data that cannot be decrypted, GitLab can be brought back into working order, data that cannot be decrypted, GitLab can be brought back into working order,
......
...@@ -2,42 +2,54 @@ ...@@ -2,42 +2,54 @@
## Add a webhook for **ALL** projects: ## Add a webhook for **ALL** projects:
```sh
# omnibus-gitlab # omnibus-gitlab
sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook" sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook"
# source installations # source installations
bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" RAILS_ENV=production bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" RAILS_ENV=production
```
## Add a webhook for projects in a given **NAMESPACE**: ## Add a webhook for projects in a given **NAMESPACE**:
```sh
# omnibus-gitlab # omnibus-gitlab
sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme
# source installations # source installations
bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production
```
## Remove a webhook from **ALL** projects using: ## Remove a webhook from **ALL** projects using:
```sh
# omnibus-gitlab # omnibus-gitlab
sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook" sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook"
# source installations # source installations
bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" RAILS_ENV=production bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" RAILS_ENV=production
```
## Remove a webhook from projects in a given **NAMESPACE**: ## Remove a webhook from projects in a given **NAMESPACE**:
```sh
# omnibus-gitlab # omnibus-gitlab
sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme
# source installations # source installations
bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production
```
## List **ALL** webhooks: ## List **ALL** webhooks:
```sh
# omnibus-gitlab # omnibus-gitlab
sudo gitlab-rake gitlab:web_hook:list sudo gitlab-rake gitlab:web_hook:list
# source installations # source installations
bundle exec rake gitlab:web_hook:list RAILS_ENV=production bundle exec rake gitlab:web_hook:list RAILS_ENV=production
```
## List the webhooks from projects in a given **NAMESPACE**: ## List the webhooks from projects in a given **NAMESPACE**:
# omnibus-gitlab ```sh
sudo gitlab-rake gitlab:web_hook:list NAMESPACE=acme # omnibus-gitlab
# source installations sudo gitlab-rake gitlab:web_hook:list NAMESPACE=acme
bundle exec rake gitlab:web_hook:list NAMESPACE=acme RAILS_ENV=production # source installations
bundle exec rake gitlab:web_hook:list NAMESPACE=acme RAILS_ENV=production
```
\ No newline at end of file
...@@ -25,14 +25,14 @@ Branch names use the format `major-minor-stable-ee` for Enterprise Edition, and ...@@ -25,14 +25,14 @@ Branch names use the format `major-minor-stable-ee` for Enterprise Edition, and
`major-minor-stable` for Community Edition. For example, for 11.8.0 you would `major-minor-stable` for Community Edition. For example, for 11.8.0 you would
use the following branches: use the following branches:
* Enterprise Edition: `11-8-stable-ee` - Enterprise Edition: `11-8-stable-ee`
* Community Edition: `11-8-stable` - Community Edition: `11-8-stable`
### 0. Backup ### 0. Backup
Make a backup just in case something goes wrong: Make a backup just in case something goes wrong:
```bash ```sh
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
``` ```
...@@ -42,13 +42,13 @@ privileges to the GitLab user on the database version. ...@@ -42,13 +42,13 @@ privileges to the GitLab user on the database version.
### 1. Stop server ### 1. Stop server
```bash ```sh
sudo service gitlab stop sudo service gitlab stop
``` ```
### 2. Get the EE code ### 2. Get the EE code
```bash ```sh
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H git remote add -f ee https://gitlab.com/gitlab-org/gitlab-ee.git sudo -u git -H git remote add -f ee https://gitlab.com/gitlab-org/gitlab-ee.git
sudo -u git -H git checkout EE_BRANCH sudo -u git -H git checkout EE_BRANCH
...@@ -56,7 +56,7 @@ sudo -u git -H git checkout EE_BRANCH ...@@ -56,7 +56,7 @@ sudo -u git -H git checkout EE_BRANCH
### 3. Install libs, migrations, etc. ### 3. Install libs, migrations, etc.
```bash ```sh
cd /home/git/gitlab cd /home/git/gitlab
# MySQL installations (note: the line below states '--without postgres') # MySQL installations (note: the line below states '--without postgres')
...@@ -80,7 +80,7 @@ document linked above and enable the indexer usage in the GitLab admin settings. ...@@ -80,7 +80,7 @@ document linked above and enable the indexer usage in the GitLab admin settings.
### 5. Start application ### 5. Start application
```bash ```sh
sudo service gitlab start sudo service gitlab start
sudo service nginx restart sudo service nginx restart
``` ```
...@@ -89,13 +89,13 @@ sudo service nginx restart ...@@ -89,13 +89,13 @@ sudo service nginx restart
Check if GitLab and its environment are configured correctly: Check if GitLab and its environment are configured correctly:
```bash ```sh
sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
``` ```
To make sure you didn't miss anything run a more thorough check with: To make sure you didn't miss anything run a more thorough check with:
```bash ```sh
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
``` ```
...@@ -105,14 +105,14 @@ If all items are green, then congratulations upgrade complete! ...@@ -105,14 +105,14 @@ If all items are green, then congratulations upgrade complete!
### 1. Revert the code to the previous version ### 1. Revert the code to the previous version
```bash ```sh
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H git checkout CE_BRANCH sudo -u git -H git checkout CE_BRANCH
``` ```
### 2. Restore from the backup ### 2. Restore from the backup
```bash ```sh
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production
``` ```
......
...@@ -54,13 +54,13 @@ Select the desired period from the calendar dropdown. ...@@ -54,13 +54,13 @@ Select the desired period from the calendar dropdown.
Contributions per group member are also presented in tabular format. Click a column header to sort the table by that column: Contributions per group member are also presented in tabular format. Click a column header to sort the table by that column:
* Member name - Member name
* Number of pushed events - Number of pushed events
* Number of opened issues - Number of opened issues
* Number of closed issues - Number of closed issues
* Number of opened MRs - Number of opened MRs
* Number of accepted MRs - Number of accepted MRs
* Number of total contributions - Number of total contributions
![Contribution analytics contributions table](img/group_stats_table.png) ![Contribution analytics contributions table](img/group_stats_table.png)
......
...@@ -1115,20 +1115,20 @@ will point the link to `wikis/style` only when the link is inside of a wiki mark ...@@ -1115,20 +1115,20 @@ will point the link to `wikis/style` only when the link is inside of a wiki mark
GFM will autolink almost any URL you put into your text: GFM will autolink almost any URL you put into your text:
```markdown ```markdown
* https://www.google.com - https://www.google.com
* https://google.com/ - https://google.com/
* ftp://ftp.us.debian.org/debian/ - ftp://ftp.us.debian.org/debian/
* smb://foo/bar/baz - smb://foo/bar/baz
* irc://irc.freenode.net/gitlab - irc://irc.freenode.net/gitlab
* http://localhost:3000 - http://localhost:3000
``` ```
* https://www.google.com - https://www.google.com
* https://google.com/ - https://google.com/
* ftp://ftp.us.debian.org/debian/ - ftp://ftp.us.debian.org/debian/
* smb://foo/bar/baz - smb://foo/bar/baz
* irc://irc.freenode.net/gitlab - irc://irc.freenode.net/gitlab
* http://localhost:3000 - http://localhost:3000
### Lists ### Lists
...@@ -1147,7 +1147,7 @@ Examples: ...@@ -1147,7 +1147,7 @@ Examples:
```md ```md
1. First ordered list item 1. First ordered list item
2. Another item 2. Another item
* Unordered sub-list. - Unordered sub-list.
1. Actual numbers don't matter, just that it's a number 1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list 1. Ordered sub-list
1. Next ordered sub-list item 1. Next ordered sub-list item
...@@ -1160,7 +1160,7 @@ Examples: ...@@ -1160,7 +1160,7 @@ Examples:
1. First ordered list item 1. First ordered list item
2. Another item 2. Another item
* Unordered sub-list. - Unordered sub-list.
1. Actual numbers don't matter, just that it's a number 1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list 1. Ordered sub-list
1. Next ordered sub-list item 1. Next ordered sub-list item
......
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