Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-05-31 03:07:46 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-05-31 03:07:46 +0300
commit6ac9f963e62db1a2c347517694b94bd86c1fb37f (patch)
tree7a35d62777b9a5a8e789865e78f971a07a01b874 /doc
parente690e4ea1fff57191fb1166e5022c2bcfe308c86 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/server_hooks.md8
-rw-r--r--doc/api/graphql/reference/index.md14
-rw-r--r--doc/api/packages/npm.md7
-rw-r--r--doc/development/code_review.md1
-rw-r--r--doc/development/github_importer.md2
-rw-r--r--doc/install/installation.md31
-rw-r--r--doc/update/patch_versions.md2
-rw-r--r--doc/update/upgrading_from_ce_to_ee.md5
-rw-r--r--doc/update/upgrading_from_source.md18
-rw-r--r--doc/user/packages/npm_registry/index.md7
10 files changed, 49 insertions, 46 deletions
diff --git a/doc/administration/server_hooks.md b/doc/administration/server_hooks.md
index 7768953b2a0..dcaa19358c4 100644
--- a/doc/administration/server_hooks.md
+++ b/doc/administration/server_hooks.md
@@ -57,11 +57,13 @@ To set server hooks for a repository:
1. Ensure the server hook files are executable and do not match the backup file pattern (`*~`). The server hooks be
in a `custom_hooks` directory that is at the root of the tarball.
1. Create the custom hooks archive with the tar command. For example, `tar -cf custom_hooks.tar custom_hooks`.
-1. Run the `hooks set` command with required options to set the Git hooks for the repository. For example,
+1. Run the `hooks set` subcommand with required options to set the Git hooks for the repository. For example,
`cat hooks.tar | gitaly hooks set --storage <storage> --repository <relative path> --config <config path>`.
- A path to a valid Gitaly configuration for the node is required to connect to the node and provided to the `--config` flag.
- Custom hooks tarball must be passed via `stdin`. For example, `cat hooks.tar | gitaly hooks set --storage <storage> --repository <relative path> --config <config path>`.
+1. If you are using Gitaly Cluster, you must run `hooks set` subcommand on all Gitaly nodes. For more information, see
+ [Server hooks on a Gitaly Cluster](#server-hooks-on-a-gitaly-cluster).
If you implemented the server hook code correctly, it should execute when the Git hook is next triggered.
@@ -90,12 +92,14 @@ To create server hooks for a repository:
example, if the script is in Ruby the shebang is probably `#!/usr/bin/env ruby`.
1. Ensure the hook file does not match the backup file
pattern (`*~`).
+1. If you are using Gitaly Cluster, you must repeat this process on all Gitaly nodes. For more information, see
+ [Server hooks on a Gitaly Cluster](#server-hooks-on-a-gitaly-cluster).
If the server hook code is properly implemented, it should execute when the Git hook is next triggered.
::EndTabs
-### Gitaly Cluster
+### Server hooks on a Gitaly Cluster
If you use [Gitaly Cluster](gitaly/index.md), an individual repository may be replicated to multiple Gitaly storages in Praefect.
Consequentially, the hook scripts must be copied to every Gitaly node that has a replica of the repository.
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index f59b7521ce6..938d8828cfc 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -5741,6 +5741,7 @@ Input type: `ScanExecutionPolicyCommitInput`
| <a id="mutationscanexecutionpolicycommitbranch"></a>`branch` | [`String`](#string) | Name of the branch to which the policy changes are committed. |
| <a id="mutationscanexecutionpolicycommitclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
| <a id="mutationscanexecutionpolicycommiterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
+| <a id="mutationscanexecutionpolicycommitvalidationerrors"></a>`validationErrors` | [`[SecurityPolicyValidationError!]`](#securitypolicyvalidationerror) | Validation errors encountered during execution of the mutation. |
### `Mutation.securityFindingCreateIssue`
@@ -21732,6 +21733,19 @@ Represents a resource scanned by a security scan.
| <a id="scannedresourcerequestmethod"></a>`requestMethod` | [`String`](#string) | HTTP request method used to access the URL. |
| <a id="scannedresourceurl"></a>`url` | [`String`](#string) | URL scanned by the scanner. |
+### `SecurityPolicyValidationError`
+
+Security policy validation error.
+
+#### Fields
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="securitypolicyvalidationerrorfield"></a>`field` | [`String!`](#string) | Error field. |
+| <a id="securitypolicyvalidationerrorlevel"></a>`level` | [`String!`](#string) | Error level. |
+| <a id="securitypolicyvalidationerrormessage"></a>`message` | [`String!`](#string) | Error message. |
+| <a id="securitypolicyvalidationerrortitle"></a>`title` | [`String`](#string) | Error title. |
+
### `SecurityReportSummary`
Represents summary of a security report.
diff --git a/doc/api/packages/npm.md b/doc/api/packages/npm.md
index 664737e317a..6f4d8446dbf 100644
--- a/doc/api/packages/npm.md
+++ b/doc/api/packages/npm.md
@@ -150,11 +150,8 @@ The examples in this document all use the project-level prefix.
### Group-level
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299834) in GitLab 16.0 [with a flag](../../administration/feature_flags.md) named `npm_group_level_endpoints`. Disabled by default.
-
-FLAG:
-On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `npm_group_level_endpoints`.
-The feature is not ready for production use.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299834) in GitLab 16.0 [with a flag](../../administration/feature_flags.md) named `npm_group_level_endpoints`. Disabled by default.
+> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121837) in GitLab 16.1. Feature flag `npm_group_level_endpoints` removed.
```plaintext
/groups/:id/-/packages/npm`
diff --git a/doc/development/code_review.md b/doc/development/code_review.md
index 97b112c19d9..81d340a0e4e 100644
--- a/doc/development/code_review.md
+++ b/doc/development/code_review.md
@@ -210,6 +210,7 @@ See the [test engineering process](https://about.gitlab.com/handbook/engineering
1. You have considered the availability and reliability risks of this change.
1. You have considered the scalability risk based on future predicted growth.
1. You have considered the performance, reliability, and availability impacts of this change on large customers who may have significantly more data than the average customer.
+1. You have considered the performance, reliability, and availability impacts of this change on customers who may run GitLab on the [minimum system](../install/requirements.md).
##### Observability instrumentation
diff --git a/doc/development/github_importer.md b/doc/development/github_importer.md
index 6ec420af5f9..4a24279043d 100644
--- a/doc/development/github_importer.md
+++ b/doc/development/github_importer.md
@@ -205,7 +205,7 @@ also reduces pressure on the system as a whole.
GitLab includes a worker called `Gitlab::Import::StuckProjectImportJobsWorker`
that periodically runs and marks project imports as failed if they have been
-running for more than 15 hours. For GitHub projects, this poses a bit of a
+running for more than 24 hours. For GitHub projects, this poses a bit of a
problem: importing large projects could take several hours depending on how
often we hit the GitHub rate limit (more on this below), but we don't want
`Gitlab::Import::StuckProjectImportJobsWorker` to mark our import as failed because of this.
diff --git a/doc/install/installation.md b/doc/install/installation.md
index 532f85acf43..4d80a02c9f1 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -4,14 +4,13 @@ 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
---
-# Installation from source **(FREE SELF)**
+# Self-compiled installation **(FREE SELF)**
This is the official installation guide to set up a production GitLab server
-using the source files. To set up a **development installation** or for many
-other installation options, see the [main installation page](index.md).
-It was created for and tested on **Debian/Ubuntu** operating systems.
+using the source files. It was created for and tested on **Debian/Ubuntu** operating systems.
Read [requirements.md](requirements.md) for hardware and operating system requirements.
-If you want to install on RHEL/CentOS, you should use the [Omnibus packages](https://about.gitlab.com/install/).
+If you want to install on RHEL/CentOS, you should use the [Linux packages](https://about.gitlab.com/install/).
+For many other installation options, see the [main installation page](index.md).
This guide is long because it covers many cases and includes all commands you
need, this is [one of the few installation scripts that actually work out of the box](https://twitter.com/robinvdvleuten/status/424163226532986880).
@@ -24,21 +23,20 @@ If you find a bug/error in this guide, **submit a merge request**
following the
[contributing guide](https://gitlab.com/gitlab-org/gitlab/-/blob/master/CONTRIBUTING.md).
-## Consider the Omnibus package installation
+## Consider the Linux package installation
-Because an installation from source is a lot of work and error prone we strongly recommend the fast and reliable [Omnibus package installation](https://about.gitlab.com/install/) (deb/rpm).
+Because a self-compiled installation is a lot of work and error prone, we strongly recommend the fast and reliable [Linux package installation](https://about.gitlab.com/install/) (deb/rpm).
-One reason the Omnibus package is more reliable is its use of runit to restart any of the GitLab processes in case one crashes.
+One reason the Linux package is more reliable is its use of runit to restart any of the GitLab processes in case one crashes.
On heavily used GitLab instances the memory usage of the Sidekiq background worker grows over time.
-
-Omnibus packages solve this by [letting the Sidekiq terminate gracefully](../administration/sidekiq/sidekiq_memory_killer.md) if it uses too much memory.
+The Linux packages solve this by [letting the Sidekiq terminate gracefully](../administration/sidekiq/sidekiq_memory_killer.md) if it uses too much memory.
After this termination runit detects Sidekiq is not running and starts it.
-Because installations from source don't use runit for process supervision, Sidekiq
+Because self-compiled installations don't use runit for process supervision, Sidekiq
can't be terminated and its memory usage grows over time.
## Select a version to install
-Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install (for example, `11-7-stable`).
+Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install (for example, `16-0-stable`).
You can select the branch in the version dropdown list in the upper-left corner of GitLab (below the menu bar).
If the highest number stable branch is unclear, check the [GitLab blog](https://about.gitlab.com/blog/) for installation guide links by version.
@@ -1147,15 +1145,6 @@ You must also change the corresponding options (for example, `ssh_user`, `ssh_ho
Apart from the always supported Markdown style, there are other rich text files that GitLab can display. But you might have to install a dependency to do so. See the [`github-markup` gem README](https://github.com/gitlabhq/markup#markups) for more information.
-### Using Sidekiq instead of Sidekiq Cluster
-
-As of GitLab 12.10, Source installations are using `bin/sidekiq-cluster` for managing Sidekiq processes.
-Using Sidekiq directly is still supported until 14.0. So if you're experiencing issues:
-
-1. Edit the system `init.d` script to remove the `SIDEKIQ_WORKERS` flag. If you have `/etc/default/gitlab`, then you should edit it instead.
-1. Restart GitLab.
-1. [Create an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/-/new) describing the problem.
-
### Prometheus server setup
You can configure the Prometheus server in `config/gitlab.yml`:
diff --git a/doc/update/patch_versions.md b/doc/update/patch_versions.md
index b6530418f97..964c6430a16 100644
--- a/doc/update/patch_versions.md
+++ b/doc/update/patch_versions.md
@@ -4,7 +4,7 @@ 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
---
-# Universal update guide for patch versions of source installations **(FREE SELF)**
+# Universal update guide for patch versions for self-compiled installations **(FREE SELF)**
## Select Version to Install
diff --git a/doc/update/upgrading_from_ce_to_ee.md b/doc/update/upgrading_from_ce_to_ee.md
index 8a66da507ec..acc2237f7a1 100644
--- a/doc/update/upgrading_from_ce_to_ee.md
+++ b/doc/update/upgrading_from_ce_to_ee.md
@@ -4,7 +4,7 @@ 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
---
-# Upgrading from Community Edition to Enterprise Edition from source **(FREE SELF)**
+# Upgrading from Community Edition to Enterprise Edition for self-compiled installations **(FREE SELF)**
NOTE:
In the past we used separate documents for upgrading from
@@ -39,9 +39,6 @@ cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
```
-For installations using MySQL, this may require granting `LOCK TABLES`
-privileges to the GitLab user on the database version.
-
### 1. Stop server
```shell
diff --git a/doc/update/upgrading_from_source.md b/doc/update/upgrading_from_source.md
index 7e2c9bf53dd..c8bed431780 100644
--- a/doc/update/upgrading_from_source.md
+++ b/doc/update/upgrading_from_source.md
@@ -4,13 +4,13 @@ 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
---
-# Upgrading Community Edition and Enterprise Edition from source **(FREE SELF)**
+# Upgrading self-compiled installations **(FREE SELF)**
Make sure you view this upgrade guide from the branch (version) of GitLab you
-would like to install (for example, `11.8`). You can select the required version of documentation in the dropdown list in the upper-right corner of GitLab documentation page.
+would like to install (for example, `16.0`). You can select the required version of documentation in the dropdown list in the upper-right corner of GitLab documentation page.
-In each of the following examples, replace `BRANCH` with the branch of the version you upgrading to (for example, `11-8-stable` for `11.8`). Replace `PREVIOUS_BRANCH` with the
-branch for the version you are upgrading from (for example, `11-7-stable` for `11.7`).
+In each of the following examples, replace `BRANCH` with the branch of the version you upgrading to (for example, `16-0-stable` for `16.0`). Replace `PREVIOUS_BRANCH` with the
+branch for the version you are upgrading from (for example, `15-11-stable` for `15.11`).
If the highest number stable branch is unclear check the
[GitLab Blog](https://about.gitlab.com/blog/archives.html) for installation
@@ -38,7 +38,11 @@ specific guidelines (should there be any) are covered separately.
### 1. Backup
-If you installed GitLab from source, make sure `rsync` is installed.
+Prerequisites:
+
+- Make sure `rsync` is installed.
+
+Perform the backup:
```shell
cd /home/git/gitlab
@@ -218,7 +222,7 @@ via [`/etc/default/gitlab`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/l
#### SMTP configuration
-If you're installing from source and use SMTP to deliver mail, you must
+If you use SMTP to deliver mail, you must
add the following line to `config/initializers/smtp_settings.rb`:
```ruby
@@ -400,7 +404,7 @@ see how to [upgrade to a later version](../administration/docs_self_host.md#upgr
Upgrading versions might need some manual intervention. For more information,
[check the version you are upgrading to](index.md#version-specific-upgrading-instructions)
for additional steps required for all GitLab installations, and for
-steps that apply to self-compiled (source) installations.
+steps that apply to self-compiled installations.
## Troubleshooting
diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md
index 33ae73dddc2..0fe2b39a591 100644
--- a/doc/user/packages/npm_registry/index.md
+++ b/doc/user/packages/npm_registry/index.md
@@ -195,11 +195,8 @@ To install a package from the instance level, the package must have been publish
### Install from the group level
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299834) in GitLab 16.0 [with a flag](../../../administration/feature_flags.md) named `npm_group_level_endpoints`. Disabled by default.
-
-FLAG:
-On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../../administration/feature_flags.md) named `npm_group_level_endpoints`.
-The feature is not ready for production use.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299834) in GitLab 16.0 [with a flag](../../../administration/feature_flags.md) named `npm_group_level_endpoints`. Disabled by default.
+> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121837) in GitLab 16.1. Feature flag `npm_group_level_endpoints` removed.
1. [Authenticate to the Package Registry](#authenticate-to-the-package-registry).