summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2018-12-06 22:29:14 +0100
committerAchilleas Pipinellis <axil@gitlab.com>2018-12-06 22:29:14 +0100
commit6de02d7909d98844a8afd6df723564fba112790d (patch)
tree38e98269dd99e8591e8d775b098f2494ebb93389
parentcaf33ea057193a472005fab4f2e8b8bfd2c1a2cd (diff)
downloadgitlab-ce-6de02d7909d98844a8afd6df723564fba112790d.tar.gz
Clarify the installation methods
-rw-r--r--doc/install/README.md74
1 files changed, 40 insertions, 34 deletions
diff --git a/doc/install/README.md b/doc/install/README.md
index f1f9020747a..9f630220705 100644
--- a/doc/install/README.md
+++ b/doc/install/README.md
@@ -6,17 +6,23 @@ description: Read through the GitLab installation methods.
# Installation
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:
+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.
-1. Performance
-1. Reliability
-1. Ease of administration (backups, upgrades and troubleshooting)
-1. 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 of 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:**
-Our Omnibus GitLab packages are mature, scalable, support
+The Omnibus GitLab packages are mature, scalable, support
[high availability](../administration/high_availability/README.md) and are used
-today on GitLab.com. Our Helm charts are recommended for those who are familiar
+today on GitLab.com. The Helm charts are recommended for those who are familiar
with Kubernetes.
## Requirements
@@ -25,29 +31,17 @@ Before installing GitLab, make sure to check the [requirements documentation](re
which includes useful information on the supported Operating Systems as well as
the hardware requirements.
-## Install GitLab using the Omnibus GitLab package (recommended)
+## Installing GitLab using the Omnibus GitLab package (recommended)
-This installation method uses the Omnibus GitLab package, using our official
-deb/rpm repositories. This is recommended for most users.
+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](../administration/high_availability/README.md).
[**> Install GitLab using the Omnibus GitLab package.**](https://about.gitlab.com/install/)
-### Alternative to Omnibus GitLab
-
-If the GitLab Omnibus package is not available in your distribution, you can
-choose between:
-
-- [Installing GitLab from source](installation.md): Useful for unsupported
- systems like *BSD. For an overview of the directory structure, read the
- [structure documentation](structure.md). While the recommended database is
- PostgreSQL, we provide information to install GitLab
- [using MySQL](database_mysql.md).
-- [Installing Omnibus GitLab using Docker](docker.md).
-
-## Install GitLab on Kubernetes via the GitLab Helm charts
+## 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
@@ -65,18 +59,30 @@ need to be aware of:
[**> Install GitLab on Kubernetes using the GitLab Helm charts.**](kubernetes/index.md)
-## Install GitLab on cloud providers
+## 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.**](docker.md)
+
+## 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](structure.md).
+
+[**> Install GitLab from source.**](installation.md)
+
+## Installing GitLab on cloud providers
-GitLab can be installed on a variety of 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.
-- [Install on AWS](aws/index.md): Install GitLab on AWS using the community AMIs that GitLab provides.
-- [Install GitLab on Google Cloud Platform](google_cloud_platform/index.md)
-- [Install GitLab on Azure](azure/index.md)
-- [Install GitLab on OpenShift](openshift_and_gitlab/index.md)
-- [Install GitLab on DC/OS](https://mesosphere.com/blog/gitlab-dcos/) via [GitLab-Mesosphere integration](https://about.gitlab.com/2016/09/16/announcing-gitlab-and-mesosphere/)
-- [Install GitLab on Google Kubernetes Engine (GKE)](https://about.gitlab.com/2017/01/23/video-tutorial-idea-to-production-on-google-container-engine-gke/): video tutorial on
-the full process of installing GitLab on Google Kubernetes Engine (GKE), pushing an application to GitLab, building the app with GitLab CI/CD, and deploying to production.
-- [Getting started with GitLab and DigitalOcean](https://about.gitlab.com/2016/04/27/getting-started-with-gitlab-and-digitalocean/): requirements, installation process, updates.
-- [Demo: Cloud Native Development with GitLab](https://about.gitlab.com/2017/04/18/cloud-native-demo/): video demonstration on how to install GitLab on Kubernetes, build a project, create Review Apps, store Docker images in Container Registry, deploy to production on Kubernetes, and monitor with Prometheus.
+- [Install on AWS](aws/index.md): Install Omnibus GitLab on AWS using the community AMIs that GitLab provides.
+- [Install GitLab on Google Cloud Platform](google_cloud_platform/index.md): Install Omnibus GitLab on a VM in GCP.
+- [Install GitLab on Azure](azure/index.md): Install Omnibus GitLab from Azure Marketplace.
+- [Install GitLab on OpenShift](openshift_and_gitlab/index.md): Install GitLab using the Docker image on OpenShift.
+- [Install GitLab on DC/OS](https://mesosphere.com/blog/gitlab-dcos/): Install GitLab on Mesosphere DC/OS via the [GitLab-Mesosphere integration](https://about.gitlab.com/2016/09/16/announcing-gitlab-and-mesosphere/).
+- [Install GitLab on DigitalOcean](https://about.gitlab.com/2016/04/27/getting-started-with-gitlab-and-digitalocean/): Install Omnibus GitLab on DigitalOcean.
- _Testing only!_ [DigitalOcean and Docker Machine](digitaloceandocker.md):
Quickly test any version of GitLab on DigitalOcean using Docker Machine.