diff options
Diffstat (limited to 'doc/install/README.md')
| -rw-r--r-- | doc/install/README.md | 102 |
1 files changed, 73 insertions, 29 deletions
diff --git a/doc/install/README.md b/doc/install/README.md index f1ef368685e..6b08bb28bbb 100644 --- a/doc/install/README.md +++ b/doc/install/README.md @@ -1,4 +1,7 @@ --- +stage: Enablement +group: Distribution +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 comments: false description: Read through the GitLab installation methods. type: index @@ -6,33 +9,42 @@ type: 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. -1. **GitLab Helm chart**: The cloud native Helm chart for installing GitLab and all - its components on Kubernetes. -1. **Docker**: The Omnibus GitLab packages dockerized. -1. **Source**: Install GitLab and all its components from scratch. - -TIP: **If in doubt, choose Omnibus:** -The Omnibus GitLab packages are mature, -[scalable](../administration/reference_architectures/index.md) and are used +GitLab can be installed in most GNU/Linux distributions and with several +cloud providers. To get the best experience from GitLab, you must balance +performance, reliability, ease of administration (backups, upgrades, and +troubleshooting), and the cost of hosting. + +Depending on your platform, select from the following available methods to +install GitLab: + +- [_Omnibus GitLab_](#installing-gitlab-using-the-omnibus-gitlab-package-recommended): + The official deb/rpm packages that contain a bundle of GitLab and the + components it depends on, including PostgreSQL, Redis, and Sidekiq. +- [_GitLab Helm chart_](#installing-gitlab-on-kubernetes-via-the-gitlab-helm-charts): + The cloud native Helm chart for installing GitLab and all of its components + on Kubernetes. +- [_Docker_](#installing-gitlab-with-docker): The Omnibus GitLab packages, + dockerized. +- [_Source_](#installing-gitlab-from-source): Install GitLab and all of its + components from scratch. +- [_Cloud provider_](#installing-gitlab-on-cloud-providers): Install directly + from platforms like AWS, Azure, and GCP. + +If you're not sure which installation method to use, we recommend you use +Omnibus GitLab. The Omnibus GitLab packages are mature, +[scalable](../administration/reference_architectures/index.md), and are used today on GitLab.com. The Helm charts are recommended for those who are familiar with Kubernetes. ## Requirements -Before installing GitLab, it is of critical importance to review the system [requirements](requirements.md). The system requirements include details on the minimum hardware, software, database, and additional requirements to support GitLab. +Before you install GitLab, be sure to review the [system requirements](requirements.md). +The system requirements include details about the minimum hardware, software, +database, and additional requirements to support GitLab. ## Installing GitLab using the Omnibus GitLab package (recommended) -The Omnibus GitLab package uses our official deb/rpm repositories. This is +The Omnibus GitLab package uses our official deb/rpm repositories, and is recommended for most users. If you need additional flexibility and resilience, we recommend deploying @@ -42,11 +54,6 @@ GitLab as described in our [reference architecture documentation](../administrat ## 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: @@ -56,11 +63,17 @@ need to be aware of: are deployed in a redundant fashion. - There are some feature [limitations to be aware of](https://docs.gitlab.com/charts/#limitations). +Due to these trade-offs, having Kubernetes experience is a requirement for +using this method. 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. + [**> Install GitLab on Kubernetes using the GitLab Helm charts.**](https://docs.gitlab.com/charts/) ## Installing GitLab with Docker -GitLab maintains a set of official Docker images based on the Omnibus GitLab package. +GitLab maintains a set of official Docker images based on the Omnibus GitLab +package. [**> Install GitLab using the official GitLab Docker images.**](docker.md) @@ -68,7 +81,7 @@ GitLab maintains a set of official Docker images based on the Omnibus GitLab pac If the Omnibus GitLab 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](structure.md). +overview of the directory structure, read the [structure documentation](installation.md#gitlab-directory-structure). [**> Install GitLab from source.**](installation.md) @@ -86,6 +99,37 @@ the above methods, provided the cloud provider supports it. - _Testing only!_ [DigitalOcean and Docker Machine](digitaloceandocker.md): Quickly test any version of GitLab on DigitalOcean using Docker Machine. -## Securing your GitLab installation - -After completing your installation, check out our [recommended practices to secure your GitLab instance](../security/README.md#securing-your-gitlab-installation). +## Next steps + +Here are a few resources you might want to check out after completing the +installation: + +- [Upload a license](../user/admin_area/license.md) or [start a free trial](https://about.gitlab.com/free-trial/): + Activate all GitLab Enterprise Edition functionality with a license. +- [Set up runners](https://docs.gitlab.com/runner/): Set up one or more GitLab + Runners, the agents that are responsible for all of GitLab's CI/CD features. +- [GitLab Pages](../administration/pages/index.md): Configure GitLab Pages to + allow hosting of static sites. +- [GitLab Registry](../administration/packages/container_registry.md): With the + GitLab Container Registry, every project can have its own space to store Docker + images. +- [Secure GitLab](../security/README.md#securing-your-gitlab-installation): + Recommended practices to secure your GitLab instance. +- [SMTP](https://docs.gitlab.com/omnibus/settings/smtp.html): Configure SMTP + for proper email notifications support. +- [LDAP](../administration/auth/ldap/index.md): Configure LDAP to be used as + an authentication mechanism for GitLab. +- [Back up and restore GitLab](../raketasks/backup_restore.md): Learn the different + ways you can back up or restore GitLab. +- [Upgrade GitLab](../update/README.md): Every 22nd of the month, a new feature-rich GitLab version + is released. Learn how to upgrade to it, or to an interim release that contains a security fix. +- [Scaling GitLab](../administration/reference_architectures/index.md): + GitLab supports several different types of clustering. +- [Advanced Search](../integration/elasticsearch.md): Leverage Elasticsearch for + faster, more advanced code search across your entire GitLab instance. +- [Geo replication](../administration/geo/index.md): + Geo is the solution for widely distributed development teams. +- [Release and maintenance policy](../policy/maintenance.md): Learn about GitLab's + policies governing version naming, as well as release pace for major, minor, patch, + and security releases. +- [Pricing](https://about.gitlab.com/pricing/): Pricing for the different tiers. |