From 6b9f82d7f97cc89ba93f1f3b6e1c52c3b90492aa Mon Sep 17 00:00:00 2001 From: Edward Welch Date: Thu, 2 Apr 2020 07:42:42 -0400 Subject: [PATCH] Adding a config change in release 1.4 upgrade doc Updating readme with links to new docs Signed-off-by: Edward Welch --- CHANGELOG.md | 2 +- README.md | 27 ++++++++++++++++----------- docs/configuration/README.md | 2 +- docs/operations/upgrade.md | 12 +++++++++++- 4 files changed, 29 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bf217035f84e..64968382abc4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ Over 130 PR's merged for this release, from 40 different contributors!! We cont Before we get into new features, version 1.4.0 brings with it the first (that we are aware of) upgrade dependency. -We have created a dedicated page for upgrading Loki in the [operations section of the docs](https://github.com/grafana/loki/tree/v1.4.0/docs/operations/upgrade.md) +We have created a dedicated page for upgrading Loki in the [operations section of the docs](https://github.com/grafana/loki/blob/master/docs/operations/upgrade.md#140) The docker image tag naming was changed, the starting in 1.4.0 docker images no longer have the `v` prefix: `grafana/loki:1.4.0` diff --git a/README.md b/README.md index 2432f4bd6162..299c9c49985a 100644 --- a/README.md +++ b/README.md @@ -39,25 +39,30 @@ Once you have Promtail, Loki, and Grafana running, continue with our [Getting Started Guide](https://github.com/grafana/loki/tree/v1.3.0/docs/getting-started/README.md) to get up and running with querying logs. +## Upgrading + +[Upgrading Loki](https://github.com/grafana/loki/blob/master/docs/operations/upgrade.md) + ### Documentation * [master](./docs/README.md) +* [v1.4.0](https://github.com/grafana/loki/tree/v1.4.0/docs/README.md) * [v1.3.0](https://github.com/grafana/loki/tree/v1.3.0/docs/README.md) * [v1.2.0](https://github.com/grafana/loki/tree/v1.2.0/docs/README.md) * [v1.1.0](https://github.com/grafana/loki/tree/v1.1.0/docs/README.md) * [v1.0.0](https://github.com/grafana/loki/tree/v1.0.0/docs/README.md) -Commonly used sections (from the latest release v1.3.0): - -- [API documentation](https://github.com/grafana/loki/tree/v1.3.0/docs/api.md) for alternative ways of getting logs into Loki. -- [Operations](https://github.com/grafana/loki/tree/v1.3.0/docs/operations) for important aspects of running Loki. -- [Promtail](https://github.com/grafana/loki/tree/v1.3.0/docs/clients/promtail) is an agent which can tail your log files and push them to Loki. -- [Pipelines](https://github.com/grafana/loki/tree/v1.3.0/docs/clients/promtail/pipelines.md) for detailed log processing pipeline documentation -- [Docker Logging Driver](https://github.com/grafana/loki/tree/v1.3.0/docs/clients/docker-driver) is a docker plugin to send logs directly to Loki from Docker containers. -- [LogCLI](https://github.com/grafana/loki/tree/v1.3.0/docs/getting-started/logcli.md) on how to query your logs without Grafana. -- [Loki Canary](https://github.com/grafana/loki/tree/v1.3.0/docs/operations/loki-canary.md) for monitoring your Loki installation for missing logs. -- [Troubleshooting](https://github.com/grafana/loki/tree/v1.3.0/docs/getting-started/troubleshooting.md) for help around frequent error messages. -- [Loki in Grafana](https://github.com/grafana/loki/tree/v1.3.0/docs/getting-started/grafana.md) for how to set up a Loki datasource in Grafana and query your logs. +Commonly used sections (from the latest release v1.4.0): + +- [API documentation](https://github.com/grafana/loki/tree/v1.4.0/docs/api.md) for alternative ways of getting logs into Loki. +- [Operations](https://github.com/grafana/loki/tree/v1.4.0/docs/operations) for important aspects of running Loki. +- [Promtail](https://github.com/grafana/loki/tree/v1.4.0/docs/clients/promtail) is an agent which can tail your log files and push them to Loki. +- [Pipelines](https://github.com/grafana/loki/tree/v1.4.0/docs/clients/promtail/pipelines.md) for detailed log processing pipeline documentation +- [Docker Logging Driver](https://github.com/grafana/loki/tree/v1.4.0/docs/clients/docker-driver) is a docker plugin to send logs directly to Loki from Docker containers. +- [LogCLI](https://github.com/grafana/loki/tree/v1.4.0/docs/getting-started/logcli.md) on how to query your logs without Grafana. +- [Loki Canary](https://github.com/grafana/loki/tree/v1.4.0/docs/operations/loki-canary.md) for monitoring your Loki installation for missing logs. +- [Troubleshooting](https://github.com/grafana/loki/tree/v1.4.0/docs/getting-started/troubleshooting.md) for help around frequent error messages. +- [Loki in Grafana](https://github.com/grafana/loki/tree/v1.4.0/docs/getting-started/grafana.md) for how to set up a Loki datasource in Grafana and query your logs. ## Getting Help diff --git a/docs/configuration/README.md b/docs/configuration/README.md index 9968b29ecd52..113dd81135ac 100644 --- a/docs/configuration/README.md +++ b/docs/configuration/README.md @@ -581,7 +581,7 @@ the index to a backing cache store. # The default validity of entries for caches unless overridden. # "defaul" is correct. -[defaul_validity: ] +[default_validity: ] # Configures the background cache when memcached is used. background: diff --git a/docs/operations/upgrade.md b/docs/operations/upgrade.md index 4ee32a8befdb..9e9883851181 100644 --- a/docs/operations/upgrade.md +++ b/docs/operations/upgrade.md @@ -8,7 +8,17 @@ On this page we will document any upgrade issues/gotchas/considerations we are a ## 1.4.0 -Loki 1.4.0 vendors Cortex v0.7.0-rc.0 which contains [several breaking config changes](https://github.com/cortexproject/cortex/blob/v0.7.0-rc.0/CHANGELOG.md), however, you would only be affected if you were configuring your schema via arguments and not a config file. This is not something we had ever provided as an option via docs and is unlikely anyone is doing, but worth mentioning. None of the other config changes are relevant to Loki. +Loki 1.4.0 vendors Cortex v0.7.0-rc.0 which contains [several breaking config changes](https://github.com/cortexproject/cortex/blob/v0.7.0-rc.0/CHANGELOG.md). + +One such config change which will affect Loki users: + +In the [cache_config](../configuration/README.md#cache_config): + +`defaul_validity` has changed to `default_validity` + +Also in the unlikely case you were configuring your schema via arguments and not a config file, this is no longer supported. This is not something we had ever provided as an option via docs and is unlikely anyone is doing, but worth mentioning. + +The other config changes should not be relevant to Loki. ### Required Upgrade Path