Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "4.1.0 to 4.2.1"
linkTitle: "4.1.0 to 4.2.1"
description: "Instructions to upgrade your observability platform for {{% ctx %}} from 4.1.0 to 4.2.1."
weight: 970
---

{{% alert title="Note" %}}
There is no upgrade to 4.2.1 required for cloud-hosted observability platforms.
{{% / alert %}}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ On the server that Grafana Loki is installed on:
1. Open a File Explorer and navigate to the folder that Grafana Loki is running from, e.g. `C:\ProgramData\Cortex\Observability\Loki`.
1. Open the `loki-local-config.yaml` configuration file in a text editor.
1. Search the file for `compactor:`.
1. If the search returns no results, proceed with the upgrade process, if results are returned then Observability has already been updated to 4.2.0 automatically as part of the [3.0.0 to 4.0.0][] upgrade and no further steps are required.
1. If the search returns no results, proceed with the upgrade process, if results are returned then Observability has already been updated to 4.2.1 automatically as part of the [3.0.0 to 4.0.0][] upgrade and no further steps are required.

## Backup Old Files

Expand All @@ -28,4 +28,4 @@ On the server that Grafana Loki is installed on:
1. [Upgrade Grafana Loki][]

[3.0.0 to 4.0.0]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3_0_0to4_0_0.OnPremise.Grafana.MainDoc" >}}
[Upgrade Grafana Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0.OnPremise.Grafana.UpgradeLoki" >}}
[Upgrade Grafana Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_1.OnPremise.Grafana.UpgradeLoki" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ Loki may take some time to remove logs older than the retention period, therefor
{{% / alert %}}

[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}}
[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0.OnPremise.Grafana.UpgradeLoki" >}}
[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_1.OnPremise.Grafana.UpgradeLoki" >}}
[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}}
[Postman]: {{< url path="Postman.Downloads.MainDoc" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,5 @@ On the server that Grafana Loki is installed on:

1. [Try it out][]

[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0.OnPremise.Grafana.BackupOldFiles" >}}
[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0.OnPremise.Grafana.Prerequisites" >}}
[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0.OnPremise.Grafana.TryItOut" >}}
[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_1.OnPremise.Grafana.Prerequisites" >}}
[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_1.OnPremise.Grafana.TryItOut" >}}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
28.4.0.25430
29.1.2.26142
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported:

[configured Loki data source]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}}
[Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}}
[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4_1_0.GrafanaDashboardsZip" >}}
[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaDashboardsZip" >}}
[Loki]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}}
[Try it Out]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.TryItOut.MainDoc" >}}
[Try it Out]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.TryItOut.MainDoc" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ This archive contains the `config.alloy` configuration file and PowerShell scrip

[Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy.MainDoc" >}}
[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}}
[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_1_0.GrafanaAlloyInstallZip" >}}
[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaAlloyInstallZip" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ This archive contains the `config.alloy` configuration file and PowerShell scrip

[Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy" >}}
[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}}
[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_1_0.GrafanaAlloyInstallZip" >}}
[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaAlloyInstallZip" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
[Reverse Proxy Authentication]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureAuthentication" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,25 @@ If the order is incorrect:
1. Select the newly created website.
1. In the *Manage Website* pane, click *Restart*.

## Configure Log Retention

Grafana Loki is configured with a default retention period of 12 months for it's logs. This means that Grafana can query data up to 12 months old. Once the 12 months is reached, Loki will remove older logs.

If a different retention period is required then this can be set, however, it should only be set to the period that is needed otherwise excessive disk space may be used unnecessarily.

To change the retention period:

1. Open the `loki-local-config.yaml` configuration file, which is located in the folder that Loki was installed to eg `C:\ProgramData\Cortex\Observability\Loki`.
1. Locate the `retention_period:` configuration value at approximately line 55.
1. Set the value of the retention required in hours, e.g. 6 months would be `4380h` or 9 months would be `6570h`.
1. Save the file.

### Re-Start the Grafana Loki Service

1. Open `services.msc`.
1. Locate the `Loki` service.
1. Right click on the service name and select `Restart`. If the service is not already running, select `Start`.

## Next Steps?

1. [Install Grafana Alloy][]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ This archive contains the `loki-local-config.yaml` configuration file, [NSSM][]

[Configure Loki]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureLoki" >}}
[Grafana Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5.GrafanaLokiInstallZip" >}}
[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.4_1_0.GrafanaLokiInstallZip" >}}
[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaLokiInstallZip" >}}
[NSSM]: {{< url path="NSSM.MainDoc" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
[Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported:

1. [Try it Out][]

[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4_1_0.GrafanaDashboardsZip" >}}
[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaDashboardsZip" >}}
[Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.MainDoc" >}}
[Loki]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.MainDoc" >}}
[Try it Out]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.TryItOut" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Log on to Gateway and run through the setup wizard:
Password: `Adm1n1strat0r`
1. On a newly installed system, you will be presented with a Setup Wizard at this point, which will guide you through some basic configuration steps:
* [Account Details]
* [LDAP Connection]
* [LDAP Authorisation]
* [Authentication]
* [Authorisation]
1. Follow the steps in the setup wizard to configure the relevant areas:

### Account Details
Expand All @@ -36,8 +36,9 @@ Log on to Gateway and run through the setup wizard:
1. Change the Administrator password to a unique, secret password and click `Next Step`:
{{< figure class="centre" src="/images/Gateway Setup3.png" title="Change Password Screen" >}}

### LDAP Connection
### Authentication

1. Select the LDAP tab.
1. Enter the details of your Active Directory server and provide a Username and Password for a user with read access to it:

A connection to an Active Directory server must be established in order to assign authorisation rights to users.
Expand All @@ -49,9 +50,9 @@ Log on to Gateway and run through the setup wizard:
1. To reduce the scope of any Active Directory searches, add one or more base DNs (Distinguished Names). For each base DN click `Add` and enter the full LDAP path e.g `CN=group, OU=organisational unit, DC=domain, DC=com`. These will be used as the roots of any Active Directory searches performed. For more information about distinguished names see <https://msdn.microsoft.com/en-us/library/aa366101(v=vs.85).aspx>.
1. Click `Test Connection` to validate the connection and the user credentials entered and click `Next Step`.

{{< figure class="centre" src="/images/Gateway Setup4.png" title="LDAP Connection Screen" >}}
{{< figure class="centre" src="/images/Gateway Setup4.png" title="Authentication Screen" >}}

### LDAP Authorisation
### Authorisation

1. If the authorisation grid fails to load first time round, click `Retry`.
1. Assign access permissions to Active Directory groups:
Expand All @@ -67,7 +68,7 @@ Log on to Gateway and run through the setup wizard:
1. Expand the groups or OUs, or search for the group or OU, to be assigned one or more roles.
1. Check the relevant roles for each group. Checking a parent group will cascade the setting to all child groups.

{{< figure class="centre" src="/images/Gateway Setup5.png" title="LDAP Authorisation Screen" >}}
{{< figure class="centre" src="/images/Gateway Setup5.png" title="Authorisation Screen" >}}

1. Click `Complete Setup` to commit the changes.
1. To test the permissions, log out as Administrator and then log in as a user with `Studio` permissions.
Expand All @@ -78,7 +79,7 @@ Log on to Gateway and run through the setup wizard:

[Account Details]: {{< ref "#account-details" >}}
[Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallationNew" >}}
[LDAP Authorisation]: {{< ref "#ldap-authorisation" >}}
[LDAP Connection]: {{< ref "#ldap-connection" >}}
[Authorisation]: {{< ref "#authorisation" >}}
[Authentication]: {{< ref "#authentication" >}}
[supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebBrowserRequirementsNew" >}}
[Post-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PostInstallation" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Log on to Gateway and run through the setup wizard:
Password: `Adm1n1strat0r`
1. On a newly installed system, you will be presented with a Setup Wizard at this point, which will guide you through some basic configuration steps:
* [Account Details]
* [LDAP Connection]
* [LDAP Authorisation]
* [Authentication]
* [Authorisation]
1. Follow the steps in the setup wizard to configure the relevant areas:

### Account Details
Expand All @@ -36,8 +36,9 @@ Log on to Gateway and run through the setup wizard:
1. Change the Administrator password to a unique, secret password and click `Next Step`:
{{< figure class="centre" src="/images/Gateway Setup3.png" title="Change Password Screen" >}}

### LDAP Connection
### Authentication

1. Select the LDAP tab.
1. Enter the details of your Active Directory server and provide a Username and Password for a user with read access to it:

A connection to an Active Directory server must be established in order to assign authorisation rights to users.
Expand All @@ -49,9 +50,9 @@ Log on to Gateway and run through the setup wizard:
1. To reduce the scope of any Active Directory searches, add one or more base DNs (Distinguished Names). For each base DN click `Add` and enter the full LDAP path e.g `CN=group, OU=organisational unit, DC=domain, DC=com`. These will be used as the roots of any Active Directory searches performed. For more information about distinguished names see <https://msdn.microsoft.com/en-us/library/aa366101(v=vs.85).aspx>.
1. Click `Test Connection` to validate the connection and the user credentials entered and click `Next Step`.

{{< figure class="centre" src="/images/Gateway Setup4.png" title="LDAP Connection Screen" >}}
{{< figure class="centre" src="/images/Gateway Setup4.png" title="Authentication Screen" >}}

### LDAP Authorisation
### Authorisation

1. If the authorisation grid fails to load first time round, click `Retry`.
1. Assign access permissions to Active Directory groups:
Expand All @@ -67,7 +68,7 @@ Log on to Gateway and run through the setup wizard:
1. Expand the groups or OUs, or search for the group or OU, to be assigned one or more roles.
1. Check the relevant roles for each group. Checking a parent group will cascade the setting to all child groups.

{{< figure class="centre" src="/images/Gateway Setup5.png" title="LDAP Authorisation Screen" >}}
{{< figure class="centre" src="/images/Gateway Setup5.png" title="Authorisation Screen" >}}

1. Click `Complete Setup` to commit the changes.
1. To test the permissions, log out as Administrator and then log in as a user with `Studio` permissions.
Expand All @@ -77,8 +78,8 @@ Log on to Gateway and run through the setup wizard:
1. [Post-Installation][]

[Account Details]: {{< ref "#account-details" >}}
[LDAP Authorisation]: {{< ref "#ldap-authorisation" >}}
[LDAP Connection]: {{< ref "#ldap-connection" >}}
[Authorisation]: {{< ref "#authorisation" >}}
[Authentication]: {{< ref "#authentication" >}}
[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServerNew" >}}
[supported web browser]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.WebBrowserRequirementsNew" >}}
[Post-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PostInstallation" >}}
[Post-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PostInstallation" >}}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "4.1.0 to 4.2.1"
linkTitle: "4.1.0 to 4.2.1"
description: "Instructions to upgrade your observability platform for {{% ctx %}} from 4.1.0 to 4.2.1."
weight: 970
---

{{% alert title="Note" %}}
There is no upgrade to 4.2.1 required for cloud-hosted observability platforms.
{{% / alert %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "On-Premise"
linkTitle: "On-Premise"
description: "Information about upgrading an on-premise observability platform for {{% ctx %}}."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Grafana"
linkTitle: "Grafana"
description: "Information about upgrading an on-premise Grafana platform for {{% ctx %}}."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "Prerequisites"
linkTitle: "Prerequisites"
description: "The prerequisites required before performing the observability upgrade."
weight: 1
---

# {{% param title %}}

## Verify Upgrade Required

On the server that Grafana Loki is installed on:

1. Log in to the server.
1. Open a File Explorer and navigate to the folder that Grafana Loki is running from, e.g. `C:\ProgramData\Cortex\Observability\Loki`.
1. Open the `loki-local-config.yaml` configuration file in a text editor.
1. Search the file for `compactor:`.
1. If the search returns no results, proceed with the upgrade process, if results are returned then Observability has already been updated to 4.2.1 automatically as part of the [3.0.0 to 4.0.0][] upgrade and no further steps are required.

## Backup Old Files

1. On the server that Grafana 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 Loki is running from, e.g. `C:\ProgramData\Cortex\Observability\Loki\`.
1. Copy the `loki-local-config.yaml` file and save it to the `Observability Backups` folder created at step 1.

## Next Steps?

1. [Upgrade Grafana Loki][]

[3.0.0 to 4.0.0]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3_0_0to4_0_0.OnPremise.Grafana.MainDoc" >}}
[Upgrade Grafana Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_1.OnPremise.Grafana.UpgradeLoki" >}}
Loading
Loading