diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-16 03:07:16 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-16 03:07:16 +0000 |
| commit | fe0260eaa337339a131624a8b71d7a05a3664a18 (patch) | |
| tree | ef249dade23077695d37ab760851f4d1d1c7556f /doc | |
| parent | cc93ae5beb8a50c959373b77a9fdd6b31a88f00c (diff) | |
| download | gitlab-ce-fe0260eaa337339a131624a8b71d7a05a3664a18.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/gitaly/monitoring.md | 3 | ||||
| -rw-r--r-- | doc/api/graphql/reference/index.md | 82 | ||||
| -rw-r--r-- | doc/update/removals.md | 65 | ||||
| -rw-r--r-- | doc/user/enterprise_user/index.md | 59 | ||||
| -rw-r--r-- | doc/user/img/get_domain_verification_code_v16_0.png | bin | 0 -> 47328 bytes | |||
| -rw-r--r-- | doc/user/img/retry_domain_verification_v16_0.png | bin | 0 -> 22593 bytes | |||
| -rw-r--r-- | doc/user/project/web_ide/index.md | 14 |
7 files changed, 211 insertions, 12 deletions
diff --git a/doc/administration/gitaly/monitoring.md b/doc/administration/gitaly/monitoring.md index a854a0a3b48..00d0499faa2 100644 --- a/doc/administration/gitaly/monitoring.md +++ b/doc/administration/gitaly/monitoring.md @@ -183,9 +183,6 @@ To monitor [repository verification](praefect.md#repository-verification), use t - `gitaly_praefect_stale_verification_leases_released_total`, the number of stale verification leases released. -The `/metrics` endpoint also provides all the metrics available under the `/db_metrics` endpoint. Using `/metrics` for `/db_metrics` metrics -is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/390266) in GitLab 15.9 and will be removed in GitLab 16.0. - You can also monitor the [Praefect logs](../logs/index.md#praefect-logs). ### Database metrics `/db_metrics` endpoint diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 47e52e6005f..8d94b45c1f9 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -3406,6 +3406,33 @@ Input type: `ExternalAuditEventDestinationUpdateInput` | <a id="mutationexternalauditeventdestinationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | | <a id="mutationexternalauditeventdestinationupdateexternalauditeventdestination"></a>`externalAuditEventDestination` | [`ExternalAuditEventDestination`](#externalauditeventdestination) | Updated destination. | +### `Mutation.geoRegistriesUpdate` + +Mutates a Geo registry. Does not mutate the registry entry if `geo_registries_update_mutation` feature flag is disabled. + +WARNING: +**Introduced** in 16.1. +This feature is an Experiment. It can be changed or removed at any time. + +Input type: `GeoRegistriesUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationgeoregistriesupdateaction"></a>`action` | [`GeoRegistryAction!`](#georegistryaction) | Action to be executed on a Geo registry. | +| <a id="mutationgeoregistriesupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationgeoregistriesupdateregistryclass"></a>`registryClass` | [`GeoRegistryClass!`](#georegistryclass) | Class of the Geo registry to be updated. | +| <a id="mutationgeoregistriesupdateregistryid"></a>`registryId` | [`GeoBaseRegistryID!`](#geobaseregistryid) | ID of the Geo registry entry to be updated. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationgeoregistriesupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationgeoregistriesupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationgeoregistriesupdateregistry"></a>`registry` | [`Registrable`](#registrable) | Updated Geo registry entry. | + ### `Mutation.gitlabSubscriptionActivate` Input type: `GitlabSubscriptionActivateInput` @@ -24391,6 +24418,36 @@ Event action. | <a id="eventactionreopened"></a>`REOPENED` | Reopened action. | | <a id="eventactionupdated"></a>`UPDATED` | Updated action. | +### `GeoRegistryAction` + +Action to trigger on one or more Geo registries. + +| Value | Description | +| ----- | ----------- | +| <a id="georegistryactionresync"></a>`RESYNC` | Resync a registry. | +| <a id="georegistryactionreverify"></a>`REVERIFY` | Reverify a registry. | + +### `GeoRegistryClass` + +Geo registry class. + +| Value | Description | +| ----- | ----------- | +| <a id="georegistryclassci_secure_file_registry"></a>`CI_SECURE_FILE_REGISTRY` | Geo::CiSecureFileRegistry registry class. | +| <a id="georegistryclasscontainer_repository_registry"></a>`CONTAINER_REPOSITORY_REGISTRY` | Geo::ContainerRepositoryRegistry registry class. | +| <a id="georegistryclassdependency_proxy_blob_registry"></a>`DEPENDENCY_PROXY_BLOB_REGISTRY` | Geo::DependencyProxyBlobRegistry registry class. | +| <a id="georegistryclassdependency_proxy_manifest_registry"></a>`DEPENDENCY_PROXY_MANIFEST_REGISTRY` | Geo::DependencyProxyManifestRegistry registry class. | +| <a id="georegistryclassjob_artifact_registry"></a>`JOB_ARTIFACT_REGISTRY` | Geo::JobArtifactRegistry registry class. | +| <a id="georegistryclasslfs_object_registry"></a>`LFS_OBJECT_REGISTRY` | Geo::LfsObjectRegistry registry class. | +| <a id="georegistryclassmerge_request_diff_registry"></a>`MERGE_REQUEST_DIFF_REGISTRY` | Geo::MergeRequestDiffRegistry registry class. | +| <a id="georegistryclasspackage_file_registry"></a>`PACKAGE_FILE_REGISTRY` | Geo::PackageFileRegistry registry class. | +| <a id="georegistryclasspages_deployment_registry"></a>`PAGES_DEPLOYMENT_REGISTRY` | Geo::PagesDeploymentRegistry registry class. | +| <a id="georegistryclasspipeline_artifact_registry"></a>`PIPELINE_ARTIFACT_REGISTRY` | Geo::PipelineArtifactRegistry registry class. | +| <a id="georegistryclassproject_wiki_repository_registry"></a>`PROJECT_WIKI_REPOSITORY_REGISTRY` | Geo::ProjectWikiRepositoryRegistry registry class. | +| <a id="georegistryclasssnippet_repository_registry"></a>`SNIPPET_REPOSITORY_REGISTRY` | Geo::SnippetRepositoryRegistry registry class. | +| <a id="georegistryclassterraform_state_version_registry"></a>`TERRAFORM_STATE_VERSION_REGISTRY` | Geo::TerraformStateVersionRegistry registry class. | +| <a id="georegistryclassupload_registry"></a>`UPLOAD_REGISTRY` | Geo::UploadRegistry registry class. | + ### `GitlabSubscriptionsUserRole` Role of User. @@ -26154,6 +26211,12 @@ An example `EpicTreeSortingID` is: `"gid://gitlab/EpicTreeSorting/1"`. Represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). +### `GeoBaseRegistryID` + +A `GeoBaseRegistryID` is a global ID. It is encoded as a string. + +An example `GeoBaseRegistryID` is: `"gid://gitlab/Geo::BaseRegistry/1"`. + ### `GitlabErrorTrackingDetailedErrorID` A `GitlabErrorTrackingDetailedErrorID` is a global ID. It is encoded as a string. @@ -26605,6 +26668,25 @@ One of: - [`NugetMetadata`](#nugetmetadata) - [`PypiMetadata`](#pypimetadata) +#### `Registrable` + +One of: + +- [`CiSecureFileRegistry`](#cisecurefileregistry) +- [`ContainerRepositoryRegistry`](#containerrepositoryregistry) +- [`DependencyProxyBlobRegistry`](#dependencyproxyblobregistry) +- [`DependencyProxyManifestRegistry`](#dependencyproxymanifestregistry) +- [`JobArtifactRegistry`](#jobartifactregistry) +- [`LfsObjectRegistry`](#lfsobjectregistry) +- [`MergeRequestDiffRegistry`](#mergerequestdiffregistry) +- [`PackageFileRegistry`](#packagefileregistry) +- [`PagesDeploymentRegistry`](#pagesdeploymentregistry) +- [`PipelineArtifactRegistry`](#pipelineartifactregistry) +- [`ProjectWikiRepositoryRegistry`](#projectwikirepositoryregistry) +- [`SnippetRepositoryRegistry`](#snippetrepositoryregistry) +- [`TerraformStateVersionRegistry`](#terraformstateversionregistry) +- [`UploadRegistry`](#uploadregistry) + #### `SecurityPolicySource` Represents a policy source. Its fields depend on the source type. diff --git a/doc/update/removals.md b/doc/update/removals.md index fcd4de7a2f5..a2dddbfaa44 100644 --- a/doc/update/removals.md +++ b/doc/update/removals.md @@ -226,6 +226,22 @@ Review the details carefully before upgrading. The [Jira DVCS connector](https://docs.gitlab.com/ee/integration/jira/dvcs/) for Jira Cloud was deprecated in GitLab 15.1 and has been removed in 16.0. Use the [GitLab for Jira Cloud app](https://docs.gitlab.com/ee/integration/jira/connect-app.html) instead. The Jira DVCS connector was also deprecated for Jira 8.13 and earlier. You can only use the Jira DVCS connector with Jira Data Center or Jira Server in Jira 8.14 and later. Upgrade your Jira instance to Jira 8.14 or later, and reconfigure the Jira integration in your GitLab instance. If you cannot upgrade your Jira instance in time and are on GitLab self-managed version, we offer a workaround until GitLab 16.6. This breaking change is deployed in GitLab 16.0 behind a feature flag named `jira_dvcs_end_of_life_amnesty`. The flag is disabled by default, but you can ask an administrator to enable the flag at any time. For questions related to this announcement, see the [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/408185). +### Legacy Gitaly configuration method + +WARNING: +This is a [breaking change](https://docs.gitlab.com/ee/development/deprecation_guidelines/). +Review the details carefully before upgrading. + +Previously, Gitaly configuration keys for Omnibus GitLab were scattered throughout the configuration file. In GitLab +15.10, we added support for a single configuration structure that matches Gitaly internal configuration. Both methods +of configuring Gitaly were supported in parallel. + +In GitLab 16.0, we removed support for the former configuration method and now only support the new configuration +method. + +Before upgrading to GitLab 16.0, administrators must migrate to the new single configuration structure. For +instructions, see [Gitaly - Omnibus GitLab configuration structure change](https://docs.gitlab.com/ee/update/#gitaly-omnibus-gitlab-configuration-structure-change). + ### Legacy Gitaly configuration methods with variables WARNING: @@ -239,6 +255,22 @@ in GitLab 16.0. These variables are replaced with standard GitLab instances that use `GIT_CONFIG_SYSTEM` and `GIT_CONFIG_GLOBAL` to configure Gitaly must switch to configuring using `config.toml`. +### Legacy Praefect configuration method + +WARNING: +This is a [breaking change](https://docs.gitlab.com/ee/development/deprecation_guidelines/). +Review the details carefully before upgrading. + +Previously, Praefect configuration keys for Omnibus GitLab were scattered throughout the configuration file. In GitLab +15.9, we added support for a single configuration structure that matches Praefect internal configuration. Both methods +of configuring Praefect were supported in parallel. + +In GitLab 16.0, we removed support for the former configuration method and now only support the new configuration +method. + +Before upgrading to GitLab 16.0, administrators must migrate to the new single configuration structure. For +instructions, see [Praefect - Omnibus GitLab configuration structure change](https://docs.gitlab.com/ee/update/#praefect-omnibus-gitlab-configuration-structure-change). + ### License-Check and the Policies tab on the License Compliance page WARNING: @@ -282,6 +314,27 @@ The [**Maximum number of active pipelines per project** limit](https://docs.gitl - [**Pipelines rate limits**](https://docs.gitlab.com/ee/user/admin_area/settings/rate_limit_on_pipelines_creation.html). - [**Total number of jobs in currently active pipelines**](https://docs.gitlab.com/ee/user/admin_area/settings/continuous_integration.html#set-cicd-limits). +### Monitoring performance metrics through Prometheus is removed + +WARNING: +This is a [breaking change](https://docs.gitlab.com/ee/development/deprecation_guidelines/). +Review the details carefully before upgrading. + +We previously launched a solution that allows you to view performance metrics by displaying data stored in a Prometheus instance. +The Prometheus instance can be set up as a GitLab-managed app or you can connect a previously configured Prometheus instance. +The latter is known as an "external Prometheus" in GitLab. The value we provided was to enable you to easily set up monitoring +(using GitLab Managed Apps) and have the visualization of the metrics all in the same tool you used to build the application. + +However, as we are removing certificate-based integrations, the full monitoring experience is also deprecated as you will not +have the option to easily set up Prometheus from GitLab. Furthermore, we plan to consolidate on +a focused observability dashboard experience instead of having multiple paths to view metrics. Because of this, we are also removing the external +Prometheus experience, together with the metrics visualization capability. + +This removal only refers to the GitLab Metrics capabilities, and **does not** include: + +- Deprecating [alerts for Prometheus](https://gitlab.com/gitlab-org/gitlab/-/issues/338834). +- [Capabilities that GitLab comes with that allow operators of GitLab to retrieve metrics from those instances](https://docs.gitlab.com/ee/administration/monitoring/prometheus/gitlab_metrics.html). + ### Non-expiring access tokens no longer supported WARNING: @@ -330,6 +383,18 @@ Before upgrading to GitLab 16.0, if you are: - Using an externally-provided PostgreSQL 12, you must upgrade to PostgreSQL 13 or later to meet the [minimum version requirements](https://docs.gitlab.com/ee/install/requirements.html#postgresql-requirements). +### Praefect custom metrics endpoint configuration + +WARNING: +This is a [breaking change](https://docs.gitlab.com/ee/development/deprecation_guidelines/). +Review the details carefully before upgrading. + +Support for using the `prometheus_exclude_database_from_default_metrics` configuration value was deprecated in +GitLab 15.9 and is removed in GitLab 16.0. We made this change to improve the performance of Praefect. +All metrics that scrape the Praefect database are now exported to the `/db_metrics` endpoint. + +You must update your metrics collection targets to use the `/db_metrics` endpoint. + ### Project REST API field `operations_access_level` removed WARNING: diff --git a/doc/user/enterprise_user/index.md b/doc/user/enterprise_user/index.md index 901731ad6f9..ffeaaa8c591 100644 --- a/doc/user/enterprise_user/index.md +++ b/doc/user/enterprise_user/index.md @@ -41,21 +41,62 @@ The following automated processes use [verified domains](../project/pages/custom Prerequisites: -- A project with [GitLab Pages](../project/pages/index.md), served under the default Pages domain `*.gitlab.io`. - A custom domain name `example.com` or subdomain `subdomain.example.com`. - Access to your domain's server control panel to set up a DNS `TXT` record to verify your domain's ownership. Setting up a verified domain is similar to [setting up a custom domain on GitLab Pages](../project/pages/custom_domains_ssl_tls_certification/index.md). However, you must: -- Only configure the DNS `TXT` record to verify the domain's ownership. -- Ignore instructions for the `A`, `CNAME`, and `ALIAS` records. +- Link the domain to a project. For more information on group-level domain verification, see [issue 5299](https://gitlab.com/groups/gitlab-org/-/epics/5299). +- Configure the DNS `TXT` record to verify the domain's ownership. -1. [Add a custom domain](../project/pages/custom_domains_ssl_tls_certification/index.md#1-add-a-custom-domain) for the matching email domain. - - The domain must match the email domain exactly. For example, if your email is `username@example.com`, verify the `example.com` domain. -1. [Get a verification code](../project/pages/custom_domains_ssl_tls_certification/index.md#2-get-the-verification-code). -1. [Set up the DNS `TXT`](../project/pages/custom_domains_ssl_tls_certification/index.md#3-set-up-dns-records) for your custom domain. -1. [Verify the domain's ownership](../project/pages/custom_domains_ssl_tls_certification/index.md#4-verify-the-domains-ownership). -1. Optional. [Add more domain aliases](../project/pages/custom_domains_ssl_tls_certification/index.md#add-more-domain-aliases). +Steps: + +#### 1. Add a custom domain for the matching email domain + +The custom domain must match the email domain exactly. For example, if your email is `username@example.com`, verify the `example.com` domain. + +1. On the top bar, select **Main menu > Groups** and find your top group. +1. On the left sidebar, select **Settings > Domain Verification**. +1. In the upper-right corner, select **Add Domain**. +1. In **Domain**, enter the domain name. +1. In **Project**, link to a project. +1. Optional. In **Certificate**, switch the **Manually enter certificate information** toggle to add an SSL/TLS + certificate. You can also add the certificate and key later. +1. Select **Add Domain**. + +#### 2. Get a verification code + +After you create a new domain, the verification code prompts you. Copy the values from GitLab +and paste them in your domain's control panel as a `TXT` record. + + + +#### 3. Verify the domain's ownership + +After you have added all the DNS records: + +1. On the top bar, select **Main menu > Groups** and find your group. +1. On the left sidebar, select **Settings > Domain Verification**. +1. On the domain table row, Select **Retry verification** (**{retry}**). + + + +WARNING: +For GitLab instances with domain verification enabled, +if the domain cannot be verified for 7 days, that domain is removed +from the GitLab project. + +> **Notes:** +> +> - Domain verification is **required for GitLab.com users**; + for GitLab self-managed instances, your GitLab administrator has the option + to [disabled custom domain verification](../../administration/pages/index.md#custom-domain-verification). +> - [DNS propagation may take some time (up to 24 hours)](https://www.inmotionhosting.com/support/domain-names/dns-nameserver-changes/complete-guide-to-dns-records/), + although it's usually a matter of minutes to complete. Until it does, verification + fails, and attempts to visit your domain result in a 404. +> - Once your domain has been verified, leave the verification record + in place. Your domain is periodically reverified, and may be + disabled if the record is removed. ### View domains in group diff --git a/doc/user/img/get_domain_verification_code_v16_0.png b/doc/user/img/get_domain_verification_code_v16_0.png Binary files differnew file mode 100644 index 00000000000..34c77866865 --- /dev/null +++ b/doc/user/img/get_domain_verification_code_v16_0.png diff --git a/doc/user/img/retry_domain_verification_v16_0.png b/doc/user/img/retry_domain_verification_v16_0.png Binary files differnew file mode 100644 index 00000000000..4183fd5a342 --- /dev/null +++ b/doc/user/img/retry_domain_verification_v16_0.png diff --git a/doc/user/project/web_ide/index.md b/doc/user/project/web_ide/index.md index 140008f8b93..bb1609a74e5 100644 --- a/doc/user/project/web_ide/index.md +++ b/doc/user/project/web_ide/index.md @@ -87,6 +87,20 @@ To view a list of files you changed in the Web IDE: Your `CHANGES`, `STAGED CHANGES`, and `MERGE CHANGES` are displayed. For more information, see the [VS Code documentation](https://code.visualstudio.com/docs/sourcecontrol/overview#_commit). +## Upload a new file + +To upload a new file and add it to the Git repository: + +1. In the **Explorer** file tree, navigate to the directory where you want to upload the file. +1. Optional. If the directory does not exist yet, select the directory path where you want to have a new directory and either: + - Right-click on the directory path, and select **New Folder...**. You can create a nested directory path with the `/` separator, for example `parentdir/subdir1/subdir2`. + - In the **Explorer** panel, in the upper-right corner, select the new folder (**{folder-new}**) icon. +1. Enter the name of the new directory, and press <kbd>Enter/Return</kbd> to create it. +1. Right-click on the directory path and select `Upload...`. +1. Select the file you want to upload, then select `Open`. You can select and add multiple files at once. + +The file is uploaded and automatically added as a new file to the Git repository. + ## Switch branches The Web IDE uses the currently selected branch by default. |
