diff options
Diffstat (limited to 'doc/install')
| -rw-r--r-- | doc/install/aws/gitlab_hybrid_on_aws.md | 12 | ||||
| -rw-r--r-- | doc/install/aws/index.md | 4 | ||||
| -rw-r--r-- | doc/install/aws/manual_install_aws.md | 2 | ||||
| -rw-r--r-- | doc/install/docker.md | 11 | ||||
| -rw-r--r-- | doc/install/install_methods.md | 8 | ||||
| -rw-r--r-- | doc/install/installation.md | 6 | ||||
| -rw-r--r-- | doc/install/migrate/compare_sm_to_saas.md | 127 | ||||
| -rw-r--r-- | doc/install/openshift_and_gitlab/index.md | 22 | ||||
| -rw-r--r-- | doc/install/relative_url.md | 6 | ||||
| -rw-r--r-- | doc/install/requirements.md | 16 |
10 files changed, 47 insertions, 167 deletions
diff --git a/doc/install/aws/gitlab_hybrid_on_aws.md b/doc/install/aws/gitlab_hybrid_on_aws.md index b4d55e30ab1..42488becbd6 100644 --- a/doc/install/aws/gitlab_hybrid_on_aws.md +++ b/doc/install/aws/gitlab_hybrid_on_aws.md @@ -14,9 +14,9 @@ Amazon provides a managed Kubernetes service offering known as [Amazon Elastic K ## Tested AWS Bill of Materials by reference architecture size -| GitLab Cloud Native Hybrid Ref Arch | GitLab Baseline Performance Test Results Omnibus on Instances | AWS Bill of Materials (BOM) for CNH | AWS Build Performance Testing Results for [CNH](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/5K/5k-QuickStart-ARM-RDS-Redis_v13-12-3-ee_2021-07-23_140128/5k-QuickStart-ARM-RDS-Redis_v13-12-3-ee_2021-07-23_140128_results.txt) | CNH Cost Estimate 3 AZs* | +| GitLab Cloud Native Hybrid Ref Arch | GitLab Baseline Performance Test Results (using the Linux package on instances) | AWS Bill of Materials (BOM) for CNH | AWS Build Performance Testing Results for [CNH](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/5K/5k-QuickStart-ARM-RDS-Redis_v13-12-3-ee_2021-07-23_140128/5k-QuickStart-ARM-RDS-Redis_v13-12-3-ee_2021-07-23_140128_results.txt) | CNH Cost Estimate 3 AZs* | | ------------------------------------------------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [2K Omnibus](../../administration/reference_architectures/2k_users.md) | [2K Baseline](https://gitlab.com/gitlab-org/quality/performance/-/wikis/Benchmarks/Latest/2k) | [2K Cloud Native Hybrid on EKS](#2k-cloud-native-hybrid-on-eks) | GPT Test Results | [1 YR Ec2 Compute Savings + 1 YR RDS & ElastiCache RIs](https://calculator.aws/#/estimate?id=544bcf1162beae6b8130ad257d081cdf9d4504e3)<br />(2 AZ Cost Estimate is in BOM Below) | +| [2K Linux package installation](../../administration/reference_architectures/2k_users.md) | [2K Baseline](https://gitlab.com/gitlab-org/quality/performance/-/wikis/Benchmarks/Latest/2k) | [2K Cloud Native Hybrid on EKS](#2k-cloud-native-hybrid-on-eks) | GPT Test Results | [1 YR Ec2 Compute Savings + 1 YR RDS & ElastiCache RIs](https://calculator.aws/#/estimate?id=544bcf1162beae6b8130ad257d081cdf9d4504e3)<br />(2 AZ Cost Estimate is in BOM Below) | | [3K](../../administration/reference_architectures/3k_users.md#cloud-native-hybrid-reference-architecture-with-helm-charts-alternative) | [3k Baseline](https://gitlab.com/gitlab-org/quality/performance/-/wikis/Benchmarks/Latest/3k) | [3K Cloud Native Hybrid on EKS](#3k-cloud-native-hybrid-on-eks) | [3K Full Fixed Scale GPT Test Results](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/3K/3k-QuickStart-ARM-RDS-Cache_v13-12-3-ee_2021-07-23_124216/3k-QuickStart-ARM-RDS-Cache_v13-12-3-ee_2021-07-23_124216_results.txt)<br /><br />[3K Elastic Auto Scale GPT Test Results](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/3K/3k-QuickStart-AutoScale-ARM-RDS-Cache_v13-12-3-ee_2021-07-23_194200/3k-QuickStart-AutoScale-ARM-RDS-Cache_v13-12-3-ee_2021-07-23_194200_results.txt) | [1 YR Ec2 Compute Savings + 1 YR RDS & ElastiCache RIs](https://calculator.aws/#/estimate?id=f1294fec554e21be999711cddcdab9c5e7f83f14)<br />(2 AZ Cost Estimate is in BOM Below) | | [5K](../../administration/reference_architectures/5k_users.md#cloud-native-hybrid-reference-architecture-with-helm-charts-alternative) | [5k Baseline](https://gitlab.com/gitlab-org/quality/performance/-/wikis/Benchmarks/Latest/5k) | [5K Cloud Native Hybrid on EKS](#5k-cloud-native-hybrid-on-eks) | [5K Full Fixed Scale GPT Test Results](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/5K/5k-QuickStart-ARM-RDS-Redis_v13-12-3-ee_2021-07-23_140128/5k-QuickStart-ARM-RDS-Redis_v13-12-3-ee_2021-07-23_140128_results.txt)<br /><br />[5K AutoScale from 25% GPT Test Results](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/5K/5k-QuickStart-AutoScale-From-25Percent-ARM-RDS-Redis_v13-12-3-ee_2021-07-24_102717/5k-QuickStart-AutoScale-From-25Percent-ARM-RDS-Redis_v13-12-3-ee_2021-07-24_102717_results.txt) | [1 YR Ec2 Compute Savings + 1 YR RDS & ElastiCache RIs](https://calculator.aws/#/estimate?id=330ee43c5b14662db5df6e52b34898d181a09e16) | | [10K](../../administration/reference_architectures/10k_users.md#cloud-native-hybrid-reference-architecture-with-helm-charts-alternative) | [10k Baseline](https://gitlab.com/gitlab-org/quality/performance/-/wikis/Benchmarks/Latest/10k) | [10K Cloud Native Hybrid on EKS](#10k-cloud-native-hybrid-on-eks) | [10K Full Fixed Scale GPT Test Results](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/10K/GL-CloudNative-10k-RDS-Graviton_v13-12-3-ee_2021-07-08_194647/GL-CloudNative-10k-RDS-Graviton_v13-12-3-ee_2021-07-08_194647_results.txt)<br /><br />[10K Elastic Auto Scale GPT Test Results](https://gitlab.com/guided-explorations/aws/implementation-patterns/gitlab-cloud-native-hybrid-on-eks/-/blob/master/gitlab-alliances-testing/10K/GL-CloudNative-10k-AutoScaling-Test_v13-12-3-ee_2021-07-09_115139/GL-CloudNative-10k-AutoScaling-Test_v13-12-3-ee_2021-07-09_115139_results.txt) | [10K 1 YR Ec2 Compute Savings + 1 YR RDS & ElastiCache RIs](https://calculator.aws/#/estimate?id=5ac2e07a22e01c36ee76b5477c5a046cd1bea792) | @@ -32,7 +32,7 @@ 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 (Omnibus + 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 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). For more information about the project, see [GitLab Environment Toolkit](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md). @@ -58,8 +58,8 @@ The Beta version deploys Aurora PostgreSQL, but the release version will deploy | 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 Omnibus GitLab (non-Kubernetes) | No | Yes | -| Can deploy Single Instance Omnibus GitLab (non-Kubernetes) | No | Yes | +| 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 | @@ -94,7 +94,7 @@ The AWS Quick Start for GitLab Cloud Native Hybrid on EKS has been tested with G ## AWS PaaS qualified for all GitLab implementations -For both Omnibus GitLab or Cloud Native Hybrid implementations, the following GitLab Service roles can be performed by AWS Services (PaaS). Any PaaS solutions that require preconfigured sizing based on the scale of your instance will also be listed in the per-instance size Bill of Materials lists. Those PaaS that do not require specific sizing, are not repeated in the BOM lists (for example, AWS Certification Manager). +For both implementations that used the Linux package or Cloud Native Hybrid implementations, the following GitLab Service roles can be performed by AWS Services (PaaS). Any PaaS solutions that require preconfigured sizing based on the scale of your instance will also be listed in the per-instance size Bill of Materials lists. Those PaaS that do not require specific sizing, are not repeated in the BOM lists (for example, AWS Certification Manager). These services have been tested with GitLab. diff --git a/doc/install/aws/index.md b/doc/install/aws/index.md index 4dcf2ce0927..febe54a8bb6 100644 --- a/doc/install/aws/index.md +++ b/doc/install/aws/index.md @@ -24,9 +24,9 @@ The following are the currently available implementation patterns for GitLab whe [Provision GitLab Cloud Native Hybrid on AWS EKS (HA)](gitlab_hybrid_on_aws.md). This document includes instructions, patterns, and automation for installing GitLab Cloud Native Hybrid on AWS EKS. It also includes [Bill of Materials](https://en.wikipedia.org/wiki/Bill_of_materials) listings and links to Infrastructure as Code. GitLab Cloud Native Hybrid is the supported way to put as much of GitLab as possible into Kubernetes. -### Patterns to Install Omnibus GitLab on AWS EC2 (HA) +### Patterns to Install GitLab by using the Linux package on AWS EC2 (HA) -[Omnibus GitLab on AWS EC2 (HA)](manual_install_aws.md) - instructions for installing GitLab on EC2 instances. Manual instructions to build a GitLab instance or create your own Infrastructure as Code (IaC). +[Installing a GitLab POC on Amazon Web Services (AWS)](manual_install_aws.md) - instructions for installing GitLab on EC2 instances. Manual instructions to build a GitLab instance or create your own Infrastructure as Code (IaC). ### Patterns for EKS cluster provisioning diff --git a/doc/install/aws/manual_install_aws.md b/doc/install/aws/manual_install_aws.md index 92ef08c2447..a952180674c 100644 --- a/doc/install/aws/manual_install_aws.md +++ b/doc/install/aws/manual_install_aws.md @@ -783,7 +783,7 @@ For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. To restore GitLab, first review the [restore documentation](../../administration/backup_restore/index.md#restore-gitlab), and primarily the restore prerequisites. Then, follow the steps under the -[Linux package installations section](../../administration/backup_restore/restore_gitlab.md#restore-for-omnibus-gitlab-installations). +[Linux package installations section](../../administration/backup_restore/restore_gitlab.md#restore-for-linux-package-installations). ## Updating GitLab diff --git a/doc/install/docker.md b/doc/install/docker.md index 925da8a2b4a..ac15b5490ce 100644 --- a/doc/install/docker.md +++ b/doc/install/docker.md @@ -284,7 +284,7 @@ Here's an example that deploys GitLab with four runners as a [stack](https://doc ## Configuration -This container uses the official Omnibus GitLab package, so all configuration +This container uses the official Linux package, so all configuration is done in the unique configuration file `/etc/gitlab/gitlab.rb`. To access the GitLab configuration file, you can start a shell session in the @@ -326,7 +326,7 @@ You can pre-configure the GitLab Docker image by adding the environment variable `gitlab.rb` setting and is evaluated before the loading of the container's `gitlab.rb` file. This behavior allows you to configure the external GitLab URL, and make database configuration or any other option from the -[Omnibus GitLab template](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template). +[Linux package template](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template). The settings contained in `GITLAB_OMNIBUS_CONFIG` aren't written to the `gitlab.rb` configuration file, and are evaluated on load. @@ -544,7 +544,7 @@ To upgrade GitLab that was [installed using Docker Engine](#install-gitlab-using On the first run, GitLab will reconfigure and upgrade itself. Refer to the GitLab [Upgrade recommendations](../policy/maintenance.md#upgrade-recommendations) -when upgrading between major versions. +when upgrading between versions. ### Upgrade GitLab using Docker compose @@ -640,7 +640,7 @@ page. ## Troubleshooting -The following information will help if you encounter problems using Omnibus GitLab and Docker. +The following information will help if you encounter problems with an installation that used the Linux package and Docker. ### Diagnose potential problems @@ -657,8 +657,7 @@ sudo docker exec -it gitlab /bin/bash ``` From within the container you can administer the GitLab container as you would -usually administer an -[Omnibus installation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/README.md) +usually administer a [Linux package installation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/README.md). ### 500 Internal Error diff --git a/doc/install/install_methods.md b/doc/install/install_methods.md index 0463c926286..fb48107e81b 100644 --- a/doc/install/install_methods.md +++ b/doc/install/install_methods.md @@ -13,7 +13,7 @@ or use one of the following methods. | Installation method | Description | When to choose | |----------------------------------------------------------------|-------------|----------------| -| [Linux package](https://docs.gitlab.com/omnibus/installation/) | The official deb/rpm packages (also known as Omnibus GitLab). The package has GitLab and dependent components, including PostgreSQL, Redis, and Sidekiq. | Use if you want the most mature, scalable method. This version is also used on GitLab.com. <br>- For additional flexibility and resilience, see the [reference architecture documentation](../administration/reference_architectures/index.md).<br>- Review the [system requirements](requirements.md).<br>- View the [list of supported Linux operating systems](../administration/package_information/supported_os.md#supported-operating-systems). | +| [Linux package](https://docs.gitlab.com/omnibus/installation/) (previously known as Omnibus GitLab) | The official `deb` and `rpm` packages. The Linux package has GitLab and dependent components, including PostgreSQL, Redis, and Sidekiq. | Use if you want the most mature, scalable method. This version is also used on GitLab.com. <br>- For additional flexibility and resilience, see the [reference architecture documentation](../administration/reference_architectures/index.md).<br>- Review the [system requirements](requirements.md).<br>- View the [list of supported Linux operating systems](../administration/package_information/supported_os.md#supported-operating-systems). | | [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.| @@ -29,10 +29,10 @@ or use one of the following methods. - macOS Installation of GitLab on these operating systems is possible, but not supported. -See the [installation from source guide](installation.md) and the [installation guides](https://about.gitlab.com/install/) for more information. +See the [installation guides](https://about.gitlab.com/install/) for more information. -See [OS versions that are no longer supported](../administration/package_information/supported_os.md#os-versions-that-are-no-longer-supported) for Omnibus installs page -for a list of supported and unsupported OS versions as well as the last support GitLab version for that OS. +See [OS versions that are no longer supported](../administration/package_information/supported_os.md#os-versions-that-are-no-longer-supported) +for a list of supported and unsupported OS versions for Linux package installations as well as the last support GitLab version for that OS. ## Microsoft Windows diff --git a/doc/install/installation.md b/doc/install/installation.md index 45c6b398a76..51a3941c5f5 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -48,8 +48,8 @@ If the highest number stable branch is unclear, check the [GitLab blog](https:// | [Ruby](#2-ruby) | `3.0.x` | From GitLab 15.10, Ruby 3.0 is required. 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. | | [RubyGems](#3-rubygems) | `3.4.x` | A specific RubyGems version is not fully needed, but it's recommended to update so you can enjoy some known performance improvements. | | [Go](#4-go) | `1.19.x` | From GitLab 16.1, Go 1.19 or later is required. | -| [Git](#git) | `2.38.x` | From GitLab 15.8, Git 2.38.x and later is required. It's highly recommended that you use the [Git version provided by Gitaly](#git). | -| [Node.js](#5-node) | `18.16.x` | From GitLab 16.1, Node.js 18.16 or later is required. | +| [Git](#git) | `2.41.x` | From GitLab 16.2, Git 2.41.x and later is required. You should use the [Git version provided by Gitaly](#git). | +| [Node.js](#5-node) | `18.17.x` | From GitLab 16.3, Node.js 18.17 or later is required. | ## GitLab directory structure @@ -260,7 +260,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` 18.x releases (v18.16.1 or later). +- `node` 18.x releases (v18.17.0 or later). [Other LTS versions of Node.js](https://github.com/nodejs/release#release-schedule) might be able to build assets, but we only guarantee Node.js 18.x. - `yarn` = v1.22.x (Yarn 2 is not supported yet) diff --git a/doc/install/migrate/compare_sm_to_saas.md b/doc/install/migrate/compare_sm_to_saas.md index 4cdc849be2c..b2fcbd5578e 100644 --- a/doc/install/migrate/compare_sm_to_saas.md +++ b/doc/install/migrate/compare_sm_to_saas.md @@ -1,124 +1,11 @@ --- -stage: Systems -group: Distribution -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +redirect_to: '../../subscriptions/choosing_subscription.md' +remove_date: '2023-10-10' --- -# Comparison of GitLab self-managed with GitLab SaaS +This document was moved to [another location](../../subscriptions/choosing_subscription.md). -GitLab SaaS is the largest hosted instance of GitLab in the world, managed by an -[all-remote team](https://about.gitlab.com/company/culture/all-remote/) that knows GitLab best. With GitLab SaaS, updates, maintenance, and patches are all performed by this team. - -Self-managed GitLab gives you a deeper breadth of control over many of the functions and systems of the application. - -## Administration - -In GitLab SaaS, administration tasks are limited compared to a self-managed application. - -In a self-managed instance: - -- You have complete access and administrative control over the application, including the [Admin Area](../../administration/settings/index.md). -- You can impersonate, create, add, and remove users. -- You can assign the [`Auditor`](../../administration/auditor_users.md) user type and `External` role. - -On GitLab SaaS: - -- You have limited administrative control. For example, you cannot impersonate, create, add, or remove users. -- You cannot access the [Admin Area](../../administration/settings/index.md). -- You cannot assign the `Auditor` user type and `External` role. - -## Logs - -Logs give insight into your processes and can help GitLab Support maintain your application and resolve problems. - -In a self-managed instance: - -- You have full access to system logs. - -On GitLab SaaS: - -- You do not have access to system logs because they are at the instance level, and managed by the GitLab [infrastructure team](https://about.gitlab.com/handbook/engineering/infrastructure/). -- You can view [Audit Events](../../administration/audit_events.md) and the [GitLab API](../../api/audit_events.md). -- You must [request audit information](https://about.gitlab.com/handbook/support/workflows/log_requests.html) from the Support team. - -## Runners - -Runners are available for both SaaS and self-managed applications. - -In a self-managed instance, your runner availability and options are broader, but there are more [security concerns](https://docs.gitlab.com/runner/security/#security-for-self-managed-runners) to consider. - -On GitLab SaaS: - -- Private [runners](../../ci/runners/index.md) are available for GitLab SaaS [groups](../../user/group/index.md) and [projects](../../user/project/index.md). -- Shared runners provided by GitLab SaaS are not configurable. Each runner instance is used once for only one job, ensuring any sensitive data left on the system is destroyed after the job is complete. -- Shared runners are subject to usage limits and are [plan specific](https://about.gitlab.com/pricing/). - -## Custom Git hooks - -In a self-managed instance you can use any custom Git hooks. - -On GitLab SaaS: - -- SaaS users do not have access to the file system, and cannot use custom Git hooks. -- You can use [webhooks](../../user/project/integrations/webhooks.md) as an alternative. - -## API and GraphQL - -In a self-managed instance, users can access all API endpoints, including those that require instance `admin` permissions. - -On GitLab SaaS: - -- SaaS users have access to all of the [API endpoints](../../api/rest/index.md) except those that require instance `admin` permissions. -- Only authorized GitLab engineers have administrative access. - -## Authentication - -In a self-managed instance: - -- You can use an internal encryption key for your data store. -- You can view console logs. -- You can enforce jobs on every pipeline across the group or organization. -- You have control over your data backup. -- You can use the [Interactive Web Terminal](../../ci/interactive_web_terminal/index.md#interactive-web-terminals) for shared runners. - -On GitLab SaaS: - -- You cannot use internal encryption key for the data store ([bring-your-own-key](https://about.gitlab.com/handbook/security/threat-management/vulnerability-management/encryption-policy.html#rolling-your-own-crypto)). -- You cannot view console logs. -- You cannot enforce jobs on every pipeline across the group or organization. -- You cannot configure or control data backups. You must use [group](../../api/group_import_export.md) and [project](../../api/project_import_export.md) export. -- The [Interactive Web Terminal](../../ci/interactive_web_terminal/index.md#interactive-web-terminals) is not available for shared runners. - -## Public or private projects - -Project privacy is different when using a self-managed application or GitLab SaaS. - -In a self-managed instance, you control who can view your projects. - -On GitLab SaaS: - -- The GitLab SaaS instance is open to the public. -- When your projects are set as `Public`, they are open to everyone on the public internet. - -## Encryption - -In a self-managed instance, you control the encryption type and configuration. - -On GitLab SaaS: - -- An [Access Management Process](https://about.gitlab.com/handbook/security/#access-management-process) is in place. -- All data on GitLab.com is encrypted at rest by default. Access to encryption keys is strictly managed by GitLab. -- GitLab does not access your tenant data except as part of a verified service request from you. - -## Support - -In a self-managed instance: - -- You can access any of your back-end systems. -- Our Support team can request logs to assist you. - -On GitLab SaaS: - -- For your privacy and security, there is no public access to GitLab back-end systems. -- Support staff work with [Site Reliability Engineers](https://about.gitlab.com/job-families/engineering/infrastructure/site-reliability-engineer/) to support the [infrastructure](https://about.gitlab.com/handbook/engineering/infrastructure/). -- GitLab Support can access instance logs and view projects, as well as impersonate users. The Support Team can access your logs. +<!-- This redirect file can be deleted after <2023-10-10>. --> +<!-- 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/openshift_and_gitlab/index.md b/doc/install/openshift_and_gitlab/index.md index 4f3df3ecff8..bb5a9b27cf5 100644 --- a/doc/install/openshift_and_gitlab/index.md +++ b/doc/install/openshift_and_gitlab/index.md @@ -12,40 +12,36 @@ OpenShift - GitLab compatibility can be addressed in three different aspects. Th OpenShift helps you to develop, deploy, and manage container-based applications. It provides you with a self-service platform to create, modify, and deploy applications on demand, thus enabling faster development and release life cycles. -## Use OpenShift to run GitLab Self-Managed +## Use OpenShift to run GitLab self-managed Running GitLab within an OpenShift cluster is officially supported using the GitLab Operator. You can learn more on [setting up GitLab on OpenShift on the GitLab Operator's documentation](https://docs.gitlab.com/charts/installation/operator.html). Some components (documented on the GitLab Operator doc) are not supported yet. -## Deploy to and integrate with OpenShift from GitLab - -Deploying custom or COTS applications on top of OpenShift from GitLab is supported using [the GitLab agent](../../user/clusters/agent/index.md). - ## Use OpenShift to run a GitLab Runner Fleet The GitLab Operator does not include the GitLab Runner. To install and manage a GitLab Runner fleet in an OpenShift cluster, use the [GitLab Runner Operator](https://gitlab.com/gitlab-org/gl-openshift/gitlab-runner-operator). -## Unsupported GitLab features +### Deploy to and integrate with OpenShift from GitLab -### Secure +Deploying custom or COTS applications on top of OpenShift from GitLab is supported using [the GitLab agent](../../user/clusters/agent/index.md). -- [License Compliance via the `License-Scanning.gitlab-ci.yml` CI/CD template](../../user/compliance/license_compliance/index.md). [License scanning of CycloneDX files](../../user/compliance/license_scanning_of_cyclonedx_files/index.md) is supported on OpenShift. -- [Code Quality scanning](../../ci/testing/code_quality.md) -- [Operational Container Scanning](../../user/clusters/agent/vulnerabilities.md) (Note: Pipeline [Container Scanning](../../user/application_security/container_scanning/index.md) is supported) +### Unsupported GitLab features -### Docker-in-Docker +#### Docker-in-Docker When using OpenShift to run a GitLab Runner Fleet, we do not support some GitLab features given OpenShift's security model. Features requiring Docker-in-Docker might not work. For Auto DevOps, the following features are not supported yet: -- Auto Code Quality -- Auto License Compliance +- [Auto Code Quality](../../ci/testing/code_quality.md) +- [License approval policies](../../user/compliance/license_approval_policies.md) +- [License Scanning](../../user/compliance/license_scanning_of_cyclonedx_files/index.md) is supported on OpenShift. - Auto Browser Performance Testing - Auto Build +- [Operational Container Scanning](../../user/clusters/agent/vulnerabilities.md) (Note: Pipeline [Container Scanning](../../user/application_security/container_scanning/index.md) is supported) For Auto Build, there's a [possible workaround using `kaniko`](../../ci/docker/using_kaniko.md). You can check the progress of the implementation in this [issue](https://gitlab.com/gitlab-org/gitlab/-/issues/332560). diff --git a/doc/install/relative_url.md b/doc/install/relative_url.md index 6f4221f9e2e..885dcba952e 100644 --- a/doc/install/relative_url.md +++ b/doc/install/relative_url.md @@ -11,7 +11,7 @@ this is not possible due to a variety of reasons. In that case, GitLab can also be installed under a relative URL, for example `https://example.com/gitlab`. This document describes how to run GitLab under a relative URL for installations -from source. If you are using an Omnibus package, +from source. If you are using an official Linux package, [the steps are different](https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-a-relative-url-for-gitlab). Use this guide along with the [installation guide](installation.md) if you are installing GitLab for the first time. @@ -32,7 +32,7 @@ relative URL is: - `/home/git/gitlab-shell/config.yml` - `/etc/default/gitlab` -After all the changes, you must recompile the assets and [restart GitLab](../administration/restart_gitlab.md#installations-from-source). +After all the changes, you must recompile the assets and [restart GitLab](../administration/restart_gitlab.md#self-compiled-installations). ## Relative URL requirements @@ -115,7 +115,7 @@ Make sure to follow all steps below: If you are using a custom init script, make sure to edit the above GitLab Workhorse setting as needed. -1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect. +1. [Restart GitLab](../administration/restart_gitlab.md#self-compiled-installations) for the changes to take effect. ## Disable relative URL in GitLab diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 5e13628e815..b095f265808 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -14,7 +14,7 @@ This page includes information about the minimum requirements you need to instal The necessary hard drive space largely depends on the size of the repositories you want to store in GitLab but as a *guideline* you should have at least as much free space as all your repositories combined take up. -The Omnibus GitLab package requires about 2.5 GB of storage space for installation. +The Linux package requires about 2.5 GB of storage space for installation. If you want to be flexible about growing your hard drive space in the future consider mounting it using [logical volume management (LVM)](https://en.wikipedia.org/wiki/Logical_volume_management) so you can add more hard drives when you need them. @@ -66,14 +66,13 @@ process, such as PostgreSQL, which can have disastrous consequences. ## Database -PostgreSQL is the only supported database, which is bundled with the Omnibus GitLab package. +PostgreSQL is the only supported database, which is bundled with the Linux package. You can also use an [external PostgreSQL database](https://docs.gitlab.com/omnibus/settings/database.html#using-a-non-packaged-postgresql-database-management-server). -Support for MySQL was removed in [GitLab 12.1](../update/index.md#1210). ### PostgreSQL Requirements The server running PostgreSQL should have _at least_ 5-10 GB of storage -available, though the exact requirements [depend on the number of users](../administration/reference_architectures/index.md). +available, though the exact requirements [depend on the number of users](../administration/reference_architectures/index.md). For Ultimate customers the server should have _at least_ 12 GB of storage available, as 1 GB of vulnerability data needs to be imported. We highly recommend using at least the minimum PostgreSQL versions (as specified in the following table) as these were used for development and testing: @@ -107,10 +106,9 @@ Support for [PostgreSQL 9.6 and 10 was removed in GitLab 13.0](https://about.git #### Additional requirements for GitLab Geo If you're using [GitLab Geo](../administration/geo/index.md), we strongly -recommend running Omnibus GitLab-managed instances, as we actively develop and -test based on those. We try to be compatible with most external (not managed by -Omnibus GitLab) databases (for example, [AWS Relational Database Service (RDS)](https://aws.amazon.com/rds/)), -but we can't guarantee compatibility. +recommend running instances installed by using the Linux package, as we actively develop and +test based on those. We try to be compatible with most external (not managed by a Linux package installation) databases +(for example, [AWS Relational Database Service (RDS)](https://aws.amazon.com/rds/)), but we can't guarantee compatibility. #### Operating system locale compatibility and silent index corruption @@ -249,7 +247,7 @@ Redis stores all user sessions and the background task queue. The requirements for Redis are as follows: -- Redis 6.0 is required from GitLab 16.0 and later. +- Redis 6.x or 7.x is required in GitLab 16.0 and later. - Redis Cluster mode is not supported. Redis Standalone must be used. - Storage requirements for Redis are minimal, about 25 kB per user on average. |