From f38469e8649b56aa17528ff652238ee46253ede3 Mon Sep 17 00:00:00 2001 From: Jan Wozniak Date: Fri, 3 Nov 2023 21:03:05 +0100 Subject: [PATCH] Fix typos in helm chart upgrade guide (#11128) **What this PR does / why we need it**: There are known deficiencies in the loki helm chart upgrade guide from `2.x` to `3.x` - https://github.com/grafana/loki/issues/9427. As a first step, I would like to propose fixing few typos. **Which issue(s) this PR fixes**: See also: https://github.com/grafana/loki/issues/9427 **Special notes for your reviewer**: **Checklist** - [x] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [X] Documentation added - [X] Changes that require user attention or interaction to upgrade are documented in `docs/sources/setup/upgrade/_index.md` Signed-off-by: Jan Wozniak Co-authored-by: J Stickler --- docs/sources/setup/upgrade/upgrade-from-2x/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/sources/setup/upgrade/upgrade-from-2x/index.md b/docs/sources/setup/upgrade/upgrade-from-2x/index.md index fc608376fede4..94b37a952cfc2 100644 --- a/docs/sources/setup/upgrade/upgrade-from-2x/index.md +++ b/docs/sources/setup/upgrade/upgrade-from-2x/index.md @@ -12,18 +12,18 @@ keywords: ## Upgrading from v2.x -v3.x represents a major milestone for this chart, showing a committment by the Loki team to provide a better supported, scalable helm chart. +v3.x represents a major milestone for this chart, showing a commitment by the Loki team to provide a better supported, scalable helm chart. In addition to moving the source code for this helm chart into the Loki repo itself, it also combines what were previously two separate charts, -[`grafana/loki`](https://github.com/grafana/helm-charts/tree/main/charts/loki) and [`grafana/loki-simple-scalable`](https://github.com/grafana/helm-charts/tree/main/charts/loki-simple-scalable) into one chart. This chart will automatically assume the "Single Binary" mode previously deployed by the `grafana/loki` chart if you are using a filesystem backend, and will assume the "Scalable" mode previoulsy deployed by the `grafana/loki-simple-scalable` chart if you are using an object storage backend. +[`grafana/loki`](https://github.com/grafana/helm-charts/tree/main/charts/loki) and [`grafana/loki-simple-scalable`](https://github.com/grafana/helm-charts/tree/main/charts/loki-simple-scalable) into one chart. This chart will automatically assume the "Single Binary" mode previously deployed by the `grafana/loki` chart if you are using a filesystem backend, and will assume the "Scalable" mode previously deployed by the `grafana/loki-simple-scalable` chart if you are using an object storage backend. As a result of this major change, upgrades from the charts this replaces might be difficult. We are attempting to support the 3 most common upgrade paths. 1. Upgrade from `grafana/loki` using local `filesystem` storage - 1. Upgrade from `grafana/loki-simple-scalable` using a cloud based object storage such as S3 or GCS, or an api compatible equivilent like MinIO. + 1. Upgrade from `grafana/loki-simple-scalable` using a cloud based object storage such as S3 or GCS, or an api compatible equivalent like MinIO. ### Upgrading from `grafana/loki` -The default installation of `grafana/loki` is a single instance backed by `filesystem` storage that is not highly available. As a result, this upgrade method will involve downtime. The upgrade will involve deleting the previously deployed loki stateful set, the running the `helm upgrade` which will create the new one with the same name, which should attach to the existing PVC or ephemeral storage, thus preserving you data. Will still highly recommend backing up all data before conducting the upgrade. +The default installation of `grafana/loki` is a single instance backed by `filesystem` storage that is not highly available. As a result, this upgrade method will involve downtime. The upgrade will involve deleting the previously deployed loki stateful set, the running the `helm upgrade` which will create the new one with the same name, which should attach to the existing PVC or ephemeral storage, thus preserving you data. We still highly recommend backing up all data before conducting the upgrade. To upgrade, you will need at least the following in your `values.yaml`: @@ -35,7 +35,7 @@ loki: type: 'filesystem' ``` -You will need to 1. Update the grafana helm repo, 2. delete the exsiting stateful set, and 3. upgrade making sure to have the values above included in your `values.yaml`. If you installed `grafana/loki` as `loki` in namespace `loki`, the commands would be: +You will need to 1. Update the grafana helm repo, 2. delete the existing stateful set, and 3. upgrade making sure to have the values above included in your `values.yaml`. If you installed `grafana/loki` as `loki` in namespace `loki`, the commands would be: ```console helm repo update grafana