add upgrade advisory to all docs

Signed-off-by: Daniel Holbach <[email protected]>
fluxcd · Nov 1, 2022 · 42cb2cf · 42cb2cf
1 parent 5d8a8de
commit 42cb2cf
Show file tree

Hide file tree

Showing 26 changed files with 208 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,13 @@
 # Flux
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 ![Flux v1 Diagram](_files/flux-cd-diagram.png)
 
 Flux is a tool that automatically ensures that the state of a cluster matches

diff --git a/docs/contributing/building.md b/docs/contributing/building.md
@@ -1,5 +1,13 @@
 # Building Flux
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 You'll need a working `go` environment version >= 1.11 (official releases are built against `1.13`).
 It's also expected that you have a Docker daemon for building images.
 

diff --git a/docs/contributing/get-started-developing.md b/docs/contributing/get-started-developing.md
@@ -1,5 +1,13 @@
 # Get started developing
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This guide shows a workflow for making a small (actually, tiny) change
 to Flux, building and testing that change locally.
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,5 +1,13 @@
 # Frequently asked questions
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 ## Migrate to Flux v2
 
 [Flux v1 is in maintenance](https://github.com/fluxcd/flux/issues/3320) on the road to becoming formally superseded by Flux v2. Flux users are all encouraged to [migrate to Flux v2](https://fluxcd.io/flux/migration/flux-v1-migration/) as early as possible.

diff --git a/docs/get-started.md b/docs/get-started.md
@@ -1,5 +1,13 @@
 # Get started
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 All you need is a Kubernetes cluster and a git repo. The git repo
 contains [manifests](https://kubernetes.io/docs/concepts/configuration/overview/)
 (as YAML files) describing what should run in the cluster. Flux imposes

diff --git a/docs/guides/provide-own-ssh-key.md b/docs/guides/provide-own-ssh-key.md
@@ -1,5 +1,13 @@
 # Providing your own SSH key
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Flux connects to the repository using an SSH key it retrieves from a
 Kubernetes secret, if the configured (`--k8s-secret-name`) secret has
 no `identity` key/value pair, it will generate new private key.

diff --git a/docs/guides/upgrading-to-1.0.md b/docs/guides/upgrading-to-1.0.md
@@ -1,5 +1,13 @@
 # Upgrading to Flux v1
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Flux v1 is a major improvement over the previous versions, and is
 different enough that you need to do a bit of work to upgrade it.
 

diff --git a/docs/guides/use-git-https.md b/docs/guides/use-git-https.md
@@ -1,5 +1,13 @@
 # Using Git over HTTPS
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Instead of making use of Flux' capabilities to generate an SSH private
 key, or [supplying your own](provide-own-ssh-key.md), it is possible to
 set environment variables and use these in your `--git-url` argument to

diff --git a/docs/guides/use-gke-workload-identity.md b/docs/guides/use-gke-workload-identity.md
@@ -1,5 +1,13 @@
 # Using GKE Workload Identity with Flux
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 When Flux is running in a GKE cluster with [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) enabled and you use Google Container Registry to host private images in your project, there are additional steps required for Flux to be able to check for updated images.
 
 Without Workload Identity, Pods in the cluster by default assume the default IAM account of the GCP compute instances they are running on. With Workload Identity enabled, however, VM instance and Pod identity is completely separate. This results in Flux no longer being able to access a private GCR registry in the same project.

diff --git a/docs/guides/use-private-git-host.md b/docs/guides/use-private-git-host.md
@@ -1,5 +1,13 @@
 # Using a private Git host
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 If you're using your own git host -- e.g., your own installation of
 gitlab, or bitbucket server -- you will need to add its host key to
 `~/.ssh/known_hosts` in the Flux daemon container.

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,5 +1,13 @@
 # Introducing Flux
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Continuous delivery is a term that encapsulates a set of best practices
 that surround building, deploying and monitoring applications. The
 goal is to provide a sustainable model for maintaining and improving

diff --git a/docs/references/automated-image-update.md b/docs/references/automated-image-update.md
@@ -1,5 +1,13 @@
 # Automated deployment of new container images
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Flux can be used to automate container image updates in your cluster.
 Flux periodically scans the pods running in your cluster and builds a list of all container images.
 Using the image pull secrets, it connects to the container registries, pulls the images metadata

diff --git a/docs/references/blueprint.md b/docs/references/blueprint.md
@@ -1,5 +1,13 @@
 # Blueprint
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This page describes the goals of Flux, how it achieves them and
 significant architectural decisions. It is intentionally high level
 to prevent it from being out of date too quickly.

diff --git a/docs/references/daemon.md b/docs/references/daemon.md
@@ -1,5 +1,13 @@
 # Daemon (fluxd)
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 ## Summary
 
 Flux daemon (`fluxd`, aka Flux agent) allows automation of application deployments and version control of cluster configuration.

diff --git a/docs/references/fluxctl.md b/docs/references/fluxctl.md
@@ -1,5 +1,13 @@
 # fluxctl
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 `fluxctl` provides an API that can be used from the command line.
 
 The `--help` for `fluxctl` is described below.

diff --git a/docs/references/fluxyaml-config-files.md b/docs/references/fluxyaml-config-files.md
@@ -1,5 +1,13 @@
 # Manifest generation through .flux.yaml configuration files
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This feature lets you generate Kubernetes manifests with a program,
 instead of having to include them in your git repo as YAML files. For
 example, you can use `kustomize` to patch a common set of resources to

diff --git a/docs/references/garbagecollection.md b/docs/references/garbagecollection.md
@@ -1,5 +1,13 @@
 # Garbage collection
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Part of syncing a cluster with a git repository is getting rid of
 resources in the cluster that have been removed in the repository. You
 can tell `fluxd` to do this "garbage collection" using the command-line

diff --git a/docs/references/git-gpg.md b/docs/references/git-gpg.md
@@ -1,5 +1,13 @@
 # Git commit signing and verification
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 ## Summary
 
 Flux can be configured to sign commits that it makes to the user git

diff --git a/docs/references/helm-operator-integration.md b/docs/references/helm-operator-integration.md
@@ -1,5 +1,13 @@
 # Integration with the Helm Operator
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 You can release charts to your cluster via "GitOps", by combining Flux
 and the [Helm Operator](https://github.com/fluxcd/helm-operator).
 

diff --git a/docs/references/monitoring.md b/docs/references/monitoring.md
@@ -1,5 +1,13 @@
 # Monitoring Flux
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 The Flux daemon exposes `/metrics` endpoints which can be scraped for
 monitoring data in Prometheus format; exact metric names and help are
 available from the endpoints themselves.

diff --git a/docs/requirements.md b/docs/requirements.md
@@ -1,5 +1,13 @@
 # Requirements and limitations
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Flux has some requirements of the files it finds in your git repo.
 
  * Flux can only deal with one such repo at a time. This limitation is

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -1,5 +1,13 @@
 # Troubleshooting
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 Also see the [issues labeled with
 `FAQ`](https://github.com/fluxcd/flux/labels/FAQ), which often
 explain workarounds.

diff --git a/docs/tutorials/driving-flux.md b/docs/tutorials/driving-flux.md
@@ -1,5 +1,13 @@
 # Automations, locks and annotations
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 In this tutorial we want to get a better feel for what we can do with
 Flux. We won't spend too much time with getting it up and running, so let's
 get that out of the way first.

diff --git a/docs/tutorials/get-started-helm.md b/docs/tutorials/get-started-helm.md
@@ -1,5 +1,13 @@
 # Get started with Flux using Helm
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 If you are using Helm already, this guide is for you. By the end
 you will have Helm installing Flux in the cluster and deploying
 any code changes for you.

diff --git a/docs/tutorials/get-started-kustomize.md b/docs/tutorials/get-started-kustomize.md
@@ -1,5 +1,13 @@
 # How to bootstrap Flux using Kustomize
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This guide shows you how to use Kustomize to bootstrap Flux on a Kubernetes cluster.
 
 ## Prerequisites

diff --git a/docs/tutorials/get-started.md b/docs/tutorials/get-started.md
@@ -1,5 +1,13 @@
 # Get started with Flux
 
+> **🛑 Upgrade Advisory**
+>
+> This documentation is for Flux (v1) which has [reached its end-of-life in November 2022](https://fluxcd.io/blog/2022/10/september-2022-update/#flux-legacy-v1-retirement-plan).
+>
+> We strongly recommend you familiarise yourself with the newest Flux and [migrate as soon as possible](https://fluxcd.io/flux/migration/).
+>
+> For documentation regarding the latest Flux, please refer to [this section](https://fluxcd.io/flux/).
+
 This short guide shows a self-contained example of Flux and just
 takes a couple of minutes to get set up. By the end you will
 have Flux running in your cluster and it will be deploying any