summaryrefslogtreecommitdiff
path: root/doc/install
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-11-19 08:27:35 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-11-19 08:27:35 +0000
commit7e9c479f7de77702622631cff2628a9c8dcbc627 (patch)
treec8f718a08e110ad7e1894510980d2155a6549197 /doc/install
parente852b0ae16db4052c1c567d9efa4facc81146e88 (diff)
downloadgitlab-ce-7e9c479f7de77702622631cff2628a9c8dcbc627.tar.gz
Add latest changes from gitlab-org/gitlab@13-6-stable-eev13.6.0-rc42
Diffstat (limited to 'doc/install')
-rw-r--r--doc/install/aws/index.md6
-rw-r--r--doc/install/azure/index.md16
-rw-r--r--doc/install/digitaloceandocker.md3
-rw-r--r--doc/install/installation.md92
-rw-r--r--doc/install/kubernetes/gitlab_chart.md5
-rw-r--r--doc/install/kubernetes/gitlab_omnibus.md5
-rw-r--r--doc/install/kubernetes/gitlab_runner_chart.md5
-rw-r--r--doc/install/kubernetes/index.md5
-rw-r--r--doc/install/kubernetes/preparation/connect.md5
-rw-r--r--doc/install/kubernetes/preparation/eks.md5
-rw-r--r--doc/install/kubernetes/preparation/networking.md5
-rw-r--r--doc/install/kubernetes/preparation/rbac.md5
-rw-r--r--doc/install/kubernetes/preparation/tiller.md5
-rw-r--r--doc/install/kubernetes/preparation/tools_installation.md5
-rw-r--r--doc/install/openshift_and_gitlab/index.md26
-rw-r--r--doc/install/pivotal/index.md6
-rw-r--r--doc/install/postgresql_extensions.md6
-rw-r--r--doc/install/requirements.md5
18 files changed, 77 insertions, 133 deletions
diff --git a/doc/install/aws/index.md b/doc/install/aws/index.md
index 93ac17d823b..a1774ddb770 100644
--- a/doc/install/aws/index.md
+++ b/doc/install/aws/index.md
@@ -312,7 +312,7 @@ We need a security group for our database that will allow inbound traffic from t
### Create the database
-DANGER: **Danger:**
+DANGER: **Warning:**
Avoid using burstable instances (t class instances) for the database as this could lead to performance issues due to CPU credits running out during sustained periods of high load.
Now, it's time to create the database:
@@ -349,6 +349,10 @@ Now that the database is created, let's move on to setting up Redis with ElastiC
ElastiCache is an in-memory hosted caching solution. Redis maintains its own
persistence and is used to store session data, temporary cache information, and background job queues for the GitLab application.
+DANGER: **Warning:**
+GitLab recommends you use ElastiCache Redis version 5.0.x, because version 6.x contains
+a bug that [prevents Sidekiq from processing jobs](https://gitlab.com/gitlab-org/gitlab/-/issues/281683).
+
### Create a Redis Security Group
1. Navigate to the EC2 dashboard.
diff --git a/doc/install/azure/index.md b/doc/install/azure/index.md
index b5e72a9b84a..9dc30ab2476 100644
--- a/doc/install/azure/index.md
+++ b/doc/install/azure/index.md
@@ -347,8 +347,8 @@ connect to it using SSH ([Secure Shell](https://en.wikipedia.org/wiki/Secure_She
If you're running Windows, you'll need to connect using [PuTTY](https://www.putty.org) or an equivalent Windows SSH client.
If you're running Linux or macOS, then you already have an SSH client installed.
-Remember that you will need to login with the username and password you specified
-[when you created](#basics) your Azure VM.
+Remember to sign in with the username and password you specified when you
+[created your Azure VM](#basics).
If you need to reset your VM password, read
[how to reset SSH credentials for a user on an Azure VM](https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshoot-ssh-connection).
@@ -375,20 +375,20 @@ read on [using PuTTY in Windows](https://mediatemple.net/community/products/dv/2
### Updating GitLab
-Once you've logged in via SSH, enter the following command to update GitLab to the latest
-version:
+After signing in by using SSH, enter the following command to update GitLab to
+the latest version:
```shell
sudo apt-get update && sudo apt-get install gitlab-ce
```
-This command will update GitLab and its associated components to the latest versions, so it will
-take a little time to complete. You'll see various update tasks being completed in your SSH
-terminal window:
+This command updates GitLab and its associated components to the latest versions,
+so it will take a little time to complete. You'll see various update tasks being
+completed in your SSH terminal window:
![GitLab updating](img/gitlab-ssh-update-in-progress.png)
-Once the update process has completed, you'll see a message like this:
+After the update process is complete, you'll see a message like this:
```plaintext
Upgrade complete! If your GitLab server is misbehaving try running
diff --git a/doc/install/digitaloceandocker.md b/doc/install/digitaloceandocker.md
index fe32b37a9ed..deb8a8cc6ca 100644
--- a/doc/install/digitaloceandocker.md
+++ b/doc/install/digitaloceandocker.md
@@ -1,4 +1,7 @@
---
+stage: none
+group: unassigned
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
type: howto
---
diff --git a/doc/install/installation.md b/doc/install/installation.md
index 0adf09595e4..87e3cd1ea06 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -90,6 +90,8 @@ The GitLab installation consists of setting up the following components:
## 1. Packages and dependencies
+### sudo
+
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
@@ -110,6 +112,8 @@ sudo apt-get install -y vim
sudo update-alternatives --set editor /usr/bin/vim.basic
```
+### Build dependencies
+
Install the required packages (needed to compile Ruby and native extensions to Ruby gems):
```shell
@@ -129,69 +133,33 @@ If you want to use Kerberos for user authentication, install `libkrb5-dev`
sudo apt-get install libkrb5-dev
```
-Make sure you have the right version of Git installed:
-
-```shell
-# Install Git
-sudo apt-get install -y git-core
+### Git
-# Make sure Git is version 2.24.0 or higher (recommended version is 2.28.0)
-git --version
-```
+From GitLab 13.6, we recommend you use the [Git version provided by
+Gitaly](https://gitlab.com/gitlab-org/gitaly/-/issues/2729)
+that:
-Starting with GitLab 12.0, Git is required to be compiled with `libpcre2`.
-Find out if that's the case:
+- Is always at the version required by GitLab.
+- May contain custom patches required for proper operation.
```shell
-ldd $(command -v git) | grep pcre2
-```
-
-The output should contain `libpcre2-8.so.0`.
+# Install dependencies
+sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev libpcre2-dev build-essential
-If the system packaged Git is too old or not compiled with `pcre2`, remove it:
+# Clone the Gitaly repository
+git clone https://gitlab.com/gitlab-org/gitaly.git -b <X-Y-stable> /tmp/gitaly
-```shell
-sudo apt-get remove git-core
+# Compile and install Git
+cd /tmp/gitaly
+sudo make git GIT_PREFIX=/usr/local
```
-On Ubuntu, install Git from [its official PPA](https://git-scm.com/download/linux):
+Replace `<X-Y-stable>` with the stable branch that matches the GitLab version you want to
+install. For example, if you want to install GitLab 13.6, use the branch name `13-6-stable`.
-```shell
-# run as root!
-add-apt-repository ppa:git-core/ppa
-apt update
-apt install git
-# repeat libpcre2 check as above
-```
+When editing `config/gitlab.yml` later, change the `git -> bin_path` to `/usr/local/bin/git`.
-On Debian, use the following compilation instructions:
-
-```shell
-# Install dependencies
-sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential
-
-# Download and compile pcre2 from source
-curl --silent --show-error --location https://ftp.pcre.org/pub/pcre/pcre2-10.33.tar.gz --output pcre2.tar.gz
-tar -xzf pcre2.tar.gz
-cd pcre2-10.33
-chmod +x configure
-./configure --prefix=/usr --enable-jit
-make
-sudo make install
-
-# Download and compile from source
-cd /tmp
-curl --remote-name --location --progress https://www.kernel.org/pub/software/scm/git/git-2.28.0.tar.gz
-echo 'f914c60a874d466c1e18467c864a910dd4ea22281ba6d4d58077cb0c3f115170 git-2.28.0.tar.gz' | shasum -a256 -c - && tar -xzf git-2.28.0.tar.gz
-cd git-2.28.0/
-./configure --with-libpcre
-make prefix=/usr/local all
-
-# Install into /usr/local/bin
-sudo make prefix=/usr/local install
-
-# When editing config/gitlab.yml later, change the git -> bin_path to /usr/local/bin/git
-```
+### GraphicsMagick
For the [Custom Favicon](../user/admin_area/appearance.md#favicon) to work, GraphicsMagick
needs to be installed.
@@ -200,6 +168,8 @@ needs to be installed.
sudo apt-get install -y graphicsmagick
```
+### Mail server
+
In order to receive mail notifications, make sure to install a mail server.
By default, Debian is shipped with `exim4` but this
[has problems](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/12754) while
@@ -212,6 +182,8 @@ sudo apt-get install -y postfix
Then select 'Internet Site' and press enter to confirm the hostname.
+### Exiftool
+
[GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse#dependencies)
requires `exiftool` to remove EXIF data from uploaded images.
@@ -243,9 +215,9 @@ Download Ruby and compile it:
```shell
mkdir /tmp/ruby && cd /tmp/ruby
-curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.6/ruby-2.6.6.tar.gz
-echo '2d78048e293817f38d4ede4ebc7873013e97bb0b ruby-2.6.6.tar.gz' | shasum -c - && tar xzf ruby-2.6.6.tar.gz
-cd ruby-2.6.6
+curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz
+echo 'cb9731a17487e0ad84037490a6baf8bfa31a09e8 ruby-2.7.2.tar.gz' | shasum -c - && tar xzf ruby-2.7.2.tar.gz
+cd ruby-2.7.2
./configure --disable-install-rdoc
make
@@ -463,22 +435,22 @@ Clone Community Edition:
```shell
# Clone GitLab repository
-sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-foss.git -b X-Y-stable gitlab
+sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-foss.git -b <X-Y-stable> gitlab
```
Clone Enterprise Edition:
```shell
# Clone GitLab repository
-sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab.git -b X-Y-stable gitlab
+sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab.git -b <X-Y-stable> gitlab
```
-Make sure to replace `X-Y-stable` with the stable branch that matches the
+Make sure to replace `<X-Y-stable>` with the stable branch that matches the
version you want to install. For example, if you want to install 11.8 you would
use the branch name `11-8-stable`.
CAUTION: **Caution:**
-You can change `X-Y-stable` to `master` if you want the *bleeding edge* version, but never install `master` on a production server!
+You can change `<X-Y-stable>` to `master` if you want the *bleeding edge* version, but never install `master` on a production server!
### Configure It
diff --git a/doc/install/kubernetes/gitlab_chart.md b/doc/install/kubernetes/gitlab_chart.md
deleted file mode 100644
index d067c341be8..00000000000
--- a/doc/install/kubernetes/gitlab_chart.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/).
diff --git a/doc/install/kubernetes/gitlab_omnibus.md b/doc/install/kubernetes/gitlab_omnibus.md
deleted file mode 100644
index d067c341be8..00000000000
--- a/doc/install/kubernetes/gitlab_omnibus.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/).
diff --git a/doc/install/kubernetes/gitlab_runner_chart.md b/doc/install/kubernetes/gitlab_runner_chart.md
deleted file mode 100644
index be58c957166..00000000000
--- a/doc/install/kubernetes/gitlab_runner_chart.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/runner/install/kubernetes.html'
----
-
-This document was moved to [another location](https://docs.gitlab.com/runner/install/kubernetes.html).
diff --git a/doc/install/kubernetes/index.md b/doc/install/kubernetes/index.md
deleted file mode 100644
index d067c341be8..00000000000
--- a/doc/install/kubernetes/index.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/).
diff --git a/doc/install/kubernetes/preparation/connect.md b/doc/install/kubernetes/preparation/connect.md
deleted file mode 100644
index 839461c982c..00000000000
--- a/doc/install/kubernetes/preparation/connect.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/installation/cloud/'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/installation/cloud/).
diff --git a/doc/install/kubernetes/preparation/eks.md b/doc/install/kubernetes/preparation/eks.md
deleted file mode 100644
index c3f53c2f580..00000000000
--- a/doc/install/kubernetes/preparation/eks.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/installation/cloud/eks.html'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/installation/cloud/eks.html).
diff --git a/doc/install/kubernetes/preparation/networking.md b/doc/install/kubernetes/preparation/networking.md
deleted file mode 100644
index 7e88bbd3cd1..00000000000
--- a/doc/install/kubernetes/preparation/networking.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/installation/deployment.html#networking-and-dns'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/installation/deployment.html#networking-and-dns).
diff --git a/doc/install/kubernetes/preparation/rbac.md b/doc/install/kubernetes/preparation/rbac.md
deleted file mode 100644
index fc18b91641c..00000000000
--- a/doc/install/kubernetes/preparation/rbac.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/installation/deployment.html#rbac'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/installation/deployment.html#rbac).
diff --git a/doc/install/kubernetes/preparation/tiller.md b/doc/install/kubernetes/preparation/tiller.md
deleted file mode 100644
index c1c7910703e..00000000000
--- a/doc/install/kubernetes/preparation/tiller.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/installation/tools.html'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/installation/tools.html).
diff --git a/doc/install/kubernetes/preparation/tools_installation.md b/doc/install/kubernetes/preparation/tools_installation.md
deleted file mode 100644
index c1c7910703e..00000000000
--- a/doc/install/kubernetes/preparation/tools_installation.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-redirect_to: 'https://docs.gitlab.com/charts/installation/tools.html'
----
-
-This document was moved to [another location](https://docs.gitlab.com/charts/installation/tools.html).
diff --git a/doc/install/openshift_and_gitlab/index.md b/doc/install/openshift_and_gitlab/index.md
index 7ac5aa6667a..2d7389a48a0 100644
--- a/doc/install/openshift_and_gitlab/index.md
+++ b/doc/install/openshift_and_gitlab/index.md
@@ -183,9 +183,9 @@ Using the all-in-one VM gives you the ability to test OpenShift whenever you
want. That means you get to play with it, shutdown the VM, and pick up where
you left off.
-Sometimes though, you may encounter some issues, like OpenShift not running
-when booting up the VM. The web UI may not responding or you may see issues
-when trying to login with `oc`, like:
+Occasionally, you may encounter issues, like OpenShift not running when booting
+up the VM. The web UI may not respond, or you may see issues when trying to sign
+in with `oc`, like:
```plaintext
The connection to the server 10.2.2.2:8443 was refused - did you specify the right host or port?
@@ -213,8 +213,7 @@ In that case, the OpenShift service might not be running, so in order to fix it:
systemctl status openshift -l
```
-Now you will be able to login using `oc` (like we did before) and visit the web
-console.
+You can now sign in by using `oc` (like we did before) and visit the web console.
## Deploy GitLab
@@ -497,14 +496,13 @@ oc adm policy add-scc-to-user anyuid system:serviceaccount:gitlab:gitlab-ce-user
## Conclusion
-By now, you should have an understanding of the basic OpenShift Origin concepts
-and a sense of how things work using the web console or the CLI.
+You should now have an understanding of the basic OpenShift Origin concepts, and
+a sense of how things work using the web console or the CLI.
-GitLab was hard to install in previous versions of OpenShift,
-but now that belongs to the past. Upload a template, create a project, add an
-application and you are done. You are ready to login to your new GitLab instance.
+Upload a template, create a project, add an application, and you're done. You're
+ready to sign in to your new GitLab instance.
-And remember that in this tutorial we just scratched the surface of what Origin
-is capable of. As always, you can refer to the detailed
-[documentation](https://docs.okd.io) to learn more about deploying your own OpenShift
-PaaS and managing your applications with the ease of containers.
+Remember that this tutorial doesn't address all that Origin is capable of. As
+always, refer to the detailed [documentation](https://docs.okd.io) to learn more
+about deploying your own OpenShift PaaS and managing your applications with
+containers.
diff --git a/doc/install/pivotal/index.md b/doc/install/pivotal/index.md
index 6a4b361c842..41a5ea82ea2 100644
--- a/doc/install/pivotal/index.md
+++ b/doc/install/pivotal/index.md
@@ -1,3 +1,9 @@
+---
+stage: none
+group: unassigned
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+---
+
# GitLab Pivotal Tile **(PREMIUM ONLY)**
CAUTION: **Discontinued:**
diff --git a/doc/install/postgresql_extensions.md b/doc/install/postgresql_extensions.md
index 9e5a1e3d627..6355806f067 100644
--- a/doc/install/postgresql_extensions.md
+++ b/doc/install/postgresql_extensions.md
@@ -1,3 +1,9 @@
+---
+stage: none
+group: unassigned
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+---
+
# Managing PostgreSQL extensions
This guide documents how to manage PostgreSQL extensions for installations with an external
diff --git a/doc/install/requirements.md b/doc/install/requirements.md
index bc320bcd335..4a61831ff86 100644
--- a/doc/install/requirements.md
+++ b/doc/install/requirements.md
@@ -57,6 +57,10 @@ The minimum required Go version is 1.13.
### Git versions
+From GitLab 13.6:
+
+- Git 2.29.x and later is required.
+
From GitLab 13.1:
- Git 2.24.x and later is required.
@@ -144,6 +148,7 @@ GitLab version | Minimum PostgreSQL version
-|-
10.0 | 9.6
13.0 | 11
+13.6 | 12
You must also ensure the `pg_trgm` and `btree_gist` extensions are [loaded into every
GitLab database](postgresql_extensions.html).