diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-21 21:16:10 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-21 21:16:10 +0300 |
commit | d2f2219fd58e572c10d77183e2f65de8fcc8df96 (patch) | |
tree | 2cde75cd3d994b7febe1349ab61b7a94a95c78cf /doc | |
parent | 6323146895db2be6f04846b3c98060b7349207b9 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/dedicated/index.md | 37 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 4 | ||||
-rw-r--r-- | doc/api/integrations.md | 8 | ||||
-rw-r--r-- | doc/ci/mobile_devops.md | 28 | ||||
-rw-r--r-- | doc/ci/runners/img/runner_fleet_dashboard.png (renamed from doc/development/img/runner_fleet_dashboard.png) | bin | 38440 -> 38440 bytes | |||
-rw-r--r-- | doc/ci/runners/runner_fleet_dashboard.md | 76 | ||||
-rw-r--r-- | doc/development/runner_fleet_dashboard.md | 72 | ||||
-rw-r--r-- | doc/integration/clickhouse.md | 17 | ||||
-rw-r--r-- | doc/subscriptions/gitlab_dedicated/index.md | 4 | ||||
-rw-r--r-- | doc/user/project/integrations/apple_app_store.md | 14 | ||||
-rw-r--r-- | doc/user/project/pages/index.md | 2 | ||||
-rw-r--r-- | doc/user/project/repository/code_suggestions/index.md | 12 | ||||
-rw-r--r-- | doc/user/project/service_desk/configure.md | 2 | ||||
-rw-r--r-- | doc/user/project/service_desk/index.md | 1 |
14 files changed, 154 insertions, 123 deletions
diff --git a/doc/administration/dedicated/index.md b/doc/administration/dedicated/index.md index ef9e53c8fb7..05a241b65dc 100644 --- a/doc/administration/dedicated/index.md +++ b/doc/administration/dedicated/index.md @@ -20,6 +20,9 @@ Examples of SaaS environment settings include `gitlab.rb` configurations and acc These environment settings cannot be changed by tenants. GitLab Dedicated Engineers also don't have direct access to tenant environments, except for [break glass situations](../../subscriptions/gitlab_dedicated/index.md#access-controls). +NOTE: +An instance refers to a GitLab Dedicated deployment, whereas a tenant refers to a customer. + ## Onboarding to GitLab Dedicated using Switchboard To create a new GitLab Dedicated environment for your organization, provide the following information to your account team: @@ -33,27 +36,27 @@ If you've been granted access to Switchboard, you receive an email invitation wi NOTE: The credentials for Switchboard are separate from any other GitLab credentials you may already have to sign in to a GitLab self-managed or GitLab.com instance. -After you first sign in to Switchboard, you must update your password and set up MFA before you can complete your onboarding to create a tenant. +After you first sign in to Switchboard, you must update your password and set up MFA before you can complete your onboarding to create a new instance. -The following stages guide you through a series of four steps to provide the information required to create your GitLab Dedicated tenant. +The following stages guide you through a series of four steps to provide the information required to create your GitLab Dedicated instance. 1. Confirm account details: Confirm key attributes of your GitLab Dedicated account: - Reference architecture: Corresponds with the number of users you provided to your account team when beginning the onboarding process. For more information, see [reference architectures](../../subscriptions/gitlab_dedicated/index.md#availability-and-scalability). - Total repository storage size: Corresponds with the storage size you provided to your account team when beginning the onboarding process. - If you need to make changes to these attributes, [submit a support ticket](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=4414917877650). -1. Tenant configuration: Provides the minimum required information needed to create your GitLab Dedicated tenant: +1. Tenant configuration: Provides the minimum required information needed to create your GitLab Dedicated instance: - Desired instance subdomain: The main domain for GitLab Dedicated instances is `gitlab-dedicated.com`. You choose the subdomain name where your instance is accessible from. For example, `customer_name.gitlab-dedicated.com`. - Desired primary region: Primary AWS region in which your data is stored. Note the [available AWS regions](../../subscriptions/gitlab_dedicated/index.md#available-aws-regions). - Desired secondary region: Secondary AWS region in which your data is stored. This region is used to recover your GitLab Dedicated instance in case of a disaster. - Desired backup region: An AWS region where the primary backups of your data are replicated. This can be the same as the primary or secondary region, or different. - Desired maintenance window: A weekly four-hour time slot that GitLab uses to perform routine maintenance and upgrade operations on all tenant instances. For more information, see [maintenance windows](#maintenance-window). 1. Security: You can provide your own [KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html) for encrypted AWS services. If you choose not to provide KMS keys, encryption keys are generated for your instance when it is created. For more information, see [encrypting your data at rest](#encrypted-data-at-rest-byok). -1. Summary: You confirm that the information you've provided in the previous steps is accurate before initiating the creation of your tenant. +1. Summary: You confirm that the information you've provided in the previous steps is accurate before initiating the creation of your instance. NOTE: -Some configuration settings (like the option to bring your own keys and your tenant name) are permanent and cannot be changed once your tenant has been created. +Some configuration settings (like the option to bring your own keys and your tenant name) are permanent and cannot be changed once your instance has been created. -It can take up to 3 hours to create the GitLab Dedicated tenant. When the setup is complete, you will receive a confirmation email with further instructions on how to access your tenant. +It can take up to 3 hours to create the GitLab Dedicated instance. When the setup is complete, you will receive a confirmation email with further instructions on how to access your instance. ### Maintenance window @@ -218,7 +221,7 @@ Make sure the AWS KMS keys are replicated to your desired primary, secondary and Configuration changes requested with a [support ticket](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=4414917877650) are batched up and applied during your environment's weekly four-hour maintenance window. -This policy does not apply to configuration changes made by a GitLab Dedicated tenant admin [using Switchboard](#configuration-changes-in-switchboard). +This policy does not apply to configuration changes made by a GitLab Dedicated instance admin [using Switchboard](#configuration-changes-in-switchboard). To have a change considered for an upcoming weekly maintenance window, all required information must be submitted in full two business days before the start of the window. @@ -232,7 +235,7 @@ Changes requested with a support ticket cannot be applied outside of a weekly ma ### Configuration changes in Switchboard -Switchboard empowers the user to make limited configuration changes to their Dedicated Tenant Instance. As Switchboard matures further configuration changes will be made available. +Switchboard empowers the user to make limited configuration changes to their GitLab Dedicated instance. As Switchboard matures further configuration changes will be made available. To change or update the configuration of your GitLab Dedicated instance, use Switchboard following the instructions in the relevant section or open a [support ticket](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=4414917877650) with your request. @@ -271,12 +274,14 @@ Consider the following when using Outbound Private Links: and repositories, or use any other GitLab functionality to access private services. - You can only establish Private Links between VPCs in the same region. Therefore, you can only establish a connection in the regions you selected for your Dedicated instance. -- The Network Load Balancer (NLB) that backs the Endpoint Service at your end must be enabled in at least one of the Availability Zones to which your Dedicated tenant was +- The Network Load Balancer (NLB) that backs the Endpoint Service at your end must be enabled in at least one of the Availability Zones to which your Dedicated instance was deployed. This is not the user-facing name such as `us-east-1a`, but the underlying [Availability Zone ID](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html). If you did not specify these during onboarding to Dedicated, you must either: - Ask for the Availability Zone IDs in the ticket you raise to enable the link and ensure the NLB is enabled in those AZs, or - Ensure the NLB has is enabled in every Availability Zone in the region. +You can view the `Reverse Private Link IAM Principal` attribute in the **Tenant Details** section of Switchboard. + To enable an Outbound Private Link: 1. [Create the Endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) through which your internal service @@ -300,7 +305,7 @@ To enable an Outbound Private Link: provide a list of DNS names that should resolve to the Private Link Endpoint. This list can be updated as needed in future. GitLab then configures the tenant instance to create the necessary Endpoint Interfaces based on the service names you provided. Any matching outbound -connections made from the tenant GitLab instance are directed through the PrivateLink into your VPC. +connections made from the tenant instance are directed through the PrivateLink into your VPC. ### Custom certificates @@ -348,7 +353,7 @@ Specify a comma separated list of IP addresses that can access your GitLab Dedic ### SAML NOTE: -GitLab Dedicated supports a limited number of SAML parameters. Parameters not shown in the configuration below are unavailable for GitLab Dedicated tenant instances. +GitLab Dedicated supports a limited number of SAML parameters. Parameters not shown in the configuration below are unavailable for GitLab Dedicated instances. Prerequisites: @@ -415,7 +420,7 @@ To activate SAML for your GitLab Dedicated instance: #### Request signing -If [SAML request signing](../../integration/saml.md#sign-saml-authentication-requests-optional) is desired, a certificate must be obtained. This certificate can be self-signed which has the advantage of not having to prove ownership of an arbitrary Common Name (CN) to a public Certificate Authority (CA)). +If [SAML request signing](../../integration/saml.md#sign-saml-authentication-requests-optional) is desired, a certificate must be obtained. This certificate can be self-signed which has the advantage of not having to prove ownership of an arbitrary Common Name (CN) to a public Certificate Authority (CA). If you choose to enable SAML request signing, the manual steps below will need to be completed before you are able to use SAML, since it requires certificate signing to happen. To enable SAML request signing, indicate on your SAML [support ticket](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=4414917877650) that you want request signing enabled. GitLab works with you on sending the Certificate Signing Request (CSR) for you to sign. Alternatively, the CSR can be signed with a public CA. After the certificate is signed, GitLab adds the certificate and its associated private key to the `security` section of the SAML configuration. Authentication requests from GitLab to your identity provider can then be signed. @@ -434,12 +439,12 @@ To enable group sync: 1. Add the [required elements](../../user/group/saml_sso/group_sync.md#configure-saml-group-sync) to the SAML configuration block you provide in your [support ticket](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=4414917877650). 1. Configure the [Group Links](../../user/group/saml_sso/group_sync.md#configure-saml-group-links). -### Add users to a tenant instance +### Add users to an instance -Tenant administrators can add Switchboard users to their tenant instance. There are two types of users: +Administrators can add Switchboard users to their GitLab Dedicated instance. There are two types of users: -- **Read only**: Users can only view tenant data. -- **Admin**: Users can edit the tenant configuration and manage users. +- **Read only**: Users can only view instance data. +- **Admin**: Users can edit the instance configuration and manage users. To add a new user to your GitLab Dedicated instance: diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 20cf9ceb7c8..dc8f93d4e7b 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -21431,6 +21431,8 @@ Defines which user roles, users, or groups can merge into a protected branch. | Name | Type | Description | | ---- | ---- | ----------- | | <a id="mergerequestallowcollaboration"></a>`allowCollaboration` | [`Boolean`](#boolean) | Indicates if members of the target project can push to the fork. | +| <a id="mergerequestallowsmultipleassignees"></a>`allowsMultipleAssignees` | [`Boolean!`](#boolean) | Allows assigning multiple users to a merge request. | +| <a id="mergerequestallowsmultiplereviewers"></a>`allowsMultipleReviewers` | [`Boolean!`](#boolean) | Allows assigning multiple reviewers to a merge request. | | <a id="mergerequestapprovalstate"></a>`approvalState` | [`MergeRequestApprovalState!`](#mergerequestapprovalstate) | Information relating to rules that must be satisfied to merge this merge request. | | <a id="mergerequestapprovalsleft"></a>`approvalsLeft` | [`Int`](#int) | Number of approvals left. | | <a id="mergerequestapprovalsrequired"></a>`approvalsRequired` | [`Int`](#int) | Number of approvals required. | @@ -24164,6 +24166,8 @@ Represents vulnerability finding of a security report on the pipeline. | <a id="projectactualrepositorysizelimit"></a>`actualRepositorySizeLimit` | [`Float`](#float) | Size limit for the repository in bytes. | | <a id="projectagentconfigurations"></a>`agentConfigurations` | [`AgentConfigurationConnection`](#agentconfigurationconnection) | Agent configurations defined by the project. (see [Connections](#connections)) | | <a id="projectallowmergeonskippedpipeline"></a>`allowMergeOnSkippedPipeline` | [`Boolean`](#boolean) | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs. | +| <a id="projectallowsmultiplemergerequestassignees"></a>`allowsMultipleMergeRequestAssignees` | [`Boolean!`](#boolean) | Project allows assigning multiple users to a merge request. | +| <a id="projectallowsmultiplemergerequestreviewers"></a>`allowsMultipleMergeRequestReviewers` | [`Boolean!`](#boolean) | Project allows assigning multiple reviewers to a merge request. | | <a id="projectapifuzzingciconfiguration"></a>`apiFuzzingCiConfiguration` | [`ApiFuzzingCiConfiguration`](#apifuzzingciconfiguration) | API fuzzing configuration for the project. | | <a id="projectarchived"></a>`archived` | [`Boolean`](#boolean) | Indicates the archived status of the project. | | <a id="projectautoclosereferencedissues"></a>`autocloseReferencedIssues` | [`Boolean`](#boolean) | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically. | diff --git a/doc/api/integrations.md b/doc/api/integrations.md index bb3f6579c58..2017b9cbec9 100644 --- a/doc/api/integrations.md +++ b/doc/api/integrations.md @@ -98,17 +98,17 @@ Parameters: | `app_store_private_key` | string | true | Apple App Store Connect private key. | | `app_store_protected_refs` | boolean | false | Set variables on protected branches and tags only. | -### Disable Apple App Store +### Disable Apple App Store Connect -Disable the Apple App Store integration for a project. Integration settings are reset. +Disable the Apple App Store Connect integration for a project. Integration settings are reset. ```plaintext DELETE /projects/:id/integrations/apple_app_store ``` -### Get Apple App Store settings +### Get Apple App Store Connect settings -Get the Apple App Store integration settings for a project. +Get the Apple App Store Connect integration settings for a project. ```plaintext GET /projects/:id/integrations/apple_app_store diff --git a/doc/ci/mobile_devops.md b/doc/ci/mobile_devops.md index e871a95d29f..4639967fb1d 100644 --- a/doc/ci/mobile_devops.md +++ b/doc/ci/mobile_devops.md @@ -338,26 +338,34 @@ To create an iOS distribution with the Apple Store integration and fastlane, you 1. Generate an API Key for App Store Connect API. In the Apple App Store Connect portal, [generate a new private key for your project](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api). -1. [Enable the Apple App Store integration](#enable-apple-app-store-integration). +1. [Enable the Apple App Store Connect integration](#enable-the-apple-app-store-connect-integration). 1. Add the release step to your pipeline and fastlane configuration. <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> -For an overview, see [Apple App Store integration demo](https://youtu.be/CwzAWVgJeK8). +For an overview, see [Apple App Store Connect integration demo](https://youtu.be/CwzAWVgJeK8). +<!-- Video published on 2023-03-17 --> -#### Enable Apple App Store Integration +#### Enable the Apple App Store Connect integration -Use the [Apple App Store integration](../user/project/integrations/apple_app_store.md) -to configure your CI/CD pipelines to connect to [App Store Connect](https://appstoreconnect.apple.com/) -to build and release apps for iOS, iPadOS, macOS, tvOS, and watchOS. To enable the integration: +Prerequisites: + +- You must have an Apple ID enrolled in the [Apple Developer Program](https://developer.apple.com/programs/enroll/). +- You must [generate a new private key](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api) for your project in the Apple App Store Connect portal. + +Use the Apple App Store Connect integration to configure your CI/CD pipelines to connect to [App Store Connect](https://appstoreconnect.apple.com). +With this integration, you can build and release apps for iOS, iPadOS, macOS, tvOS, and watchOS. + +To enable the Apple App Store Connect integration in GitLab: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > Integrations**. -1. Select **Apple App Store**. +1. Select **Apple App Store Connect**. 1. Under **Enable integration**, select the **Active** checkbox. 1. Provide the Apple App Store Connect configuration information: - - **Issuer ID**: You can find the Apple App Store Connect Issuer ID in the **Keys** section under **Users and Access** in the Apple App Store Connect portal. - - **Key ID**: The key ID of the new private key that was just generated. - - **Private Key**: The private key that was just generated. You can only download this key one time. + - **Issuer ID**: The Apple App Store Connect issuer ID. + - **Key ID**: The key ID of the generated private key. + - **Private key**: The generated private key. You can download this key only once. + - **Protected branches and tags only**: Enable to set variables on protected branches and tags only. 1. Select **Save changes**. With the integration enabled, you can use fastlane to distribute a build to TestFlight diff --git a/doc/development/img/runner_fleet_dashboard.png b/doc/ci/runners/img/runner_fleet_dashboard.png Binary files differindex 242ebf4aea9..242ebf4aea9 100644 --- a/doc/development/img/runner_fleet_dashboard.png +++ b/doc/ci/runners/img/runner_fleet_dashboard.png diff --git a/doc/ci/runners/runner_fleet_dashboard.md b/doc/ci/runners/runner_fleet_dashboard.md new file mode 100644 index 00000000000..08579f6ff92 --- /dev/null +++ b/doc/ci/runners/runner_fleet_dashboard.md @@ -0,0 +1,76 @@ +--- +stage: Verify +group: Runner +info: >- + To determine the technical writer assigned to the Stage/Group associated with + this page, see + https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- +# Runner Fleet Dashboard **(ULTIMATE)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424495) in GitLab 16.6 + +GitLab administrators can use the Runner Fleet Dashboard to assess the health of your instance runners. +The Runner Fleet Dashboard shows: + +- Recent CI errors related caused by runner infrastructure. +- Number of concurrent jobs executed on most busy runners. +- Histogram of job queue times [(available only with ClickHouse)](#enable-more-ci-analytics-features-with-clickhouse). + +![Runner Fleet Dashboard](img/runner_fleet_dashboard.png) + +## View the Runner Fleet Dashboard + +Prerequisites: + +- You must be an administrator. + +To view the runner fleet dashboard: + +1. On the left sidebar, at the bottom, select **Admin Area**. +1. Select **Runners**. +1. Click **Fleet dashboard**. + +Most of the dashboard works without any additional actions, with the +exception of **Wait time to pick a job** chart and [proposed features](#whats-next). +These features require [setting up an additional infrastructure](#enable-more-ci-analytics-features-with-clickhouse). + +## Enable more CI analytics features with ClickHouse **(ULTIMATE EXPERIMENT)** + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11180) in GitLab 16.7 behind several [feature flags](#enable-clickhouse-integration-and-features). + +This feature is an [Experiment](../../policy/experiment-beta-support.md). +To test it, we have launched an early adopters program. +To join the list of users testing this feature, contact us in +[epic 11180](https://gitlab.com/groups/gitlab-org/-/epics/11180). + +### Enable ClickHouse integration and features + +To enable additional CI analytics features: + +1. [Configure ClickHouse integration](../../integration/clickhouse.md) +1. [Enable](../../administration/feature_flags.md#how-to-enable-and-disable-features-behind-flags) the following feature flags: + + | Feature flag name | Purpose | + |------------------------------------|---------------------------------------------------------------------------| + | `ci_data_ingestion_to_click_house` | Enables synchronization of new finished CI builds to Clickhouse database. | + | `clickhouse_ci_analytics` | Enables the **Wait time to pick a job** chart. | + +<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> +For a video walkthrough, see [Setting up Runner Fleet Dashboard with ClickHouse](https://www.youtube.com/watch?v=YpGV95Ctbpk). + +### What's next + +Support for usage and cost analysis are proposed in +[epic 11183](https://gitlab.com/groups/gitlab-org/-/epics/11183). + +## Feedback + +To help us improve the Runner Fleet Dashboard, you can provide feedback in +[issue 421737](https://gitlab.com/gitlab-org/gitlab/-/issues/421737). +In particular: + +- How easy or difficult it was to setup GitLab to make the dashboard work. +- How useful you found the dashboard. +- What other information you would like to see on that dashboard. +- Any other related thoughts and ideas. diff --git a/doc/development/runner_fleet_dashboard.md b/doc/development/runner_fleet_dashboard.md index f2683785e59..77c89f2adb5 100644 --- a/doc/development/runner_fleet_dashboard.md +++ b/doc/development/runner_fleet_dashboard.md @@ -1,69 +1,11 @@ --- -stage: Verify -group: Runner -info: >- - To determine the technical writer assigned to the Stage/Group associated with - this page, see - https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +redirect_to: '../ci/runners/runner_fleet_dashboard.md' +remove_date: '2024-03-01' --- -# Runner Fleet Dashboard **(ULTIMATE EXPERIMENT)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424495) in GitLab 16.6 behind several [feature flags](../integration/clickhouse.md#enable-feature-flags). +This document was moved to [another location](../ci/runners/runner_fleet_dashboard.md). -This feature is an [Experiment](../policy/experiment-beta-support.md). -To join the list of users testing this feature, contact us in -[epic 11180](https://gitlab.com/groups/gitlab-org/-/epics/11180). - -GitLab administrators can use the Runner Fleet Dashboard to assess the health of your instance runners. -The Runner Fleet Dashboard shows: - -- Recent CI errors related caused by runner infrastructure. -- Number of concurrent jobs executed on most busy runners. -- Histogram of job queue times (available only with ClickHouse). - -There is a proposal to introduce [more features](#whats-next) to the Runner Fleet Dashboard. - -![Runner Fleet Dashboard](img/runner_fleet_dashboard.png) - -## View the Runner Fleet Dashboard - -Prerequisites: - -- You must be an administrator. - -To view the runner fleet dashboard: - -1. On the left sidebar, at the bottom, select **Admin Area**. -1. Select **Runners**. -1. Click **Fleet dashboard**. - -Most of the dashboard works without any additional actions, with the -exception of **Wait time to pick a job** chart and [proposed features](#whats-next). -These features require setting up an additional infrastructure, described in this page. - -To test the Runner Fleet Dashboard and gather feedback, we have launched an early adopters program -for some customers to try this feature. - -## Requirements - -To test the Runner Fleet Dashboard as part of the early adopters program, you must: - -- Run GitLab 16.7 or above. -- Have an [Ultimate license](https://about.gitlab.com/pricing/). -- Be able to run [ClickHouse database](../integration/clickhouse.md). We recommend using [ClickHouse Cloud](https://clickhouse.cloud/). - -## What's next - -Support for usage and cost analysis are proposed in -[epic 11183](https://gitlab.com/groups/gitlab-org/-/epics/11183). - -## Feedback - -To help us improve the Runner Fleet Dashboard, you can provide feedback in -[issue 421737](https://gitlab.com/gitlab-org/gitlab/-/issues/421737). -In particular: - -- How easy or difficult it was to setup GitLab to make the dashboard work. -- How useful you found the dashboard. -- What other information you would like to see on that dashboard. -- Any other related thoughts and ideas. +<!-- This redirect file can be deleted after <2024-03-01>. --> +<!-- 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/integration/clickhouse.md b/doc/integration/clickhouse.md index 6932df1c47e..1382488ad57 100644 --- a/doc/integration/clickhouse.md +++ b/doc/integration/clickhouse.md @@ -4,7 +4,9 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# ClickHouse integration guidelines +# ClickHouse integration guidelines **(EXPERIMENT)** + +This feature is an [Experiment](../policy/experiment-beta-support.md). Instructions about how to setup integration between GitLab and ClickHouse database. @@ -15,7 +17,6 @@ To setup ClickHouse as the GitLab data storage: 1. [Run ClickHouse Cluster and configure database](#run-and-configure-clickhouse). 1. [Configure GitLab connection to Clickhouse](#configure-the-gitlab-connection-to-clickhouse). 1. [Run ClickHouse migrations](#run-clickhouse-migrations). -1. [Enable the feature flags](#enable-feature-flags). ### Run and configure ClickHouse @@ -123,15 +124,3 @@ To create the required database objects execute: ```shell sudo gitlab-rake gitlab:clickhouse:migrate ``` - -### Enable feature flags - -Features that use ClickHouse are currently under development and are disabled by feature flags. - -To enable these features, [enable](../administration/feature_flags.md#how-to-enable-and-disable-features-behind-flags) -the following feature flags: - -| Feature flag name | Purpose | -|------------------------------------|---------------------------------------------------------------------------| -| `ci_data_ingestion_to_click_house` | Enables synchronization of new finished CI builds to Clickhouse database. | -| `clickhouse_ci_analytics` | Enables the **Wait time to pick a job** chart. | diff --git a/doc/subscriptions/gitlab_dedicated/index.md b/doc/subscriptions/gitlab_dedicated/index.md index ae4a7c2fe3f..2259f2f1aa1 100644 --- a/doc/subscriptions/gitlab_dedicated/index.md +++ b/doc/subscriptions/gitlab_dedicated/index.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # GitLab Dedicated -GitLab Dedicated is a fully isolated, single-tenant SaaS service that is: +GitLab Dedicated is a fully isolated, single-tenant SaaS solution that is: - Hosted and managed by GitLab, Inc. - Deployed on AWS in a cloud region of your choice. See [available AWS regions](#available-aws-regions). @@ -69,7 +69,7 @@ GitLab Dedicated offers the following [compliance certifications](https://about. #### Isolation -As a single-tenant SaaS service, GitLab Dedicated provides infrastructure-level isolation of your GitLab environment. Your environment is placed into a separate AWS account from other tenants. This AWS account contains all of the underlying infrastructure necessary to host the GitLab application and your data stays within the account boundary. You administer the application while GitLab manages the underlying infrastructure. Tenant environments are also completely isolated from GitLab.com. +As a single-tenant SaaS solution, GitLab Dedicated provides infrastructure-level isolation of your GitLab environment. Your environment is placed into a separate AWS account from other tenants. This AWS account contains all of the underlying infrastructure necessary to host the GitLab application and your data stays within the account boundary. You administer the application while GitLab manages the underlying infrastructure. Tenant environments are also completely isolated from GitLab.com. #### Access controls diff --git a/doc/user/project/integrations/apple_app_store.md b/doc/user/project/integrations/apple_app_store.md index 3031ae42e4d..18022fbaeb8 100644 --- a/doc/user/project/integrations/apple_app_store.md +++ b/doc/user/project/integrations/apple_app_store.md @@ -16,19 +16,20 @@ The feature is still in development, but you can: - [Report a bug](https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/feedback/-/issues/new?issuable_template=report_bug). - [Share feedback](https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/feedback/-/issues/new?issuable_template=general_feedback). -With the Apple App Store Connect integration, you can configure your CI/CD pipelines to connect to [App Store Connect](https://appstoreconnect.apple.com) to build and release apps for iOS, iPadOS, macOS, tvOS, and watchOS. +Use the Apple App Store Connect integration to configure your CI/CD pipelines to connect to [App Store Connect](https://appstoreconnect.apple.com). +With this integration, you can build and release apps for iOS, iPadOS, macOS, tvOS, and watchOS. The Apple App Store Connect integration works out of the box with [fastlane](https://fastlane.tools/). You can also use this integration with other build tools. -## Prerequisites +## Enable the integration in GitLab -An Apple ID enrolled in the [Apple Developer Program](https://developer.apple.com/programs/enroll/) is required to enable this integration. +Prerequisites: -## Configure GitLab +- You must have an Apple ID enrolled in the [Apple Developer Program](https://developer.apple.com/programs/enroll/). +- You must [generate a new private key](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api) for your project in the Apple App Store Connect portal. -GitLab supports enabling the Apple App Store Connect integration at the project level. Complete these steps in GitLab: +To enable the Apple App Store Connect integration in GitLab: -1. In the Apple App Store Connect portal, generate a new private key for your project by following [these instructions](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api). 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > Integrations**. 1. Select **Apple App Store Connect**. @@ -38,7 +39,6 @@ GitLab supports enabling the Apple App Store Connect integration at the project - **Key ID**: The key ID of the generated private key. - **Private key**: The generated private key. You can download this key only once. - **Protected branches and tags only**: Enable to set variables on protected branches and tags only. - 1. Select **Save changes**. After you enable the integration: diff --git a/doc/user/project/pages/index.md b/doc/user/project/pages/index.md index d658a09e760..00dfe0c66d9 100644 --- a/doc/user/project/pages/index.md +++ b/doc/user/project/pages/index.md @@ -226,7 +226,7 @@ Some other examples of mixing [variables](../../../ci/variables/index.md) with s ### Use multiple deployments to create pages environments -You can use multiple GitLap Pages deployments to create a new [environment](../../../ci/environments/index.md). +You can use multiple GitLab Pages deployments to create a new [environment](../../../ci/environments/index.md). For example: ```yaml diff --git a/doc/user/project/repository/code_suggestions/index.md b/doc/user/project/repository/code_suggestions/index.md index 875b72354e4..3be54ad39f1 100644 --- a/doc/user/project/repository/code_suggestions/index.md +++ b/doc/user/project/repository/code_suggestions/index.md @@ -19,7 +19,9 @@ Write code more efficiently by using generative AI to suggest code while you're With Code Suggestions, you get: - Code Completion, which suggests completions to the current line you are typing. These suggestions are usually low latency. -- Code Generation, which generates code based on a natural language code comment block. +- Code Generation, which generates code based on a natural language code + comment block. Write a comment like `# Type more here` to generate the + appropriate code, based on the context of your comment and the rest of your code. - Algorithms or large code blocks may take more than 10 seconds to generate. - Streaming of code generation responses is supported in VS Code, leading to faster average response times. Other supported IDEs offer slower response times and will return the generated code in a single block. @@ -53,7 +55,11 @@ For languages not listed in the following table, Code Suggestions might not func ### Supported languages in IDEs -Editor support for languages is documented in the following table. +Code Suggestions is aware of common popular programming concepts and +infrastructure-as-code interfaces, like Kubernetes Resource Model (KRM), +Google Cloud CLI, and Terraform. + +The editor supports these languages: | Language | VS Code | JetBrains IDEs | Visual Studio | Neovim | |------------------|------------------------|------------------------|------------------------|--------| @@ -71,8 +77,6 @@ Editor support for languages is documented in the following table. | Scala | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | Swift | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | TypeScript | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| Google Cloud | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | -| Kubernetes Resource Model (KRM) | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | | Terraform | **{check-circle}** Yes (Requires third-party extension providing Terraform support) | **{check-circle}** Yes | **{dotted-circle}** No | **{check-circle}** Yes (Requires third-party extension providing the `terraform` file type) | NOTE: diff --git a/doc/user/project/service_desk/configure.md b/doc/user/project/service_desk/configure.md index 91dbe7a38dd..87cdf795dd1 100644 --- a/doc/user/project/service_desk/configure.md +++ b/doc/user/project/service_desk/configure.md @@ -165,6 +165,7 @@ the assignees of the issue and creates to-do items for them. <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> For a walkthrough, see [a short showcase video](https://youtu.be/163wDM1e43o). +<!-- Video published on 2023-12-12 --> Prerequisites: @@ -191,6 +192,7 @@ Maintain brand identity and instill confidence among support requesters with a d <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> For an overview, see [a short showcase video](https://youtu.be/_moD5U3xcQs). +<!-- Video published on 2023-09-12 --> This feature is in [Beta](../../../policy/experiment-beta-support.md#beta). A Beta feature is not production-ready, but is unlikely to change drastically diff --git a/doc/user/project/service_desk/index.md b/doc/user/project/service_desk/index.md index 0a76915b3fa..6a15b9798f7 100644 --- a/doc/user/project/service_desk/index.md +++ b/doc/user/project/service_desk/index.md @@ -16,6 +16,7 @@ through email. <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> For a video overview, see [Introducing GitLab Service Desk (GitLab 16.7)](https://www.youtube.com/watch?v=LDVQXv3I5rI). +<!-- Video published on 2023-12-19 --> ## Service Desk workflow |