From 7e0caf6b77e797170f63d0a7ff31283e811e277e Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 22 Aug 2024 13:36:32 +0100 Subject: [PATCH 01/15] added initial structure for observability upgrade --- .../Guides/upgrade-observability/_index.md | 6 ++++ .../upgrade-observability/cloud/_index.md | 6 ++++ .../cloud/pre-requisites.md | 10 ++++++ .../upgrade-observability/cloud/try-it-out | 11 ++++++ .../cloud/upgrade-promtail.md | 35 ++++++++++++++++++ .../on-premise/_index.md | 6 ++++ .../on-premise/pre-requisites.md | 23 ++++++++++++ .../on-premise/try-it-out | 11 ++++++ .../on-premise/upgrade-grafana.md | 25 +++++++++++++ .../on-premise/upgrade-loki.md | 36 +++++++++++++++++++ .../on-premise/upgrade-promtail.md | 35 ++++++++++++++++++ 11 files changed, 204 insertions(+) create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/_index.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/cloud/pre-requisites.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/on-premise/pre-requisites.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/_index.md new file mode 100644 index 000000000..8faaea3a2 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/_index.md @@ -0,0 +1,6 @@ +--- +title: "Upgrade Observability" +linkTitle: "Upgrade Observability" +description: "Information about upgrading your observability platform for {{% ctx %}}." +weight: 1000 +--- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md new file mode 100644 index 000000000..503182482 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md @@ -0,0 +1,6 @@ +--- +title: "Upgrade a cloud hosted Observability platform" +linkTitle: "Upgrade a cloud hosted Observability platform" +description: "A guide to upgrade a cloud hosted observability platform for {{% ctx %}}." +weight: 1000 +--- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/pre-requisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/pre-requisites.md new file mode 100644 index 000000000..ac4153abc --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/pre-requisites.md @@ -0,0 +1,10 @@ +--- +title: "Prerequisites" +linkTitle: "Prerequisites" +description: "The pre-requisites required before performing the Observability upgrade." +weight: 1 +--- + +Download the Promtail X.X.X Archive from the CORTEX Product Documentation. + +Extract the promtail-windows-amd64.exe zip to your downloads folder diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out new file mode 100644 index 000000000..c3927d3b3 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out @@ -0,0 +1,11 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out the observability platform after upgrade." +weight: 3 +--- + +Navigate to https://v-demoaux1.demo.wearecortex.com:3000 and login with the Grafana Administrator credentials. +Under Starred Dashboards, click on the Flow Execution Requests dashboard +In the top right, set the time period to the Last 90 days. +If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md new file mode 100644 index 000000000..32a664814 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md @@ -0,0 +1,35 @@ +--- +title: "Upgrade Promtail" +linkTitle: "Upgrade Promtail" +description: "The steps to upgrade Promtail." +weight: 2 +--- + +RDP to V-APPX +Open File Explorer and navigate to C:\Promtail\ +Backup promtail-local-config.yaml to a secure location. +Open PowerShell as Administrator in the C:\Promtail\ directory +Run the Remove-Promtail.ps1 script by executing .\Remove-Promtail.ps1 +Remove all files from the C:\Promtail\ directory except log files and tmp directory. This includes: +Install-Promtail.ps1 +nssm.exe +Promtail-local-config.yaml +Promtail-windows-amd64.exe +Remove-Promtail.ps1 +Start-Promtail.ps1 +Stop-Promtail.ps1 +In a browser on V-APPX, navigate to the CORTEX Product Documentation and find the Promtail install instructions for your version of CORTEX. +Download the Promtail X.X.X Archive from the CORTEX Product Documentation. +Extract the promtail-windows-amd64.exe zip to your downloads folder +Open the unzipped promtail-windows-amd64.exe directory and copy to executable to C:\Promtail\ +Download the Promtail Install.zip Archive from the CORTEX Product Documentation. +Extract the Promtail.Install.zip to your downloads folder. +Open the unzipped Promtail.Install.zip directory and copy its contents to C:\Promtail +Open the promtail-local-config.yaml and compare against the backup made in Step 3. +Update the filename property to the correct location (e.g. c:/Promtail/tmp/positions.yaml) +Update the clients URL property to the value found in the backup. +Save your changes +Open PowerShell as Administrator in the C:\Promtail\ directory +Run the Install-Promtail.ps1 script by executing .\Install-Promtail.ps1 +Run the Start-Promtail.ps1 script by executing .\Start-Promtail.ps1 +Open services.msc and confirm the Promtail service exists and has started. \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md new file mode 100644 index 000000000..bbfc43842 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md @@ -0,0 +1,6 @@ +--- +title: "Upgrade an on-premise Observability platform" +linkTitle: "Upgrade an on-premise Observability platform" +description: "A guide to upgrade an on-premise observability platform for {{% ctx %}}." +weight: 1000 +--- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/pre-requisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/pre-requisites.md new file mode 100644 index 000000000..0cd6bfbc0 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/pre-requisites.md @@ -0,0 +1,23 @@ +--- +title: "Prerequisites" +linkTitle: "Prerequisites" +description: "The pre-requisites required before performing the Observability upgrade." +weight: 1 +--- + +Navigate to https://v-demoaux1.demo.wearecortex.com:3000 note the version number under the login prompt. +This will be for comparison after completing the Grafana upgrade. + +Using credentials from password vault, login to Grafana. +Navigate to the Flow Execution Requests dashboard, set the timeframe to the last 90 days and confirm data is present. - screenshot the dashboard for reference to confirm the upgrade later on + + +Click Grafana.X.X.X in the CORTEX Product Documentation and download the Standalone Windows Binaries from the Grafana download page. + +Download the Grafana Loki X.X.X Archive from the CORTEX Product Documentation. + +Download the Promtail X.X.X Archive from the CORTEX Product Documentation. + +Extract grafana-enterprise-X.X.X.windows-amd64.zip to your downloads folder +Extract the loki-windows-amd64.exe zip to your downloads folder. +Extract the promtail-windows-amd64.exe zip to your downloads folder diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out new file mode 100644 index 000000000..157e02f51 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out @@ -0,0 +1,11 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out the observability platform after upgrade." +weight: 5 +--- + +Navigate to https://v-demoaux1.demo.wearecortex.com:3000 and login with the Grafana Administrator credentials. +Under Starred Dashboards, click on the Flow Execution Requests dashboard +In the top right, set the time period to the Last 90 days. +If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md new file mode 100644 index 000000000..9d86f2d5e --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md @@ -0,0 +1,25 @@ +--- +title: "Upgrade Grafana" +linkTitle: "Upgrade Grafana" +description: "The steps to upgrade Grafana." +weight: 2 +--- + +RDP to V-DEMOAUX1 +Navigate to https://v-demoaux1.demo.wearecortex.com:3000 note the version number under the login prompt. +This will be for comparison after completing the Grafana upgrade. +Using credentials from password vault, login to Grafana. +Navigate to the Flow Execution Requests dashboard, set the timeframe to the last 90 days and confirm data is present. +Open File Explorer and navigate to C:\Program Files\GrafanaLabs\grafana\conf\ +Backup custom.ini and defaults.ino to a secure location. +Open Services.msc from your Start-menu and stop the Grafana service. +In a browser on V-DEMOAUX1, navigate to the CORTEX Product Documentation on and find the Grafana install instructions for your version of CORTEX. +Click Grafana.X.X.X in the CORTEX Product Documentation and download the Standalone Windows Binaries from the Grafana download page. +Extract grafana-enterprise-X.X.X.windows-amd64.zip to your downloads folder +This zip file contains many small files, stressing the IOPS of the disk. Extraction can take a couple minutes and will show slow speeds when handling many small files. +Open the unzipped grafana-enteprise-X.X.X.windows-amd64 directory and open grafana-vX.X.X directory. +Copy the contents of grafana-vX.X.X into C:\Program Files\GrafanaLabs\grafana directory, and click Replace all existing files in the prompt. +These instructions were taken from Grafana's website here: https://grafana.com/docs/grafana/latest/upgrade-guide/upgrade-v10.4/#windows +Ensure that custom.ini and defaults.ini are unchanged in the C:\Program Files\GrafanaLabs\grafana\conf directory. +Start the Grafana service. +To confirm Grafana has updated, navigate to https://v-demoaux1.demo.wearecortex.com:3000 and confirm the version number changed on the login screen. \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md new file mode 100644 index 000000000..9eb59929e --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md @@ -0,0 +1,36 @@ +--- +title: "Upgrade Loki" +linkTitle: "Upgrade Loki" +description: "The steps to upgrade Loki." +weight: 3 +--- + +RDP to V-DEMOAUX1 +Open File Explorer and navigate to C:\Loki\ +Backup loki-local-config.yaml to a secure location. +Open PowerShell as Administrator in the C:\Loki\ directory +Run the Remove-Loki.ps1 script by executing .\Remove-Loki.ps1 +Remove all files from the C:\Loki\ directory except log files. This includes: +Install-Loki.ps1 +loki-local-config.yaml +loki-windows-amd64.exe +nssm.exe +Remove-Loki.ps1 +Start-Loki.ps1 +Stop-Loki.ps1 +In a browser on V-DEMOAUX1, navigate to the CORTEX Product Documentation and find the Loki install instructions for your version of CORTEX. +Download the Grafana Loki X.X.X Archive from the CORTEX Product Documentation. +Extract the loki-windows-amd64.exe zip to your downloads folder. +Open the unzipped loki-windows-amd64.exe directory and copy the executable to C:\Loki\ +Download the Grafana Loki Install.zip Archive from the CORTEX Product Documentation +Extract the Grafana.Loki.Install.zip zip to your downloads folder. +Open the unzipped Grafana.Loki.Install.zip directory and copy its contents to C:\Loki\ +Open loki-local-config.yaml in Notepad++ and compare against the backup made in step 3. +The data for Grafana dashboards is defined under schema_config. +If there are differences under schema_config, copy the config from the backup and put it directly under configs in schema_config. Ensure the formatting is identical to whats already found in the file. +Update the pre-existing schema_config entry in the new loki-local-config.yaml file to start from todays date. +Save your changes +Open PowerShell as Administrator in the C:\Loki\ directory. +Run the Install-Loki.ps1 script by executing .\Install-Loki.ps1 +Run the Start-Loki.ps1 script by executing .\Start-Loki.ps1 +Open services.msc and confirm the Loki service exists and has started. \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md new file mode 100644 index 000000000..ff3314cd3 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md @@ -0,0 +1,35 @@ +--- +title: "Upgrade Promtail" +linkTitle: "Upgrade Promtail" +description: "The steps to upgrade Promtail." +weight: 4 +--- + +RDP to V-APPX +Open File Explorer and navigate to C:\Promtail\ +Backup promtail-local-config.yaml to a secure location. +Open PowerShell as Administrator in the C:\Promtail\ directory +Run the Remove-Promtail.ps1 script by executing .\Remove-Promtail.ps1 +Remove all files from the C:\Promtail\ directory except log files and tmp directory. This includes: +Install-Promtail.ps1 +nssm.exe +Promtail-local-config.yaml +Promtail-windows-amd64.exe +Remove-Promtail.ps1 +Start-Promtail.ps1 +Stop-Promtail.ps1 +In a browser on V-APPX, navigate to the CORTEX Product Documentation and find the Promtail install instructions for your version of CORTEX. +Download the Promtail X.X.X Archive from the CORTEX Product Documentation. +Extract the promtail-windows-amd64.exe zip to your downloads folder +Open the unzipped promtail-windows-amd64.exe directory and copy to executable to C:\Promtail\ +Download the Promtail Install.zip Archive from the CORTEX Product Documentation. +Extract the Promtail.Install.zip to your downloads folder. +Open the unzipped Promtail.Install.zip directory and copy its contents to C:\Promtail +Open the promtail-local-config.yaml and compare against the backup made in Step 3. +Update the filename property to the correct location (e.g. c:/Promtail/tmp/positions.yaml) +Update the clients URL property to the value found in the backup. +Save your changes +Open PowerShell as Administrator in the C:\Promtail\ directory +Run the Install-Promtail.ps1 script by executing .\Install-Promtail.ps1 +Run the Start-Promtail.ps1 script by executing .\Start-Promtail.ps1 +Open services.msc and confirm the Promtail service exists and has started. \ No newline at end of file From f5a10e27a532522e22896359a6759f84f5041512 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 22 Aug 2024 15:39:50 +0100 Subject: [PATCH 02/15] modified structure and added initial links --- .../upgrade-observability/cloud/_index.md | 6 +++--- .../{pre-requisites.md => prerequisites.md} | 10 ++++++++++ .../cloud/{try-it-out => try-it-out.md} | 8 ++++++-- .../cloud/upgrade-promtail.md | 12 +++++++++++- .../upgrade-observability/on-premise/_index.md | 6 +++--- .../{pre-requisites.md => prerequisites.md} | 11 +++++++++++ .../on-premise/{try-it-out => try-it-out.md} | 6 +++++- .../on-premise/upgrade-grafana.md | 12 +++++++++++- .../on-premise/upgrade-loki.md | 12 +++++++++++- .../on-premise/upgrade-promtail.md | 12 +++++++++++- data/urls.toml | 17 +++++++++++++++-- 11 files changed, 97 insertions(+), 15 deletions(-) rename content/en/docs/2024.7/Guides/upgrade-observability/cloud/{pre-requisites.md => prerequisites.md} (61%) rename content/en/docs/2024.7/Guides/upgrade-observability/cloud/{try-it-out => try-it-out.md} (77%) rename content/en/docs/2024.7/Guides/upgrade-observability/on-premise/{pre-requisites.md => prerequisites.md} (83%) rename content/en/docs/2024.7/Guides/upgrade-observability/on-premise/{try-it-out => try-it-out.md} (88%) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md index 503182482..b8e1c498c 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md @@ -1,6 +1,6 @@ --- -title: "Upgrade a cloud hosted Observability platform" -linkTitle: "Upgrade a cloud hosted Observability platform" -description: "A guide to upgrade a cloud hosted observability platform for {{% ctx %}}." +title: "Upgrade Cloud hosted platform" +linkTitle: "Upgrade Cloud hosted platform" +description: "Information about upgrading a Cloud hosted observability platform for {{% ctx %}}." weight: 1000 --- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/pre-requisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md similarity index 61% rename from content/en/docs/2024.7/Guides/upgrade-observability/cloud/pre-requisites.md rename to content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md index ac4153abc..10b81dee2 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/pre-requisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md @@ -5,6 +5,16 @@ description: "The pre-requisites required before performing the Observability up weight: 1 --- +# {{% param title %}} + +## Make Artefacts Available + Download the Promtail X.X.X Archive from the CORTEX Product Documentation. Extract the promtail-windows-amd64.exe zip to your downloads folder + +## Next Steps? + +1. [Upgrade Promtail][] + +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.UpgradePromtail" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md similarity index 77% rename from content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out rename to content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md index c3927d3b3..518ec28f9 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md @@ -1,11 +1,15 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out the observability platform after upgrade." +description: "Information about trying out the Observability platform after upgrade." weight: 3 --- +# {{% param title %}} + +## Test upgraded Observability platform + Navigate to https://v-demoaux1.demo.wearecortex.com:3000 and login with the Grafana Administrator credentials. Under Starred Dashboards, click on the Flow Execution Requests dashboard In the top right, set the time period to the Last 90 days. -If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. \ No newline at end of file +If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md index 32a664814..085190f0c 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md @@ -5,6 +5,10 @@ description: "The steps to upgrade Promtail." weight: 2 --- +# {{% param title %}} + +## Perform Upgrade + RDP to V-APPX Open File Explorer and navigate to C:\Promtail\ Backup promtail-local-config.yaml to a secure location. @@ -32,4 +36,10 @@ Save your changes Open PowerShell as Administrator in the C:\Promtail\ directory Run the Install-Promtail.ps1 script by executing .\Install-Promtail.ps1 Run the Start-Promtail.ps1 script by executing .\Start-Promtail.ps1 -Open services.msc and confirm the Promtail service exists and has started. \ No newline at end of file +Open services.msc and confirm the Promtail service exists and has started. + +## Next Steps? + +1. [Try it out][] + +[Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.TryItOut" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md index bbfc43842..6144b1e72 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md @@ -1,6 +1,6 @@ --- -title: "Upgrade an on-premise Observability platform" -linkTitle: "Upgrade an on-premise Observability platform" -description: "A guide to upgrade an on-premise observability platform for {{% ctx %}}." +title: "Upgrade On-Premise platform" +linkTitle: "Upgrade On-Premise platform" +description: "Information about upgrading an On-Premise observability platform for {{% ctx %}}." weight: 1000 --- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/pre-requisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md similarity index 83% rename from content/en/docs/2024.7/Guides/upgrade-observability/on-premise/pre-requisites.md rename to content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md index 0cd6bfbc0..b501eaf0b 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/pre-requisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md @@ -5,12 +5,17 @@ description: "The pre-requisites required before performing the Observability up weight: 1 --- +# {{% param title %}} + +## Verify Old Versions + Navigate to https://v-demoaux1.demo.wearecortex.com:3000 note the version number under the login prompt. This will be for comparison after completing the Grafana upgrade. Using credentials from password vault, login to Grafana. Navigate to the Flow Execution Requests dashboard, set the timeframe to the last 90 days and confirm data is present. - screenshot the dashboard for reference to confirm the upgrade later on +## Make Artefacts Available Click Grafana.X.X.X in the CORTEX Product Documentation and download the Standalone Windows Binaries from the Grafana download page. @@ -21,3 +26,9 @@ Download the Promtail X.X.X Archive from the CORTEX Product Documentation. Extract grafana-enterprise-X.X.X.windows-amd64.zip to your downloads folder Extract the loki-windows-amd64.exe zip to your downloads folder. Extract the promtail-windows-amd64.exe zip to your downloads folder + +## Next Steps? + +1. [Upgrade Grafana][] + +[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeGrafana" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md similarity index 88% rename from content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out rename to content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md index 157e02f51..8853de35c 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md @@ -5,7 +5,11 @@ description: "Information about trying out the observability platform after upgr weight: 5 --- +# {{% param title %}} + +## Test upgraded Observability platform + Navigate to https://v-demoaux1.demo.wearecortex.com:3000 and login with the Grafana Administrator credentials. Under Starred Dashboards, click on the Flow Execution Requests dashboard In the top right, set the time period to the Last 90 days. -If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. \ No newline at end of file +If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md index 9d86f2d5e..e865c85c2 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md @@ -5,6 +5,10 @@ description: "The steps to upgrade Grafana." weight: 2 --- +# {{% param title %}} + +## Perform Upgrade + RDP to V-DEMOAUX1 Navigate to https://v-demoaux1.demo.wearecortex.com:3000 note the version number under the login prompt. This will be for comparison after completing the Grafana upgrade. @@ -22,4 +26,10 @@ Copy the contents of grafana-vX.X.X into C:\Program Files\GrafanaLabs\grafana di These instructions were taken from Grafana's website here: https://grafana.com/docs/grafana/latest/upgrade-guide/upgrade-v10.4/#windows Ensure that custom.ini and defaults.ini are unchanged in the C:\Program Files\GrafanaLabs\grafana\conf directory. Start the Grafana service. -To confirm Grafana has updated, navigate to https://v-demoaux1.demo.wearecortex.com:3000 and confirm the version number changed on the login screen. \ No newline at end of file +To confirm Grafana has updated, navigate to https://v-demoaux1.demo.wearecortex.com:3000 and confirm the version number changed on the login screen. + +## Next Steps? + +1. [Upgrade Loki][] + +[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeLoki" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md index 9eb59929e..179a6ba1c 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md @@ -5,6 +5,10 @@ description: "The steps to upgrade Loki." weight: 3 --- +# {{% param title %}} + +## Perform Upgrade + RDP to V-DEMOAUX1 Open File Explorer and navigate to C:\Loki\ Backup loki-local-config.yaml to a secure location. @@ -33,4 +37,10 @@ Save your changes Open PowerShell as Administrator in the C:\Loki\ directory. Run the Install-Loki.ps1 script by executing .\Install-Loki.ps1 Run the Start-Loki.ps1 script by executing .\Start-Loki.ps1 -Open services.msc and confirm the Loki service exists and has started. \ No newline at end of file +Open services.msc and confirm the Loki service exists and has started. + +## Next Steps? + +1. [Upgrade Promtail][] + +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradePromtail" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md index ff3314cd3..50c962fbd 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md @@ -5,6 +5,10 @@ description: "The steps to upgrade Promtail." weight: 4 --- +# {{% param title %}} + +## Perform Upgrade + RDP to V-APPX Open File Explorer and navigate to C:\Promtail\ Backup promtail-local-config.yaml to a secure location. @@ -32,4 +36,10 @@ Save your changes Open PowerShell as Administrator in the C:\Promtail\ directory Run the Install-Promtail.ps1 script by executing .\Install-Promtail.ps1 Run the Start-Promtail.ps1 script by executing .\Start-Promtail.ps1 -Open services.msc and confirm the Promtail service exists and has started. \ No newline at end of file +Open services.msc and confirm the Promtail service exists and has started. + +## Next Steps? + +1. [Try it out][] + +[Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.TryItOut" >}} diff --git a/data/urls.toml b/data/urls.toml index 2d20fcf31..695bb1a50 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -293,8 +293,8 @@ TryItOut= "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out" AntivirusExclusions = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#antivirus-exclusions" HardwareRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/prerequisites#hardware-requirements" - [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation] - MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/" + [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation] + MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/" [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana] MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/" Architecture = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/architecture" @@ -518,6 +518,19 @@ TryItOut = "/docs/guides/upgrade-cortex/2024.5-to-2024.7/single-server-without-ha/try-it-out" UpgradeApplicationServer = "/docs/guides/upgrade-cortex/2024.5-to-2024.7/single-server-without-ha/upgrade-application-server" UpgradeWebApplicationServer = "/docs/guides/upgrade-cortex/2024.5-to-2024.7/single-server-without-ha/upgrade-web-application-server" + [Cortex.Guides.UpgradeObservability] + MainDoc = "/docs/guides/upgrade-observability/" + [Cortex.Guides.UpgradeObservability.OnPremise] + Prerequisites = "/docs/guides/upgrade-observability/on-premise/prerequisites" + UpgradeGrafana = "/docs/guides/upgrade-observability/on-premise/upgrade-grafana" + UpgradeLoki = "/docs/guides/upgrade-observability/on-premise/upgrade-loki" + UpgradePromtail = "/docs/guides/upgrade-observability/on-premise/upgrade-promtail" + TryItOut = "/docs/guides/upgrade-observability/on-premise/try-it-out" + [Cortex.Guides.UpgradeObservability.Cloud] + Prerequisites = "/docs/guides/upgrade-observability/cloud/prerequisites" + UpgradePromtail = "/docs/guides/upgrade-observability/cloud/upgrade-promtail" + TryItOut = "/docs/guides/upgrade-observability/cloud/try-it-out" + [Cortex.Reference] MainDoc = "/docs/reference/" [Cortex.Reference.Apis] From 609f6734e06fe2d6b630560d7ce87734c11f85b6 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 22 Aug 2024 16:01:30 +0100 Subject: [PATCH 03/15] Updated pre-requisites --- .../cloud/prerequisites.md | 16 +++++++-- .../on-premise/prerequisites.md | 36 ++++++++++--------- .../on-premise/upgrade-grafana.md | 5 --- 3 files changed, 33 insertions(+), 24 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md index 10b81dee2..a47cd3465 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md @@ -7,11 +7,21 @@ weight: 1 # {{% param title %}} -## Make Artefacts Available +## Verify Old Version + +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Login to Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* +1. Click the *Flow Execution Requests* dashboard to open it. +1. Change the time period to be *Last 90 days* and confirm data is present. +1. Make a note of values returned, or alternatively take a screenshot of the dashboard, to use later to verify the upgrade. -Download the Promtail X.X.X Archive from the CORTEX Product Documentation. +## Make Artefacts Available -Extract the promtail-windows-amd64.exe zip to your downloads folder +1. Download the required artefacts to a folder on the machine: + 1. [Promtail 3.0.0][] archive. +1. Extract the downloaded Promtail to a folder with the same name. ## Next Steps? diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md index b501eaf0b..0a1b5bd1f 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md @@ -1,34 +1,38 @@ --- title: "Prerequisites" linkTitle: "Prerequisites" -description: "The pre-requisites required before performing the Observability upgrade." +description: "The prerequisites required before performing the Observability upgrade." weight: 1 --- # {{% param title %}} -## Verify Old Versions +## Verify Old Version -Navigate to https://v-demoaux1.demo.wearecortex.com:3000 note the version number under the login prompt. -This will be for comparison after completing the Grafana upgrade. - -Using credentials from password vault, login to Grafana. -Navigate to the Flow Execution Requests dashboard, set the timeframe to the last 90 days and confirm data is present. - screenshot the dashboard for reference to confirm the upgrade later on +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Make a note the version number under the login prompt. +1. Login to Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* +1. Click the *Flow Execution Requests* dashboard to open it. +1. Change the time period to be *Last 90 days* and confirm data is present. +1. Make a note of values returned, or alternatively take a screenshot of the dashboard, to use later to verify the upgrade. ## Make Artefacts Available -Click Grafana.X.X.X in the CORTEX Product Documentation and download the Standalone Windows Binaries from the Grafana download page. - -Download the Grafana Loki X.X.X Archive from the CORTEX Product Documentation. - -Download the Promtail X.X.X Archive from the CORTEX Product Documentation. - -Extract grafana-enterprise-X.X.X.windows-amd64.zip to your downloads folder -Extract the loki-windows-amd64.exe zip to your downloads folder. -Extract the promtail-windows-amd64.exe zip to your downloads folder +1. Download the required artefacts to a folder on the machine: + 1. [Grafana 10.4.1][] Standalone Windows Binaries. + 1. [Grafana Loki 3.0.0][] archive. + 1. [Promtail 3.0.0][] archive. +1. Extract the downloaded Grafana file to a folder with the same name. +1. Extract the downloaded Loki file to a folder with the same name. +1. Extract the downloaded Promtail to a folder with the same name. ## Next Steps? 1. [Upgrade Grafana][] +[Grafana 10.4.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.10.4.1.Windows" >}} +[Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} +[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} [Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeGrafana" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md index e865c85c2..d4d170288 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md @@ -9,11 +9,6 @@ weight: 2 ## Perform Upgrade -RDP to V-DEMOAUX1 -Navigate to https://v-demoaux1.demo.wearecortex.com:3000 note the version number under the login prompt. -This will be for comparison after completing the Grafana upgrade. -Using credentials from password vault, login to Grafana. -Navigate to the Flow Execution Requests dashboard, set the timeframe to the last 90 days and confirm data is present. Open File Explorer and navigate to C:\Program Files\GrafanaLabs\grafana\conf\ Backup custom.ini and defaults.ino to a secure location. Open Services.msc from your Start-menu and stop the Grafana service. From 5d9a3b9a334d3d97778d4184a82932b70558cefb Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Tue, 27 Aug 2024 17:35:01 +0100 Subject: [PATCH 04/15] Added additional upgrade instructions for observability --- .../cloud/prerequisites.md | 11 ++- .../upgrade-observability/cloud/try-it-out.md | 51 +++++++++- .../cloud/upgrade-promtail.md | 95 +++++++++++++------ .../on-premise/_index.md | 2 +- .../on-premise/prerequisites.md | 30 +++++- .../on-premise/try-it-out.md | 57 ++++++++++- .../on-premise/upgrade-grafana.md | 27 +++--- .../on-premise/upgrade-loki.md | 92 ++++++++++++------ .../on-premise/upgrade-promtail.md | 95 +++++++++++++------ data/urls.toml | 10 +- 10 files changed, 353 insertions(+), 117 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md index a47cd3465..029bad92b 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md @@ -20,11 +20,20 @@ weight: 1 ## Make Artefacts Available 1. Download the required artefacts to a folder on the machine: - 1. [Promtail 3.0.0][] archive. + + * [Promtail 3.0.0][] archive. + 1. Extract the downloaded Promtail to a folder with the same name. +## Backup Old Files + +1. On the Application Server(s) that Promtail is installed on, create a folder called `Observability Backups` in a known location. +1. Open File Explorer and navigate to `C:\Promtail\`. +1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7. + ## Next Steps? 1. [Upgrade Promtail][] +[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} [Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.UpgradePromtail" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md index 518ec28f9..cfe97407f 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md @@ -7,9 +7,50 @@ weight: 3 # {{% param title %}} -## Test upgraded Observability platform +## Confirm Dashboards load -Navigate to https://v-demoaux1.demo.wearecortex.com:3000 and login with the Grafana Administrator credentials. -Under Starred Dashboards, click on the Flow Execution Requests dashboard -In the top right, set the time period to the Last 90 days. -If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Login to Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* +1. Click the *Flow Execution Requests* dashboard to open it. +1. Change the time period to be *Last 90 days* and confirm data is present. +1. Confirm the data from the previous step is similar to the data captured when [verifying the old version][]. + +## Confirm New Data is Processed + +{{% alert title="Note" %}} +Any flow can be used that exists on the system and can be executed. +{{% / alert %}} + +1. Open an HTTP client, such as [Postman][]. Make a request with the following format: + | Property | Value | + |---------------|-------------------------------------------------------------------------------------| + | Action | POST | + | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| + | Content Type | application/json | + | Body | {} | + | Authentication| Basic | + | Username | The value used for `ApiGatewayBasicAuthUsername` when Application Services were installed.| + | Password | The value used for `ApiGatewayBasicAuthPassword` when Application Services were installed.| + + {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} + +1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Requests* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Platform Health* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} + +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.VerifyOldVersion" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md index 085190f0c..3c05dbf4a 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md @@ -7,39 +7,78 @@ weight: 2 # {{% param title %}} +This guide describes how to upgrade the Promtail installation. Please ensure that the [Prerequisites] for upgrading Observability have been completed before starting this upgrade. + ## Perform Upgrade -RDP to V-APPX -Open File Explorer and navigate to C:\Promtail\ -Backup promtail-local-config.yaml to a secure location. -Open PowerShell as Administrator in the C:\Promtail\ directory -Run the Remove-Promtail.ps1 script by executing .\Remove-Promtail.ps1 -Remove all files from the C:\Promtail\ directory except log files and tmp directory. This includes: -Install-Promtail.ps1 -nssm.exe -Promtail-local-config.yaml -Promtail-windows-amd64.exe -Remove-Promtail.ps1 -Start-Promtail.ps1 -Stop-Promtail.ps1 -In a browser on V-APPX, navigate to the CORTEX Product Documentation and find the Promtail install instructions for your version of CORTEX. -Download the Promtail X.X.X Archive from the CORTEX Product Documentation. -Extract the promtail-windows-amd64.exe zip to your downloads folder -Open the unzipped promtail-windows-amd64.exe directory and copy to executable to C:\Promtail\ -Download the Promtail Install.zip Archive from the CORTEX Product Documentation. -Extract the Promtail.Install.zip to your downloads folder. -Open the unzipped Promtail.Install.zip directory and copy its contents to C:\Promtail -Open the promtail-local-config.yaml and compare against the backup made in Step 3. -Update the filename property to the correct location (e.g. c:/Promtail/tmp/positions.yaml) -Update the clients URL property to the value found in the backup. -Save your changes -Open PowerShell as Administrator in the C:\Promtail\ directory -Run the Install-Promtail.ps1 script by executing .\Install-Promtail.ps1 -Run the Start-Promtail.ps1 script by executing .\Start-Promtail.ps1 -Open services.msc and confirm the Promtail service exists and has started. +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Promtail service. +{{% / 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. Open PowerShell as Administrator. +1. Change the directory to the Promtail folder by executing the following command: + + ``` powershell + 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. Delete the following files from the directory: + + * Install-Promtail.ps1 + * nssm.exe + * Promtail-local-config.yaml + * Promtail-windows-amd64.exe + * Remove-Promtail.ps1 + * Start-Promtail.ps1 + * Stop-Promtail.ps1 + +1. In File Explorer, navigate to the extracted Promtail folder performed as part of [Make Artefacts Available][]. +1. Copy the contents of `promtail-windows-amd64.exe` into the `C:\Promtail` directory. +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. Open promtail-local-config.yaml in Notepad++ and compare against the [backed up][] version: + + * Update the filename property to the value found in the [backed up][] version. + * Update the clients URL property to the value found in the [backed up][] version. + * Save the new promtail-local-config.yaml file. + +1. Open PowerShell as Administrator. +1. Change the directory to the Promtail folder by executing the following command: + + ``` powershell + cd C:\Promtail + ``` + +1. Install Promtail by executing the following command: + + ``` powershell + .\Install-Promtail.ps1 + ``` + +1. Start the Promtail service by executing the following command: + + ``` powershell + .\Start-Promtail.ps1 + ``` + +1. Check that the Promtail service has installed and started correctly: + * Open Services.msc from the Start menu. + * Locate the Promtail service and confirm that it is `Running`. ## Next Steps? 1. [Try it out][] +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Prerequisites" >}} [Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.TryItOut" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md index 6144b1e72..27923c7e2 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md @@ -2,5 +2,5 @@ title: "Upgrade On-Premise platform" linkTitle: "Upgrade On-Premise platform" description: "Information about upgrading an On-Premise observability platform for {{% ctx %}}." -weight: 1000 +weight: 1 --- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md index 0a1b5bd1f..31894a76c 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md @@ -21,12 +21,30 @@ weight: 1 ## Make Artefacts Available 1. Download the required artefacts to a folder on the machine: - 1. [Grafana 10.4.1][] Standalone Windows Binaries. - 1. [Grafana Loki 3.0.0][] archive. - 1. [Promtail 3.0.0][] archive. + + * [Grafana 10.4.1][] Standalone Windows Binaries. + * [Grafana Loki 3.0.0][] archive. + * [Grafana Loki Install][] archive. + * [Promtail 3.0.0][] archive. + * [Promtail Install][] archive. + 1. Extract the downloaded Grafana file to a folder with the same name. -1. Extract the downloaded Loki file to a folder with the same name. -1. Extract the downloaded Promtail to a folder with the same name. +1. Extract the downloaded Grafana Loki file to a folder with the same name. +1. Extract the downloaded Grafana Loki Install file to a folder with the same name. +1. Extract the downloaded Promtail file to a folder with the same name. +1. Extract the downloaded Promtail Install file to a folder with the same name. + +## 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 `C:\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.ino` file and save it to the `Observability Backups` folder created at step 1. +1. In File Explorer and navigate to `C:\Loki\`. +1. Copy the `loki-local-config.yaml` file and save it to the `Observability Backups` folder created at step 1. +1. On the Application Server(s) that Promtail is installed on, create a folder called `Observability Backups` in a known location. +1. Open File Explorer and navigate to `C:\Promtail\`. +1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7. ## Next Steps? @@ -34,5 +52,7 @@ weight: 1 [Grafana 10.4.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.10.4.1.Windows" >}} [Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} +[Grafana Loki Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaLokiInstallZip" >}} [Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} +[Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} [Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeGrafana" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md index 8853de35c..6ebe1dbfd 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md @@ -7,9 +7,56 @@ weight: 5 # {{% param title %}} -## Test upgraded Observability platform +## Confirm Grafana Upgrade -Navigate to https://v-demoaux1.demo.wearecortex.com:3000 and login with the Grafana Administrator credentials. -Under Starred Dashboards, click on the Flow Execution Requests dashboard -In the top right, set the time period to the Last 90 days. -If values are shown as confirmed in the Upgrading Grafana steps, then the upgrade has worked and all data has been brought forward. +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000`. +1. Identify the version number under the login prompt. +1. Confirm the version has updated to be 10.4.1. + +## Confirm Dashboards load + +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Login to Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* +1. Click the *Flow Execution Requests* dashboard to open it. +1. Change the time period to be *Last 90 days* and confirm data is present. +1. Confirm the data from the previous step is similar to the data captured when [verifying the old version][]. + +## Confirm New Data is Processed + +{{% alert title="Note" %}} +Any flow can be used that exists on the system and can be executed. +{{% / alert %}} + +1. Open an HTTP client, such as [Postman][]. Make a request with the following format: + | Property | Value | + |---------------|-------------------------------------------------------------------------------------| + | Action | POST | + | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| + | Content Type | application/json | + | Body | {} | + | Authentication| Basic | + | Username | The value used for `ApiGatewayBasicAuthUsername` when Application Services were installed.| + | Password | The value used for `ApiGatewayBasicAuthPassword` when Application Services were installed.| + + {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} + +1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Requests* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Platform Health* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} + +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.VerifyOldVersion" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md index d4d170288..c632c0558 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md @@ -7,24 +7,25 @@ weight: 2 # {{% param title %}} +This guide describes how to upgrade the Grafana installation. Please ensure that the [Prerequisites] for upgrading Observability have been completed before starting this upgrade. + ## Perform Upgrade -Open File Explorer and navigate to C:\Program Files\GrafanaLabs\grafana\conf\ -Backup custom.ini and defaults.ino to a secure location. -Open Services.msc from your Start-menu and stop the Grafana service. -In a browser on V-DEMOAUX1, navigate to the CORTEX Product Documentation on and find the Grafana install instructions for your version of CORTEX. -Click Grafana.X.X.X in the CORTEX Product Documentation and download the Standalone Windows Binaries from the Grafana download page. -Extract grafana-enterprise-X.X.X.windows-amd64.zip to your downloads folder -This zip file contains many small files, stressing the IOPS of the disk. Extraction can take a couple minutes and will show slow speeds when handling many small files. -Open the unzipped grafana-enteprise-X.X.X.windows-amd64 directory and open grafana-vX.X.X directory. -Copy the contents of grafana-vX.X.X into C:\Program Files\GrafanaLabs\grafana directory, and click Replace all existing files in the prompt. -These instructions were taken from Grafana's website here: https://grafana.com/docs/grafana/latest/upgrade-guide/upgrade-v10.4/#windows -Ensure that custom.ini and defaults.ini are unchanged in the C:\Program Files\GrafanaLabs\grafana\conf directory. -Start the Grafana service. -To confirm Grafana has updated, navigate to https://v-demoaux1.demo.wearecortex.com:3000 and confirm the version number changed on the login screen. +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. 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. Open Services.msc from the Start menu. +1. Locate the Grafana service and start it by right-clicking on the service and selecting `Start`. ## Next Steps? 1. [Upgrade Loki][] +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Prerequisites" >}} [Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeLoki" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md index 179a6ba1c..aafcb080d 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md @@ -7,40 +7,74 @@ weight: 3 # {{% param title %}} +This guide describes how to upgrade the Loki installation. Please ensure that the [Grafana Upgrade] has been completed before starting this upgrade. + ## Perform Upgrade -RDP to V-DEMOAUX1 -Open File Explorer and navigate to C:\Loki\ -Backup loki-local-config.yaml to a secure location. -Open PowerShell as Administrator in the C:\Loki\ directory -Run the Remove-Loki.ps1 script by executing .\Remove-Loki.ps1 -Remove all files from the C:\Loki\ directory except log files. This includes: -Install-Loki.ps1 -loki-local-config.yaml -loki-windows-amd64.exe -nssm.exe -Remove-Loki.ps1 -Start-Loki.ps1 -Stop-Loki.ps1 -In a browser on V-DEMOAUX1, navigate to the CORTEX Product Documentation and find the Loki install instructions for your version of CORTEX. -Download the Grafana Loki X.X.X Archive from the CORTEX Product Documentation. -Extract the loki-windows-amd64.exe zip to your downloads folder. -Open the unzipped loki-windows-amd64.exe directory and copy the executable to C:\Loki\ -Download the Grafana Loki Install.zip Archive from the CORTEX Product Documentation -Extract the Grafana.Loki.Install.zip zip to your downloads folder. -Open the unzipped Grafana.Loki.Install.zip directory and copy its contents to C:\Loki\ -Open loki-local-config.yaml in Notepad++ and compare against the backup made in step 3. -The data for Grafana dashboards is defined under schema_config. -If there are differences under schema_config, copy the config from the backup and put it directly under configs in schema_config. Ensure the formatting is identical to whats already found in the file. -Update the pre-existing schema_config entry in the new loki-local-config.yaml file to start from todays date. -Save your changes -Open PowerShell as Administrator in the C:\Loki\ directory. -Run the Install-Loki.ps1 script by executing .\Install-Loki.ps1 -Run the Start-Loki.ps1 script by executing .\Start-Loki.ps1 -Open services.msc and confirm the Loki service exists and has started. +1. Log in to the server hosting your Loki service. +1. Open PowerShell as Administrator. +1. Change the directory to the Loki folder by executing the following command: + + ``` powershell + 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. Delete the following files from the directory: + + * Install-Loki.ps1 + * loki-local-config.yaml + * loki-windows-amd64.exe + * nssm.exe + * Remove-Loki.ps1 + * Start-Loki.ps1 + * Stop-Loki.ps1 + +1. In File Explorer, navigate to the extracted Grafana Loki folder performed as part of [Make Artefacts Available][]. +1. Copy the contents of `loki-windows-amd64.exe` into the `C:\Loki` directory. +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. Open loki-local-config.yaml in Notepad++ and compare against the [backed up][] version: + + * The data for Grafana dashboards is defined under schema_config. + * If there are differences under schema_config, copy the config from the backup and add it directly under configs in schema_config. Ensure the formatting is identical to that which is already found in the file. + * Update the pre-existing schema_config entry in the new loki-local-config.yaml file to start from todays date. + * Save the new loki-local-config.yaml file. + +1. Open PowerShell as Administrator. +1. Change the directory to the Loki folder by executing the following command: + + ``` powershell + cd C:\Loki + ``` + +1. Install Loki by executing the following command: + + ``` powershell + .\Install-Loki.ps1 + ``` + +1. Start the Loki service by executing the following command: + + ``` powershell + .\Start-Loki.ps1 + ``` + +1. Check that the Loki service has installed and started correctly: + * Open Services.msc from the Start menu. + * Locate the Loki service and confirm that it is `Running`. ## Next Steps? 1. [Upgrade Promtail][] +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.BackupOldFiles" >}} +[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeGrafana" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.MakeArtefactsAvailable" >}} [Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradePromtail" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md index 50c962fbd..158facdbc 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md @@ -7,39 +7,78 @@ weight: 4 # {{% param title %}} +This guide describes how to upgrade the Promtail installation. Please ensure that the [Loki Upgrade][] has been completed before starting this upgrade. + ## Perform Upgrade -RDP to V-APPX -Open File Explorer and navigate to C:\Promtail\ -Backup promtail-local-config.yaml to a secure location. -Open PowerShell as Administrator in the C:\Promtail\ directory -Run the Remove-Promtail.ps1 script by executing .\Remove-Promtail.ps1 -Remove all files from the C:\Promtail\ directory except log files and tmp directory. This includes: -Install-Promtail.ps1 -nssm.exe -Promtail-local-config.yaml -Promtail-windows-amd64.exe -Remove-Promtail.ps1 -Start-Promtail.ps1 -Stop-Promtail.ps1 -In a browser on V-APPX, navigate to the CORTEX Product Documentation and find the Promtail install instructions for your version of CORTEX. -Download the Promtail X.X.X Archive from the CORTEX Product Documentation. -Extract the promtail-windows-amd64.exe zip to your downloads folder -Open the unzipped promtail-windows-amd64.exe directory and copy to executable to C:\Promtail\ -Download the Promtail Install.zip Archive from the CORTEX Product Documentation. -Extract the Promtail.Install.zip to your downloads folder. -Open the unzipped Promtail.Install.zip directory and copy its contents to C:\Promtail -Open the promtail-local-config.yaml and compare against the backup made in Step 3. -Update the filename property to the correct location (e.g. c:/Promtail/tmp/positions.yaml) -Update the clients URL property to the value found in the backup. -Save your changes -Open PowerShell as Administrator in the C:\Promtail\ directory -Run the Install-Promtail.ps1 script by executing .\Install-Promtail.ps1 -Run the Start-Promtail.ps1 script by executing .\Start-Promtail.ps1 -Open services.msc and confirm the Promtail service exists and has started. +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Promtail service. +{{% / 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. Open PowerShell as Administrator. +1. Change the directory to the Promtail folder by executing the following command: + + ``` powershell + 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. Delete the following files from the directory: + + * Install-Promtail.ps1 + * nssm.exe + * Promtail-local-config.yaml + * Promtail-windows-amd64.exe + * Remove-Promtail.ps1 + * Start-Promtail.ps1 + * Stop-Promtail.ps1 + +1. In File Explorer, navigate to the extracted Promtail folder performed as part of [Make Artefacts Available][]. +1. Copy the contents of `promtail-windows-amd64.exe` into the `C:\Promtail` directory. +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. Open promtail-local-config.yaml in Notepad++ and compare against the [backed up][] version: + + * Update the filename property to the value found in the [backed up][] version. + * Update the clients URL property to the value found in the [backed up][] version. + * Save the new promtail-local-config.yaml file. + +1. Open PowerShell as Administrator. +1. Change the directory to the Promtail folder by executing the following command: + + ``` powershell + cd C:\Promtail + ``` + +1. Install Promtail by executing the following command: + + ``` powershell + .\Install-Promtail.ps1 + ``` + +1. Start the Promtail service by executing the following command: + + ``` powershell + .\Start-Promtail.ps1 + ``` + +1. Check that the Promtail service has installed and started correctly: + * Open Services.msc from the Start menu. + * Locate the Promtail service and confirm that it is `Running`. ## Next Steps? 1. [Try it out][] +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.BackupOldFiles" >}} +[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeLoki" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.MakeArtefactsAvailable" >}} [Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.TryItOut" >}} diff --git a/data/urls.toml b/data/urls.toml index 695bb1a50..90933d2b8 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -521,15 +521,21 @@ [Cortex.Guides.UpgradeObservability] MainDoc = "/docs/guides/upgrade-observability/" [Cortex.Guides.UpgradeObservability.OnPremise] + BackupOldFiles = "/docs/guides/upgrade-observability/on-premise/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-observability/on-premise/prerequisites/#make-artefacts-available" Prerequisites = "/docs/guides/upgrade-observability/on-premise/prerequisites" + TryItOut = "/docs/guides/upgrade-observability/on-premise/try-it-out" UpgradeGrafana = "/docs/guides/upgrade-observability/on-premise/upgrade-grafana" UpgradeLoki = "/docs/guides/upgrade-observability/on-premise/upgrade-loki" UpgradePromtail = "/docs/guides/upgrade-observability/on-premise/upgrade-promtail" - TryItOut = "/docs/guides/upgrade-observability/on-premise/try-it-out" + VerifyOldVersion = "/docs/guides/upgrade-observability/on-premise/prerequisites/#verify-old-version" [Cortex.Guides.UpgradeObservability.Cloud] + BackupOldFiles = "/docs/guides/upgrade-observability/cloud/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-observability/cloud/prerequisites/#make-artefacts-available" Prerequisites = "/docs/guides/upgrade-observability/cloud/prerequisites" - UpgradePromtail = "/docs/guides/upgrade-observability/cloud/upgrade-promtail" TryItOut = "/docs/guides/upgrade-observability/cloud/try-it-out" + UpgradePromtail = "/docs/guides/upgrade-observability/cloud/upgrade-promtail" + VerifyOldVersion = "/docs/guides/upgrade-observability/cloud/prerequisites/#verify-old-version" [Cortex.Reference] MainDoc = "/docs/reference/" From c80886024b8f83cefb11f025a83dce3f137b79ad Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 28 Aug 2024 16:41:52 +0100 Subject: [PATCH 05/15] Made changes following PO Review --- .../upgrade-observability/cloud/_index.md | 6 ++-- .../cloud/grafana/_index.md | 6 ++++ .../cloud/{ => grafana}/prerequisites.md | 15 ++++++---- .../cloud/{ => grafana}/try-it-out.md | 6 ++-- .../cloud/{ => grafana}/upgrade-promtail.md | 14 ++++----- .../on-premise/_index.md | 6 ++-- .../on-premise/grafana/_index.md | 6 ++++ .../on-premise/{ => grafana}/prerequisites.md | 18 +++++------ .../on-premise/{ => grafana}/try-it-out.md | 2 +- .../{ => grafana}/upgrade-grafana.md | 8 ++--- .../on-premise/{ => grafana}/upgrade-loki.md | 14 ++++----- .../{ => grafana}/upgrade-promtail.md | 14 ++++----- data/urls.toml | 30 ++++++++++--------- 13 files changed, 81 insertions(+), 64 deletions(-) create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/_index.md rename content/en/docs/2024.7/Guides/upgrade-observability/cloud/{ => grafana}/prerequisites.md (58%) rename content/en/docs/2024.7/Guides/upgrade-observability/cloud/{ => grafana}/try-it-out.md (94%) rename content/en/docs/2024.7/Guides/upgrade-observability/cloud/{ => grafana}/upgrade-promtail.md (89%) create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/_index.md rename content/en/docs/2024.7/Guides/upgrade-observability/on-premise/{ => grafana}/prerequisites.md (75%) rename content/en/docs/2024.7/Guides/upgrade-observability/on-premise/{ => grafana}/try-it-out.md (98%) rename content/en/docs/2024.7/Guides/upgrade-observability/on-premise/{ => grafana}/upgrade-grafana.md (89%) rename content/en/docs/2024.7/Guides/upgrade-observability/on-premise/{ => grafana}/upgrade-loki.md (88%) rename content/en/docs/2024.7/Guides/upgrade-observability/on-premise/{ => grafana}/upgrade-promtail.md (88%) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md index b8e1c498c..c0d7a6beb 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md @@ -1,6 +1,6 @@ --- -title: "Upgrade Cloud hosted platform" -linkTitle: "Upgrade Cloud hosted platform" -description: "Information about upgrading a Cloud hosted observability platform for {{% ctx %}}." +title: "Cloud" +linkTitle: "Cloud" +description: "Information about upgrading a cloud-hosted observability platform for {{% ctx %}}." weight: 1000 --- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/_index.md new file mode 100644 index 000000000..1337f8126 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/_index.md @@ -0,0 +1,6 @@ +--- +title: "Grafana" +linkTitle: "Grafana" +description: "Information about upgrading a cloud-hosted Grafana platform for {{% ctx %}}." +weight: 1000 +--- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md similarity index 58% rename from content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md rename to content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md index 029bad92b..77f2819a6 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md @@ -1,7 +1,7 @@ --- title: "Prerequisites" linkTitle: "Prerequisites" -description: "The pre-requisites required before performing the Observability upgrade." +description: "The prerequisites required before performing the observability upgrade." weight: 1 --- @@ -9,26 +9,28 @@ weight: 1 ## Verify Old Version -1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Navigate to your Grafana website e.g. `https://{Team URL}.grafana.net` 1. Login to Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* 1. Click the *Flow Execution Requests* dashboard to open it. 1. Change the time period to be *Last 90 days* and confirm data is present. -1. Make a note of values returned, or alternatively take a screenshot of the dashboard, to use later to verify the upgrade. +1. Make a note of values returned in the Overview tiles, or alternatively take a screenshot of the dashboard, to use later to verify the upgrade. ## Make Artefacts Available -1. Download the required artefacts to a folder on the machine: +1. Download the required artefacts to a folder on your machine: * [Promtail 3.0.0][] archive. + * [Promtail Install][] archive. 1. Extract the downloaded Promtail to a folder with the same name. +1. Extract the downloaded Promtail Install file to a folder with the same name. ## Backup Old Files 1. On the Application Server(s) that Promtail is installed on, create a folder called `Observability Backups` in a known location. -1. Open File Explorer and navigate to `C:\Promtail\`. +1. Open File Explorer and navigate to the location where Promtail is running from, e.g. `C:\Promtail\`. 1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7. ## Next Steps? @@ -36,4 +38,5 @@ weight: 1 1. [Upgrade Promtail][] [Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.UpgradePromtail" >}} +[Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.UpgradePromtail" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md similarity index 94% rename from content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md rename to content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md index cfe97407f..c14e68d48 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md @@ -1,7 +1,7 @@ --- title: "Try it out" linkTitle: "Try it out" -description: "Information about trying out the Observability platform after upgrade." +description: "Information about trying out the observability platform after upgrade." weight: 3 --- @@ -9,7 +9,7 @@ weight: 3 ## Confirm Dashboards load -1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Navigate to your Grafana website e.g. `https://{Team URL}.grafana.net` 1. Login to Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* @@ -53,4 +53,4 @@ If other requests have been made then there may be more than one request visible {{% / alert %}} [Postman]: {{< url path="Postman.Downloads.MainDoc" >}} -[verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.VerifyOldVersion" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/upgrade-promtail.md similarity index 89% rename from content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md rename to content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/upgrade-promtail.md index 3c05dbf4a..898806322 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 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. Open PowerShell as Administrator. +1. Run Windows PowerShell as Administrator. 1. Change the directory to the Promtail folder by executing the following command: ``` powershell @@ -42,7 +42,7 @@ 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 contents of `promtail-windows-amd64.exe` into the `C:\Promtail` directory. +1. Copy the `promtail-windows-amd64.exe` file into the `C:\Promtail` directory. 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. Open promtail-local-config.yaml in Notepad++ and compare against the [backed up][] version: @@ -51,7 +51,7 @@ These steps will need to be performed on all application servers that host a Pro * Update the clients URL property to the value found in the [backed up][] version. * Save the new promtail-local-config.yaml file. -1. Open PowerShell as Administrator. +1. Run Windows PowerShell as Administrator. 1. Change the directory to the Promtail folder by executing the following command: ``` powershell @@ -78,7 +78,7 @@ These steps will need to be performed on all application servers that host a Pro 1. [Try it out][] -[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.BackupOldFiles" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.MakeArtefactsAvailable" >}} -[Prerequisites]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Prerequisites" >}} -[Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.TryItOut" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.Prerequisites" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.TryItOut" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md index 27923c7e2..59f2ef8fd 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/_index.md @@ -1,6 +1,6 @@ --- -title: "Upgrade On-Premise platform" -linkTitle: "Upgrade On-Premise platform" -description: "Information about upgrading an On-Premise observability platform for {{% ctx %}}." +title: "On-Premise" +linkTitle: "On-Premise" +description: "Information about upgrading an on-premise observability platform for {{% ctx %}}." weight: 1 --- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/_index.md new file mode 100644 index 000000000..0b777445d --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/_index.md @@ -0,0 +1,6 @@ +--- +title: "Grafana" +linkTitle: "Grafana" +description: "Information about upgrading an on-premise Grafana platform for {{% ctx %}}." +weight: 1 +--- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/prerequisites.md similarity index 75% rename from content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md rename to content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/prerequisites.md index 31894a76c..13f1d9e5d 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/prerequisites.md @@ -1,7 +1,7 @@ --- title: "Prerequisites" linkTitle: "Prerequisites" -description: "The prerequisites required before performing the Observability upgrade." +description: "The prerequisites required before performing the observability upgrade." weight: 1 --- @@ -10,17 +10,17 @@ weight: 1 ## Verify Old Version 1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` -1. Make a note the version number under the login prompt. +1. Make a note of the version number under the login prompt. 1. Login to Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* 1. Click the *Flow Execution Requests* dashboard to open it. 1. Change the time period to be *Last 90 days* and confirm data is present. -1. Make a note of values returned, or alternatively take a screenshot of the dashboard, to use later to verify the upgrade. +1. Make a note of values returned in the Overview tiles, or alternatively take a screenshot of the dashboard, to use later to verify the upgrade. ## Make Artefacts Available -1. Download the required artefacts to a folder on the machine: +1. Download the required artefacts to a folder on your machine: * [Grafana 10.4.1][] Standalone Windows Binaries. * [Grafana Loki 3.0.0][] archive. @@ -37,13 +37,13 @@ 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 `C:\Program Files\GrafanaLabs\grafana\conf\`. +1. Open File Explorer and navigate to the location that Grafana was installed to, e.g. `C:\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.ino` file and save it to the `Observability Backups` folder created at step 1. -1. In File Explorer and navigate to `C:\Loki\`. +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\`. 1. Copy the `loki-local-config.yaml` file and save it to the `Observability Backups` folder created at step 1. 1. On the Application Server(s) that Promtail is installed on, create a folder called `Observability Backups` in a known location. -1. Open File Explorer and navigate to `C:\Promtail\`. +1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\Promtail\`. 1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7. ## Next Steps? @@ -55,4 +55,4 @@ weight: 1 [Grafana Loki Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaLokiInstallZip" >}} [Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} [Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} -[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeGrafana" >}} +[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.UpgradeGrafana" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md similarity index 98% rename from content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md rename to content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md index 6ebe1dbfd..b14ffac48 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md @@ -59,4 +59,4 @@ If other requests have been made then there may be more than one request visible {{% / alert %}} [Postman]: {{< url path="Postman.Downloads.MainDoc" >}} -[verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.VerifyOldVersion" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md similarity index 89% rename from content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md rename to content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md index c632c0558..e8439df64 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-grafana.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md @@ -25,7 +25,7 @@ This guide describes how to upgrade the Grafana installation. Please ensure that 1. [Upgrade Loki][] -[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.BackupOldFiles" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.MakeArtefactsAvailable" >}} -[Prerequisites]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Prerequisites" >}} -[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeLoki" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.Prerequisites" >}} +[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.UpgradeLoki" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-loki.md similarity index 88% rename from content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md rename to content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-loki.md index aafcb080d..7553c6769 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-loki.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-loki.md @@ -12,7 +12,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th ## Perform Upgrade 1. Log in to the server hosting your Loki service. -1. Open PowerShell as Administrator. +1. Run Windows PowerShell as Administrator. 1. Change the directory to the Loki folder by executing the following command: ``` powershell @@ -37,7 +37,7 @@ 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 contents of `loki-windows-amd64.exe` into the `C:\Loki` directory. +1. Copy the `loki-windows-amd64.exe` file into the `C:\Loki` directory. 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. Open loki-local-config.yaml in Notepad++ and compare against the [backed up][] version: @@ -47,7 +47,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Update the pre-existing schema_config entry in the new loki-local-config.yaml file to start from todays date. * Save the new loki-local-config.yaml file. -1. Open PowerShell as Administrator. +1. Run Windows PowerShell as Administrator. 1. Change the directory to the Loki folder by executing the following command: ``` powershell @@ -74,7 +74,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. [Upgrade Promtail][] -[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.BackupOldFiles" >}} -[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeGrafana" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.MakeArtefactsAvailable" >}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradePromtail" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.BackupOldFiles" >}} +[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.UpgradeGrafana" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.UpgradePromtail" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md similarity index 88% rename from content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md rename to content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md index 158facdbc..786674176 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/upgrade-promtail.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 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. Open PowerShell as Administrator. +1. Run Windows PowerShell as Administrator. 1. Change the directory to the Promtail folder by executing the following command: ``` powershell @@ -42,7 +42,7 @@ 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 contents of `promtail-windows-amd64.exe` into the `C:\Promtail` directory. +1. Copy the `promtail-windows-amd64.exe` file into the `C:\Promtail` directory. 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. Open promtail-local-config.yaml in Notepad++ and compare against the [backed up][] version: @@ -51,7 +51,7 @@ These steps will need to be performed on all application servers that host a Pro * Update the clients URL property to the value found in the [backed up][] version. * Save the new promtail-local-config.yaml file. -1. Open PowerShell as Administrator. +1. Run Windows PowerShell as Administrator. 1. Change the directory to the Promtail folder by executing the following command: ``` powershell @@ -78,7 +78,7 @@ These steps will need to be performed on all application servers that host a Pro 1. [Try it out][] -[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.BackupOldFiles" >}} -[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.UpgradeLoki" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.MakeArtefactsAvailable" >}} -[Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.TryItOut" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.BackupOldFiles" >}} +[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.UpgradeLoki" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.TryItOut" >}} diff --git a/data/urls.toml b/data/urls.toml index 90933d2b8..84d1c5ab2 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -521,21 +521,23 @@ [Cortex.Guides.UpgradeObservability] MainDoc = "/docs/guides/upgrade-observability/" [Cortex.Guides.UpgradeObservability.OnPremise] - BackupOldFiles = "/docs/guides/upgrade-observability/on-premise/prerequisites/#backup-old-files" - MakeArtefactsAvailable = "/docs/guides/upgrade-observability/on-premise/prerequisites/#make-artefacts-available" - Prerequisites = "/docs/guides/upgrade-observability/on-premise/prerequisites" - TryItOut = "/docs/guides/upgrade-observability/on-premise/try-it-out" - UpgradeGrafana = "/docs/guides/upgrade-observability/on-premise/upgrade-grafana" - UpgradeLoki = "/docs/guides/upgrade-observability/on-premise/upgrade-loki" - UpgradePromtail = "/docs/guides/upgrade-observability/on-premise/upgrade-promtail" - VerifyOldVersion = "/docs/guides/upgrade-observability/on-premise/prerequisites/#verify-old-version" + [Cortex.Guides.UpgradeObservability.OnPremise.Grafana] + BackupOldFiles = "/docs/guides/upgrade-observability/on-premise/grafana/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-observability/on-premise/grafana/prerequisites/#make-artefacts-available" + Prerequisites = "/docs/guides/upgrade-observability/on-premise/grafana/prerequisites" + TryItOut = "/docs/guides/upgrade-observability/on-premise/grafana/try-it-out" + UpgradeGrafana = "/docs/guides/upgrade-observability/on-premise/grafana/upgrade-grafana" + UpgradeLoki = "/docs/guides/upgrade-observability/on-premise/grafana/upgrade-loki" + UpgradePromtail = "/docs/guides/upgrade-observability/on-premise/grafana/upgrade-promtail" + VerifyOldVersion = "/docs/guides/upgrade-observability/on-premise/grafana/prerequisites/#verify-old-version" [Cortex.Guides.UpgradeObservability.Cloud] - BackupOldFiles = "/docs/guides/upgrade-observability/cloud/prerequisites/#backup-old-files" - MakeArtefactsAvailable = "/docs/guides/upgrade-observability/cloud/prerequisites/#make-artefacts-available" - Prerequisites = "/docs/guides/upgrade-observability/cloud/prerequisites" - TryItOut = "/docs/guides/upgrade-observability/cloud/try-it-out" - UpgradePromtail = "/docs/guides/upgrade-observability/cloud/upgrade-promtail" - VerifyOldVersion = "/docs/guides/upgrade-observability/cloud/prerequisites/#verify-old-version" + [Cortex.Guides.UpgradeObservability.Cloud.Grafana] + BackupOldFiles = "/docs/guides/upgrade-observability/cloud/grafana/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-observability/cloud/grafana/prerequisites/#make-artefacts-available" + Prerequisites = "/docs/guides/upgrade-observability/cloud/grafana/prerequisites" + TryItOut = "/docs/guides/upgrade-observability/cloud/grafana/try-it-out" + UpgradePromtail = "/docs/guides/upgrade-observability/cloud/grafana/upgrade-promtail" + VerifyOldVersion = "/docs/guides/upgrade-observability/cloud/grafana/prerequisites/#verify-old-version" [Cortex.Reference] MainDoc = "/docs/reference/" From 67d8068a643a46df596bb62d8ef08e8f19349f4f Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 29 Aug 2024 08:47:32 +0100 Subject: [PATCH 06/15] removed references to notepad++ --- .../upgrade-observability/cloud/grafana/upgrade-promtail.md | 2 +- .../upgrade-observability/on-premise/grafana/upgrade-loki.md | 2 +- .../on-premise/grafana/upgrade-promtail.md | 2 +- 3 files changed, 3 insertions(+), 3 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 898806322..4634ade5b 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 @@ -45,7 +45,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Copy the `promtail-windows-amd64.exe` file into the `C:\Promtail` directory. 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. Open promtail-local-config.yaml in Notepad++ and compare against the [backed up][] version: +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. * Update the clients URL property to the value found in the [backed up][] version. 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 7553c6769..90df5d355 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 @@ -40,7 +40,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. Copy the `loki-windows-amd64.exe` file into the `C:\Loki` directory. 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. Open loki-local-config.yaml in Notepad++ and compare against the [backed up][] version: +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. * If there are differences under schema_config, copy the config from the backup and add it directly under configs in schema_config. Ensure the formatting is identical to that which is already found in the file. 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 786674176..a815f3d25 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 @@ -45,7 +45,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Copy the `promtail-windows-amd64.exe` file into the `C:\Promtail` directory. 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. Open promtail-local-config.yaml in Notepad++ and compare against the [backed up][] version: +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. * Update the clients URL property to the value found in the [backed up][] version. From 9fd2f2bdbe30a4d7ecae50eb5dd7c08ecf042767 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 29 Aug 2024 09:34:55 +0100 Subject: [PATCH 07/15] 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 From e58bcec84adb94d491dfffdbfdda903ab280e2a3 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 29 Aug 2024 11:41:02 +0100 Subject: [PATCH 08/15] Updated following PR Review --- .../cloud/grafana/prerequisites.md | 8 ++++--- .../cloud/grafana/try-it-out.md | 2 +- .../cloud/grafana/upgrade-promtail.md | 22 +++++++++--------- .../on-premise/grafana/prerequisites.md | 8 ++++--- .../on-premise/grafana/try-it-out.md | 2 +- .../on-premise/grafana/upgrade-grafana.md | 8 +++---- .../on-premise/grafana/upgrade-loki.md | 23 ++++++++++--------- .../on-premise/grafana/upgrade-promtail.md | 22 +++++++++--------- 8 files changed, 50 insertions(+), 45 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md index 77f2819a6..4a22e996c 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md @@ -29,9 +29,11 @@ weight: 1 ## Backup Old Files -1. On the Application Server(s) that Promtail is installed on, create a folder called `Observability Backups` in a known location. -1. Open File Explorer and navigate to the location where Promtail is running from, e.g. `C:\Promtail\`. -1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7. +On each Application Server that Promtail is installed on: + +1. Create a folder called `Observability Backups` in a known location. +1. Open File Explorer and navigate to the location where Promtail is running from, e.g. `C:\Promtail`. +1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 1. ## Next Steps? diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md index c14e68d48..c35fdfd23 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md @@ -7,7 +7,7 @@ weight: 3 # {{% param title %}} -## Confirm Dashboards load +## Confirm Dashboards Load 1. Navigate to your Grafana website e.g. `https://{Team URL}.grafana.net` 1. Login to Grafana. 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 2b1377913..4fc186ae4 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 @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `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 @@ -35,18 +35,18 @@ These steps will need to be performed on all application servers that host a Pro * Start-Promtail.ps1 * 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 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 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: +1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder performed as part of [Make Artefacts Available][]. +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 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. - * Update the clients URL property to the value found in the [backed up][] version. - * Save the new promtail-local-config.yaml file. + * Update the *filename* property under *positions* to be the value found in the [backed up][] version. + * Update the *url* property under *clients* to be the value found in the [backed up][] version. + * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `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 @@ -61,7 +61,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Check that the Promtail service has installed and started correctly: * Open Services.msc from the Start menu. - * Locate the Promtail service and confirm that it is `Running`. + * Locate the *Promtail* service and confirm that it is *Running*. ## Next Steps? 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 d34438c7d..16d553d86 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 @@ -42,9 +42,11 @@ weight: 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\`. 1. Copy the `loki-local-config.yaml` file and save it to the `Observability Backups` folder created at step 1. -1. On the Application Server(s) that Promtail is installed on, create a folder called `Observability Backups` in a known location. -1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\Promtail\`. -1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7. +1. On each Application Server that Promtail is installed on: + + 1. Create a folder called `Observability Backups` in a known location. + 1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\Promtail`. + 1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7.1. ## Next Steps? diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md index b14ffac48..86cf66c00 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md @@ -13,7 +13,7 @@ weight: 5 1. Identify the version number under the login prompt. 1. Confirm the version has updated to be 10.4.1. -## Confirm Dashboards load +## Confirm Dashboards Load 1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` 1. Login to Grafana. 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 656fc1d33..ef879f969 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 @@ -13,13 +13,13 @@ 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 Installation folder performed as part of [Make Artefacts Available][]. +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 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 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. 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`. +1. Locate the *Grafana* service and start it by right-clicking on the service and selecting *Start*. ## Next Steps? 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 09064c1eb..3eddd9513 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,14 +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 folder where Loki is running from, e.g. `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 the folder where Loki is running from, e.g. `C:\Loki`. +1. Open a File Explorer and navigate to the folder where Loki was running from, e.g. `C:\Loki`. 1. Delete the following files from the directory: * Install-Loki.ps1 @@ -31,19 +31,20 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Start-Loki.ps1 * Stop-Loki.ps1 -1. In File Explorer, navigate to the extracted Grafana Loki folder performed as part of [Make Artefacts Available][]. +1. In File Explorer, navigate to the extracted `loki-windows-amd64.exe` folder performed as part of [Make Artefacts Available][]. 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. 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 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: +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. - * If there are differences under schema_config, copy the config from the backup and add it directly under configs in schema_config. Ensure the formatting is identical to that which is already found in the file. - * Update the pre-existing schema_config entry in the new loki-local-config.yaml file to start from todays date. - * Save the new loki-local-config.yaml file. + * The data for Grafana dashboards is defined under *schema_config*. + * If there are differences under *schema_config*, copy the config from the backup and add it directly under configs in *schema_config*. + * Ensure the formatting is identical, including indentations, to that which is already found in the file. + * Update the pre-existing *schema_config* entry in the new `loki-local-config.yaml` file to start from todays date. + * Save the new `loki-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Loki files have been copied to, e.g. `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 @@ -58,7 +59,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. Check that the Loki service has installed and started correctly: * Open Services.msc from the Start menu. - * Locate the Loki service and confirm that it is `Running`. + * Locate the *Loki* service and confirm that it is *Running*. ## Next Steps? 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 cd9bb7158..76b211eaa 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 @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `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 @@ -35,18 +35,18 @@ These steps will need to be performed on all application servers that host a Pro * Start-Promtail.ps1 * 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 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 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: +1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder performed as part of [Make Artefacts Available][]. +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 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. - * Update the clients URL property to the value found in the [backed up][] version. - * Save the new promtail-local-config.yaml file. + * Update the *filename* property under *positions* to be the value found in the [backed up][] version. + * Update the *url* property under *clients* to be the value found in the [backed up][] version. + * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `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 @@ -61,7 +61,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Check that the Promtail service has installed and started correctly: * Open Services.msc from the Start menu. - * Locate the Promtail service and confirm that it is `Running`. + * Locate the *Promtail* service and confirm that it is *Running*. ## Next Steps? From 50cc79f775c3fa3989fe4e408aa49e02c2dd46e1 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 29 Aug 2024 12:23:36 +0100 Subject: [PATCH 09/15] fixed broken link --- data/urls.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/urls.toml b/data/urls.toml index 84d1c5ab2..efb661faf 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -2763,4 +2763,4 @@ CharacterSets = "https://www.w3.org/Style/XSL/TestSuite/results/4/XEP/charsets.pdf" SqlInjection = "https://www.w3schools.com/sql/sql_injection.asp" [Mozilla] - UriSyntax = "https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web#syntax_of_uniform_resource_identifiers_uris" \ No newline at end of file + UriSyntax = "https://developer.mozilla.org/en-US/docs/Web/URI#syntax_of_uniform_resource_identifiers_uris" \ No newline at end of file From d7c6f8caccb959b3f379445fa8e924ca008e4c73 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Fri, 30 Aug 2024 10:16:46 +0100 Subject: [PATCH 10/15] Modified following Testing --- .../cloud/grafana/prerequisites.md | 4 +- .../cloud/grafana/try-it-out.md | 22 ++++------ .../cloud/grafana/upgrade-promtail.md | 8 ++-- .../on-premise/grafana/prerequisites.md | 14 +++---- .../on-premise/grafana/try-it-out.md | 22 ++++------ .../on-premise/grafana/upgrade-grafana.md | 8 ++-- .../on-premise/grafana/upgrade-loki.md | 40 ++++++++++++++----- .../on-premise/grafana/upgrade-promtail.md | 8 ++-- 8 files changed, 68 insertions(+), 58 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md index 4a22e996c..d141133bc 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/prerequisites.md @@ -24,8 +24,8 @@ weight: 1 * [Promtail 3.0.0][] archive. * [Promtail Install][] archive. -1. Extract the downloaded Promtail to a folder with the same name. -1. Extract the downloaded Promtail Install file to a folder with the same name. +1. Extract the downloaded `promtail-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Promtail.Install` archive to a folder with the same name. ## Backup Old Files diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md index c35fdfd23..d0a4c3ff6 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md @@ -7,6 +7,8 @@ weight: 3 # {{% param title %}} +This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Promtail][] has been completed before taking these steps. + ## Confirm Dashboards Load 1. Navigate to your Grafana website e.g. `https://{Team URL}.grafana.net` @@ -23,20 +25,10 @@ weight: 3 Any flow can be used that exists on the system and can be executed. {{% / alert %}} -1. Open an HTTP client, such as [Postman][]. Make a request with the following format: - | Property | Value | - |---------------|-------------------------------------------------------------------------------------| - | Action | POST | - | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| - | Content Type | application/json | - | Body | {} | - | Authentication| Basic | - | Username | The value used for `ApiGatewayBasicAuthUsername` when Application Services were installed.| - | Password | The value used for `ApiGatewayBasicAuthPassword` when Application Services were installed.| - - {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} - -1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. +1. Open a flow that you are able to execute on an adhoc basic. +1. Start the flow. +1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. 1. Click the *Flow Execution Requests* dashboard to open it. @@ -52,5 +44,5 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.UpgradePromtail" >}} [verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.VerifyOldVersion" >}} 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 4fc186ae4..91cab8f67 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 @@ -24,6 +24,8 @@ These steps will need to be performed on all application servers that host a Pro .\Remove-Promtail.ps1 ``` +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Promtail service is confirmed. 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: @@ -35,11 +37,11 @@ These steps will need to be performed on all application servers that host a Pro * Start-Promtail.ps1 * Stop-Promtail.ps1 -1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder performed as part of [Make Artefacts Available][]. +1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. 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. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. 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: +1. Open `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. * Update the *url* property under *clients* to be the value found in the [backed up][] version. 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 16d553d86..1a7dbf3e1 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 @@ -22,22 +22,22 @@ weight: 1 1. Download the required artefacts to a folder on your machine: - * [Grafana 10.4.1][] Standalone Windows Binaries. + * [Grafana 10.4.1][] Standalone Windows Binaries archive. * [Grafana Loki 3.0.0][] archive. * [Grafana Loki Install][] archive. * [Promtail 3.0.0][] archive. * [Promtail Install][] archive. -1. Extract the downloaded Grafana file to a folder with the same name. -1. Extract the downloaded Grafana Loki file to a folder with the same name. -1. Extract the downloaded Grafana Loki Install file to a folder with the same name. -1. Extract the downloaded Promtail file to a folder with the same name. -1. Extract the downloaded Promtail Install file to a folder with the same name. +1. Extract the downloaded `grafana-enterprise-10.4.1.windows-amd64` archive to a folder with the same name. +1. Extract the downloaded `loki-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Grafana.Loki.Install` archive to a folder with the same name. +1. Extract the downloaded `promtail-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Promtail.Install` archive to a folder with the same name. ## 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 previously installed to, e.g. `%SystemDrive%\Program Files\GrafanaLabs\grafana\conf`. +1. Open File Explorer and navigate to the location that Grafana was previously installed to, typically `%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/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md index 86cf66c00..6ac3c6569 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md @@ -7,6 +7,8 @@ weight: 5 # {{% param title %}} +This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Promtail][] has been completed before taking these steps. + ## Confirm Grafana Upgrade 1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000`. @@ -29,20 +31,10 @@ weight: 5 Any flow can be used that exists on the system and can be executed. {{% / alert %}} -1. Open an HTTP client, such as [Postman][]. Make a request with the following format: - | Property | Value | - |---------------|-------------------------------------------------------------------------------------| - | Action | POST | - | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| - | Content Type | application/json | - | Body | {} | - | Authentication| Basic | - | Username | The value used for `ApiGatewayBasicAuthUsername` when Application Services were installed.| - | Password | The value used for `ApiGatewayBasicAuthPassword` when Application Services were installed.| - - {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} - -1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. +1. Open a flow that you are able to execute on an adhoc basic. +1. Start the flow. +1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. 1. Click the *Flow Execution Requests* dashboard to open it. @@ -58,5 +50,5 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.UpgradePromtail" >}} [verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.OnPremise.Grafana.VerifyOldVersion" >}} 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 ef879f969..c60d9a272 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 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 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. In File Explorer, navigate to the `grafana-enterprise-10.4.1.windows-amd64` folder created as part of [Make Artefacts Available][]. +1. Open the `grafana-v10.4.1` subfolder. +1. Copy the contents of this folder into the Grafana install location, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana`, and click `Replace the files in the destination` when prompted. +1. Copy the [backed up][] `custom.ini` and `defaults.ini` files into the Grafana install configuration location, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana\conf`, and click `Replace the files in the destination` 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 3eddd9513..22e2eec7b 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 @@ -20,6 +20,8 @@ This guide describes how to upgrade the Loki installation. Please ensure that th .\Remove-Loki.ps1 ``` +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Loki service is confirmed. 1. Open a File Explorer and navigate to the folder where Loki was running from, e.g. `C:\Loki`. 1. Delete the following files from the directory: @@ -31,17 +33,37 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Start-Loki.ps1 * Stop-Loki.ps1 -1. In File Explorer, navigate to the extracted `loki-windows-amd64.exe` folder performed as part of [Make Artefacts Available][]. +1. In File Explorer, navigate to the extracted `loki-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. 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. In File Explorer, navigate to the extracted `Grafana.Loki.Install` folder created as part of [Make Artefacts Available][]. 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*. - * If there are differences under *schema_config*, copy the config from the backup and add it directly under configs in *schema_config*. - * Ensure the formatting is identical, including indentations, to that which is already found in the file. - * Update the pre-existing *schema_config* entry in the new `loki-local-config.yaml` file to start from todays date. - * Save the new `loki-local-config.yaml` file. +1. Open the new `loki-local-config.yaml` file in a text editor and compare against the [backed up][] version. If there are differences between the two files in the *schema_config* > *configs* section: + + 1. In the new file, change the date next to `- from` to be today's date. + 1. Copy the old config section from the backup and add it immediately under *configs* and before the existing `- from ` line ensuring that formatting (including indentations) remain identical to that which is used in the new file. + + The new *schema_config* should result in something similar to: + + ```yaml + schema_config: + configs: + - from: 2020-10-24 + store: boltdb-shipper + object_store: filesystem + schema: v11 + index: + prefix: index_ + period: 24h + - from: 2024-08-29 + store: tsdb + object_store: filesystem + schema: v13 + index: + prefix: index_ + period: 24h + ``` + + 1. Save the new `loki-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. 1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\Loki`. 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 76b211eaa..e317fb110 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 @@ -24,6 +24,8 @@ These steps will need to be performed on all application servers that host a Pro .\Remove-Promtail.ps1 ``` +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Promtail service is confirmed. 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: @@ -35,11 +37,11 @@ These steps will need to be performed on all application servers that host a Pro * Start-Promtail.ps1 * Stop-Promtail.ps1 -1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder performed as part of [Make Artefacts Available][]. +1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. 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. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. 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: +1. Open the new `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. * Update the *url* property under *clients* to be the value found in the [backed up][] version. From 761fffaa29309b79137394dd83ec4a24699a719a Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Fri, 30 Aug 2024 13:59:04 +0100 Subject: [PATCH 11/15] Added Dashboard Upgrade guide --- .../upgrade-observability/cloud/_index.md | 2 +- .../dashboards/Grafana/_index.md | 6 +++ .../dashboards/Grafana/try-it-out.md | 36 ++++++++++++++++ .../dashboards/Grafana/upgrade-dashboards.md | 42 +++++++++++++++++++ .../dashboards/_index.md | 6 +++ data/urls.toml | 5 +++ 6 files changed, 96 insertions(+), 1 deletion(-) create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/upgrade-dashboards.md create mode 100644 content/en/docs/2024.7/Guides/upgrade-observability/dashboards/_index.md diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md index c0d7a6beb..4eaa242d6 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/_index.md @@ -2,5 +2,5 @@ title: "Cloud" linkTitle: "Cloud" description: "Information about upgrading a cloud-hosted observability platform for {{% ctx %}}." -weight: 1000 +weight: 500 --- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md new file mode 100644 index 000000000..cd369f728 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md @@ -0,0 +1,6 @@ +--- +title: "Grafana" +linkTitle: "Grafana" +description: "Information about upgrading the default Grafana dashboards for your observability platform." +weight: 1000 +--- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md new file mode 100644 index 000000000..9b9d464d8 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md @@ -0,0 +1,36 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out the observability platform after upgrading the dashboards." +weight: 3 +--- + +# {{% param title %}} + +## Confirm New Dashboards Display Data + +{{% alert title="Note" %}} +Any flow can be used that exists on the system and can be executed. +{{% / alert %}} + +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. +1. Open a flow that you are able to execute on an adhoc basic. +1. Start the flow. +1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Requests* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Platform Health* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} + +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.UpgradePromtail" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeObservability.Cloud.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/upgrade-dashboards.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/upgrade-dashboards.md new file mode 100644 index 000000000..8a431a5e1 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/upgrade-dashboards.md @@ -0,0 +1,42 @@ +--- +title: "Upgrade Dashboards" +linkTitle: "Upgrade Dashboards" +description: "Information about upgrading your Grafana dashboards." +weight: 1 +--- + +# {{% param title %}} + +This guide describes how to upgrade the default dashboards that are provided for your observability platform. + +## Download the Default Dashboards + +1. Download [Grafana.Dashboards.zip][] archive containing the {{% ctx %}} Innovation default dashboards. +1. Extract the content of the downloaded archive to a suitable location. + +## Import New Dashboards + +## Import Dashboards + +1. Log in to your configured Grafana with a user that has the *Admin* role. +1. Go to *Dashboards* via the menu on the left sidebar. +1. Click the *New* button and select *Import* from the drop-down menu. +1. Click the *Upload JSON file* button. +1. Locate the `Flow Execution Requests.json` file [extracted][] from the downloaded `Grafana.Dashboards.zip`. +1. Select the file and click *Open*. +{{% alert title="Note" %}} +You will receive warnings that *A dashboard or folder with the same name already exists* and *Dashboard named 'Flow Execution Requests' in folder 'Cortex' has the same UID*. These can be ignored. +{{% / alert %}} + +1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. +1. Select your configured Loki data source from the dropdown menu. +1. Click *Import (Overwrite)*. +1. Repeat steps 2 - 8 for the `Platform Health.json` file. + +## Next Steps? + +1. [Try it out][] + +[extracted]: {{< url path="Cortex.Guides.UpgradeObservability.Dashboards.Grafana.Download" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaDashboardsZip" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeObservability.Dashboards.Grafana.TryItOut" >}} diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/_index.md new file mode 100644 index 000000000..4078c1304 --- /dev/null +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/_index.md @@ -0,0 +1,6 @@ +--- +title: "Dashboards" +linkTitle: "Dashboards" +description: "Information about upgrading the default dashboards provided for your observability platform." +weight: 1000 +--- \ No newline at end of file diff --git a/data/urls.toml b/data/urls.toml index efb661faf..ca32d90a3 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -538,6 +538,11 @@ TryItOut = "/docs/guides/upgrade-observability/cloud/grafana/try-it-out" UpgradePromtail = "/docs/guides/upgrade-observability/cloud/grafana/upgrade-promtail" VerifyOldVersion = "/docs/guides/upgrade-observability/cloud/grafana/prerequisites/#verify-old-version" + [Cortex.Guides.UpgradeObservability.Dashboards] + [Cortex.Guides.UpgradeObservability.Dashboards.Grafana] + Download = "/docs/guides/upgrade-observability/dashboards/grafana/upgrade-dashboards/#download-the-default-dashboards" + UpgradeDashboards = "/docs/guides/upgrade-observability/dashboards/grafana/upgrade-dashboards" + TryItOut = "/docs/guides/upgrade-observability/dashboards/grafana/try-it-out" [Cortex.Reference] MainDoc = "/docs/reference/" From 331ed86c75270bf3da816dcc91f1a97d49fece53 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Fri, 30 Aug 2024 14:20:00 +0100 Subject: [PATCH 12/15] Updated descriptions to read as change from default rather than the other way round --- .../perform-gateway-installation.md | 2 +- .../single-server-without-ha/install-web-application-server.md | 2 +- .../perform-gateway-installation.md | 2 +- .../single-server-without-ha/install-web-application-server.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 661794921..01307b5d3 100644 --- a/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -61,7 +61,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov |`CertificateFriendlyName` | Replace this with the friendly name that you would like to be allocated to the certificate.

If `ImportCertificate` is set to `$false` this must be [assigned][Assign Certificate Friendly Name] prior to running the installation and the Friendly Name used must be specified to allow the website to use the correct certificate.| |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is a newly created Cortex site or an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| |`ApplySecurityMeasures` | Change this from `$true` to `$false` if you do not require the Recommended [Security Best Practices][] to be implemented as part of the installation process.| - |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| + |`UsingWindowsDefender` | Change this from `$false` to `$true` if you are using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | diff --git a/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md b/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md index 0186e4d39..4d86fba50 100644 --- a/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md @@ -125,7 +125,7 @@ A Friendly Name should be assigned to the certificate being used for the Cortex |`CertificateFriendlyName` | Replace this with the friendly name that you would like to be allocated to the certificate.

If `ImportCertificate` is set to `$false`, this must be [assigned][Assign Certificate Friendly Name] prior to running the installation and the Friendly Name used must be specified to allow the website to use the correct certificate.| |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is a newly created Cortex site or an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| |`ApplySecurityMeasures` | Change this from `$true` to `$false` if you do not require the Recommended [Security Best Practices][] to be implemented as part of the installation process.| - |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| + |`UsingWindowsDefender` | Change this from `$false` to `$true` if you are using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | diff --git a/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index ef86d9528..547e5e1a0 100644 --- a/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -67,7 +67,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta |`CertificateFriendlyName` | Replace this with the friendly name that you would like to be allocated to the certificate.

If `ImportCertificate` is set to `$false` this must be [assigned][Assign Certificate Friendly Name] prior to running the installation and the Friendly Name used must be specified to allow the website to use the correct certificate.| |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is a newly created Cortex site or an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| |`ApplySecurityMeasures` | Change this from `$true` to `$false` if you do not require the Recommended [Security Best Practices][] to be implemented as part of the installation process.| - |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| + |`UsingWindowsDefender` | Change this from `$false` to `$true` if you are using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | diff --git a/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md b/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md index 5a48a3b64..ce88ad527 100644 --- a/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md @@ -168,7 +168,7 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi |`CertificateFriendlyName` | Replace this with the friendly name that you would like to be allocated to the certificate.

If `ImportCertificate` is set to `$false` this must be [assigned][Assign Certificate Friendly Name] prior to running the installation and the Friendly Name used must be specified to allow the website to use the correct certificate.| |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is a newly created {{% ctx %}} site or an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| |`ApplySecurityMeasures` | Change this from `$true` to `$false` if you do not require the Recommended [Security Best Practices][] to be implemented as part of the installation process.| - |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| + |`UsingWindowsDefender` | Change this from `$false` to `$true` if you are using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | From 6e5319d1f0ca8ec3a10a9bf7beda9ec44f2b5d1d Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Fri, 30 Aug 2024 15:03:11 +0100 Subject: [PATCH 13/15] Fixed spelling mistake following review --- .../Guides/upgrade-observability/cloud/grafana/try-it-out.md | 2 +- .../Guides/upgrade-observability/dashboards/Grafana/_index.md | 2 +- .../upgrade-observability/dashboards/Grafana/try-it-out.md | 2 +- .../upgrade-observability/on-premise/grafana/try-it-out.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md index d0a4c3ff6..017b74bfb 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md @@ -26,7 +26,7 @@ Any flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. -1. Open a flow that you are able to execute on an adhoc basic. +1. Open a flow that you are able to execute on an adhoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md index cd369f728..83fd0b271 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/_index.md @@ -1,6 +1,6 @@ --- title: "Grafana" linkTitle: "Grafana" -description: "Information about upgrading the default Grafana dashboards for your observability platform." +description: "Information about upgrading the default Grafana dashboards for your observability platform." weight: 1000 --- \ No newline at end of file diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md index 9b9d464d8..864eebf72 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md @@ -14,7 +14,7 @@ Any flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. -1. Open a flow that you are able to execute on an adhoc basic. +1. Open a flow that you are able to execute on an adhoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md index 6ac3c6569..50df8c095 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md @@ -32,7 +32,7 @@ Any flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. -1. Open a flow that you are able to execute on an adhoc basic. +1. Open a flow that you are able to execute on an adhoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. From 3dfe7c3fb6efad0b6a21374e696cc4f69f562849 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Fri, 30 Aug 2024 15:08:18 +0100 Subject: [PATCH 14/15] fixed spelling mistake --- .../Guides/upgrade-observability/cloud/grafana/try-it-out.md | 2 +- .../upgrade-observability/dashboards/Grafana/try-it-out.md | 2 +- .../upgrade-observability/on-premise/grafana/try-it-out.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md index 017b74bfb..32eb9a80d 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md @@ -26,7 +26,7 @@ Any flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. -1. Open a flow that you are able to execute on an adhoc basis. +1. Open a flow that you are able to execute on an ad hoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md index 864eebf72..8d6a1f756 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md @@ -14,7 +14,7 @@ Any flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. -1. Open a flow that you are able to execute on an adhoc basis. +1. Open a flow that you are able to execute on an ad hoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md index 50df8c095..e5c4b7283 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md @@ -32,7 +32,7 @@ Any flow can be used that exists on the system and can be executed. {{% / alert %}} 1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. -1. Open a flow that you are able to execute on an adhoc basis. +1. Open a flow that you are able to execute on an ad hoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. 1. Open the *Dashboards* page via the menu on the left sidebar. From e057e9eade3437df64d730041575fe838ed9d574 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Fri, 30 Aug 2024 15:37:24 +0100 Subject: [PATCH 15/15] fixed URL issue --- .../Guides/upgrade-observability/cloud/grafana/try-it-out.md | 2 +- .../upgrade-observability/dashboards/Grafana/try-it-out.md | 2 +- .../upgrade-observability/on-premise/grafana/try-it-out.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md index 32eb9a80d..f6d53e219 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/cloud/grafana/try-it-out.md @@ -25,7 +25,7 @@ This guide describes how to verify that the upgrade has been successful. Please Any flow can be used that exists on the system and can be executed. {{% / alert %}} -1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. `https://server.domain.com/gateway`, and log in when prompted. 1. Open a flow that you are able to execute on an ad hoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md index 8d6a1f756..09b163023 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/dashboards/Grafana/try-it-out.md @@ -13,7 +13,7 @@ weight: 3 Any flow can be used that exists on the system and can be executed. {{% / alert %}} -1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. `https://server.domain.com/gateway`, and log in when prompted. 1. Open a flow that you are able to execute on an ad hoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. diff --git a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md index e5c4b7283..3f46dd3c6 100644 --- a/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2024.7/Guides/upgrade-observability/on-premise/grafana/try-it-out.md @@ -31,7 +31,7 @@ This guide describes how to verify that the upgrade has been successful. Please Any flow can be used that exists on the system and can be executed. {{% / alert %}} -1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. https://server.domain.com/gateway, and log in when prompted. +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. `https://server.domain.com/gateway`, and log in when prompted. 1. Open a flow that you are able to execute on an ad hoc basis. 1. Start the flow. 1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana.