diff options
Diffstat (limited to 'doc/install')
| -rw-r--r-- | doc/install/aws/gitlab_hybrid_on_aws.md | 36 | ||||
| -rw-r--r-- | doc/install/azure/index.md | 2 | ||||
| -rw-r--r-- | doc/install/cloud_native/index.md | 11 | ||||
| -rw-r--r-- | doc/install/install_methods.md | 2 | ||||
| -rw-r--r-- | doc/install/next_steps.md | 2 | ||||
| -rw-r--r-- | doc/install/requirements.md | 14 |
6 files changed, 16 insertions, 51 deletions
diff --git a/doc/install/aws/gitlab_hybrid_on_aws.md b/doc/install/aws/gitlab_hybrid_on_aws.md index 42488becbd6..b39f39f293e 100644 --- a/doc/install/aws/gitlab_hybrid_on_aws.md +++ b/doc/install/aws/gitlab_hybrid_on_aws.md @@ -32,38 +32,12 @@ Amazon provides a managed Kubernetes service offering known as [Amazon Elastic K ## Available Infrastructure as Code for GitLab Cloud Native Hybrid -The [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md) is an effort made by GitLab to create a multi-cloud, multi-GitLab (Linux package installation + Cloud Native Hybrid) toolkit to provision GitLab. GET is developed by GitLab developers and is open to community contributions. GET is where GitLab is investing its resources as the primary option for Infrastructure as Code, and is being actively used in production as a part of [GitLab Dedicated](../../subscriptions/gitlab_dedicated/index.md). +The [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md) is a set of opinionated Terraform +and Ansible scripts. These scripts help with the deployment of Linux package or Cloud Native Hybrid environments on selected cloud providers and are used +by GitLab developers for [GitLab Dedicated](../../subscriptions/gitlab_dedicated/index.md) (for example). -For more information about the project, see [GitLab Environment Toolkit](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md). - -The [AWS Quick Start for GitLab Cloud Native Hybrid on EKS](https://aws-quickstart.github.io/quickstart-eks-gitlab/) is developed by AWS, GitLab, and the community that contributes to AWS Quick Starts, whether directly to the GitLab Quick Start or to the underlying Quick Start dependencies GitLab inherits (for example, EKS Quick Start). - -GET is recommended for most deployments. The AWS Quick Start can be used if the IaC language of choice is CloudFormation, integration with AWS services like Control Tower is desired, or preference for a UI-driven configuration experience or when any aspect in the below table is an overriding concern. - -NOTE: -This automation is in **[Open Beta](https://about.gitlab.com/handbook/product/gitlab-the-product/#open-beta)**. GitLab is working with AWS on resolving [the outstanding issues](https://github.com/aws-quickstart/quickstart-eks-gitlab/issues?q=is%3Aissue+is%3Aopen+%5BHL%5D) before it is fully released. You can subscribe to this issue to be notified of progress and release announcements: [AWS Quick Start for GitLab Cloud Native Hybrid on EKS Status: Beta](https://gitlab.com/gitlab-com/alliances/aws/public-tracker/-/issues/11).<br><br> -The Beta version deploys Aurora PostgreSQL, but the release version will deploy Amazon RDS PostgreSQL due to [known issues](https://gitlab.com/gitlab-com/alliances/aws/public-tracker/-/issues?label_name%5B%5D=AWS+Known+Issue) with Aurora. All performance testing results will also be redone after this change has been made. - -| | [AWS Quick Start for GitLab Cloud Native Hybrid on EKS](https://aws-quickstart.github.io/quickstart-eks-gitlab/) | [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit) | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| Overview and Vision | [AWS Quick Start](https://aws.amazon.com/solutions/implementations/amazon-eks/) | [GitLab Environment Toolkit](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md) | -| Licensing | [Open Source (Apache 2.0)](https://github.com/aws-quickstart/quickstart-eks-gitlab/blob/main/LICENSE.txt) | [GitLab Enterprise Edition license](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/LICENSE) ([GitLab Premium tier](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md)) | -| GitLab Support | [GitLab Beta Support](../../policy/experiment-beta-support.md#beta) | [GitLab GA Support](../../policy/experiment-beta-support.md#generally-available-ga) | -| GitLab Reference Architecture Compliant | Yes | Yes | -| GitLab Performance Tool (GPT) Tested | Yes | Yes | -| Amazon Well Architected Compliant | Yes<br />(via Quick Start program) | Critical portions <br />reviewed by AWS | -| Target Cloud Platforms | AWS | AWS, Google, Azure | -| IaC Languages | CloudFormation (Quick Starts) | Terraform, Ansible | -| Community Contributions and Participation (EcoSystem) | <u>GitLab QSG</u>: Getting Started<br /><u>For QSG Dependencies (for example, EKS)</u>: Substantial | Getting Started | -| Compatible with AWS Meta-Automation Services (via CloudFormation) | - [AWS Service Catalog](https://aws.amazon.com/servicecatalog/) (Direct Import)<br>- [ServiceNow via an AWS Service Catalog Connector](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/integrations-servicenow.html#integrations-servicenow)<br>- [Jira Service Manager via an AWS Service Catalog Connector](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/integrations-jiraservicedesk.html#integrations-jiraservicedesk)<br>- [AWS Control Tower](https://docs.aws.amazon.com/controltower/) ([Integration](https://aws.amazon.com/blogs/infrastructure-and-automation/deploy-aws-quick-start-to-multiple-accounts-using-aws-control-tower/))<br>- Quick Starts<br>- [AWS SaaS Factory](https://aws.amazon.com/partners/programs/saas-factory/) | No | -| Results in a Ready-to-Use instance | Yes | Manual Actions or <br />Supplemental IaC Required | -| **<u>Configuration Features</u>** | | | -| Can deploy Linux package (non-Kubernetes) | No | Yes | -| Can deploy a single instance by using the Linux package (non-Kubernetes) | No | Yes | -| Complete Internal Encryption | 85%, Targeting 100% | Manual | -| AWS GovCloud Support | Yes | TBD | -| No Code Form-Based Deployment User Experience Available | Yes | No | -| Full IaC User Experience Available | Yes | Yes | +You can use the GitLab Environment Toolkit to deploy a Cloud Native Hybrid environment on AWS. However, it's not required and may not support every valid +permutation. That said, the scripts are presented as-is and you can adapt them accordingly. ### Two and Three Zone High Availability diff --git a/doc/install/azure/index.md b/doc/install/azure/index.md index 8a3cd720079..60591991ea7 100644 --- a/doc/install/azure/index.md +++ b/doc/install/azure/index.md @@ -248,7 +248,7 @@ in this section whenever you need to update GitLab. To determine the version of GitLab you're currently running: -1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. On the left sidebar, select **Search or go to**. 1. Select **Admin Area**. 1. On the left sidebar, select **Overview > Dashboard**. 1. Find the version under the **Components** table. diff --git a/doc/install/cloud_native/index.md b/doc/install/cloud_native/index.md deleted file mode 100644 index d971cd419e9..00000000000 --- a/doc/install/cloud_native/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -redirect_to: 'https://docs.gitlab.com/charts/' -remove_date: '2023-09-09' ---- - -This document was moved to [another location](https://docs.gitlab.com/charts/). - -<!-- This redirect file can be deleted after <2023-09-09>. --> -<!-- 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 -->
\ No newline at end of file diff --git a/doc/install/install_methods.md b/doc/install/install_methods.md index fb48107e81b..5945e418274 100644 --- a/doc/install/install_methods.md +++ b/doc/install/install_methods.md @@ -17,7 +17,7 @@ or use one of the following methods. | [Helm chart](https://docs.gitlab.com/charts/) | A chart for installing a cloud-native version of GitLab and its components on Kubernetes. | Use if your infrastructure is on Kubernetes and you're familiar with how it works. Management, observability, and some concepts are different than traditional deployments.<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, because most services are deployed in a redundant fashion.<br/><br/> | | [Docker](docker.md) | The GitLab packages in a Docker container. | Use if you're familiar with Docker. | | [Source](installation.md) | GitLab and its components from scratch. | Use if none of the previous methods are available for your platform. Can use for unsupported systems like \*BSD.| -| [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#documentation) | A set of automation tools. | Use to deploy a [reference architecture](../administration/reference_architectures/index.md) on most major cloud providers. Has some [limitations](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#missing-features-to-be-aware-of) and manual setup for production environments. | +| [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#documentation) | A set of opinionated Terraform and Ansible scripts. | Use to deploy a [reference architecture](../administration/reference_architectures/index.md) on selected major cloud providers. Has some [limitations](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#missing-features-to-be-aware-of) and manual setup for production environments. | | [GitLab Operator](https://docs.gitlab.com/operator/) | An installation and management method that follows the [Kubernetes Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). | Use to run GitLab in an [OpenShift](openshift_and_gitlab/index.md) environment. | ## Unsupported Linux distributions and Unix-like operating systems diff --git a/doc/install/next_steps.md b/doc/install/next_steps.md index ecc456cd3ec..4ad6a011cd6 100644 --- a/doc/install/next_steps.md +++ b/doc/install/next_steps.md @@ -42,7 +42,7 @@ installation. - [Back up and restore GitLab](../administration/backup_restore/index.md): Learn the different ways you can back up or restore GitLab. -- [Upgrade GitLab](../update/index.md): Every 22nd of the month, a new feature-rich GitLab version +- [Upgrade GitLab](../update/index.md): Every 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. - [Release and maintenance policy](../policy/maintenance.md): Learn about GitLab policies governing version naming, as well as release pace for major, minor, patch, diff --git a/doc/install/requirements.md b/doc/install/requirements.md index b095f265808..81244594a59 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -50,11 +50,13 @@ The following is the recommended minimum Memory hardware guidance for a handful - 8 GB RAM supports up to 1000 users - More users? Consult the [reference architectures page](../administration/reference_architectures/index.md) -In addition to the above, we generally recommend having at least 2 GB of swap on your server, -even if you currently have enough available RAM. Having swap helps to reduce the chance of errors occurring -if your available memory changes. We also recommend configuring the kernel's swappiness setting -to a low value like `10` to make the most of your RAM while still having the swap -available when needed. +For smaller installations, you should: + +- Have at least 2 GB of swap on your server, even if you have enough available RAM. Having swap helps to reduce the chance of + errors occurring if your available memory changes. +- Configure the kernel's swappiness setting to a low value like `10` to make the most of your RAM while still having the swap available when needed. + +For larger installations that follow our reference architectures, you [shouldn't configure swap](../administration/reference_architectures/index.md#no-swap). NOTE: Although excessive swapping is undesired and degrades performance, it is an @@ -98,7 +100,7 @@ The following managed PostgreSQL services are known to be incompatible and shoul | GitLab version | Managed service | |----------------|-------------------------------------------------------| -| 14.4+ | Amazon Aurora (see [14.4.0](../update/index.md#1440)) | +| 14.4+ | Amazon Aurora (see [14.4.0](../update/versions/gitlab_14_changes.md#1440)) | NOTE: Support for [PostgreSQL 9.6 and 10 was removed in GitLab 13.0](https://about.gitlab.com/releases/2020/05/22/gitlab-13-0-released/#postgresql-11-is-now-the-minimum-required-version-to-install-gitlab) so that GitLab can benefit from PostgreSQL 11 improvements, such as partitioning. |