From 2a62685c46e5d185386513bb9e8bd100bfacf611 Mon Sep 17 00:00:00 2001 From: Adam Boguszewski Date: Mon, 28 Nov 2022 14:16:38 +0100 Subject: [PATCH] docs: remove dead links to v1 and v2 docs --- deploy/docs/v1_conf_examples.md | 3 --- deploy/docs/v1_migration_doc.md | 3 --- deploy/docs/v2_migration_doc.md | 3 --- docs/README.md | 7 +++++-- docs/best-practices.md | 2 -- docs/existing-prometheus-doc.md | 2 -- docs/non-helm-installation.md | 3 --- docs/side-by-side-prometheus.md | 2 -- docs/standalone-prometheus.md | 2 -- docs/troubleshoot-collection.md | 4 +--- 10 files changed, 6 insertions(+), 25 deletions(-) delete mode 100644 deploy/docs/v1_conf_examples.md delete mode 100644 deploy/docs/v1_migration_doc.md delete mode 100644 deploy/docs/v2_migration_doc.md diff --git a/deploy/docs/v1_conf_examples.md b/deploy/docs/v1_conf_examples.md deleted file mode 100644 index 2534922a9e..0000000000 --- a/deploy/docs/v1_conf_examples.md +++ /dev/null @@ -1,3 +0,0 @@ -# Configuring Fluentd - -Moved to [/docs/v1-conf-examples.md](/docs/v1-conf-examples.md) diff --git a/deploy/docs/v1_migration_doc.md b/deploy/docs/v1_migration_doc.md deleted file mode 100644 index ae84beefbc..0000000000 --- a/deploy/docs/v1_migration_doc.md +++ /dev/null @@ -1,3 +0,0 @@ -# Kubernetes Collection 1.0.0 - Breaking Changes - -Moved to [/docs/v1-migration-doc.md](/docs/v1-migration-doc.md) diff --git a/deploy/docs/v2_migration_doc.md b/deploy/docs/v2_migration_doc.md deleted file mode 100644 index e239a57f81..0000000000 --- a/deploy/docs/v2_migration_doc.md +++ /dev/null @@ -1,3 +0,0 @@ -# Kubernetes Collection `v2.0.0` - Breaking Changes - -Moved to [/docs/v2-migration-doc.md](/docs/v2-migration-doc.md) diff --git a/docs/README.md b/docs/README.md index a35cbcdd52..de8b2a35cc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -36,8 +36,8 @@ Documentation links: - [Traces - auto-instrumentation in Kubernetes](https://help.sumologic.com/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/kubernetes) - Upgrades - - [Upgrade from v0.17 to v1.0](/docs/v1-migration-doc.md) - - [Upgrade from v1.3 to v2.0](/docs/v2-migration-doc.md) + - [Upgrade from v0.17 to v1.0][migration-doc-v1] + - [Upgrade from v1.3 to v2.0][migration-doc-v2] - [Migration steps from `SumoLogic/fluentd-kubernetes-sumologic`](/docs/migration-steps.md) - [Troubleshooting Collection](/docs/troubleshoot-collection.md) @@ -45,6 +45,9 @@ Documentation links: - [Performance estimates for running collection chart](/docs/performance.md) - [Dev Releases](/docs/dev.md) +[migration-doc-v1]: https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/release-v2/deploy/docs/v1_migration_doc.md +[migration-doc-v2]: https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/release-v2/deploy/docs/v2_migration_doc.md + ## Solution overview The diagram below illustrates the components of the Kubernetes collection solution. diff --git a/docs/best-practices.md b/docs/best-practices.md index 179bd448ed..22780d647e 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -621,8 +621,6 @@ fluentd: You can find more information on the `grep` filter plugin in the [fluentd documentation](https://docs.fluentd.org/filter/grep). -Refer to our [documentation](v1-conf-examples.md) for other examples of how you can -customize the fluentd pipeline. ## Modifying logs in Fluentd diff --git a/docs/existing-prometheus-doc.md b/docs/existing-prometheus-doc.md index 580156b55c..c5f876ea7f 100644 --- a/docs/existing-prometheus-doc.md +++ b/docs/existing-prometheus-doc.md @@ -315,8 +315,6 @@ helm upgrade --install my-release sumologic/sumologic -f user-values.yaml ## Upgrading Sumo Logic Collection -__Note, if you are upgrading to version 1.x of our collection from a version before 1.x, please see our [migration guide](v1-migration-doc.md).__ - To upgrade our helm chart to a newer version, you must first run update your local helm repo. ```bash diff --git a/docs/non-helm-installation.md b/docs/non-helm-installation.md index 8506d298ba..07cba87bfd 100644 --- a/docs/non-helm-installation.md +++ b/docs/non-helm-installation.md @@ -321,9 +321,6 @@ cat user-values.yaml | \ ## Upgrading Sumo Logic Collection -**Note, if you are upgrading to version 1.x of our collection from a version before 1.x, -please see our [migration guide](v1-migration-doc.md).** - To upgrade you can simply re-generate the YAML when a new version of the Kubernetes collection is available. You can use the same commands used to create the YAML in the first place. diff --git a/docs/side-by-side-prometheus.md b/docs/side-by-side-prometheus.md index fb50cde795..f2a6ad66be 100644 --- a/docs/side-by-side-prometheus.md +++ b/docs/side-by-side-prometheus.md @@ -370,8 +370,6 @@ helm upgrade --install my-release sumologic/sumologic -f user-values.yaml ### Upgrading Sumo Logic Collection -**Note, if you are upgrading to version 1.x of our collection from a version before 1.x, please see our [migration guide](v1-migration-doc.md).** - To upgrade our helm chart to a newer version, you must first run update your local helm repo. ```bash diff --git a/docs/standalone-prometheus.md b/docs/standalone-prometheus.md index 0223b2eece..e57fcee474 100644 --- a/docs/standalone-prometheus.md +++ b/docs/standalone-prometheus.md @@ -225,8 +225,6 @@ helm upgrade --install my-release sumologic/sumologic -f user-values.yaml ## Upgrading Sumo Logic Collection -__Note, if you are upgrading to version 1.x of our collection from a version before 1.x, please see our [migration guide](v1-migration-doc.md).__ - To upgrade our Helm chart to a newer version, you must first run update your local Helm repo. ```bash diff --git a/docs/troubleshoot-collection.md b/docs/troubleshoot-collection.md index 959bacb1fd..0bce161128 100644 --- a/docs/troubleshoot-collection.md +++ b/docs/troubleshoot-collection.md @@ -494,9 +494,7 @@ If you observe the following errors from Fluentd pods: 2021-01-18 15:47:23 +0000 [warn]: #0 [sumologic.endpoint.logs.gc] failed to flush the buffer. retry_time=3 next_retry_seconds=2021-01-18 15:47:27 +0000 chunk="5b92e97a5ee3cbd7e59859644d9686e3" error_class=Zlib::GzipFile::Error error="not in gzip format" ``` -Please see [migration topic on that](v2-migration-doc.md#gzip-compression-errors). - -If the problem still occurs, please disable gzip compression for buffer. +Please disable gzip compression for buffer. Add following configuration to your `user-values.yaml` and upgrade collection: ```yaml