kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Reword note about familiarity with k8s

This commit is contained in:
Achilleas Pipinellis 2018-12-03 18:56:25 +01:00
parent 478cd66377
commit 81869d22d9
No known key found for this signature in database
GPG Key ID: A0996FBD3E92C17B
4 changed files with 39 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
doc/install/README.md
View File

@ -6,17 +6,7 @@ description: Read through the GitLab installation methods.
# Installation # Installation
GitLab can be installed in most GNU/Linux distributions and in a number GitLab can be installed in most GNU/Linux distributions and in a number
of cloud providers. of cloud providers. To get the best experience from GitLab you need to balance:
## Requirements
Before installing GitLab, make sure to check the [requirements documentation](requirements.md)
which includes useful information on the supported Operating Systems as well as
the hardware requirements.
## Installation methods
To get the best experience from GitLab you need to balance:
1. Performance 1. Performance
1. Reliability 1. Reliability
@ -29,44 +19,44 @@ Our Omnibus GitLab packages are mature, scalable, support
today on GitLab.com. Our Helm charts are recommended for those who are familiar today on GitLab.com. Our Helm charts are recommended for those who are familiar
with Kubernetes. with Kubernetes.
### Install GitLab using the Omnibus GitLab package (recommended) ## Requirements
This installation method [uses the Omnibus GitLab package](https://about.gitlab.com/install/), Before installing GitLab, make sure to check the [requirements documentation](requirements.md)
using our official deb/rpm repositories. This is the recommended way. which includes useful information on the supported Operating Systems as well as
the hardware requirements.
## Install GitLab using the Omnibus GitLab package (recommended)
This installation method uses the Omnibus GitLab package, using our official
deb/rpm repositories. This is the recommended way.
If you need additional flexibility and resilience, we recommend deploying If you need additional flexibility and resilience, we recommend deploying
GitLab as described in our [High Availability documentation](../administration/high_availability/README.md). 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 ### Alternative to Omnibus GitLab
If the GitLab Omnibus package is not available in your distribution, you can If the GitLab Omnibus package is not available in your distribution, you can
choose between: choose between:
- [Installation from source](installation.md): Install GitLab from source. - [Installing GitLab from source](installation.md): Useful for unsupported
Useful for unsupported systems like *BSD. For an overview of the directory systems like *BSD. For an overview of the directory structure, read the
structure, read the [structure documentation](structure.md). [structure documentation](structure.md). While the recommended database is
While the recommended database is PostgreSQL, we provide information to install PostgreSQL, we provide information to install GitLab
GitLab [using MySQL](database_mysql.md). [using MySQL](database_mysql.md).
- [Docker](docker.md): Install Omnibus GitLab using Docker. - [Installing Omnibus GitLab using Docker](docker.md).
### Install GitLab on Kubernetes via the GitLab Helm charts ## Install GitLab on Kubernetes via the GitLab Helm charts
NOTE: **If in doubt, choose Omnibus:** NOTE: **Kubernetes experience required:**
We recommend being familiar with Kubernetes before using it to deploy GitLab in We recommend being familiar with Kubernetes before using it to deploy GitLab in
production. The methods for management, observability, and some concepts are production. The methods for management, observability, and some concepts are
different than traditional deployments. different than traditional deployments.
GitLab is committed to Kubernetes as a foundational technology. There are three When installing GitLab on kubernetes, there are a number of trade-offs that you
areas where Kubernetes intersects with GitLab: need to be aware of that may not be immediately obvious and could prevent you
getting the best experience from GitLab:
1. Deploying your applications from GitLab projects to Kubernetes (e.g., see [Auto DevOps](../topics/autodevops/index.md)).
1. [Running GitLab CI/CD Runners in a Kubernetes Cluster](https://docs.gitlab.com/runner/install/kubernetes.html).
1. Installing GitLab in Kubernetes.
While we recommend using GitLab for the first two points above, for most scenarios
we do not currently recommend installing GitLab in Kubernetes. There are a number
of trade-offs that you need to be aware of that may not be immediately obvious
and could prevent you getting the best experience from GitLab:
- Configuration of features such as object storage and backups can be more challenging. - Configuration of features such as object storage and backups can be more challenging.
- Administration and troubleshooting requires Kubernetes knowledge. - Administration and troubleshooting requires Kubernetes knowledge.
@ -75,10 +65,9 @@ and could prevent you getting the best experience from GitLab:
are deployed in a redundant fashion. are deployed in a redundant fashion.
- There are some feature [limitations to be aware of](kubernetes/gitlab_chart.md#limitations). - There are some feature [limitations to be aware of](kubernetes/gitlab_chart.md#limitations).
If you're happy with the trade-offs, you can use our official Helm charts to get [**> Install GitLab on Kubernetes using the GitLab Helm charts.**](kubernetes/index.md)
started and [install GitLab in Kubernetes](kubernetes/index.md).
### Install GitLab on cloud providers ## Install GitLab on cloud providers
GitLab can be installed on a variety of cloud providers: GitLab can be installed on a variety of cloud providers:

7
doc/install/docker.md
View File

@ -7,9 +7,10 @@ GitLab provides official Docker images to allowing you to easily take advantage
## Omnibus GitLab based images ## Omnibus GitLab based images
GitLab maintains a set of [official Docker images](https://hub.docker.com/r/gitlab) based on our [Omnibus GitLab package](https://docs.gitlab.com/omnibus/README.html). These images include: GitLab maintains a set of [official Docker images](https://hub.docker.com/r/gitlab) based on our [Omnibus GitLab package](https://docs.gitlab.com/omnibus/README.html). These images include:
* [GitLab Community Edition](https://hub.docker.com/r/gitlab/gitlab-ce/)
* [GitLab Enterprise Edition](https://hub.docker.com/r/gitlab/gitlab-ee/) - [GitLab Community Edition](https://hub.docker.com/r/gitlab/gitlab-ce/)
* [GitLab Runner](https://hub.docker.com/r/gitlab/gitlab-runner/) - [GitLab Enterprise Edition](https://hub.docker.com/r/gitlab/gitlab-ee/)
- [GitLab Runner](https://hub.docker.com/r/gitlab/gitlab-runner/)
A [complete usage guide](https://docs.gitlab.com/omnibus/docker/) to these images is available, as well as the [Dockerfile used for building the images](https://gitlab.com/gitlab-org/omnibus-gitlab/tree/master/docker). A [complete usage guide](https://docs.gitlab.com/omnibus/docker/) to these images is available, as well as the [Dockerfile used for building the images](https://gitlab.com/gitlab-org/omnibus-gitlab/tree/master/docker).

10
doc/install/kubernetes/gitlab_chart.md
View File

@ -1,13 +1,13 @@
# GitLab Helm Chart # GitLab Helm Chart
This is the official way to install GitLab on a cloud native environment. This is the official way to install GitLab on a cloud native environment.
For more information on other available GitLab Helm Charts, see the [charts overview](index.md#chart-overview).
TIP: **If in doubt, choose Omnibus GitLab:** NOTE: **Kubernetes experience required:**
Our [Omnibus GitLab packages](../README.md#install-gitlab-using-the-omnibus-gitlab-package-recommended) Our Helm charts are recommended for those who are familiar with Kubernetes.
If you're not sure if Kubernetes is for you, our
[Omnibus GitLab packages](../README.md#install-gitlab-using-the-omnibus-gitlab-package-recommended)
are mature, scalable, support [high availability](../../administration/high_availability/README.md) 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 and are used today on GitLab.com.
are familiar with Kubernetes.
## Introduction ## Introduction

9
doc/install/kubernetes/index.md
View File

@ -4,11 +4,12 @@ description: 'Read through the different methods to deploy GitLab on Kubernetes.
# Installing GitLab on Kubernetes # Installing GitLab on Kubernetes
TIP: **If in doubt, choose Omnibus GitLab:** NOTE: **Kubernetes experience required:**
Our [Omnibus GitLab packages](../README.md#install-gitlab-using-the-omnibus-gitlab-package-recommended) Our Helm charts are recommended for those who are familiar with Kubernetes.
If you're not sure if Kubernetes is for you, our
[Omnibus GitLab packages](../README.md#install-gitlab-using-the-omnibus-gitlab-package-recommended)
are mature, scalable, support [high availability](../../administration/high_availability/README.md) 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 and are used today on GitLab.com.
are familiar with Kubernetes.
The easiest method to deploy GitLab on [Kubernetes](https://kubernetes.io/) is The easiest method to deploy GitLab on [Kubernetes](https://kubernetes.io/) is
to take advantage of GitLab's Helm charts. [Helm](https://github.com/kubernetes/helm/blob/master/README.md) to take advantage of GitLab's Helm charts. [Helm](https://github.com/kubernetes/helm/blob/master/README.md)