gitlab-org--gitlab-foss/doc/install
Marcel Amirault d2cb8f785e Update docs to pass new markdownlint
Deletes extra spaces and line, makes lists consistent, and
fixes links.
2019-08-22 08:50:31 +00:00
..
aws Change gitlab-rake to gitlab-backup for backup and restore tasks 2019-08-07 09:14:52 +10:00
azure Fix markdown causing kramdown warnings 2019-08-21 13:50:22 +00:00
google_cloud_platform Fix whitespace in install and integration docs 2019-07-11 15:21:26 +00:00
kubernetes Fix most bare URLs in project 2019-07-02 08:50:00 +00:00
openshift_and_gitlab Fix whitespace in install and integration docs 2019-07-11 15:21:26 +00:00
pivotal Changing badges to use parentheses not brackets 2019-07-08 08:50:38 +00:00
digitaloceandocker.md Fix whitespace in install and integration docs 2019-07-11 15:21:26 +00:00
docker.md Fix assorted links 2019-08-07 06:19:00 +00:00
google-protobuf.md Clean up docs under install/ 2019-06-03 20:13:53 +02:00
installation.md Update docs to pass new markdownlint 2019-08-22 08:50:31 +00:00
ldap.md Docs: Add badges and fix redirect style in 3 docs 2019-05-17 00:30:59 +00:00
README.md Changing badges to use parentheses not brackets 2019-07-08 08:50:38 +00:00
redis.md Clean up docs under install/ 2019-06-03 20:13:53 +02:00
relative_url.md Fix whitespace in install and integration docs 2019-07-11 15:21:26 +00:00
requirements.md Make ruby 2.6 the officially supported version 2019-08-14 23:16:55 +00:00
structure.md Clean up docs under install/ 2019-06-03 20:13:53 +02:00

comments description type
false Read through the GitLab installation methods. index

Installation (CORE ONLY)

GitLab can be installed in most GNU/Linux distributions and in a number of cloud providers. To get the best experience from GitLab you need to balance performance, reliability, ease of administration (backups, upgrades and troubleshooting), and cost of hosting.

There are many ways you can install GitLab depending on your platform:

  1. Omnibus Gitlab: The official deb/rpm packages that contain a bundle of GitLab and the various components it depends on like PostgreSQL, Redis, Sidekiq, etc.
  2. GitLab Helm chart: The cloud native Helm chart for installing GitLab and all its components on Kubernetes.
  3. Docker: The Omnibus GitLab packages dockerized.
  4. Source: Install GitLab and all its components from scratch.

TIP: If in doubt, choose Omnibus: The Omnibus GitLab packages are mature, scalable, support high availability and are used today on GitLab.com. The Helm charts are recommended for those who are familiar with Kubernetes.

Requirements

Before installing GitLab, make sure to check the requirements documentation which includes useful information on the supported Operating Systems as well as the hardware requirements.

The Omnibus GitLab package uses our official deb/rpm repositories. This is recommended for most users.

If you need additional flexibility and resilience, we recommend deploying GitLab as described in our High Availability documentation.

> Install GitLab using the Omnibus GitLab package.

Installing GitLab on Kubernetes via the GitLab Helm charts

NOTE: Kubernetes experience required: We recommend being familiar with Kubernetes before using it to deploy GitLab in production. The methods for management, observability, and some concepts are different than traditional deployments.

When installing GitLab on Kubernetes, there are some trade-offs that you need to be aware of:

  • Administration and troubleshooting requires Kubernetes knowledge.
  • It can be more expensive for smaller installations. The default installation requires more resources than a single node Omnibus deployment, as most services are deployed in a redundant fashion.
  • There are some feature limitations to be aware of.

> Install GitLab on Kubernetes using the GitLab Helm charts.

Installing GitLab with Docker

GitLab maintains a set of official Docker images based on the Omnibus GitLab package.

> Install GitLab using the official GitLab Docker images.

Installing GitLab from source

If the GitLab Omnibus package is not available in your distribution, you can install GitLab from source: Useful for unsupported systems like *BSD. For an overview of the directory structure, read the structure documentation.

> Install GitLab from source.

Installing GitLab on cloud providers

GitLab can be installed on a variety of cloud providers by using any of the above methods, provided the cloud provider supports it.