diff options
Diffstat (limited to 'doc/install')
| -rw-r--r-- | doc/install/aws/manual_install_aws.md | 4 | ||||
| -rw-r--r-- | doc/install/azure/index.md | 2 | ||||
| -rw-r--r-- | doc/install/cloud_native/index.md | 51 | ||||
| -rw-r--r-- | doc/install/index.md | 6 | ||||
| -rw-r--r-- | doc/install/installation.md | 10 | ||||
| -rw-r--r-- | doc/install/pivotal/index.md | 11 | ||||
| -rw-r--r-- | doc/install/requirements.md | 8 |
7 files changed, 66 insertions, 26 deletions
diff --git a/doc/install/aws/manual_install_aws.md b/doc/install/aws/manual_install_aws.md index b0e71cbc77e..8b827d05b57 100644 --- a/doc/install/aws/manual_install_aws.md +++ b/doc/install/aws/manual_install_aws.md @@ -299,8 +299,8 @@ The steps for doing this vary depending on which registrar you use and is beyond ## PostgreSQL with RDS -For our database server we will use Amazon RDS which offers Multi AZ -for redundancy. First we'll create a security group and subnet group, then we'll +For our database server we will use Amazon RDS for PostgreSQL which offers Multi AZ +for redundancy (Aurora is **not** supported). First we'll create a security group and subnet group, then we'll create the actual RDS instance. ### RDS Security Group diff --git a/doc/install/azure/index.md b/doc/install/azure/index.md index 06518ff58de..780dfe17dac 100644 --- a/doc/install/azure/index.md +++ b/doc/install/azure/index.md @@ -71,7 +71,7 @@ The first items you need to configure are the basic settings of the underlying v the user Azure uses to connect to the VM through SSH. By default, the user has root access. 1. Determine if you want to provide your own SSH key or let Azure create one for you. - Read the [SSH documentation](../../ssh/index.md) to learn more about how to set up SSH + Read the [SSH documentation](../../user/ssh.md) to learn more about how to set up SSH public keys. Review your entered settings, and then proceed to the Disks tab. diff --git a/doc/install/cloud_native/index.md b/doc/install/cloud_native/index.md new file mode 100644 index 00000000000..45d484b045a --- /dev/null +++ b/doc/install/cloud_native/index.md @@ -0,0 +1,51 @@ +--- +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/#assignments +comments: false +description: Install GitLab in a cloud native environment +type: index +--- + +# Cloud Native GitLab **(FREE SELF)** + +[Cloud Native GitLab](https://gitlab.com/gitlab-org/build/CNG) provides cloud +native containers to deploy GitLab. These containers may be deployed and managed +via Helm using GitLab Charts or GitLab Operator on Kubernetes, OpenShift, +and Kubernetes compatible container platforms: + +- [Helm charts](https://docs.gitlab.com/charts/): The cloud native Helm chart + installs GitLab and all of its components on Kubernetes. Use this method if + your infrastructure is built on Kubernetes and you're familiar with how it + works. The methods for management, observability, and some concepts are + different than traditional deployments. +- [GitLab Operator](https://docs.gitlab.com/operator/): The GitLab Operator + provides an installation and management method for GitLab following the + [Kubernetes Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). + You can also use the GitLab Operator to run GitLab in an + [OpenShift](../openshift_and_gitlab/index.md) environment. + +Here's an overview of how the containers are built: + +```mermaid +graph TD + subgraph Code + CNG --> HC + CNG --> GOP + HC --> GOP + end + + subgraph Deploy + GOP --> K8s + GOP --> OS + CNG --> DC + HC --> K8s + end + + CNG[Cloud Native GitLab containers] + HC[Helm Chart] + K8s(Kubernetes) + GOP[GitLab Operator] + OS(OpenShift) + DC(Docker Compose) +``` diff --git a/doc/install/index.md b/doc/install/index.md index b27d3683cd5..deb94031e44 100644 --- a/doc/install/index.md +++ b/doc/install/index.md @@ -29,10 +29,10 @@ install GitLab: |----------------------------------------------------------------|-------------|----------------| | [Linux package](https://docs.gitlab.com/omnibus/installation/) | The official deb/rpm packages (also known as Omnibus GitLab) that contains a bundle of GitLab and the components it depends on, including PostgreSQL, Redis, and Sidekiq. | This method is recommended for getting started. The Linux packages are mature, scalable, and are used today on GitLab.com. If you need additional flexibility and resilience, we recommend deploying GitLab as described in the [reference architecture documentation](../administration/reference_architectures/index.md). | | [Helm charts](https://docs.gitlab.com/charts/) | The cloud native Helm chart for installing GitLab and all of its components on Kubernetes. | When installing GitLab on Kubernetes, there are some trade-offs that you need to be aware of: <br/>- Administration and troubleshooting requires Kubernetes knowledge.<br/>- It can be more expensive for smaller installations. The default installation requires more resources than a single node Linux package deployment, as most services are deployed in a redundant fashion.<br/><br/> Use this method if your infrastructure is built on Kubernetes and you're familiar with how it works. The methods for management, observability, and some concepts are different than traditional deployments. | -| [Docker](https://docs.gitlab.com/omnibus/docker/) | The GitLab packages, Dockerized. | Use this method if you're familiar with Docker. | +| [Docker](docker.md) | The GitLab packages, Dockerized. | Use this method if you're familiar with Docker. | | [Source](installation.md) | Install GitLab and all of its components from scratch. | Use this method if none of the previous methods are available for your platform. Useful for unsupported systems like \*BSD.| -| [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#documentation) | The GitLab Environment toolkit provides a set of automation tools to deploy a [reference architecture](../administration/reference_architectures/index.md) on most major cloud providers. | Customers are very welcome to trial and evaluate GET today, however be aware of [key limitations](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#missing-features-to-be-aware-of) of the current iteration. For production environments further manual setup will be required based on your specific requirements. | -| [GitLab Operator](https://docs.gitlab.com/charts/installation/operator.html) | The GitLab Operator provides an installation and management method for GitLab following the [Kubernetes Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). | Use the GitLab Operator to run GitLab in an [OpenShift](openshift_and_gitlab/index.md) environment. | +| [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#documentation) | The GitLab Environment Toolkit provides a set of automation tools to deploy a [reference architecture](../administration/reference_architectures/index.md) on most major cloud providers. | Customers are very welcome to trial and evaluate GET today, however be aware of [key limitations](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#missing-features-to-be-aware-of) of the current iteration. For production environments further manual setup will be required based on your specific requirements. | +| [GitLab Operator](https://docs.gitlab.com/operator/) | The GitLab Operator provides an installation and management method for GitLab following the [Kubernetes Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). | Use the GitLab Operator to run GitLab in an [OpenShift](openshift_and_gitlab/index.md) environment. | ## Install GitLab on cloud providers diff --git a/doc/install/installation.md b/doc/install/installation.md index 21d1ee84722..c03c600fe0b 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -51,7 +51,7 @@ If the highest number stable branch is unclear, check the [GitLab blog](https:// | [Ruby](#2-ruby) | `2.7` | From GitLab 13.6, Ruby 2.7 is required. Ruby 3.0 is not supported yet (see [the relevant epic](https://gitlab.com/groups/gitlab-org/-/epics/5149) for the current status). You must use the standard MRI implementation of Ruby. We love [JRuby](https://www.jruby.org/) and [Rubinius](https://github.com/rubinius/rubinius#the-rubinius-language-platform), but GitLab needs several Gems that have native extensions. | | [Go](#3-go) | `1.16` | | | [Git](#git) | `2.33.x` | From GitLab 14.4, Git 2.33.x and later is required. It's highly recommended that you use the [Git version provided by Gitaly](#git). | -| [Node.js](#4-node) | `12.22.1` | GitLab uses [webpack](https://webpack.js.org/) to compile frontend assets. Node.js 14.x is recommended, as it's faster. You can check which version you're running with `node -v`. You need to update it to a newer version if needed. | +| [Node.js](#4-node) | `14.15.0` | GitLab uses [webpack](https://webpack.js.org/) to compile frontend assets. Node.js 16.x is recommended, as it's faster. You can check which version you're running with `node -v`. You need to update it to a newer version if needed. | ## GitLab directory structure @@ -263,7 +263,7 @@ GitLab requires the use of Node to compile JavaScript assets, and Yarn to manage JavaScript dependencies. The current minimum requirements for these are: -- `node` >= v12.22.1. (We recommend node 14.x as it is faster) +- `node` >= v14.15.0. (We recommend node 16.x as it is faster) - `yarn` = v1.22.x (Yarn 2 is not supported yet) In many distributions, @@ -271,8 +271,8 @@ the versions provided by the official package repositories are out of date, so we need to install through the following commands: ```shell -# install node v14.x -curl --location "https://deb.nodesource.com/setup_14.x" | sudo bash - +# install node v16.x +curl --location "https://deb.nodesource.com/setup_16.x" | sudo bash - sudo apt-get install -y nodejs npm install --global yarn @@ -1121,7 +1121,7 @@ host localhost # Give your setup a name (here: override localhost) hostname 127.0.0.1; # Your server name or IP ``` -You also need to change the corresponding options (for example, `ssh_user`, `ssh_host`, `admin_uri`) in the `config\gitlab.yml` file. +You also need to change the corresponding options (for example, `ssh_user`, `ssh_host`, `admin_uri`) in the `config/gitlab.yml` file. ### Additional Markup Styles diff --git a/doc/install/pivotal/index.md b/doc/install/pivotal/index.md deleted file mode 100644 index 56dde411884..00000000000 --- a/doc/install/pivotal/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: '../index.md' -remove_date: '2022-03-08' ---- - -This document was removed. For information about installing GitLab, see [this page](../index.md). - -<!-- This redirect file can be deleted after <2022-03-08>. --> -<!-- Redirects that point to other docs in the same project expire in three months. --> -<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 11f623641c1..8006b886414 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -13,11 +13,11 @@ the minimum requirements needed to install and use GitLab. ### Supported Linux distributions -- Ubuntu (16.04/18.04/20.04) -- Debian (9/10) +- Ubuntu (18.04/20.04) +- Debian (9/10/11) - AlmaLinux (8) - CentOS (7) -- openSUSE Leap (15.2) +- openSUSE Leap (15.3) - SUSE Linux Enterprise Server (12 SP2/12 SP5) - Red Hat Enterprise Linux (use the AlmaLinux or CentOS instructions) - Scientific Linux (use the CentOS instructions) @@ -120,7 +120,7 @@ the following table) as these were used for development and testing: | GitLab version | Minimum PostgreSQL version | |----------------|----------------------------| | 13.0 | 11 | -| 14.0 | 12 | +| 14.0 | 12.10 | You must also ensure the following extensions are loaded into every GitLab database. [Read more about this requirement, and troubleshooting](postgresql_extensions.md). |