Skip to content

Commit 73788d1

Browse files
ereadKati Paizee
authored andcommitted
Update some installation type references for docs
1 parent cc44623 commit 73788d1

18 files changed

+126
-229
lines changed

doc/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ to work best with the available resources. Check out the [documentation](setting
4343
- [Storing Git data in an alternative directory](settings/configuration.md#store-git-data-in-an-alternative-directory)
4444
- [Changing the name of the Git user group](settings/configuration.md#change-the-name-of-the-git-user-or-group)
4545
- [Specify numeric user and group identifiers](settings/configuration.md#specify-numeric-user-and-group-identifiers)
46-
- [Only start Omnibus GitLab services after a given file system is mounted](settings/configuration.md#start-omnibus-gitlab-services-only-after-a-given-file-system-is-mounted)
46+
- [Start Linux package installation services only after a given file system is mounted](settings/configuration.md#start-linux-package-installation-services-only-after-a-given-file-system-is-mounted)
4747
- [Disable user and group account management](settings/configuration.md#disable-user-and-group-account-management)
4848
- [Disable storage directory management](settings/configuration.md#disable-storage-directories-management)
4949
- [Failed authentication ban](settings/configuration.md#configure-a-failed-authentication-ban)
@@ -72,9 +72,8 @@ to work best with the available resources. Check out the [documentation](setting
7272
- [Upgrade from Community Edition to Enterprise Edition](https://docs.gitlab.com/ee/update/package/convert_to_ee.html)
7373
- [Upgrade to the latest version](https://docs.gitlab.com/ee/update/package/#upgrade-using-the-official-repositories)
7474
- [Downgrade to an earlier version](https://docs.gitlab.com/ee/update/package/downgrade.html)
75-
- [Upgrade from a non-Omnibus installation to an Omnibus installation using a backup](update/convert_to_omnibus.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-using-a-backup)
76-
- [Upgrade from non-Omnibus PostgreSQL to an Omnibus installation in-place](update/convert_to_omnibus.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-in-place)
77-
- [Upgrade from non-Omnibus MySQL to an Omnibus installation (version 6.8+)](update/convert_to_omnibus.md#upgrading-from-non-omnibus-mysql-to-an-omnibus-installation-version-68)
75+
- [Upgrade from a non-Linux package PostgreSQL to a Linux package installation using a backup](update/convert_to_omnibus.md#upgrading-from-a-non-linux-package-postgresql-to-a-linux-package-installation-using-a-backup)
76+
- [Upgrade from a non-Linux package PostgreSQL to a Linux package installation in-place](update/convert_to_omnibus.md#upgrading-from-a-non-linux-package-postgresql-to-a-linux-package-installation-in-place)
7877

7978
## Troubleshooting
8079

doc/installation/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
55
---
66

7-
# Installing GitLab with Omnibus packages **(FREE SELF)**
7+
# Install GitLab with the Linux package **(FREE SELF)**
88

99
## Prerequisites
1010

@@ -21,7 +21,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
2121

2222
## Installation and Configuration
2323

24-
These configuration settings are commonly used when configuring Omnibus GitLab.
24+
These configuration settings are commonly used when configuring a Linux package installation.
2525
For a complete list of settings, see the [README](../index.md#configuring) file.
2626

2727
- [Installing GitLab](https://about.gitlab.com/install/).
@@ -37,16 +37,16 @@ For a complete list of settings, see the [README](../index.md#configuring) file.
3737
- [Enabling GitLab Pages](https://docs.gitlab.com/ee/administration/pages/).
3838
- If you want HTTPS enabled, you must get wildcard certificates.
3939
- [Enabling Elasticsearch](https://docs.gitlab.com/ee/integration/advanced_search/elasticsearch.html).
40-
- [GitLab Mattermost](https://docs.gitlab.com/ee/integration/mattermost/) Set up the Mattermost messaging app that ships with Omnibus GitLab package.
40+
- [GitLab Mattermost](https://docs.gitlab.com/ee/integration/mattermost/). Set up the Mattermost messaging app that ships with the Linux package.
4141
- [GitLab Prometheus](https://docs.gitlab.com/ee/administration/monitoring/prometheus/index.html)
42-
Set up the Prometheus monitoring included in the Omnibus GitLab package.
42+
Set up the Prometheus monitoring included in the Linux package.
4343
- [GitLab High Availability Roles](../roles/index.md).
4444

4545
### Set up the initial password
4646

47-
> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5331) in Omnibus GitLab 14.0.
47+
> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5331) in GitLab 14.0.
4848
49-
By default, Omnibus GitLab automatically generates a password for the
49+
By default, a Linux package installation automatically generates a password for the
5050
initial administrator user account (`root`) and stores it to
5151
`/etc/gitlab/initial_root_password` for at least 24 hours. For security reasons,
5252
after 24 hours, this file is automatically removed by the first `gitlab-ctl reconfigure`.
@@ -93,8 +93,8 @@ To uninstall the Linux package, you can opt to either keep your data (repositori
9393
database, configuration) or remove all of them:
9494

9595
1. Optional. To remove
96-
[all users and groups created by Omnibus GitLab](../settings/configuration.md#disable-user-and-group-account-management)
97-
before removing the GitLab package (with `apt` or `yum`):
96+
[all users and groups created by the Linux package](../settings/configuration.md#disable-user-and-group-account-management)
97+
before removing the package (with `apt` or `yum`):
9898

9999
```shell
100100
sudo gitlab-ctl stop && sudo gitlab-ctl remove-accounts

doc/settings/backups.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
66

77
# Backup **(FREE SELF)**
88

9-
## Backup and restore Omnibus GitLab configuration
9+
## Backup and restore configuration on a Linux package installation
1010

1111
It is recommended to keep a copy of `/etc/gitlab`, or at least of
1212
`/etc/gitlab/gitlab-secrets.json`, in a safe place. If you ever
@@ -18,7 +18,7 @@ and 'secure variables' stored in GitLab CI will be lost.
1818
It is not recommended to store your configuration backup in the
1919
same place as your application data backup, see below.
2020

21-
All configuration for Omnibus GitLab is stored in `/etc/gitlab`. To backup your
21+
All configuration for Linux package installations is stored in `/etc/gitlab`. To backup your
2222
configuration, just run `sudo gitlab-ctl backup-etc` (introduced in GitLab 12.3). It creates a tar
2323
archive in `/etc/gitlab/config_backup/`. Directory and backup files will be
2424
readable only to root.
@@ -164,7 +164,7 @@ For details check [backup restore document](https://docs.gitlab.com/ee/raketasks
164164

165165
## Manually manage backup directory
166166

167-
Omnibus GitLab creates the backup directory set with `gitlab_rails['backup_path']`. The directory is owned by the user that is running GitLab and it has strict permissions set to be accessible to only that user.
167+
Linux package installations create the backup directory set with `gitlab_rails['backup_path']`. The directory is owned by the user that is running GitLab and it has strict permissions set to be accessible to only that user.
168168
That directory will hold backup archives and they contain sensitive information.
169169
In some organizations permissions need to be different because of, for example, shipping the backup archives offsite.
170170

doc/settings/configuration.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
55
---
66

7-
# Configuration options for the GitLab Linux package **(FREE SELF)**
7+
# Configuration options for Linux package installations **(FREE SELF)**
88

99
To configure GitLab, set the relevant options in the `/etc/gitlab/gitlab.rb` file.
1010

@@ -60,7 +60,7 @@ To change the external URL:
6060

6161
### Specify the external URL at the time of installation
6262

63-
If you use the GitLab Linux package, you can set up your GitLab instance
63+
If you use the Linux package, you can set up your GitLab instance
6464
with the minimum number of commands by using the `EXTERNAL_URL` environment variable.
6565
If this variable is set, it is automatically detected and its value is written
6666
as `external_url` in the `gitlab.rb` file.
@@ -112,7 +112,7 @@ If you have any issues, see the [troubleshooting section](#relative-url-troubles
112112

113113
## Load external configuration file from non-root user
114114

115-
Omnibus GitLab package loads all configuration from `/etc/gitlab/gitlab.rb` file.
115+
Linux package installations load all configuration from `/etc/gitlab/gitlab.rb` file.
116116
This file has strict file permissions and is owned by the `root` user. The reason for strict permissions
117117
and ownership is that `/etc/gitlab/gitlab.rb` is being executed as Ruby code by the `root` user during `gitlab-ctl reconfigure`. This means
118118
that users who have to write access to `/etc/gitlab/gitlab.rb` can add a configuration that is executed as code by `root`.
@@ -140,7 +140,7 @@ postgresql['internal_certificate'] = File.read('/path/to/server.crt')
140140

141141
## Store Git data in an alternative directory
142142

143-
By default, Omnibus GitLab stores the Git repository data under
143+
By default, Linux package installations store the Git repository data under
144144
`/var/opt/gitlab/git-data`. The repositories are stored in a subfolder called
145145
`repositories`.
146146

@@ -218,7 +218,7 @@ endpoint and specify the `repository_storage` attribute.
218218
NOTE:
219219
We do not recommend changing the user or group of an existing installation because it can cause unpredictable side effects.
220220

221-
By default, Omnibus GitLab uses the user name `git` for Git GitLab Shell login,
221+
By default, Linux package installations use the user name `git` for Git GitLab Shell login,
222222
ownership of the Git data itself, and SSH URL generation on the web interface.
223223
Similarly, the `git` group is used for group ownership of the Git data.
224224

@@ -243,7 +243,7 @@ Make sure that the new user can access the `repositories` and `uploads` director
243243
244244
## Specify numeric user and group identifiers
245245
246-
Omnibus GitLab creates users for GitLab, PostgreSQL, Redis, NGINX, etc. To
246+
Linux package installations create users for GitLab, PostgreSQL, Redis, NGINX, etc. To
247247
specify the numeric identifiers for these users:
248248
249249
1. Edit `/etc/gitlab/gitlab.rb`:
@@ -271,7 +271,8 @@ specify the numeric identifiers for these users:
271271
sudo gitlab-ctl reconfigure
272272
```
273273
274-
1. Optional. If you're changing `user['uid']` and `user['gid']`, make sure to update the uid/guid of any files not managed by Omnibus directly, for example, the logs:
274+
1. Optional. If you're changing `user['uid']` and `user['gid']`, make sure to update the uid/guid of any files not managed by the Linux package
275+
directly, for example, the logs:
275276

276277
```shell
277278
find /var/log/gitlab -uid <old_uid> | xargs -I:: chown git ::
@@ -282,14 +283,14 @@ find /var/opt/gitlab -gid <old_uid> | xargs -I:: chgrp git ::
282283

283284
## Disable user and group account management
284285

285-
By default, Omnibus GitLab creates system user and group accounts,
286+
By default, Linux package installations create system user and group accounts,
286287
as well as keeping the information updated.
287288
These system accounts run various components of the package.
288289
Most users don't need to change this behavior.
289290
However, if your system accounts are managed by other software, for example, LDAP, you
290291
might need to disable account management done by the GitLab package.
291292
292-
By default, the Omnibus GitLab package expects the following users and groups to exist:
293+
By default, the Linux package installations expect the following users and groups to exist:
293294
294295
| Linux user and group | Required | Description |
295296
| -------------------- | --------------------------------------- | -------------------------------------------------------------------- |
@@ -395,15 +396,15 @@ To move an existing home directory, GitLab services need to be stopped and some
395396
396397
## Disable storage directories management
397398
398-
The Omnibus GitLab package takes care of creating all the necessary directories
399+
The Linux package takes care of creating all the necessary directories
399400
with the correct ownership and permissions, as well as keeping this updated.
400401
401402
Some of the directories hold large amounts of data so in certain setups,
402403
those directories are most likely mounted on an NFS (or some other) share.
403404
404405
Some types of mounts don't allow the automatic creation of directories by the root user
405406
(default user for initial setup), for example, NFS with `root_squash` enabled on the
406-
share. To work around this, the Omnibus GitLab package attempts to create
407+
share. To work around this, the Linux package attempts to create
407408
those directories using the directory's owner user.
408409
409410
### Disable the `/etc/gitlab` directory management
@@ -428,7 +429,7 @@ that directory:
428429
If you are mounting all GitLab storage directories, each on a separate mount,
429430
you should completely disable the management of storage directories.
430431
431-
The Omnibus GitLab package expects these directories to exist
432+
Linux package installations expect these directories to exist
432433
on the file system. It is up to you to create and set correct
433434
permissions if this setting is set.
434435
@@ -465,9 +466,9 @@ To disable the management of storage directories:
465466
sudo gitlab-ctl reconfigure
466467
```
467468
468-
## Start Omnibus GitLab services only after a given file system is mounted
469+
## Start Linux package installation services only after a given file system is mounted
469470
470-
If you want to prevent Omnibus GitLab services (NGINX, Redis, Puma, etc.)
471+
If you want to prevent Linux package installation services (NGINX, Redis, Puma, etc.)
471472
from starting before a given file system is mounted:
472473
473474
1. Edit `/etc/gitlab/gitlab.rb`:
@@ -490,7 +491,7 @@ of each Puma process (Rails metrics). Every Puma process needs to write
490491
a metrics file to a temporary location for each controller request.
491492
Prometheus then collects all these files and processes their values.
492493
493-
To avoid creating disk I/O, the Omnibus GitLab package uses a
494+
To avoid creating disk I/O, the Linux package uses a
494495
runtime directory.
495496
496497
During `reconfigure`, the package check if `/run` is a `tmpfs` mount.

0 commit comments

Comments
 (0)