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/ci | |
parent | 6323146895db2be6f04846b3c98060b7349207b9 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/ci')
-rw-r--r-- | doc/ci/mobile_devops.md | 28 | ||||
-rw-r--r-- | doc/ci/runners/img/runner_fleet_dashboard.png | bin | 0 -> 38440 bytes | |||
-rw-r--r-- | doc/ci/runners/runner_fleet_dashboard.md | 76 |
3 files changed, 94 insertions, 10 deletions
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/ci/runners/img/runner_fleet_dashboard.png b/doc/ci/runners/img/runner_fleet_dashboard.png Binary files differnew file mode 100644 index 00000000000..242ebf4aea9 --- /dev/null +++ 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. |