From 9fd2f2bdbe30a4d7ecae50eb5dd7c08ecf042767 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 29 Aug 2024 09:34:55 +0100 Subject: [PATCH] Further changes following PO Review --- .../cloud/grafana/upgrade-promtail.md | 21 +++++-------------- .../on-premise/grafana/prerequisites.md | 2 +- .../on-premise/grafana/upgrade-grafana.md | 6 +++--- .../on-premise/grafana/upgrade-loki.md | 20 +++++------------- .../on-premise/grafana/upgrade-promtail.md | 21 +++++-------------- 5 files changed, 19 insertions(+), 51 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/upgrade-promtail.md index 4634ade5b..2b1377913 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/upgrade-promtail.md @@ -16,21 +16,15 @@ These steps will need to be performed on all application servers that host a Pro {{% / alert %}} 1. Log in to the application server. -1. In file explorer, navigate to the extracted Grafana install folder performed as part of [Make Artefacts Available][]. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the Promtail folder by executing the following command: - - ``` powershell - cd C:\Promtail - ``` - +1. Change the directory to the folder where Promtail is running from, e.g. `CD C:\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell .\Remove-Promtail.ps1 ``` -1. Open a File Explorer and navigate to `C:\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -42,9 +36,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted Promtail folder performed as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the `C:\Promtail` directory. +1. Copy the `promtail-windows-amd64.exe` file into the folder that promtail was previously running from, e.g. `C:\Promtail`. 1. In File Explorer, navigate to the extracted Promtail Install folder performed as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the `C:\Promtail` directory. +1. Copy the contents of this location into the folder that promtail was previously running from, e.g. `C:\Promtail`. 1. Open promtail-local-config.yaml in a text editor and compare against the [backed up][] version: * Update the filename property to the value found in the [backed up][] version. @@ -52,12 +46,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new promtail-local-config.yaml file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the Promtail folder by executing the following command: - - ``` powershell - cd C:\Promtail - ``` - +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `CD C:\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/prerequisites.md index 13f1d9e5d..d34438c7d 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/prerequisites.md @@ -37,7 +37,7 @@ weight: 1 ## Backup Old Files 1. On the server that Grafana and Loki is installed on, create a folder called `Observability Backups` in a known location. -1. Open File Explorer and navigate to the location that Grafana was installed to, e.g. `C:\Program Files\GrafanaLabs\grafana\conf\`. +1. Open File Explorer and navigate to the location that Grafana was previously installed to, e.g. `%SystemDrive%\Program Files\GrafanaLabs\grafana\conf`. 1. Copy the `custom.ini` file and save it to the `Observability Backups` folder created at step 1. 1. Copy the `defaults.ini` file and save it to the `Observability Backups` folder created at step 1. 1. In File Explorer, navigate to the location that Loki is running from, e.g. `C:\Loki\`. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md index e8439df64..656fc1d33 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md @@ -14,10 +14,10 @@ This guide describes how to upgrade the Grafana installation. Please ensure that 1. Log in to the server hosting your Grafana website. 1. Open Services.msc from the Start menu. 1. Locate the Grafana service and stop it by right-clicking on the service and selecting `Stop`. -1. In file explorer, navigate to the extracted Grafana install folder performed as part of [Make Artefacts Available][]. +1. In file explorer, navigate to the extracted Grafana Installation folder performed as part of [Make Artefacts Available][]. 1. Open the `Grafana-v10.4.1` folder. -1. Copy the contents of `Grafana-v10.4.1` into the `C:\Program Files\GrafanaLabs\grafana` directory, and click `Replace all existing files` when prompted. -1. Copy the [backed up][] custom.ini and defaults.ini files into the `C:\Program Files\GrafanaLabs\grafana` directory, and click `Replace all existing files` when prompted. +1. Copy the contents of `Grafana-v10.4.1` into the Grafana install location, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana`, and click `Replace all existing files` when prompted. +1. Copy the [backed up][] custom.ini and defaults.ini files into the Grafana install location, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana`, and click `Replace all existing files` when prompted. 1. Open Services.msc from the Start menu. 1. Locate the Grafana service and start it by right-clicking on the service and selecting `Start`. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-loki.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-loki.md index 90df5d355..09064c1eb 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-loki.md @@ -13,19 +13,14 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. Log in to the server hosting your Loki service. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the Loki folder by executing the following command: - - ``` powershell - cd C:\Loki - ``` - +1. Change the directory to the folder where Loki is running from, e.g. `CD C:\Loki`. 1. Remove the current Loki installation by executing the following command: ``` powershell .\Remove-Loki.ps1 ``` -1. Open a File Explorer and navigate to `C:\Loki` +1. Open a File Explorer and navigate to the folder where Loki is running from, e.g. `C:\Loki`. 1. Delete the following files from the directory: * Install-Loki.ps1 @@ -37,9 +32,9 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Stop-Loki.ps1 1. In File Explorer, navigate to the extracted Grafana Loki folder performed as part of [Make Artefacts Available][]. -1. Copy the `loki-windows-amd64.exe` file into the `C:\Loki` directory. +1. Copy the `loki-windows-amd64.exe` file into the folder that Loki was previously running from, e.g. `C:\Loki`. 1. In File Explorer, navigate to the extracted Grafana Loki Install folder performed as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the `C:\Loki` directory. +1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\Loki`. 1. Open loki-local-config.yaml in a text editor and compare against the [backed up][] version: * The data for Grafana dashboards is defined under schema_config. @@ -48,12 +43,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Save the new loki-local-config.yaml file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the Loki folder by executing the following command: - - ``` powershell - cd C:\Loki - ``` - +1. Change the directory to the folder where the Loki files have been copied to, e.g. `CD C:\Loki`. 1. Install Loki by executing the following command: ``` powershell diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md index a815f3d25..cd9bb7158 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md @@ -16,21 +16,15 @@ These steps will need to be performed on all application servers that host a Pro {{% / alert %}} 1. Log in to the application server. -1. In file explorer, navigate to the extracted Grafana install folder performed as part of [Make Artefacts Available][]. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the Promtail folder by executing the following command: - - ``` powershell - cd C:\Promtail - ``` - +1. Change the directory to the folder where Promtail is running from, e.g. `CD C:\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell .\Remove-Promtail.ps1 ``` -1. Open a File Explorer and navigate to `C:\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -42,9 +36,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted Promtail folder performed as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the `C:\Promtail` directory. +1. Copy the `promtail-windows-amd64.exe` file into the folder that promtail was previously running from, e.g. `C:\Promtail`. 1. In File Explorer, navigate to the extracted Promtail Install folder performed as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the `C:\Promtail` directory. +1. Copy the contents of this location into the folder that promtail was previously running from, e.g. `C:\Promtail`. 1. Open promtail-local-config.yaml in text editor and compare against the [backed up][] version: * Update the filename property to the value found in the [backed up][] version. @@ -52,12 +46,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new promtail-local-config.yaml file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the Promtail folder by executing the following command: - - ``` powershell - cd C:\Promtail - ``` - +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `CD C:\Promtail`. 1. Install Promtail by executing the following command: ``` powershell