From fad7fd458659a61b4be4e03da69461c6826b4655 Mon Sep 17 00:00:00 2001 From: Evan Read <eread@gitlab.com> Date: Thu, 5 Oct 2023 14:09:29 +1000 Subject: [PATCH] Update docs for the removal of bundled Grafana --- .../performance/grafana_configuration.md | 14 +++++++++----- doc/update/versions/gitlab_16_changes.md | 11 +++++------ 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/doc/administration/monitoring/performance/grafana_configuration.md b/doc/administration/monitoring/performance/grafana_configuration.md index ba0fed0fac186..a69eb67e77e78 100644 --- a/doc/administration/monitoring/performance/grafana_configuration.md +++ b/doc/administration/monitoring/performance/grafana_configuration.md @@ -14,8 +14,7 @@ series metrics through graphs and dashboards. GitLab writes performance data to and Grafana allows you to query the data to display graphs. WARNING: -Grafana bundled with GitLab was deprecated GitLab 16.0 and removed in GitLab 16.3. -For more information, see [deprecation notes](#deprecation-of-bundled-grafana). +Grafana bundled with GitLab was deprecated GitLab 16.0 and [removed](#grafana-bundled-with-gitlab-removed) in GitLab 16.3. ## Import GitLab dashboards @@ -65,12 +64,15 @@ configuration screen: - No scopes appear. - The `read_user` scope is included. -## Deprecation of bundled Grafana +<!--- start_remove The following content will be removed on remove_date: '2023-12-22' --> -Bundled Grafana was an optional service for Linux package installations that provided a user interface to GitLab metrics. +## Grafana bundled with GitLab (removed) + +Grafana bundled with GitLab was an optional service for Linux package installations that provided a user interface to +GitLab metrics. The version of Grafana that is bundled with Linux package installations is no longer supported. If you're using the -bundled Grafana, you should switch to a newer version from [Grafana Labs](https://grafana.com/grafana/). +Grafana that came bundled with GitLab, you should switch to a newer version from [Grafana Labs](https://grafana.com/grafana/). ### Switch to new Grafana instance @@ -80,3 +82,5 @@ To switch away from bundled Grafana to a newer version of Grafana from Grafana L 1. [Export the existing dashboards](https://grafana.com/docs/grafana/latest/dashboards/manage-dashboards/#export-a-dashboard) from bundled Grafana. 1. [Import the existing dashboards](https://grafana.com/docs/grafana/latest/dashboards/manage-dashboards/#import-a-dashboard) in the new Grafana instance. 1. [Configure GitLab](#integrate-with-gitlab-ui) to use the new Grafana instance. + +<!--- end_remove --> diff --git a/doc/update/versions/gitlab_16_changes.md b/doc/update/versions/gitlab_16_changes.md index 19b2edb5de67c..11ec566e8c937 100644 --- a/doc/update/versions/gitlab_16_changes.md +++ b/doc/update/versions/gitlab_16_changes.md @@ -84,9 +84,9 @@ For more information about upgrading GitLab Helm Chart, see [the release notes f ## 16.3.0 -- **Update to GitLab 16.3.5 or later**. This avoids [issue 425971](https://gitlab.com/gitlab-org/gitlab/-/issues/425971) that causes an excessive use of database disk space for GitLab 16.3.3 and 16.3.4. +- **Update to GitLab 16.3.5 or later**. This avoids [issue 425971](https://gitlab.com/gitlab-org/gitlab/-/issues/425971) that causes an excessive use of database disk space for GitLab 16.3.3 and 16.3.4. -- A unique index was added to ensure that there’s no duplicate NPM packages in the database. If you have duplicate NPM packages, you need to upgrade to 16.1 first, or you are likely to run into the following error: `PG::UniqueViolation: ERROR: could not create unique index "idx_packages_on_project_id_name_version_unique_when_npm"`. +- A unique index was added to ensure that there's no duplicate NPM packages in the database. If you have duplicate NPM packages, you need to upgrade to 16.1 first, or you are likely to run into the following error: `PG::UniqueViolation: ERROR: could not create unique index "idx_packages_on_project_id_name_version_unique_when_npm"`. - For Go applications, [`crypto/tls`: verifying certificate chains containing large RSA keys is slow (CVE-2023-29409)](https://github.com/golang/go/issues/61460) introduced a hard limit of 8192 bits for RSA keys. In the context of Go applications at GitLab, RSA keys can be configured for: @@ -293,10 +293,9 @@ Specific information applies to Linux package installations: Prior to upgrading, administrators of Linux package installations must ensure the installation is using [PostgreSQL 13](https://docs.gitlab.com/omnibus/settings/database.html#upgrade-packaged-postgresql-server). -- Bundled Grafana is deprecated and is no longer supported. It is removed in GitLab 16.3. - - For more information, see [deprecation notes](../../administration/monitoring/performance/grafana_configuration.md#deprecation-of-bundled-grafana). - +- Grafana that was bundled with GitLab is deprecated and is no longer supported. It is + [removed](../../administration/monitoring/performance/grafana_configuration.md#grafana-bundled-with-gitlab-removed) in + GitLab 16.3. - This upgrades `openssh-server` to `1:8.9p1-3`. Using `ssh-keyscan -t rsa` with older OpenSSH clients to obtain public key information is no longer viable because of -- GitLab