From 4b51b1db7f7a7756de7a644abf01a2ed520ce00d Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Mon, 21 Mar 2022 18:00:13 +0100 Subject: [PATCH 01/10] create 'docs/installation' section Signed-off-by: Daniel Holbach --- content/en/blog/2021-03-01-march-update/index.md | 2 +- content/en/docs/concepts.md | 2 +- content/en/docs/get-started.md | 4 ++-- content/en/docs/guides/image-update.md | 8 ++++---- content/en/docs/guides/webhook-receivers.md | 2 +- .../en/docs/{installation.md => installation/_index.md} | 3 ++- .../docs/{guides => installation}/repository-structure.md | 3 +-- content/en/docs/use-cases/aws-codecommit.md | 6 +++--- static/_redirects | 1 + 9 files changed, 16 insertions(+), 15 deletions(-) rename content/en/docs/{installation.md => installation/_index.md} (99%) rename content/en/docs/{guides => installation}/repository-structure.md (98%) diff --git a/content/en/blog/2021-03-01-march-update/index.md b/content/en/blog/2021-03-01-march-update/index.md index c73b597c9..b0c90fe7a 100644 --- a/content/en/blog/2021-03-01-march-update/index.md +++ b/content/en/blog/2021-03-01-march-update/index.md @@ -109,7 +109,7 @@ Capili](https://www.meetup.com/GitOps-Community/events/276539791/) > Flux v2. > > In this session, Leigh Capili, DX Engineer at Weaveworks, will demo -> the [Flux guide on how to Migrate from Flux v1](/docs/migration/flux-v1-migration/), +> the [Flux guide on how to Migrate from Flux v1](/docs/installation/migration/flux-v1-migration), > including bootstrapping a cluster with Flux 1 and how to move it over > to Flux v2. > diff --git a/content/en/docs/concepts.md b/content/en/docs/concepts.md index 782bbfa9b..21b5eb503 100644 --- a/content/en/docs/concepts.md +++ b/content/en/docs/concepts.md @@ -70,4 +70,4 @@ are created for the Flux components, then the manifests are pushed to an existin The bootstrap is done using the `flux` CLI or using our [Terraform Provider](https://github.com/fluxcd/terraform-provider-flux). -For more information, take a look at [the bootstrap documentation](installation.md#bootstrap). +For more information, take a look at [the bootstrap documentation](installation/_index.md#bootstrap). diff --git a/content/en/docs/get-started.md b/content/en/docs/get-started.md index 2bdda572c..7d4d9f3e5 100644 --- a/content/en/docs/get-started.md +++ b/content/en/docs/get-started.md @@ -30,7 +30,7 @@ To install the CLI with Homebrew run: brew install fluxcd/tap/flux ``` -For other installation methods, see the [CLI install documentation](installation.md#install-the-flux-cli). +For other installation methods, see the [CLI install documentation](installation/_index.md#install-the-flux-cli). ## Export your credentials @@ -59,7 +59,7 @@ The output is similar to: ## Install Flux onto your cluster -For information on how to bootstrap using a GitHub org, Gitlab and other git providers, see [Installation](installation.md). +For information on how to bootstrap using a GitHub org, Gitlab and other git providers, see [Installation](installation/_index.md). Run the bootstrap command: diff --git a/content/en/docs/guides/image-update.md b/content/en/docs/guides/image-update.md index a24e232cb..72fda7e47 100644 --- a/content/en/docs/guides/image-update.md +++ b/content/en/docs/guides/image-update.md @@ -87,7 +87,7 @@ synchronize with the specified path inside the repository. You can install Flux and bootstrap repositories hosted on GitLab, BitBucket, Azure DevOps and any other Git provider that support SSH or token-based authentication. When using SSH, make sure the deploy key is configured with write access `--read-write-key`. -Please see the [installation guide](../installation.md) for more details. +Please see the [installation guide](../installation/_index.md) for more details. {{% /alert %}} ## Deploy a demo app @@ -651,7 +651,7 @@ There is native support for the AWS Elastic Container Registry available since which was released with Flux release v0.19. This depends on setting the `--aws-autologin-for-ecr` flag, which assumes any ECR repositories with IAM roles assigned to the cluster can be freely shared across any cluster tenants. This flag can be added by including a patch in the `kustomization.yaml` overlay file in your `flux-system`, -similar to the process described in [customize Flux manifests](../installation.md/#customize-flux-manifests): +similar to the process described in [customize Flux manifests](../installation/_index.md/#customize-flux-manifests): ```yaml patches: @@ -673,7 +673,7 @@ There is native support for the GCP Google Container Registry available since `i which was released with Flux release v0.26.0. This feature is enabled by setting the `--gcp-autologin-for-gcr` flag. This works with both clusters that have Workload Identity enabled, and those that use the default service account. This flag can be added by including a patch in the `kustomization.yaml` overlay file in your `flux-system`, -similar to the process described in [customize Flux manifests](../installation.md/#customize-flux-manifests): +similar to the process described in [customize Flux manifests](../installation/_index.md/#customize-flux-manifests): ```yaml patches: @@ -713,7 +713,7 @@ There is native support for the Azure Container Registry] available since `image-reflector-controller` [v0.16.0][v0.16.0 image reflector changelog] which was released with Flux release v0.26.0. This feature is enabled by setting the `--azure-autologin-for-acr` flag, This flag can be added by including a patch in the `kustomization.yaml` overlay file in your `flux-system`, -similar to the process described in [customize Flux manifests](../installation.md/#customize-flux-manifests): +similar to the process described in [customize Flux manifests](../installation/_index.md/#customize-flux-manifests): ```yaml patches: diff --git a/content/en/docs/guides/webhook-receivers.md b/content/en/docs/guides/webhook-receivers.md index 859cd7831..d59356ee2 100644 --- a/content/en/docs/guides/webhook-receivers.md +++ b/content/en/docs/guides/webhook-receivers.md @@ -16,7 +16,7 @@ every time a source changes. Using webhook receivers make To follow this guide you'll need a Kubernetes cluster with the GitOps toolkit controllers installed on it. Please see the [get started guide](../get-started.md) -or the [installation guide](../installation.md). +or the [installation guide](../installation/_index.md). The [notification controller](../components/notification/_index.md) can handle events coming from external systems diff --git a/content/en/docs/installation.md b/content/en/docs/installation/_index.md similarity index 99% rename from content/en/docs/installation.md rename to content/en/docs/installation/_index.md index 865edaa90..d0e7e16fd 100644 --- a/content/en/docs/installation.md +++ b/content/en/docs/installation/_index.md @@ -1,6 +1,7 @@ --- title: "Installation" -description: "Flux install, bootstrap, upgrade and uninstall documentation." +description: > + Day 1 Operations: Flux install, bootstrap, upgrade and uninstall documentation. weight: 30 --- diff --git a/content/en/docs/guides/repository-structure.md b/content/en/docs/installation/repository-structure.md similarity index 98% rename from content/en/docs/guides/repository-structure.md rename to content/en/docs/installation/repository-structure.md index 441313f69..de56ed098 100644 --- a/content/en/docs/guides/repository-structure.md +++ b/content/en/docs/installation/repository-structure.md @@ -1,6 +1,5 @@ --- -title: "Ways of structuring your repositories" -linkTitle: "Ways of structuring your repositories" +title: "Structuring your Flux repositories" description: "How to structure your Git repositories for a smooth GitOps experience with Flux." weight: 10 --- diff --git a/content/en/docs/use-cases/aws-codecommit.md b/content/en/docs/use-cases/aws-codecommit.md index b0e186597..84935562a 100644 --- a/content/en/docs/use-cases/aws-codecommit.md +++ b/content/en/docs/use-cases/aws-codecommit.md @@ -25,9 +25,9 @@ For more details on how to create an EKS cluster with `eksctl` please see [eksct ## Flux Installation for AWS CodeCommit -The following replicates the [Flux bootstrap procedure](../installation.md#bootstrap) and represents +The following replicates the [Flux bootstrap procedure](../installation/_index.md#bootstrap) and represents the best practice for structuring the repository. For more information on the structure of the repository -please see [Ways of structuring your repositories](../guides/repository-structure.md). +please see [Ways of structuring your repositories](../installation/repository-structure.md). Ensure you can login to [console.aws.amazon.com](https://console.aws.amazon.com) for your proper organization, and create a new repository to hold your Flux install and other Kubernetes resources. @@ -45,7 +45,7 @@ Create a directory inside the repository: mkdir -p ./clusters/my-cluster/flux-system ``` -Download the [Flux CLI](../installation.md#install-the-flux-cli) and generate the manifests with: +Download the [Flux CLI](../installation/_index.md#install-the-flux-cli) and generate the manifests with: ```sh flux install \ diff --git a/static/_redirects b/static/_redirects index 5016c0e59..3a0348988 100644 --- a/static/_redirects +++ b/static/_redirects @@ -12,6 +12,7 @@ /docs/roadmap /roadmap 301! /integrations /ecosystem 301! /docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! +/guides/repository-structure /installation/repository-structure 301! /flagger/how-it-works /flagger/usage/how-it-works 301! From e70ff731a7b19b31ad65e7b66cd4fd7a15a186fc Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Mon, 21 Mar 2022 18:08:00 +0100 Subject: [PATCH 02/10] add installation/platforms section Signed-off-by: Daniel Holbach --- content/en/blog/2021-08-30-september-update/index.md | 2 +- content/en/blog/2021-10-29-november-update/index.md | 2 +- content/en/blog/2022-01-31-january-update/index.md | 2 +- content/en/blog/2022-03-01-february-update/index.md | 2 +- .../en/blog/2022-03-09-pod-security-standard-restricted.md | 2 +- content/en/docs/guides/cron-job-image-auth.md | 2 +- content/en/docs/guides/mozilla-sops.md | 2 +- content/en/docs/installation/_index.md | 4 ++-- content/en/docs/installation/platforms/_index.md | 3 +++ .../{use-cases => installation/platforms}/aws-codecommit.md | 0 .../en/docs/{use-cases => installation/platforms}/azure.md | 0 .../docs/{use-cases => installation/platforms}/openshift.md | 0 static/_redirects | 3 +++ 13 files changed, 15 insertions(+), 9 deletions(-) create mode 100644 content/en/docs/installation/platforms/_index.md rename content/en/docs/{use-cases => installation/platforms}/aws-codecommit.md (100%) rename content/en/docs/{use-cases => installation/platforms}/azure.md (100%) rename content/en/docs/{use-cases => installation/platforms}/openshift.md (100%) diff --git a/content/en/blog/2021-08-30-september-update/index.md b/content/en/blog/2021-08-30-september-update/index.md index 462e9d0ea..df52e85aa 100644 --- a/content/en/blog/2021-08-30-september-update/index.md +++ b/content/en/blog/2021-08-30-september-update/index.md @@ -126,7 +126,7 @@ create a new GitRepository object as a source for other objects. ![Flux Operator](flux-operator-screenshot2.png) -Please consult the [Flux OpenShift documentation](/docs/use-cases/openshift/) +Please consult the [Flux OpenShift documentation](/docs/installation/platforms/openshift/) for the installation steps. If you have any questions or feedback, please reach out to Chanwit or diff --git a/content/en/blog/2021-10-29-november-update/index.md b/content/en/blog/2021-10-29-november-update/index.md index 2f2965d5e..a1f9631d8 100644 --- a/content/en/blog/2021-10-29-november-update/index.md +++ b/content/en/blog/2021-10-29-november-update/index.md @@ -92,7 +92,7 @@ to the load tester Helm chart. If you have been watching the OpenShift GitOps space, you will have seen quite a bit of movement lately. We talked about this in some of our last posts, we got [OpenShift docs up for -Flux](/docs/use-cases/openshift/), the +Flux](/docs/installation/platforms/openshift/), the Flux Operator has landed in the OperatorHub and RedHat were key presenters at the the last GitOps One-Stop Shop Event (see below). diff --git a/content/en/blog/2022-01-31-january-update/index.md b/content/en/blog/2022-01-31-january-update/index.md index 1b9341076..48105094f 100644 --- a/content/en/blog/2022-01-31-january-update/index.md +++ b/content/en/blog/2022-01-31-january-update/index.md @@ -420,7 +420,7 @@ So since the last Flux update blog we got a lot done: - Also [instructions for auto-login (ACR/ECR/GCR)](/docs/guides/cron-job-image-auth/) - We explain [how to bootstrap Flux on AWS EKS with CodeCommit Git - repositories](/docs/use-cases/aws-codecommit/) + repositories](/docs/installation/platforms/aws-codecommit/) - Docs updates for Flux v0.26.0, including a \"Multi-tenancy lockdown\" section in the install docs - References in the Helm Operator (legacy) section were updated to diff --git a/content/en/blog/2022-03-01-february-update/index.md b/content/en/blog/2022-03-01-february-update/index.md index 2b6d9f6b9..3239f34d5 100644 --- a/content/en/blog/2022-03-01-february-update/index.md +++ b/content/en/blog/2022-03-01-february-update/index.md @@ -278,7 +278,7 @@ just a quick summary of everything that landed in the past month: - Some docs which received particular attention this time around were - [Flux Resources](/resources/) - [Using Flux on - OpenShift](/docs/use-cases/openshift/) + OpenShift](/docs/installation/platforms/openshift/) - [Monitoring with Prometheus](/docs/guides/monitoring/) diff --git a/content/en/blog/2022-03-09-pod-security-standard-restricted.md b/content/en/blog/2022-03-09-pod-security-standard-restricted.md index 5d5c9654f..620cdf28f 100644 --- a/content/en/blog/2022-03-09-pod-security-standard-restricted.md +++ b/content/en/blog/2022-03-09-pod-security-standard-restricted.md @@ -83,7 +83,7 @@ issue](https://github.com/fluxcd/source-controller/issues/582) ([related upstream report](https://github.com/openshift/cluster-kube-apiserver-operator/issues/1325)). The work-around right now is to remove the seccomp profile as -described in [these instructions](/docs/use-cases/openshift/#flux-installation-with-cli). +described in [these instructions](/docs/installation/platforms/openshift/#flux-installation-with-cli). {{% /note %}} ## `seccomp` and `RuntimeDefault` diff --git a/content/en/docs/guides/cron-job-image-auth.md b/content/en/docs/guides/cron-job-image-auth.md index 2ceb32638..da6400166 100644 --- a/content/en/docs/guides/cron-job-image-auth.md +++ b/content/en/docs/guides/cron-job-image-auth.md @@ -303,7 +303,7 @@ Note that the resulting ImagePullSecret for Flux could also be specified by Pods #### Generating Tokens for Managed Identities [short-lived] -As a pre-requisite, your AKS cluster will need [AAD Pod Identity](../use-cases/azure.md#aad-pod-identity) installed. +As a pre-requisite, your AKS cluster will need [AAD Pod Identity](../installation/platforms/azure.md#aad-pod-identity) installed. Once we have AAD Pod Identity installed, we can create a Deployment that frequently refreshes an image pull secret into our desired Namespace. diff --git a/content/en/docs/guides/mozilla-sops.md b/content/en/docs/guides/mozilla-sops.md index bd7413481..fd133cd19 100644 --- a/content/en/docs/guides/mozilla-sops.md +++ b/content/en/docs/guides/mozilla-sops.md @@ -316,7 +316,7 @@ Note that when using `flux bootstrap` you can [set the annotation](../cheatsheet #### Azure -When using Azure Key Vault you need to authenticate kustomize-controller either with [aad-pod-identity](../use-cases/azure.md#aad-pod-identity) +When using Azure Key Vault you need to authenticate kustomize-controller either with [aad-pod-identity](../installation/platforms/azure.md#aad-pod-identity) or by passing [Service Principal credentials as environment variables](https://github.com/mozilla/sops#encrypting-using-azure-key-vault). Create the Azure Key-Vault: diff --git a/content/en/docs/installation/_index.md b/content/en/docs/installation/_index.md index d0e7e16fd..e52801b0a 100644 --- a/content/en/docs/installation/_index.md +++ b/content/en/docs/installation/_index.md @@ -109,8 +109,8 @@ architectures. If your Git provider is **AWS CodeCommit**, **Azure DevOps**, **Bitbucket Server**, **GitHub** or **GitLab** please follow the specific bootstrap procedure: -* [AWS CodeCommit](./use-cases/aws-codecommit.md#flux-installation-for-aws-codecommit) -* [Azure DevOps](./use-cases/azure.md#flux-installation-for-azure-devops) +* [AWS CodeCommit](./platforms/aws-codecommit.md#flux-installation-for-aws-codecommit) +* [Azure DevOps](./platforms/azure.md#flux-installation-for-azure-devops) * [Bitbucket Server and Data Center](#bitbucket-server-and-data-center) * [GitHub.com and GitHub Enterprise](#github-and-github-enterprise) * [GitLab.com and GitLab Enterprise](#gitlab-and-gitlab-enterprise) diff --git a/content/en/docs/installation/platforms/_index.md b/content/en/docs/installation/platforms/_index.md new file mode 100644 index 000000000..48a164f01 --- /dev/null +++ b/content/en/docs/installation/platforms/_index.md @@ -0,0 +1,3 @@ +--- +title: Platforms +--- diff --git a/content/en/docs/use-cases/aws-codecommit.md b/content/en/docs/installation/platforms/aws-codecommit.md similarity index 100% rename from content/en/docs/use-cases/aws-codecommit.md rename to content/en/docs/installation/platforms/aws-codecommit.md diff --git a/content/en/docs/use-cases/azure.md b/content/en/docs/installation/platforms/azure.md similarity index 100% rename from content/en/docs/use-cases/azure.md rename to content/en/docs/installation/platforms/azure.md diff --git a/content/en/docs/use-cases/openshift.md b/content/en/docs/installation/platforms/openshift.md similarity index 100% rename from content/en/docs/use-cases/openshift.md rename to content/en/docs/installation/platforms/openshift.md diff --git a/static/_redirects b/static/_redirects index 3a0348988..5fb55baa7 100644 --- a/static/_redirects +++ b/static/_redirects @@ -13,6 +13,9 @@ /integrations /ecosystem 301! /docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! /guides/repository-structure /installation/repository-structure 301! +/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! +/docs/use-cases/azure /docs/installation/platforms/azure 301! +/docs/use-cases/openshift /docs/installation/platforms/openshift 301! /flagger/how-it-works /flagger/usage/how-it-works 301! From c1026b42e4b64701e927e1690ebc442721b075ae Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Mon, 21 Mar 2022 18:31:42 +0100 Subject: [PATCH 03/10] create operations section, move notifications Signed-off-by: Daniel Holbach --- content/en/blog/2022-03-01-february-update/index.md | 2 +- content/en/docs/flux-e2e.md | 4 ++-- content/en/docs/gitops-toolkit/debugging.md | 2 +- content/en/docs/migration/flux-v1-migration.md | 4 ++-- content/en/docs/operations/_index.md | 6 ++++++ content/en/docs/{guides => operations}/monitoring.md | 0 content/en/docs/{guides => operations}/notifications.md | 3 --- content/en/docs/{guides => operations}/webhook-receivers.md | 0 content/en/roadmap.md | 2 +- static/_redirects | 3 +++ 10 files changed, 16 insertions(+), 10 deletions(-) create mode 100644 content/en/docs/operations/_index.md rename content/en/docs/{guides => operations}/monitoring.md (100%) rename content/en/docs/{guides => operations}/notifications.md (99%) rename content/en/docs/{guides => operations}/webhook-receivers.md (100%) diff --git a/content/en/blog/2022-03-01-february-update/index.md b/content/en/blog/2022-03-01-february-update/index.md index 3239f34d5..187cdb3c9 100644 --- a/content/en/blog/2022-03-01-february-update/index.md +++ b/content/en/blog/2022-03-01-february-update/index.md @@ -280,7 +280,7 @@ just a quick summary of everything that landed in the past month: - [Using Flux on OpenShift](/docs/installation/platforms/openshift/) - [Monitoring with - Prometheus](/docs/guides/monitoring/) + Prometheus](/docs/operations/monitoring/) Thanks a lot to these folks who contributed to docs and website: Adam Dickinson, akirillow, Chanwit Kaewkasi, Davi Garcia, Emanuele Massara, diff --git a/content/en/docs/flux-e2e.md b/content/en/docs/flux-e2e.md index 930548d18..9d23afdc5 100644 --- a/content/en/docs/flux-e2e.md +++ b/content/en/docs/flux-e2e.md @@ -591,8 +591,8 @@ The health checking feature is called [Health Assessment][] in the Flux Kustomiz [HelmRepository API]: /docs/components/source/helmrepositories/ [HelmChart API]: /docs/components/source/helmcharts/ [HelmChartTemplate.spec.reconcileStrategy]: /docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate -[Setup Notifications]: /docs/guides/notifications/ +[Setup Notifications]: /docs/operations/notifications/ [Alert API]: /docs/components/notification/alert/ [Event API]: /docs/components/notification/event/ -[Setup Git Commit Status Notications]: /docs/guides/notifications/#git-commit-status +[Setup Git Commit Status Notications]: /docs/operations/notifications/#git-commit-status [Health Assessment]: /docs/components/kustomize/kustomization/#health-assessment diff --git a/content/en/docs/gitops-toolkit/debugging.md b/content/en/docs/gitops-toolkit/debugging.md index dd834284c..018915276 100644 --- a/content/en/docs/gitops-toolkit/debugging.md +++ b/content/en/docs/gitops-toolkit/debugging.md @@ -43,5 +43,5 @@ or shared with one of the maintainers. As `kubectl top` gives a limited (and at times inaccurate) overview of resource usage, it is often better to make use of the Grafana metrics -to gather insights. See [monitoring](../guides/monitoring.md) for a +to gather insights. See [monitoring](../operations/monitoring.md) for a guide on how to visualize this data with a Grafana dashboard. diff --git a/content/en/docs/migration/flux-v1-migration.md b/content/en/docs/migration/flux-v1-migration.md index 4b2728bd0..fd7e0f3aa 100644 --- a/content/en/docs/migration/flux-v1-migration.md +++ b/content/en/docs/migration/flux-v1-migration.md @@ -292,8 +292,8 @@ flux create alert app \ ``` For more details, read the guides on how to configure -[notifications]({{< relref "../guides/notifications.md" >}}) and -[webhooks]({{< relref "../guides/webhook-receivers.md" >}}). +[notifications]({{< relref "../operations/notifications.md" >}}) and +[webhooks]({{< relref "../operations/webhook-receivers.md" >}}). ### Flux debugging diff --git a/content/en/docs/operations/_index.md b/content/en/docs/operations/_index.md new file mode 100644 index 000000000..6412c5250 --- /dev/null +++ b/content/en/docs/operations/_index.md @@ -0,0 +1,6 @@ +--- +title: "Operations" +description: > + Day 2: Managing Flux. +weight: 35 +--- diff --git a/content/en/docs/guides/monitoring.md b/content/en/docs/operations/monitoring.md similarity index 100% rename from content/en/docs/guides/monitoring.md rename to content/en/docs/operations/monitoring.md diff --git a/content/en/docs/guides/notifications.md b/content/en/docs/operations/notifications.md similarity index 99% rename from content/en/docs/guides/notifications.md rename to content/en/docs/operations/notifications.md index 883d02b18..22c53451c 100644 --- a/content/en/docs/guides/notifications.md +++ b/content/en/docs/operations/notifications.md @@ -3,9 +3,6 @@ title: "Setup Notifications" linkTitle: "Setup Notifications" description: "Configure alerting for Slack, Teams, Discord and others using Flux notification controller." weight: 30 -card: - name: tasks - weight: 50 --- When operating a cluster, different teams may wish to receive notifications about diff --git a/content/en/docs/guides/webhook-receivers.md b/content/en/docs/operations/webhook-receivers.md similarity index 100% rename from content/en/docs/guides/webhook-receivers.md rename to content/en/docs/operations/webhook-receivers.md diff --git a/content/en/roadmap.md b/content/en/roadmap.md index 71e41b557..074d306be 100644 --- a/content/en/roadmap.md +++ b/content/en/roadmap.md @@ -103,7 +103,7 @@ State | Item ----- | ---- :heavy_check_mark: | [Offer a migration guide for those that are using Flux in read-only mode to synchronize plain manifests](/docs/migration/flux-v1-migration/) :heavy_check_mark: | [Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays](/docs/migration/flux-v1-migration/) -:heavy_check_mark: | [Offer a dedicated component for forwarding events to external messaging platforms](/docs/guides/notifications/) +:heavy_check_mark: | [Offer a dedicated component for forwarding events to external messaging platforms](/docs/operations/notifications/) Non-Goals diff --git a/static/_redirects b/static/_redirects index 5fb55baa7..03e77ca2b 100644 --- a/static/_redirects +++ b/static/_redirects @@ -16,6 +16,9 @@ /docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! /docs/use-cases/azure /docs/installation/platforms/azure 301! /docs/use-cases/openshift /docs/installation/platforms/openshift 301! +/docs/guides/notifications /docs/operations/notifications 301! +/docs/guides/monitoring /docs/operations/monitoring 301! +/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! /flagger/how-it-works /flagger/usage/how-it-works 301! From ac63ff30f9f33705513813efd5a67ecf62c4aee2 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 22 Mar 2022 10:22:36 +0100 Subject: [PATCH 04/10] create operations/secrets section Signed-off-by: Daniel Holbach --- content/en/blog/2022-01-31-january-update/index.md | 2 +- content/en/docs/flux-e2e.md | 2 +- content/en/docs/installation/platforms/aws-codecommit.md | 2 +- content/en/docs/installation/platforms/azure.md | 2 +- content/en/docs/operations/secrets/_index.md | 4 ++++ .../en/docs/{guides => operations/secrets}/mozilla-sops.md | 0 .../en/docs/{guides => operations/secrets}/sealed-secrets.md | 0 content/en/docs/use-cases/gh-actions-manifest-generation.md | 4 ++-- content/en/docs/use-cases/helm.md | 2 +- static/_redirects | 2 ++ 10 files changed, 13 insertions(+), 7 deletions(-) create mode 100644 content/en/docs/operations/secrets/_index.md rename content/en/docs/{guides => operations/secrets}/mozilla-sops.md (100%) rename content/en/docs/{guides => operations/secrets}/sealed-secrets.md (100%) diff --git a/content/en/blog/2022-01-31-january-update/index.md b/content/en/blog/2022-01-31-january-update/index.md index 48105094f..c0c8c9f2f 100644 --- a/content/en/blog/2022-01-31-january-update/index.md +++ b/content/en/blog/2022-01-31-january-update/index.md @@ -416,7 +416,7 @@ Flux and explain it in our documentation is important to us. So since the last Flux update blog we got a lot done: - We added instructions on how to [encrypt secrets using HashiCorp - Vault](/docs/guides/mozilla-sops/#encrypting-secrets-using-hashicorp-vault) + Vault](/docs/operations/secrets/mozilla-sops/#encrypting-secrets-using-hashicorp-vault) - Also [instructions for auto-login (ACR/ECR/GCR)](/docs/guides/cron-job-image-auth/) - We explain [how to bootstrap Flux on AWS EKS with CodeCommit Git diff --git a/content/en/docs/flux-e2e.md b/content/en/docs/flux-e2e.md index 9d23afdc5..9fe751142 100644 --- a/content/en/docs/flux-e2e.md +++ b/content/en/docs/flux-e2e.md @@ -581,7 +581,7 @@ The health checking feature is called [Health Assessment][] in the Flux Kustomiz [BucketSpec Custom Resource]: /docs/components/source/buckets/ [HelmRepository Custom Resource]: /docs/components/source/helmrepositories/ [HelmChart Custom Resource]: /docs/components/source/helmcharts/ -[Mozilla SOPS Guide]: /docs/guides/mozilla-sops/ +[Mozilla SOPS Guide]: /docs/operations/secrets/mozilla-sops/ [Kustomize Build Flags]: /docs/faq/#what-is-the-behavior-of-kustomize-used-by-flux [server-side apply and update]: https://kubernetes.io/docs/reference/using-api/server-side-apply/ [field management]: https://kubernetes.io/docs/reference/using-api/server-side-apply/#field-management diff --git a/content/en/docs/installation/platforms/aws-codecommit.md b/content/en/docs/installation/platforms/aws-codecommit.md index 84935562a..21beab49e 100644 --- a/content/en/docs/installation/platforms/aws-codecommit.md +++ b/content/en/docs/installation/platforms/aws-codecommit.md @@ -163,7 +163,7 @@ You will need to use AWS KMS and enable the IAM OIDC provider on the cluster. Patch kustomize-controller with the proper IAM credentials, so that it may access your AWS KMS, and then begin committing SOPS encrypted files to the Git repository with the proper AWS KMS configuration. -See the [Mozilla SOPS AWS Guide](../guides/mozilla-sops.md#aws) for further detail. +See the [Mozilla SOPS AWS Guide](../operations/secrets/mozilla-sops.md#aws) for further detail. ## Image Updates with Elastic Container Registry diff --git a/content/en/docs/installation/platforms/azure.md b/content/en/docs/installation/platforms/azure.md index 47f737c91..cfee74375 100644 --- a/content/en/docs/installation/platforms/azure.md +++ b/content/en/docs/installation/platforms/azure.md @@ -256,7 +256,7 @@ If you want to use Managed Identities, install or enable [AAD Pod Identity](#aad Patch kustomize-controller with the proper Azure credentials, so that it may access your Azure Key Vault, and then begin committing SOPS encrypted files to the Git repository with the proper Azure Key Vault configuration. -See the [Mozilla SOPS Azure Guide](../guides/mozilla-sops.md#azure) for further detail. +See the [Mozilla SOPS Azure Guide](../operations/secrets/mozilla-sops.md#azure) for further detail. ## Image Updates with Azure Container Registry diff --git a/content/en/docs/operations/secrets/_index.md b/content/en/docs/operations/secrets/_index.md new file mode 100644 index 000000000..f217b7a8d --- /dev/null +++ b/content/en/docs/operations/secrets/_index.md @@ -0,0 +1,4 @@ +--- +title: "Managing secrets" +weight: 85 +--- diff --git a/content/en/docs/guides/mozilla-sops.md b/content/en/docs/operations/secrets/mozilla-sops.md similarity index 100% rename from content/en/docs/guides/mozilla-sops.md rename to content/en/docs/operations/secrets/mozilla-sops.md diff --git a/content/en/docs/guides/sealed-secrets.md b/content/en/docs/operations/secrets/sealed-secrets.md similarity index 100% rename from content/en/docs/guides/sealed-secrets.md rename to content/en/docs/operations/secrets/sealed-secrets.md diff --git a/content/en/docs/use-cases/gh-actions-manifest-generation.md b/content/en/docs/use-cases/gh-actions-manifest-generation.md index 281f496ac..83f2bea83 100644 --- a/content/en/docs/use-cases/gh-actions-manifest-generation.md +++ b/content/en/docs/use-cases/gh-actions-manifest-generation.md @@ -1272,12 +1272,12 @@ If you are on GitHub, and are struggling to get started using GitHub Actions, or [Manual Gating]: /flagger/usage/webhooks#manual-gating [flux create tenant]: /cmd/flux_create_tenant [Flux 2 Multi-Tenancy Guide]: https://github.com/fluxcd/flux2-multi-tenancy -[Mozilla SOPS]: /guides/mozilla-sops/ +[Mozilla SOPS]: /docs/operations/secrets/mozilla-sops/ [example 10.4 jsonnet]: https://github.com/kingdonb/any_old_app/blob/release/0.10.4/manifests/example.jsonnet [anguslees example jsonnet]: https://github.com/anguslees/kustomize-libsonnet/blob/master/example.jsonnet [Kubernetes docs on Using Service Accounts]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-multiple-service-accounts [sops/issues/315]: https://github.com/mozilla/sops/issues/315 -[using various cloud providers]: /guides/mozilla-sops/#using-various-cloud-providers +[using various cloud providers]: /operations/secrets/mozilla-sops/#using-various-cloud-providers [Decrypt SOPS Secrets]: https://github.com/marketplace/actions/decrypt-sops-secrets [Sops Binary Installer]: https://github.com/marketplace/actions/sops-binary-installer [04-update-fleet-infra.yaml]: https://github.com/kingdonb/any_old_app/blob/main/.github/workflows/04-update-fleet-infra.yaml diff --git a/content/en/docs/use-cases/helm.md b/content/en/docs/use-cases/helm.md index 1b7b318ac..0daec4492 100644 --- a/content/en/docs/use-cases/helm.md +++ b/content/en/docs/use-cases/helm.md @@ -158,7 +158,7 @@ on any chart without additional templated annotations. You may also use Kustomize Controller built-in [Mozilla SOPS integration](../components/kustomize/kustomization.md#secrets-decryption) to securely manage your encrypted secrets stored in git. -See the [Flux SOPS guide](../guides/mozilla-sops.md) for step-by-step instructions through various use cases. +See the [Flux SOPS guide](../operations/secrets/mozilla-sops.md) for step-by-step instructions through various use cases. ## Automatic Release Upgrades diff --git a/static/_redirects b/static/_redirects index 03e77ca2b..eda6d5afb 100644 --- a/static/_redirects +++ b/static/_redirects @@ -19,6 +19,8 @@ /docs/guides/notifications /docs/operations/notifications 301! /docs/guides/monitoring /docs/operations/monitoring 301! /docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! +/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! +/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! /flagger/how-it-works /flagger/usage/how-it-works 301! From ed65584e1d25dafa6feb211044effb615398b960 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 22 Mar 2022 10:34:28 +0100 Subject: [PATCH 05/10] create workflows section Signed-off-by: Daniel Holbach --- content/en/blog/2021-01-06-january-update.md | 2 +- content/en/blog/2021-03-31-april-update.md | 4 + .../en/blog/2021-04-29-may-update/index.md | 2 +- .../blog/2022-01-31-january-update/index.md | 2 +- content/en/docs/flux-e2e.md | 4 +- .../installation/platforms/aws-codecommit.md | 4 +- .../en/docs/installation/platforms/azure.md | 4 +- .../migration/flux-v1-automation-migration.md | 10 +-- .../docs/migration/helm-operator-migration.md | 2 +- .../en/docs/use-cases/gh-actions-auto-pr.md | 4 +- .../gh-actions-manifest-generation.md | 4 +- content/en/docs/use-cases/helm.md | 4 +- content/en/docs/use-cases/jenkins.md | 6 +- content/en/docs/workflows/_index.md | 4 + .../{guides => workflows}/helmreleases.md | 0 .../{guides => workflows}/image-update.md | 0 content/en/legacy/flux/faq.md | 2 +- content/en/roadmap.md | 10 ++- static/_redirects | 84 ++++++++++--------- 19 files changed, 87 insertions(+), 65 deletions(-) create mode 100644 content/en/docs/workflows/_index.md rename content/en/docs/{guides => workflows}/helmreleases.md (100%) rename content/en/docs/{guides => workflows}/image-update.md (100%) diff --git a/content/en/blog/2021-01-06-january-update.md b/content/en/blog/2021-01-06-january-update.md index 3a8fa030b..b2f89cfff 100644 --- a/content/en/blog/2021-01-06-january-update.md +++ b/content/en/blog/2021-01-06-january-update.md @@ -76,7 +76,7 @@ improvements, it comes with many new features. The highlights are: Automated Image Updates ----------------------- -[Automated Image Updates Guide](/docs/guides/image-update/) (alpha release) +[Automated Image Updates Guide](/docs/workflows/image-update/) (alpha release) Flux v2 now includes two controllers for automating image updates \-- one of the controllers is for scanning container image repositories, and diff --git a/content/en/blog/2021-03-31-april-update.md b/content/en/blog/2021-03-31-april-update.md index a9bfcc700..bc7d517f7 100644 --- a/content/en/blog/2021-03-31-april-update.md +++ b/content/en/blog/2021-03-31-april-update.md @@ -67,7 +67,11 @@ Hot on the heels of this was `0.11.0` and v0.1.1 of the Terraform module. - SOPS in the `kustomize-controller` has been updated to v3.7.0, support for the newly added age encryption format is planned. :hourglass_flowing_sand: - All controllers do now record the suspend status of resources in a gotk_suspend_status Prometheus gauge metric. +<<<<<<< HEAD πŸš€ Check out [the guide on how to automate image updates to Git](/docs/guides/image-update/). +======= +πŸš€ Check out [the guide on how to automate image updates](/docs/workflows/image-update/) to Git. +>>>>>>> create workflows section Next up we will triage `image-*` issues and mark upcoming changes for v1alpha2. The proposal for v1alpha2 is under discussion at [https://github.com/fluxcd/flux2/discussions/1124](https://github.com/fluxcd/flux2/discussions/1124). diff --git a/content/en/blog/2021-04-29-may-update/index.md b/content/en/blog/2021-04-29-may-update/index.md index 280c53baa..80642da29 100644 --- a/content/en/blog/2021-04-29-may-update/index.md +++ b/content/en/blog/2021-04-29-may-update/index.md @@ -97,7 +97,7 @@ automation](https://github.com/fluxcd/flux2/discussions/1333). Checkout the [new bootstrap customisation feature](/docs/installation/_index.md#customize-flux-manifests). -The [Image automation guide](/docs/guides/image-update/) has been updated +The [Image automation guide](/docs/workflows/image-update/) has been updated to the new APIs, and also includes a reference to a new [GitHub Actions use case guide](/docs/use-cases/gh-actions-auto-pr/), for automatic pull request creation with Flux and GitHub Actions. This diff --git a/content/en/blog/2022-01-31-january-update/index.md b/content/en/blog/2022-01-31-january-update/index.md index c0c8c9f2f..3e99a2ab5 100644 --- a/content/en/blog/2022-01-31-january-update/index.md +++ b/content/en/blog/2022-01-31-january-update/index.md @@ -67,7 +67,7 @@ New feature in action: flux diff kustomization token-based authentication when decrypting SOPS encrypted secrets. - Auto-login to AWS ECR, Azure ACR and Google Cloud GCR for [image update - automation](/docs/guides/image-update/#imagerepository-cloud-providers-authentication) + automation](/docs/workflows/image-update/#imagerepository-cloud-providers-authentication) on EKS, AKS or GKE. - On single-tenant clusters, image automation can now refer to Git repositories in other namespaces than the diff --git a/content/en/docs/flux-e2e.md b/content/en/docs/flux-e2e.md index 9fe751142..1a2ff7ce3 100644 --- a/content/en/docs/flux-e2e.md +++ b/content/en/docs/flux-e2e.md @@ -574,7 +574,7 @@ The health checking feature is called [Health Assessment][] in the Flux Kustomiz [Image reflector and automation controllers]: /docs/components/image/ [Helm Chart Hooks]: https://helm.sh/docs/topics/charts_hooks/ [Post Rendering]: https://helm.sh/docs/topics/advanced/#post-rendering -[image automation guide]: /docs/guides/image-update/#configure-image-update-for-custom-resources +[image automation guide]: /docs/workflows/image-update/#configure-image-update-for-custom-resources [Core Concepts]: /docs/concepts/ [Get Started with Flux]: /docs/get-started/ [GitRepository Custom Resource]: /docs/components/source/gitrepositories/ @@ -586,7 +586,7 @@ The health checking feature is called [Health Assessment][] in the Flux Kustomiz [server-side apply and update]: https://kubernetes.io/docs/reference/using-api/server-side-apply/ [field management]: https://kubernetes.io/docs/reference/using-api/server-side-apply/#field-management [HelmRelease API]: /docs/components/helm/api/ -[HelmRelease Guide]: /docs/guides/helmreleases/ +[HelmRelease Guide]: /docs/workflows/helmreleases/ [Helm Use Case]: /docs/use-cases/helm/ [HelmRepository API]: /docs/components/source/helmrepositories/ [HelmChart API]: /docs/components/source/helmcharts/ diff --git a/content/en/docs/installation/platforms/aws-codecommit.md b/content/en/docs/installation/platforms/aws-codecommit.md index 21beab49e..7d47a5130 100644 --- a/content/en/docs/installation/platforms/aws-codecommit.md +++ b/content/en/docs/installation/platforms/aws-codecommit.md @@ -176,8 +176,8 @@ EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html) to c node groups, these IAM permissions are applied to your worker node IAM Role by default. {{% /alert %}} -Follow the [Image Update Automation Guide](../guides/image-update.md) and see the -[ECR specific section](../guides/image-update.md#aws-elastic-container-registry) for more details. +Follow the [Image Update Automation Guide](../workflows/image-update.md) and see the +[ECR specific section](../workflows/image-update.md#aws-elastic-container-registry) for more details. Your EKS cluster's configuration can also be updated to [allow the kubelets to pull images from ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/ECR_on_EKS.html) diff --git a/content/en/docs/installation/platforms/azure.md b/content/en/docs/installation/platforms/azure.md index cfee74375..852ef341c 100644 --- a/content/en/docs/installation/platforms/azure.md +++ b/content/en/docs/installation/platforms/azure.md @@ -271,8 +271,8 @@ flux install \ --export > ./clusters/my-cluster/flux-system/gotk-components.yaml ``` -Follow the [Image Update Automation Guide](../guides/image-update.md) and see the -[ACR specific section](../guides/image-update.md#azure-container-registry) for more details. +Follow the [Image Update Automation Guide](../workflows/image-update.md) and see the +[ACR specific section](../workflows/image-update.md#azure-container-registry) for more details. Your AKS cluster's configuration can also be updated to [allow the kubelets to pull images from ACR](https://docs.microsoft.com/en-us/azure/aks/cluster-container-registry-integration) diff --git a/content/en/docs/migration/flux-v1-automation-migration.md b/content/en/docs/migration/flux-v1-automation-migration.md index c6d5e315e..829b620bf 100644 --- a/content/en/docs/migration/flux-v1-automation-migration.md +++ b/content/en/docs/migration/flux-v1-automation-migration.md @@ -741,17 +741,17 @@ $ kubectl logs -n flux-system deploy/image-automation-controller Once you are satisfied that it is working, you can migrate the rest of the manifests using the steps from ["Migrating each manifest to Flux v2"](#migrating-each-manifest-to-flux-v2) above. -[image-update-tute]: /docs/guides/image-update/ +[image-update-tute]: /docs/workflows/image-update/ [imagepolicy-ref]: /docs/components/image/imagepolicies/ [helm-auto]: /legacy/flux/references/helm-operator-integration/#automated-image-detection -[image-update-tute-custom]: /docs/guides/image-update/#configure-image-update-for-custom-resources -[flux-v1-migration]: /docs/migration/flux-v1-migration/ +[image-update-tute-custom]: /docs/workflows/image-update/#configure-image-update-for-custom-resources +[flux-v1-migration]: /docs/installation/migration/flux-v1-migration/ [install-cli]: /docs/get-started/#install-the-flux-cli [flux-bootstrap]: /docs/installation/_index.md#bootstrap [github-pat]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token [auto-object-ref]: /docs/components/image/imageupdateautomations/ -[image-update-tute-creds]: /docs/guides/image-update/#configure-image-scanning -[image-update-tute-clouds]: /docs/guides/image-update/#imagerepository-cloud-providers-authentication +[image-update-tute-creds]: /docs/workflows/image-update/#configure-image-scanning +[image-update-tute-clouds]: /docs/workflows/image-update/#imagerepository-cloud-providers-authentication [image-tags-guide]: /docs/guides/sortable-image-tags/ [auto-ref]: /docs/components/image/imageupdateautomations/ [semver]: https://semver.org diff --git a/content/en/docs/migration/helm-operator-migration.md b/content/en/docs/migration/helm-operator-migration.md index f4f70227e..42d977fe1 100644 --- a/content/en/docs/migration/helm-operator-migration.md +++ b/content/en/docs/migration/helm-operator-migration.md @@ -839,7 +839,7 @@ kubectl delete crd helmreleases.helm.fluxcd.io ### Are automated image updates supported? -Yes, image updates are supported for `HelmRelease` as well as any other Kubernetes custom resources stored in Git. See the [Image Update Guide](/docs/guides/image-update/#configure-image-update-for-custom-resources) for more information. +Yes, image updates are supported for `HelmRelease` as well as any other Kubernetes custom resources stored in Git. See the [Image Update Guide](/docs/workflows/image-update/#configure-image-update-for-custom-resources) for more information. ### How do I automatically apply my `HelmRelease` resources to the cluster? diff --git a/content/en/docs/use-cases/gh-actions-auto-pr.md b/content/en/docs/use-cases/gh-actions-auto-pr.md index 05676a49d..c210e11a7 100644 --- a/content/en/docs/use-cases/gh-actions-auto-pr.md +++ b/content/en/docs/use-cases/gh-actions-auto-pr.md @@ -68,7 +68,7 @@ This way you can automatically push changes to a `staging` branch and require re Experiment with these strategies to find the right automated workflow solution for your team! -[Image Update Guide]: /docs/guides/image-update/ -[Push updates to a different branch]: /docs/guides/image-update/#push-updates-to-a-different-branch +[Image Update Guide]: /docs/workflows/image-update/ +[Push updates to a different branch]: /docs/workflows/image-update/#push-updates-to-a-different-branch [GitHub Pull Request Action]: https://github.com/marketplace/actions/github-pull-request-action [Create Pull Request Action]: https://github.com/marketplace/actions/create-pull-request diff --git a/content/en/docs/use-cases/gh-actions-manifest-generation.md b/content/en/docs/use-cases/gh-actions-manifest-generation.md index 83f2bea83..a3344a34e 100644 --- a/content/en/docs/use-cases/gh-actions-manifest-generation.md +++ b/content/en/docs/use-cases/gh-actions-manifest-generation.md @@ -1237,7 +1237,7 @@ If you are on GitHub, and are struggling to get started using GitHub Actions, or [flux2/discussions/802]: https://github.com/fluxcd/flux2/discussions/802 [flux2/issues/543]: https://github.com/fluxcd/flux2/issues/543 -[image update guide]: /docs/guides/image-update/ +[image update guide]: /docs/workflows/image-update/ [any old app]: https://github.com/kingdonb/any_old_app [Flux bootstrap guide]: /docs/get-started/ [String Substitution with sed -i]: #string-substitution-with-sed-i @@ -1282,7 +1282,7 @@ If you are on GitHub, and are struggling to get started using GitHub Actions, or [Sops Binary Installer]: https://github.com/marketplace/actions/sops-binary-installer [04-update-fleet-infra.yaml]: https://github.com/kingdonb/any_old_app/blob/main/.github/workflows/04-update-fleet-infra.yaml [Push directory to another repository]: https://github.com/marketplace/actions/push-directory-to-another-repository -[Flux v2 image automation]: /docs/guides/image-update/ +[Flux v2 image automation]: /docs/workflows/image-update/ [Image Automation Controllers]: /docs/components/image/ [Example of a build process with timestamp tagging]: /docs/guides/sortable-image-tags/#example-of-a-build-process-with-timestamp-tagging [Sortable image tags to use with automation]: /docs/guides/sortable-image-tags/#formats-and-alternatives diff --git a/content/en/docs/use-cases/helm.md b/content/en/docs/use-cases/helm.md index 0daec4492..18dae573d 100644 --- a/content/en/docs/use-cases/helm.md +++ b/content/en/docs/use-cases/helm.md @@ -149,7 +149,7 @@ You may manage these `ConfigMap` and `Secret` resources any way you wish, but there are several benefits to managing these with the Flux Kustomize Controller. It is fairly straigtforward to use Kustomize `configMapGenerator` -to [trigger a Helm release upgrade every time the encoded values change](../guides/helmreleases.md#refer-to-values-in-configmaps-generated-with-kustomize). +to [trigger a Helm release upgrade every time the encoded values change](../workflows/helmreleases.md#refer-to-values-in-configmaps-generated-with-kustomize). This common use case currently solveable in Helm by [adding specially crafted annotations](https://helm.sh/docs/howto/charts_tips_and_tricks/#automatically-roll-deployments) to a chart. The Flux Kustomize Controller method allows you to accomplish this @@ -239,6 +239,6 @@ spec: ## Next Steps -- [Guides > Manage Helm Releases](../guides/helmreleases.md) +- [Guides > Manage Helm Releases](../workflows/helmreleases.md) - [Toolkit Components > Helm Controller](../components/helm/_index.md) - [Migration > Migrate to the Helm Controller](../migration/helm-operator-migration.md) diff --git a/content/en/docs/use-cases/jenkins.md b/content/en/docs/use-cases/jenkins.md index 2f7a513db..321bd3d2c 100644 --- a/content/en/docs/use-cases/jenkins.md +++ b/content/en/docs/use-cases/jenkins.md @@ -23,7 +23,7 @@ Flux's Source Controller periodically reconciles the config repository where the A revision can be any commit at the head of the branch or tag, or a specific commit hash described in the field `spec.ref` in the `GitRepository`. We could also specify a semver expression here, so that Flux infers the latest tag within a range specified. There are many possible configurations. -A specific commit hash can also be listed in the `GitRepositoryRef`, though this is less common than pointing to a branch, as in this case Flux is no longer performing continuous delivery of changes, but instead reconciles with some specific fixed revision as listed and curated by hand. This behavior, though not particularly ergonomic, could be useful during an [incident response](/docs/guides/image-update/#incident-management). +A specific commit hash can also be listed in the `GitRepositoryRef`, though this is less common than pointing to a branch, as in this case Flux is no longer performing continuous delivery of changes, but instead reconciles with some specific fixed revision as listed and curated by hand. This behavior, though not particularly ergonomic, could be useful during an [incident response](/docs/workflows/image-update/#incident-management). Pinning to a particular revision allows an operator to handle updates explicitly and manually but still via GitOps. While this effectively disables some automated features of Flux, it is also a capable way to operate. Jenkins jobs could also write commit hashes into manifests, and while cats can live with dogs, this is not important for this example. @@ -267,7 +267,7 @@ when { } ``` -This is important since git tags can be used for [Automating image updates to Git](/docs/guides/image-update/) in production. +This is important since git tags can be used for [Automating image updates to Git](/docs/workflows/image-update/) in production. Using SemVer tags, you can automatically promote new tags to production via policy. @@ -304,7 +304,7 @@ Update deployments via Flux's [ImagePolicy] CRD, and the Image Update Automation [doesn't even have Docker underneath]: https://kubernetes.io/blog/2020/12/02/dockershim-faq/#why-is-dockershim-being-deprecated [Mirantis has taken over support of dockershim]: https://www.mirantis.com/blog/mirantis-to-take-over-support-of-kubernetes-dockershim-2/ [Sortable image tags]: /docs/guides/sortable-image-tags/ -[image update guide]: /docs/guides/image-update/ +[image update guide]: /docs/workflows/image-update/ [credentials]: https://github.com/jenkinsci/pipeline-examples/blob/master/declarative-examples/simple-examples/credentialsUsernamePassword.groovy [populating environment variables]: https://github.com/jenkinsci/pipeline-examples/blob/master/declarative-examples/simple-examples/scriptVariableAssignment.groovy [only against a particular branch]: https://github.com/jenkinsci/pipeline-examples/blob/master/declarative-examples/simple-examples/whenBranchMaster.groovy diff --git a/content/en/docs/workflows/_index.md b/content/en/docs/workflows/_index.md new file mode 100644 index 000000000..816a19b01 --- /dev/null +++ b/content/en/docs/workflows/_index.md @@ -0,0 +1,4 @@ +--- +title: Workflows +weight: 80 +--- diff --git a/content/en/docs/guides/helmreleases.md b/content/en/docs/workflows/helmreleases.md similarity index 100% rename from content/en/docs/guides/helmreleases.md rename to content/en/docs/workflows/helmreleases.md diff --git a/content/en/docs/guides/image-update.md b/content/en/docs/workflows/image-update.md similarity index 100% rename from content/en/docs/guides/image-update.md rename to content/en/docs/workflows/image-update.md diff --git a/content/en/legacy/flux/faq.md b/content/en/legacy/flux/faq.md index a0c9c4d28..3278e07ce 100644 --- a/content/en/legacy/flux/faq.md +++ b/content/en/legacy/flux/faq.md @@ -42,7 +42,7 @@ An error is captured as a Kubernetes `Event` CRD, and is reflected in the `Statu There is an idealized use case of GitOps we might explain as: when an update comes, a pull-request is automatically opened and when it gets merged, it is automatically applied to the cluster. That sounds great, but is not really how things work in Flux v1. -In Flux v2, this can actually be used as a real strategy; it is straight-forward to implement and covered by documenation: [Push updates to a different branch](/docs/guides/image-update/#push-updates-to-a-different-branch). +In Flux v2, this can actually be used as a real strategy; it is straight-forward to implement and covered by documenation: [Push updates to a different branch](/docs/workflows/image-update/#push-updates-to-a-different-branch). In Flux v1, it was possible to set up incoming webhooks with [flux-recv](https://github.com/fluxcd/flux-recv) as a sidecar to Flux, which while it worked nicely, it isn't nicely integrated and frankly feels bolted-on, sort of like an after-market part. This may be more than appearance, it isn't mentioned at all in Flux v1 docs! diff --git a/content/en/roadmap.md b/content/en/roadmap.md index 074d306be..ff213bf25 100644 --- a/content/en/roadmap.md +++ b/content/en/roadmap.md @@ -126,7 +126,7 @@ Tasks ### Flux image update feature parity Image automation is available as a prerelease. See [this -guide](/docs/guides/image-update/) for how to +guide](/docs/workflows/image-update/) for how to install and use it. Goals @@ -147,14 +147,20 @@ Tasks - [x] Design the automation component - [x] Implement the image scan/patch/push workflow - [x] Integrate the new components in the Flux CLI [fluxcd/flux2#538](https://github.com/fluxcd/flux2/pull/538) +<<<<<<< HEAD - [x] Write a guide for how to use image automation ([guide here](/docs/guides/image-update/)) - [x] ACR/ECR/GCR integration ([guide here](/docs/guides/image-update/#imagerepository-cloud-providers-authentication)) - [x] Write a migration guide from Flux v1 annotations ([guide here](/docs/migration/flux-v1-automation-migration/)) +======= +- [x] Write a guide for how to use image automation ([guide here](/docs/workflows/image-update/)) +- [x] ACR/ECR/GCR integration ([guide here](/docs/workflows/image-update/#imagerepository-cloud-providers-authentication)) +- [x] Write a migration guide from Flux v1 annotations ([guide here](/docs/installation/migration/flux-v1-automation-migration/)) +>>>>>>> 8edc5de... . ### Helm v3 feature parity Helm support in Flux v2 is ready to try. See the [Helm controller -guide](/docs/guides/helmreleases/), and the [Helm +guide](/docs/workflows/helmreleases/), and the [Helm controller migration guide](/docs/migration/helm-operator-migration/). diff --git a/static/_redirects b/static/_redirects index eda6d5afb..50c30d55d 100644 --- a/static/_redirects +++ b/static/_redirects @@ -1,40 +1,48 @@ -/docs/components/helm/controller /docs/components/helm 301! -/docs/components/image/controller /docs/components/image 301! -/docs/components/kustomize/controller /docs/components/kustomize 301! -/docs/components/notification/controller /docs/components/notification 301! -/docs/components/source/controller /docs/components/source 301! -/docs/guides/installation /docs/installation 301! -/contributing /docs/contributing 301! -/docs/contributing/flux2 /docs/contributing/flux 301! -/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! -/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! -/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! -/docs/roadmap /roadmap 301! -/integrations /ecosystem 301! -/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! -/guides/repository-structure /installation/repository-structure 301! -/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! -/docs/use-cases/azure /docs/installation/platforms/azure 301! -/docs/use-cases/openshift /docs/installation/platforms/openshift 301! -/docs/guides/notifications /docs/operations/notifications 301! -/docs/guides/monitoring /docs/operations/monitoring 301! -/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! -/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! -/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! +/docs/components/helm/controller /docs/components/helm 301! +/docs/components/image/controller /docs/components/image 301! +/docs/components/kustomize/controller /docs/components/kustomize 301! +/docs/components/notification/controller /docs/components/notification 301! +/docs/components/source/controller /docs/components/source 301! +/docs/guides/installation /docs/installation 301! +/contributing /docs/contributing 301! +/docs/contributing/flux2 /docs/contributing/flux 301! +/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! +/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! +/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! +/docs/roadmap /roadmap 301! +/integrations /ecosystem 301! +/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! +/guides/repository-structure /installation/repository-structure 301! +/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! +/docs/use-cases/azure /docs/installation/platforms/azure 301! +/docs/use-cases/openshift /docs/installation/platforms/openshift 301! +/docs/guides/notifications /docs/operations/notifications 301! +/docs/guides/monitoring /docs/operations/monitoring 301! +/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! +/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! +/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! +/docs/guides/helmreleases /docs/workflows/helmreleases 301! +/docs/guides/image-update /docs/workflows/image-update 301! +/docs/flux-e2e /docs/concepts/flux-e2e 301! +/docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! +/docs/migration/timetable /docs/installation/migration/timetable 301! +/docs/migration/faq-migration /docs/installation/migration/faq-migration 301! +/docs/migration/flux-v1-migration /docs/installation/migration/flux-v1-migration 301! +/docs/migration/flux-v1-automation-migration /docs/installation/migration/flux-v1-automation-migration 301! -/flagger/how-it-works /flagger/usage/how-it-works 301! -/flagger/usage/progressive-delivery /flagger/tutorials/istio-progressive-delivery 301! -/flagger/usage/ab-testing /flagger/tutorials/istio-ab-testing 301! -/flagger/usage/blue-green /flagger/tutorials/kubernetes-blue-green 301! -/flagger/usage/appmesh-progressive-delivery /flagger/tutorials/appmesh-progressive-delivery 301! -/flagger/usage/linkerd-progressive-delivery /flagger/tutorials/linkerd-progressive-delivery 301! -/flagger/usage/contour-progressive-delivery /flagger/tutorials/contour-progressive-delivery 301! -/flagger/usage/gloo-progressive-delivery /flagger/tutorials/gloo-progressive-delivery 301! -/flagger/usage/nginx-progressive-delivery /flagger/tutorials/nginx-progressive-delivery 301! -/flagger/usage/skipper-progressive-delivery /flagger/tutorials/skipper-progressive-delivery 301! -/flagger/usage/crossover-progressive-delivery /flagger/tutorials/crossover-progressive-delivery 301! -/flagger/usage/traefik-progressive-delivery /flagger/tutorials/traefik-progressive-delivery 301! -/flagger/usage/osm-progressive-delivery /flagger/tutorials/osm-progressive-delivery 301! -/flagger/usage/kuma-progressive-delivery /flagger/tutorials/kuma-progressive-delivery 301! -/flagger/usage/gatewayapi-progressive-delivery /flagger/tutorials/gatewayapi-progressive-delivery 301! +/flagger/how-it-works /flagger/usage/how-it-works 301! +/flagger/usage/progressive-delivery /flagger/tutorials/istio-progressive-delivery 301! +/flagger/usage/ab-testing /flagger/tutorials/istio-ab-testing 301! +/flagger/usage/blue-green /flagger/tutorials/kubernetes-blue-green 301! +/flagger/usage/appmesh-progressive-delivery /flagger/tutorials/appmesh-progressive-delivery 301! +/flagger/usage/linkerd-progressive-delivery /flagger/tutorials/linkerd-progressive-delivery 301! +/flagger/usage/contour-progressive-delivery /flagger/tutorials/contour-progressive-delivery 301! +/flagger/usage/gloo-progressive-delivery /flagger/tutorials/gloo-progressive-delivery 301! +/flagger/usage/nginx-progressive-delivery /flagger/tutorials/nginx-progressive-delivery 301! +/flagger/usage/skipper-progressive-delivery /flagger/tutorials/skipper-progressive-delivery 301! +/flagger/usage/crossover-progressive-delivery /flagger/tutorials/crossover-progressive-delivery 301! +/flagger/usage/traefik-progressive-delivery /flagger/tutorials/traefik-progressive-delivery 301! +/flagger/usage/osm-progressive-delivery /flagger/tutorials/osm-progressive-delivery 301! +/flagger/usage/kuma-progressive-delivery /flagger/tutorials/kuma-progressive-delivery 301! +/flagger/usage/gatewayapi-progressive-delivery /flagger/tutorials/gatewayapi-progressive-delivery 301! From 42fd67aa6a02add74dbcd69b762fed4b34829d43 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 22 Mar 2022 13:01:59 +0100 Subject: [PATCH 06/10] move flux-e2e under /concepts Signed-off-by: Daniel Holbach --- .../docs/{concepts.md => concepts/_index.md} | 0 content/en/docs/{ => concepts}/flux-e2e.md | 0 static/_redirects | 64 +++++++++---------- 3 files changed, 32 insertions(+), 32 deletions(-) rename content/en/docs/{concepts.md => concepts/_index.md} (100%) rename content/en/docs/{ => concepts}/flux-e2e.md (100%) diff --git a/content/en/docs/concepts.md b/content/en/docs/concepts/_index.md similarity index 100% rename from content/en/docs/concepts.md rename to content/en/docs/concepts/_index.md diff --git a/content/en/docs/flux-e2e.md b/content/en/docs/concepts/flux-e2e.md similarity index 100% rename from content/en/docs/flux-e2e.md rename to content/en/docs/concepts/flux-e2e.md diff --git a/static/_redirects b/static/_redirects index 50c30d55d..c9414827b 100644 --- a/static/_redirects +++ b/static/_redirects @@ -1,35 +1,35 @@ -/docs/components/helm/controller /docs/components/helm 301! -/docs/components/image/controller /docs/components/image 301! -/docs/components/kustomize/controller /docs/components/kustomize 301! -/docs/components/notification/controller /docs/components/notification 301! -/docs/components/source/controller /docs/components/source 301! -/docs/guides/installation /docs/installation 301! -/contributing /docs/contributing 301! -/docs/contributing/flux2 /docs/contributing/flux 301! -/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! -/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! -/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! -/docs/roadmap /roadmap 301! -/integrations /ecosystem 301! -/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! -/guides/repository-structure /installation/repository-structure 301! -/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! -/docs/use-cases/azure /docs/installation/platforms/azure 301! -/docs/use-cases/openshift /docs/installation/platforms/openshift 301! -/docs/guides/notifications /docs/operations/notifications 301! -/docs/guides/monitoring /docs/operations/monitoring 301! -/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! -/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! -/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! -/docs/guides/helmreleases /docs/workflows/helmreleases 301! -/docs/guides/image-update /docs/workflows/image-update 301! -/docs/flux-e2e /docs/concepts/flux-e2e 301! -/docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! -/docs/migration/timetable /docs/installation/migration/timetable 301! -/docs/migration/faq-migration /docs/installation/migration/faq-migration 301! -/docs/migration/flux-v1-migration /docs/installation/migration/flux-v1-migration 301! -/docs/migration/flux-v1-automation-migration /docs/installation/migration/flux-v1-automation-migration 301! - +/docs/components/helm/controller /docs/components/helm 301! +/docs/components/image/controller /docs/components/image 301! +/docs/components/kustomize/controller /docs/components/kustomize 301! +/docs/components/notification/controller /docs/components/notification 301! +/docs/components/source/controller /docs/components/source 301! +/docs/guides/installation /docs/installation 301! +/contributing /docs/contributing 301! +/docs/contributing/flux2 /docs/contributing/flux 301! +/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! +/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! +/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! +/docs/roadmap /roadmap 301! +/integrations /ecosystem 301! +/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! +/docs/guides/repository-structure /docs/installation/repository-structure 301! +/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! +/docs/use-cases/azure /docs/installation/platforms/azure 301! +/docs/use-cases/openshift /docs/installation/platforms/openshift 301! +/docs/guides/notifications /docs/operations/notifications 301! +/docs/guides/monitoring /docs/operations/monitoring 301! +/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! +/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! +/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! +/docs/guides/helmreleases /docs/workflows/helmreleases 301! +/docs/guides/image-update /docs/workflows/image-update 301! +/docs/flux-e2e /docs/concepts/flux-e2e 301! +/docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! +/docs/migration/timetable /docs/installation/migration/timetable 301! +/docs/migration/faq-migration /docs/installation/migration/faq-migration 301! +/docs/migration/flux-v1-migration /docs/installation/migration/flux-v1-migration 301! +/docs/migration/flux-v1-automation-migration /docs/installation/migration/flux-v1-automation-migration 301! +/docs/flux-e2e /docs/concepts/flux-e2e 301! /flagger/how-it-works /flagger/usage/how-it-works 301! /flagger/usage/progressive-delivery /flagger/tutorials/istio-progressive-delivery 301! From 5d4df661ca8fcbb6230ee5a96138e6cc831383ed Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 22 Mar 2022 13:13:26 +0100 Subject: [PATCH 07/10] Move migration under installation Ref: #718 Not 100% happy with this yet, but let's see... Signed-off-by: Daniel Holbach --- content/en/_index.html | 2 +- .../en/blog/2021-05-31-june-update/index.md | 2 +- .../en/blog/2021-08-02-august-update/index.md | 4 ++ content/en/docs/faq.md | 10 +-- .../en/docs/installation/migration/_index.md | 5 ++ .../migration/faq-migration.md | 0 .../migration/flux-v1-automation-migration.md | 0 .../migration/flux-v1-migration.md | 6 +- .../migration/helm-operator-migration.md | 0 .../{ => installation}/migration/timetable.md | 2 +- content/en/docs/migration/_index.md | 6 -- content/en/docs/use-cases/helm.md | 2 +- content/en/roadmap.md | 14 ++--- layouts/partials/docs/legacy-warning.html | 2 +- static/_redirects | 63 +++++++++---------- 15 files changed, 57 insertions(+), 61 deletions(-) create mode 100644 content/en/docs/installation/migration/_index.md rename content/en/docs/{ => installation}/migration/faq-migration.md (100%) rename content/en/docs/{ => installation}/migration/flux-v1-automation-migration.md (100%) rename content/en/docs/{ => installation}/migration/flux-v1-migration.md (98%) rename content/en/docs/{ => installation}/migration/helm-operator-migration.md (100%) rename content/en/docs/{ => installation}/migration/timetable.md (97%) delete mode 100644 content/en/docs/migration/_index.md diff --git a/content/en/_index.html b/content/en/_index.html index 22939ddf7..96ea4815c 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -278,7 +278,7 @@

Other Flux projects

button2-url="/legacy/helm-operator/" button2-caption="Helm Operator Documentation" button2-color="blue" %}} We owe our success and good reputation as GitOps project to Flux and Helm Operator. They are the v1 iteration of our project and currently in [maintenance mode](https://github.com/fluxcd/flux/issues/3320). -We **strongly advise** everyone to familiarise themselves with the latest version of Flux and [start the process of migrating](/docs/migration/). +We **strongly advise** everyone to familiarise themselves with the latest version of Flux and [start the process of migrating](/docs/installation/migration/). {{% /blocks/project %}} {{% /blocks/section %}} diff --git a/content/en/blog/2021-05-31-june-update/index.md b/content/en/blog/2021-05-31-june-update/index.md index 131e89f79..e6fe30f5a 100644 --- a/content/en/blog/2021-05-31-june-update/index.md +++ b/content/en/blog/2021-05-31-june-update/index.md @@ -44,7 +44,7 @@ Docs: If you are entirely new to Flux, check out our [get started guide](/docs/get-started/). If you are on an older version of Flux, check out our [migration -documentation](/docs/migration/). +documentation](/docs/installation/migration/). ## Flagger 1.11 is here diff --git a/content/en/blog/2021-08-02-august-update/index.md b/content/en/blog/2021-08-02-august-update/index.md index 3881acbfc..19e02d6be 100644 --- a/content/en/blog/2021-08-02-august-update/index.md +++ b/content/en/blog/2021-08-02-august-update/index.md @@ -130,7 +130,11 @@ to Scott Rigby on Slack. In last month's update we discussed how Flux's APIs are now stable. To clarify what this means for the Flux project as a whole, we added the following section to [our migration +<<<<<<< HEAD timetable](/docs/migration/timetable/): +======= +timetable](/docs/installation/migration/timetable/): +>>>>>>> Move migration under installation - Flux 1: Superseded - All existing projects encouraged to migrate to Flux 2, and diff --git a/content/en/docs/faq.md b/content/en/docs/faq.md index 43f15dd71..1137e754e 100644 --- a/content/en/docs/faq.md +++ b/content/en/docs/faq.md @@ -325,18 +325,18 @@ when Bitnami publishes a new version of the metrics-server chart. Flux v1 is a monolithic do-it-all operator; Flux v2 separates the functionalities into specialized controllers, collectively called the GitOps Toolkit. -You can find a detailed comparison of Flux v1 and v2 features in the [migration FAQ](../migration/faq-migration/). +You can find a detailed comparison of Flux v1 and v2 features in the [migration FAQ](../installation/migration/faq-migration/). ### How can I migrate from v1 to v2? The Flux community has created guides and example repositories to help you migrate to Flux v2: -- [Migrate from Flux v1](/docs/migration/flux-v1-migration/) -- [Migrate from `.flux.yaml` and kustomize](/docs/migration/flux-v1-migration/#flux-with-kustomize) -- [Migrate from Flux v1 automated container image updates](/docs/migration/flux-v1-automation-migration/) +- [Migrate from Flux v1](/docs/installation/migration/flux-v1-migration/) +- [Migrate from `.flux.yaml` and kustomize](/docs/installation/migration/flux-v1-migration/#flux-with-kustomize) +- [Migrate from Flux v1 automated container image updates](/docs/installation/migration/flux-v1-automation-migration/) - [How to manage multi-tenant clusters with Flux v2](https://github.com/fluxcd/flux2-multi-tenancy) -- [Migrate from Helm Operator to Flux v2](/docs/migration/helm-operator-migration/) +- [Migrate from Helm Operator to Flux v2](/docs/installation/migration/helm-operator-migration/) - [How to structure your HelmReleases](https://github.com/fluxcd/flux2-kustomize-helm-example) ## Release questions diff --git a/content/en/docs/installation/migration/_index.md b/content/en/docs/installation/migration/_index.md new file mode 100644 index 000000000..717225ea3 --- /dev/null +++ b/content/en/docs/installation/migration/_index.md @@ -0,0 +1,5 @@ +--- +title: "Migration from v1" +description: "Migration guides for Flux Legacy (v1) and Helm Operator users." +weight: 60 +--- diff --git a/content/en/docs/migration/faq-migration.md b/content/en/docs/installation/migration/faq-migration.md similarity index 100% rename from content/en/docs/migration/faq-migration.md rename to content/en/docs/installation/migration/faq-migration.md diff --git a/content/en/docs/migration/flux-v1-automation-migration.md b/content/en/docs/installation/migration/flux-v1-automation-migration.md similarity index 100% rename from content/en/docs/migration/flux-v1-automation-migration.md rename to content/en/docs/installation/migration/flux-v1-automation-migration.md diff --git a/content/en/docs/migration/flux-v1-migration.md b/content/en/docs/installation/migration/flux-v1-migration.md similarity index 98% rename from content/en/docs/migration/flux-v1-migration.md rename to content/en/docs/installation/migration/flux-v1-migration.md index fd7e0f3aa..087ace34c 100644 --- a/content/en/docs/migration/flux-v1-migration.md +++ b/content/en/docs/installation/migration/flux-v1-migration.md @@ -66,7 +66,7 @@ repository. The Git repository created during bootstrap can be used to define the state of your fleet of Kubernetes clusters. For a detailed walk-through of the bootstrap procedure please see the [installation -guide](../installation/_index.md). +guide](../_index.md). {{% alert color="info" color="warning" title="'flux bootstrap' target" %}} `flux bootstrap` should not be run against a Git branch or path @@ -292,8 +292,8 @@ flux create alert app \ ``` For more details, read the guides on how to configure -[notifications]({{< relref "../operations/notifications.md" >}}) and -[webhooks]({{< relref "../operations/webhook-receivers.md" >}}). +[notifications]({{< relref "/docs/operations/notifications.md" >}}) and +[webhooks]({{< relref "/docs/operations/webhook-receivers.md" >}}). ### Flux debugging diff --git a/content/en/docs/migration/helm-operator-migration.md b/content/en/docs/installation/migration/helm-operator-migration.md similarity index 100% rename from content/en/docs/migration/helm-operator-migration.md rename to content/en/docs/installation/migration/helm-operator-migration.md diff --git a/content/en/docs/migration/timetable.md b/content/en/docs/installation/migration/timetable.md similarity index 97% rename from content/en/docs/migration/timetable.md rename to content/en/docs/installation/migration/timetable.md index 8ea07c945..daa7479e5 100644 --- a/content/en/docs/migration/timetable.md +++ b/content/en/docs/installation/migration/timetable.md @@ -9,7 +9,7 @@ hugeTable: true {{% alert color="info" title="πŸ’– Flux Migration Commitment" %}} This public timetable clarifies our commitment to end users. Its purpose is to help improve your experience in deciding how and when to plan infra decisions related to Flux versions. -Please refer to the [Roadmap]({{< relref "../../roadmap.md" >}}) for additional details. +Please refer to the [Roadmap]({{< relref "/roadmap.md" >}}) for additional details. {{% /alert %}} | Date | Flux 1 | Flux 2 CLI | GOTK[^1] | diff --git a/content/en/docs/migration/_index.md b/content/en/docs/migration/_index.md deleted file mode 100644 index 4abfaefc1..000000000 --- a/content/en/docs/migration/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Migration" -linkTitle: "Migration" -description: "Migration guides for Flux v1 and Helm Operator users." -weight: 60 ---- diff --git a/content/en/docs/use-cases/helm.md b/content/en/docs/use-cases/helm.md index 18dae573d..8a7fd901c 100644 --- a/content/en/docs/use-cases/helm.md +++ b/content/en/docs/use-cases/helm.md @@ -241,4 +241,4 @@ spec: - [Guides > Manage Helm Releases](../workflows/helmreleases.md) - [Toolkit Components > Helm Controller](../components/helm/_index.md) -- [Migration > Migrate to the Helm Controller](../migration/helm-operator-migration.md) +- [Migration > Migrate to the Helm Controller](../installation/migration/helm-operator-migration.md) diff --git a/content/en/roadmap.md b/content/en/roadmap.md index ff213bf25..63d79b302 100644 --- a/content/en/roadmap.md +++ b/content/en/roadmap.md @@ -12,7 +12,7 @@ type: page The Flux custom resource definitions which are at `v1beta1`, `v1beta2` and `v2beta1` and their controllers are considered stable and production ready. Going forward, breaking changes to the beta CRDs will be accompanied by a conversion mechanism. -Please see the [Migration and Support Timetable](docs/migration/timetable.md) for our commitment to end users. +Please see the [Migration and Support Timetable](docs/installation/migration/timetable.md) for our commitment to end users. {{% /alert %}} The following components are considered production ready: @@ -91,7 +91,7 @@ In our planning discussions we identified three areas of work: Flux v2 read-only is ready to try. See the [Getting Started](/docs/get-started/) how-to, and the [Migration -guide](/docs/migration/flux-v1-migration/). +guide](/docs/installation/migration/flux-v1-migration/). This would be the first stepping stone: we want Flux v2 to be on-par with today's Flux in [read-only mode](https://github.com/fluxcd/flux/blob/master/docs/faq.md#can-i-run-flux-with-readonly-git-access) @@ -147,22 +147,16 @@ Tasks - [x] Design the automation component - [x] Implement the image scan/patch/push workflow - [x] Integrate the new components in the Flux CLI [fluxcd/flux2#538](https://github.com/fluxcd/flux2/pull/538) -<<<<<<< HEAD -- [x] Write a guide for how to use image automation ([guide here](/docs/guides/image-update/)) -- [x] ACR/ECR/GCR integration ([guide here](/docs/guides/image-update/#imagerepository-cloud-providers-authentication)) -- [x] Write a migration guide from Flux v1 annotations ([guide here](/docs/migration/flux-v1-automation-migration/)) -======= - [x] Write a guide for how to use image automation ([guide here](/docs/workflows/image-update/)) - [x] ACR/ECR/GCR integration ([guide here](/docs/workflows/image-update/#imagerepository-cloud-providers-authentication)) - [x] Write a migration guide from Flux v1 annotations ([guide here](/docs/installation/migration/flux-v1-automation-migration/)) ->>>>>>> 8edc5de... . ### Helm v3 feature parity Helm support in Flux v2 is ready to try. See the [Helm controller guide](/docs/workflows/helmreleases/), and the [Helm controller migration -guide](/docs/migration/helm-operator-migration/). +guide](/docs/installation/migration/helm-operator-migration/). Goals @@ -188,4 +182,4 @@ Tasks - [x] Implement support for Helm charts from Git - [x] Implement support for referring to an alternative chart values file - [x] Stabilize API -- [x] [Create a migration guide for Helm Operator users](docs/migration/helm-operator-migration.md) +- [x] [Create a migration guide for Helm Operator users](docs/installation/migration/helm-operator-migration.md) diff --git a/layouts/partials/docs/legacy-warning.html b/layouts/partials/docs/legacy-warning.html index 0a5fadae5..2d1f05e69 100644 --- a/layouts/partials/docs/legacy-warning.html +++ b/layouts/partials/docs/legacy-warning.html @@ -3,7 +3,7 @@

Upgrade Advisory

This documentation is for Flux (v1) and Helm Operator (v1). Both projects are in maintenance mode and will soon reach end-of-life. We strongly recommend you familiarise yourself with the newest Flux and - start looking at your migration path.

+ start looking at your migration path.

For documentation regarding the latest Flux, please refer to this section.

diff --git a/static/_redirects b/static/_redirects index c9414827b..7f587437d 100644 --- a/static/_redirects +++ b/static/_redirects @@ -1,35 +1,34 @@ -/docs/components/helm/controller /docs/components/helm 301! -/docs/components/image/controller /docs/components/image 301! -/docs/components/kustomize/controller /docs/components/kustomize 301! -/docs/components/notification/controller /docs/components/notification 301! -/docs/components/source/controller /docs/components/source 301! -/docs/guides/installation /docs/installation 301! -/contributing /docs/contributing 301! -/docs/contributing/flux2 /docs/contributing/flux 301! -/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! -/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! -/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! -/docs/roadmap /roadmap 301! -/integrations /ecosystem 301! -/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! -/docs/guides/repository-structure /docs/installation/repository-structure 301! -/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! -/docs/use-cases/azure /docs/installation/platforms/azure 301! -/docs/use-cases/openshift /docs/installation/platforms/openshift 301! -/docs/guides/notifications /docs/operations/notifications 301! -/docs/guides/monitoring /docs/operations/monitoring 301! -/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! -/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! -/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! -/docs/guides/helmreleases /docs/workflows/helmreleases 301! -/docs/guides/image-update /docs/workflows/image-update 301! -/docs/flux-e2e /docs/concepts/flux-e2e 301! -/docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! -/docs/migration/timetable /docs/installation/migration/timetable 301! -/docs/migration/faq-migration /docs/installation/migration/faq-migration 301! -/docs/migration/flux-v1-migration /docs/installation/migration/flux-v1-migration 301! -/docs/migration/flux-v1-automation-migration /docs/installation/migration/flux-v1-automation-migration 301! -/docs/flux-e2e /docs/concepts/flux-e2e 301! +/docs/components/helm/controller /docs/components/helm 301! +/docs/components/image/controller /docs/components/image 301! +/docs/components/kustomize/controller /docs/components/kustomize 301! +/docs/components/notification/controller /docs/components/notification 301! +/docs/components/source/controller /docs/components/source 301! +/docs/guides/installation /docs/installation 301! +/contributing /docs/contributing 301! +/docs/contributing/flux2 /docs/contributing/flux 301! +/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! +/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! +/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! +/docs/roadmap /roadmap 301! +/integrations /ecosystem 301! +/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! +/docs/guides/repository-structure /docs/installation/repository-structure 301! +/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! +/docs/use-cases/azure /docs/installation/platforms/azure 301! +/docs/use-cases/openshift /docs/installation/platforms/openshift 301! +/docs/guides/notifications /docs/operations/notifications 301! +/docs/guides/monitoring /docs/operations/monitoring 301! +/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! +/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! +/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! +/docs/guides/helmreleases /docs/workflows/helmreleases 301! +/docs/guides/image-update /docs/workflows/image-update 301! +/docs/flux-e2e /docs/concepts/flux-e2e 301! +/docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! +/docs/migration/timetable /docs/installation/migration/timetable 301! +/docs/migration/faq-migration /docs/installation/migration/faq-migration 301! +/docs/migration/flux-v1-migration /docs/installation/migration/flux-v1-migration 301! +/docs/migration/flux-v1-automation-migration /docs/installation/migration/flux-v1-automation-migration 301! /flagger/how-it-works /flagger/usage/how-it-works 301! /flagger/usage/progressive-delivery /flagger/tutorials/istio-progressive-delivery 301! From c06fefaf0ad01463032fc8e655ae3b9c72ed1b84 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 22 Mar 2022 13:34:37 +0100 Subject: [PATCH 08/10] Remove guides section Signed-off-by: Daniel Holbach --- content/en/blog/2020-12-01-december-update/index.md | 2 +- content/en/blog/2021-03-01-march-update/index.md | 7 ++++--- content/en/blog/2021-05-31-june-update/index.md | 2 +- content/en/blog/2022-01-31-january-update/index.md | 2 +- content/en/docs/guides/_index.md | 6 ------ .../migration/flux-v1-automation-migration.md | 2 +- .../en/docs/use-cases/gh-actions-manifest-generation.md | 8 ++++---- content/en/docs/use-cases/jenkins.md | 6 +++--- .../en/docs/{guides => workflows}/cron-job-image-auth.md | 0 content/en/docs/workflows/image-update.md | 2 +- .../en/docs/{guides => workflows}/sortable-image-tags.md | 0 content/en/legacy/flux/faq.md | 4 ++-- static/_redirects | 2 ++ 13 files changed, 20 insertions(+), 23 deletions(-) delete mode 100644 content/en/docs/guides/_index.md rename content/en/docs/{guides => workflows}/cron-job-image-auth.md (100%) rename content/en/docs/{guides => workflows}/sortable-image-tags.md (100%) diff --git a/content/en/blog/2020-12-01-december-update/index.md b/content/en/blog/2020-12-01-december-update/index.md index 349521f02..8a0566823 100644 --- a/content/en/blog/2020-12-01-december-update/index.md +++ b/content/en/blog/2020-12-01-december-update/index.md @@ -27,7 +27,7 @@ To get you started with setting up Flux and managing multi-tenant environments, ## Guides for Helm users -If you have been using the Helm Operator in the past, you should be able to easily upgrade to the Helm Controller (Flux v2). Check out [this guide](/docs/migration/helm-operator-migration/) and please give us feedback - we’d love to hear from you: +If you have been using the Helm Operator in the past, you should be able to easily upgrade to the Helm Controller (Flux v2). Check out [this guide](/docs/installation/migration/helm-operator-migration) and please give us feedback - we’d love to hear from you. If you are interested in an example which describes how you can keep e.g. two clusters updated with minimal duplication, check out this repository - it uses Flux v2, Helm and Kustomize: diff --git a/content/en/blog/2021-03-01-march-update/index.md b/content/en/blog/2021-03-01-march-update/index.md index b0c90fe7a..b2e8996fc 100644 --- a/content/en/blog/2021-03-01-march-update/index.md +++ b/content/en/blog/2021-03-01-march-update/index.md @@ -109,8 +109,9 @@ Capili](https://www.meetup.com/GitOps-Community/events/276539791/) > Flux v2. > > In this session, Leigh Capili, DX Engineer at Weaveworks, will demo -> the [Flux guide on how to Migrate from Flux v1](/docs/installation/migration/flux-v1-migration), > including bootstrapping a cluster with Flux 1 and how to move it over +> the [Flux guide on how to Migrate from Flux v1](/docs/installation/migration/flux-v1-migration), +> including boostrapping a cluster with Flux 1 and how to move it over > to Flux v2. > > If we don\'t get to everything in this session, we will have @@ -119,9 +120,9 @@ Capili](https://www.meetup.com/GitOps-Community/events/276539791/) > > Resources: > -> πŸ“ [Flux v2 Documentation](/docs/) +> πŸ“ [Flux v2 Documentation](/docs) > -> πŸ“ [Flux v2 Guide Migrate from Flux v1](/docs/migration/flux-v1-migration/) +> πŸ“ [Flux v2 Guide Migrate from Flux v1](/docs/installation/migration/flux-v1-migration) > > πŸ“ [Flux v2 roadmap](/roadmap/). diff --git a/content/en/blog/2021-05-31-june-update/index.md b/content/en/blog/2021-05-31-june-update/index.md index e6fe30f5a..f1a287e7f 100644 --- a/content/en/blog/2021-05-31-june-update/index.md +++ b/content/en/blog/2021-05-31-june-update/index.md @@ -39,7 +39,7 @@ Docs: - πŸ“” [GitRepository include documentation](/docs/components/source/gitrepositories/#including-gitrepository) - 🎁 Checkout the new [guide on ways of structuring your - repositories](/docs/guides/repository-structure/) + repositories](/docs/installation/repository-structure/) If you are entirely new to Flux, check out our [get started guide](/docs/get-started/). If you are on diff --git a/content/en/blog/2022-01-31-january-update/index.md b/content/en/blog/2022-01-31-january-update/index.md index 3e99a2ab5..22b649f62 100644 --- a/content/en/blog/2022-01-31-january-update/index.md +++ b/content/en/blog/2022-01-31-january-update/index.md @@ -418,7 +418,7 @@ So since the last Flux update blog we got a lot done: - We added instructions on how to [encrypt secrets using HashiCorp Vault](/docs/operations/secrets/mozilla-sops/#encrypting-secrets-using-hashicorp-vault) - Also [instructions for auto-login - (ACR/ECR/GCR)](/docs/guides/cron-job-image-auth/) + (ACR/ECR/GCR)](/docs/workflows/cron-job-image-auth/) - We explain [how to bootstrap Flux on AWS EKS with CodeCommit Git repositories](/docs/installation/platforms/aws-codecommit/) - Docs updates for Flux v0.26.0, including a \"Multi-tenancy diff --git a/content/en/docs/guides/_index.md b/content/en/docs/guides/_index.md deleted file mode 100644 index d348f21e2..000000000 --- a/content/en/docs/guides/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "User Guides" -linkTitle: "Guides" -description: "Flux user guides." -weight: 40 ---- diff --git a/content/en/docs/installation/migration/flux-v1-automation-migration.md b/content/en/docs/installation/migration/flux-v1-automation-migration.md index 829b620bf..dfc84998e 100644 --- a/content/en/docs/installation/migration/flux-v1-automation-migration.md +++ b/content/en/docs/installation/migration/flux-v1-automation-migration.md @@ -752,6 +752,6 @@ from ["Migrating each manifest to Flux v2"](#migrating-each-manifest-to-flux-v2) [auto-object-ref]: /docs/components/image/imageupdateautomations/ [image-update-tute-creds]: /docs/workflows/image-update/#configure-image-scanning [image-update-tute-clouds]: /docs/workflows/image-update/#imagerepository-cloud-providers-authentication -[image-tags-guide]: /docs/guides/sortable-image-tags/ +[image-tags-guide]: /docs/workflows/sortable-image-tags/ [auto-ref]: /docs/components/image/imageupdateautomations/ [semver]: https://semver.org diff --git a/content/en/docs/use-cases/gh-actions-manifest-generation.md b/content/en/docs/use-cases/gh-actions-manifest-generation.md index a3344a34e..65010fb7d 100644 --- a/content/en/docs/use-cases/gh-actions-manifest-generation.md +++ b/content/en/docs/use-cases/gh-actions-manifest-generation.md @@ -126,7 +126,7 @@ echo ::set-output name=VERSION::${VERSION} ``` {{% alert title="When migrating to Flux v2" %}} -Users will find that [some guidance has changed since Flux v1](https://github.com/fluxcd/flux2/discussions/802#discussioncomment-320189). Tagging images with a `GIT_SHA` was a common practice that is no longer supported by Flux's Image Automation. A newer alternative is adding timestamp or build number in [Sortable image tags]({{< relref "../guides/sortable-image-tags/" >}}), preferred by the `image-automation-controller`. +Users will find that [some guidance has changed since Flux v1](https://github.com/fluxcd/flux2/discussions/802#discussioncomment-320189). Tagging images with a `GIT_SHA` was a common practice that is no longer supported by Flux's Image Automation. A newer alternative is adding timestamp or build number in [Sortable image tags]({{< relref "../workflows/sortable-image-tags/" >}}), preferred by the `image-automation-controller`. {{% /alert %}} Next we call out to a shell script `update-k8s.sh` taking one argument, the Git SHA value from GitHub: @@ -1246,7 +1246,7 @@ If you are on GitHub, and are struggling to get started using GitHub Actions, or [Commit Across Repositories Workflow]: #commit-across-repositories-workflow [01-manifest-generate.yaml]: https://github.com/kingdonb/any_old_app/blob/main/.github/workflows/01-manifest-generate.yaml [some guidance has changed since Flux v1]: https://github.com/fluxcd/flux2/discussions/802#discussioncomment-320189 -[Sortable image tags]: /guides/sortable-image-tags/ +[Sortable image tags]: /workflows/sortable-image-tags/ [Okteto's Getting Started Guides]: https://github.com/okteto/go-getting-started/blob/master/k8s.yml [Build and push Docker images]: https://github.com/marketplace/actions/build-and-push-docker-images [Prepare step]: https://github.com/fluxcd/kustomize-controller/blob/5da1fc043db4a1dc9fd3cf824adc8841b56c2fcd/.github/workflows/release.yml#L17-L25 @@ -1284,5 +1284,5 @@ If you are on GitHub, and are struggling to get started using GitHub Actions, or [Push directory to another repository]: https://github.com/marketplace/actions/push-directory-to-another-repository [Flux v2 image automation]: /docs/workflows/image-update/ [Image Automation Controllers]: /docs/components/image/ -[Example of a build process with timestamp tagging]: /docs/guides/sortable-image-tags/#example-of-a-build-process-with-timestamp-tagging -[Sortable image tags to use with automation]: /docs/guides/sortable-image-tags/#formats-and-alternatives +[Example of a build process with timestamp tagging]: /docs/workflows/sortable-image-tags/#example-of-a-build-process-with-timestamp-tagging +[Sortable image tags to use with automation]: /docs/workflows/sortable-image-tags/#formats-and-alternatives diff --git a/content/en/docs/use-cases/jenkins.md b/content/en/docs/use-cases/jenkins.md index 321bd3d2c..596b8a6ae 100644 --- a/content/en/docs/use-cases/jenkins.md +++ b/content/en/docs/use-cases/jenkins.md @@ -303,7 +303,7 @@ Update deployments via Flux's [ImagePolicy] CRD, and the Image Update Automation [docker plugin]: https://plugins.jenkins.io/docker-plugin/ [doesn't even have Docker underneath]: https://kubernetes.io/blog/2020/12/02/dockershim-faq/#why-is-dockershim-being-deprecated [Mirantis has taken over support of dockershim]: https://www.mirantis.com/blog/mirantis-to-take-over-support-of-kubernetes-dockershim-2/ -[Sortable image tags]: /docs/guides/sortable-image-tags/ +[Sortable image tags]: /docs/workflows/sortable-image-tags/ [image update guide]: /docs/workflows/image-update/ [credentials]: https://github.com/jenkinsci/pipeline-examples/blob/master/declarative-examples/simple-examples/credentialsUsernamePassword.groovy [populating environment variables]: https://github.com/jenkinsci/pipeline-examples/blob/master/declarative-examples/simple-examples/scriptVariableAssignment.groovy @@ -315,8 +315,8 @@ Update deployments via Flux's [ImagePolicy] CRD, and the Image Update Automation [Dockerfile]: https://github.com/kingdonb/jenkins-example-workflow/blob/main/Dockerfile [jenkins/docker-pod.yaml]: https://github.com/kingdonb/jenkins-example-workflow/blob/main/jenkins/docker-pod.yaml [jenkins/run-tests.sh]: https://github.com/kingdonb/jenkins-example-workflow/blob/main/jenkins/run-tests.sh -[using an ImagePolicy object]: /docs/guides/sortable-image-tags/#using-in-an-imagepolicy-object +[using an ImagePolicy object]: /docs/workflows/sortable-image-tags/#using-in-an-imagepolicy-object [Kubernetes examples for Buildkit]: https://github.com/moby/buildkit/tree/master/examples/kubernetes [Buildkit CLI for Kubectl]: https://github.com/vmware-tanzu/buildkit-cli-for-kubectl [KubeCon/CloudNativeCon EU 2021]: https://www.youtube.com/watch?v=vTh6jkW_xtI -[ImagePolicy]: /docs/guides/sortable-image-tags/#using-in-an-imagepolicy-object +[ImagePolicy]: /docs/workflows/sortable-image-tags/#using-in-an-imagepolicy-object diff --git a/content/en/docs/guides/cron-job-image-auth.md b/content/en/docs/workflows/cron-job-image-auth.md similarity index 100% rename from content/en/docs/guides/cron-job-image-auth.md rename to content/en/docs/workflows/cron-job-image-auth.md diff --git a/content/en/docs/workflows/image-update.md b/content/en/docs/workflows/image-update.md index 72fda7e47..024e3ce44 100644 --- a/content/en/docs/workflows/image-update.md +++ b/content/en/docs/workflows/image-update.md @@ -746,7 +746,7 @@ pod-managed identities add-on that is in preview. {{% /alert %}} {{% alert title="Migrating from cron-based registry credentials sync" color="warning" %}} -If you are migrating from the [Generating Tokens for Managed Identities [short-lived]](/docs/guides/cron-job-image-auth/#generating-tokens-for-managed-identities-short-lived) approach, `spec.secretRef` must be removed from your `ImageRepository`! +If you are migrating from the [Generating Tokens for Managed Identities [short-lived]](/docs/workflows/cron-job-image-auth/#generating-tokens-for-managed-identities-short-lived) approach, `spec.secretRef` must be removed from your `ImageRepository`! Failing to do so will, eventually, cause the `image-reflector-controller` to use stale credentials when it tries to get images from the ACR. {{% /alert %}} diff --git a/content/en/docs/guides/sortable-image-tags.md b/content/en/docs/workflows/sortable-image-tags.md similarity index 100% rename from content/en/docs/guides/sortable-image-tags.md rename to content/en/docs/workflows/sortable-image-tags.md diff --git a/content/en/legacy/flux/faq.md b/content/en/legacy/flux/faq.md index 3278e07ce..c0d86a8af 100644 --- a/content/en/legacy/flux/faq.md +++ b/content/en/legacy/flux/faq.md @@ -6,7 +6,7 @@ weight: 80 ## 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](/docs/migration/flux-v1-migration/) as early as possible. +[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](/docs/installation/migration/flux-v1-migration/) as early as possible. ### Why should I upgrade @@ -24,7 +24,7 @@ Flux v1 implementation of image automation has serious performance issues scalin That's right, rate limiting undoutedly happened because of abusive clients pulling image metadata from many images (like Flux v1 did,) images that might only be stored for the purpose of retention policies, that might be relegated to cold storage if they were not being periodically retrieved. -Flux v2 resolved this with [sortable image tags](/docs/guides/sortable-image-tags/); (this is a breaking change.) +Flux v2 resolved this with [sortable image tags](/docs/workflows/sortable-image-tags/); (this is a breaking change.) Flux v1 requires one Flux daemon to be running per git repository/branch that syncs to the cluster. Flux v2 only expects cluster operators to run one source-controller instance, allowing to manage multiple repositories, or multiple clusters (or an entire fleet) with just one Flux installation. diff --git a/static/_redirects b/static/_redirects index 7f587437d..d32975fcc 100644 --- a/static/_redirects +++ b/static/_redirects @@ -23,6 +23,8 @@ /docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! /docs/guides/helmreleases /docs/workflows/helmreleases 301! /docs/guides/image-update /docs/workflows/image-update 301! +/docs/guides/cron-job-image-auth /docs/workflows/cron-job-image-auth 301! +/docs/guides/sortable-image-tags /docs/workflows/sortable-image-tags 301! /docs/flux-e2e /docs/concepts/flux-e2e 301! /docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! /docs/migration/timetable /docs/installation/migration/timetable 301! From 81774edaec5780c763068c4fbf865f8cbf420369 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 22 Mar 2022 14:02:29 +0100 Subject: [PATCH 09/10] remove use-cases section Signed-off-by: Daniel Holbach --- .../en/blog/2021-04-29-may-update/index.md | 2 +- content/en/docs/concepts/flux-e2e.md | 2 +- .../docs/{use-cases => installation}/helm.md | 0 content/en/docs/use-cases/_index.md | 6 -- content/en/docs/workflows/_index.md | 2 +- .../gh-actions-auto-pr.md | 0 .../gh-actions-manifest-generation.md | 0 content/en/docs/workflows/image-update.md | 2 +- .../docs/{use-cases => workflows}/jenkins.md | 0 static/_redirects | 70 ++++++++++--------- 10 files changed, 41 insertions(+), 43 deletions(-) rename content/en/docs/{use-cases => installation}/helm.md (100%) delete mode 100644 content/en/docs/use-cases/_index.md rename content/en/docs/{use-cases => workflows}/gh-actions-auto-pr.md (100%) rename content/en/docs/{use-cases => workflows}/gh-actions-manifest-generation.md (100%) rename content/en/docs/{use-cases => workflows}/jenkins.md (100%) diff --git a/content/en/blog/2021-04-29-may-update/index.md b/content/en/blog/2021-04-29-may-update/index.md index 80642da29..ab160f2fa 100644 --- a/content/en/blog/2021-04-29-may-update/index.md +++ b/content/en/blog/2021-04-29-may-update/index.md @@ -99,7 +99,7 @@ feature](/docs/installation/_index.md#customize-flux-manifests). The [Image automation guide](/docs/workflows/image-update/) has been updated to the new APIs, and also includes a reference to a -new [GitHub Actions use case guide](/docs/use-cases/gh-actions-auto-pr/), +new [GitHub Actions use case guide](/docs/workflows/gh-actions-auto-pr/), for automatic pull request creation with Flux and GitHub Actions. This guide is for you, if you want Flux updates to go to a staging branch, where they can be reviewed and approved before going to production. diff --git a/content/en/docs/concepts/flux-e2e.md b/content/en/docs/concepts/flux-e2e.md index 1a2ff7ce3..f4f1f6d23 100644 --- a/content/en/docs/concepts/flux-e2e.md +++ b/content/en/docs/concepts/flux-e2e.md @@ -587,7 +587,7 @@ The health checking feature is called [Health Assessment][] in the Flux Kustomiz [field management]: https://kubernetes.io/docs/reference/using-api/server-side-apply/#field-management [HelmRelease API]: /docs/components/helm/api/ [HelmRelease Guide]: /docs/workflows/helmreleases/ -[Helm Use Case]: /docs/use-cases/helm/ +[Helm Use Case]: /docs/installation/helm/ [HelmRepository API]: /docs/components/source/helmrepositories/ [HelmChart API]: /docs/components/source/helmcharts/ [HelmChartTemplate.spec.reconcileStrategy]: /docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate diff --git a/content/en/docs/use-cases/helm.md b/content/en/docs/installation/helm.md similarity index 100% rename from content/en/docs/use-cases/helm.md rename to content/en/docs/installation/helm.md diff --git a/content/en/docs/use-cases/_index.md b/content/en/docs/use-cases/_index.md deleted file mode 100644 index fa9d88a9d..000000000 --- a/content/en/docs/use-cases/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Use Cases" -linkTitle: "Use Cases" -description: "Flux use cases." -weight: 50 ---- diff --git a/content/en/docs/workflows/_index.md b/content/en/docs/workflows/_index.md index 816a19b01..f0ff29543 100644 --- a/content/en/docs/workflows/_index.md +++ b/content/en/docs/workflows/_index.md @@ -1,4 +1,4 @@ --- title: Workflows -weight: 80 +weight: 45 --- diff --git a/content/en/docs/use-cases/gh-actions-auto-pr.md b/content/en/docs/workflows/gh-actions-auto-pr.md similarity index 100% rename from content/en/docs/use-cases/gh-actions-auto-pr.md rename to content/en/docs/workflows/gh-actions-auto-pr.md diff --git a/content/en/docs/use-cases/gh-actions-manifest-generation.md b/content/en/docs/workflows/gh-actions-manifest-generation.md similarity index 100% rename from content/en/docs/use-cases/gh-actions-manifest-generation.md rename to content/en/docs/workflows/gh-actions-manifest-generation.md diff --git a/content/en/docs/workflows/image-update.md b/content/en/docs/workflows/image-update.md index 024e3ce44..991d7a823 100644 --- a/content/en/docs/workflows/image-update.md +++ b/content/en/docs/workflows/image-update.md @@ -445,7 +445,7 @@ spec: ``` You can use CI automation e.g. GitHub Actions such as -Flux's [GitHub Actions Auto PR](/docs/use-cases/gh-actions-auto-pr) example +Flux's [GitHub Actions Auto PR](/docs/workflows/gh-actions-auto-pr) example to open a pull request against the checkout branch. This way you can manually approve the image updates before they are applied on your clusters. diff --git a/content/en/docs/use-cases/jenkins.md b/content/en/docs/workflows/jenkins.md similarity index 100% rename from content/en/docs/use-cases/jenkins.md rename to content/en/docs/workflows/jenkins.md diff --git a/static/_redirects b/static/_redirects index d32975fcc..329bf5086 100644 --- a/static/_redirects +++ b/static/_redirects @@ -1,36 +1,40 @@ -/docs/components/helm/controller /docs/components/helm 301! -/docs/components/image/controller /docs/components/image 301! -/docs/components/kustomize/controller /docs/components/kustomize 301! -/docs/components/notification/controller /docs/components/notification 301! -/docs/components/source/controller /docs/components/source 301! -/docs/guides/installation /docs/installation 301! -/contributing /docs/contributing 301! -/docs/contributing/flux2 /docs/contributing/flux 301! -/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! -/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! -/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! -/docs/roadmap /roadmap 301! -/integrations /ecosystem 301! -/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! -/docs/guides/repository-structure /docs/installation/repository-structure 301! -/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! -/docs/use-cases/azure /docs/installation/platforms/azure 301! -/docs/use-cases/openshift /docs/installation/platforms/openshift 301! -/docs/guides/notifications /docs/operations/notifications 301! -/docs/guides/monitoring /docs/operations/monitoring 301! -/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! -/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! -/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! -/docs/guides/helmreleases /docs/workflows/helmreleases 301! -/docs/guides/image-update /docs/workflows/image-update 301! -/docs/guides/cron-job-image-auth /docs/workflows/cron-job-image-auth 301! -/docs/guides/sortable-image-tags /docs/workflows/sortable-image-tags 301! -/docs/flux-e2e /docs/concepts/flux-e2e 301! -/docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! -/docs/migration/timetable /docs/installation/migration/timetable 301! -/docs/migration/faq-migration /docs/installation/migration/faq-migration 301! -/docs/migration/flux-v1-migration /docs/installation/migration/flux-v1-migration 301! -/docs/migration/flux-v1-automation-migration /docs/installation/migration/flux-v1-automation-migration 301! +/docs/components/helm/controller /docs/components/helm 301! +/docs/components/image/controller /docs/components/image 301! +/docs/components/kustomize/controller /docs/components/kustomize 301! +/docs/components/notification/controller /docs/components/notification 301! +/docs/components/source/controller /docs/components/source 301! +/docs/guides/installation /docs/installation 301! +/contributing /docs/contributing 301! +/docs/contributing/flux2 /docs/contributing/flux 301! +/docs/contributing/docs/hugo-shortcodes /docs/contributing/docs/writing-docs 301! +/legacy/helm-operator/guides/upgrade-to-ga /legacy/helm-operator/how-to/upgrade-to-ga 301! +/legacy/helm-operator/guides/upgrade-to-beta /legacy/helm-operator/how-to/upgrade-to-beta 301! +/docs/roadmap /roadmap 301! +/integrations /ecosystem 301! +/docs/contributing/docs/some-background https://github.com/fluxcd/website#readme 301! +/docs/guides/repository-structure /docs/installation/repository-structure 301! +/docs/use-cases/aws-codecommit /docs/installation/platforms/aws-codecommit 301! +/docs/use-cases/azure /docs/installation/platforms/azure 301! +/docs/use-cases/openshift /docs/installation/platforms/openshift 301! +/docs/guides/notifications /docs/operations/notifications 301! +/docs/guides/monitoring /docs/operations/monitoring 301! +/docs/guides/webhook-receivers /docs/operations/webhook-receivers 301! +/docs/guides/mozilla-sops /docs/operations/secrets/mozilla-sops 301! +/docs/guides/sealed-secrets /docs/operations/secrets/sealed-secrets 301! +/docs/guides/helmreleases /docs/workflows/helmreleases 301! +/docs/guides/image-update /docs/workflows/image-update 301! +/docs/guides/cron-job-image-auth /docs/workflows/cron-job-image-auth 301! +/docs/guides/sortable-image-tags /docs/workflows/sortable-image-tags 301! +/docs/use-cases/jenkins /docs/workflows/jenkins 301! +/docs/use-cases/gh-actions-auto-pr /docs/workflows/gh-actions-auto-pr 301! +/docs/use-cases/gh-actions-manifest-generation /docs/workflows/gh-actions-manifest-generation 301! +/docs/use-cases/helm /docs/installation/helm 301! +/docs/flux-e2e /docs/concepts/flux-e2e 301! +/docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! +/docs/migration/timetable /docs/installation/migration/timetable 301! +/docs/migration/faq-migration /docs/installation/migration/faq-migration 301! +/docs/migration/flux-v1-migration /docs/installation/migration/flux-v1-migration 301! +/docs/migration/flux-v1-automation-migration /docs/installation/migration/flux-v1-automation-migration 301! /flagger/how-it-works /flagger/usage/how-it-works 301! /flagger/usage/progressive-delivery /flagger/tutorials/istio-progressive-delivery 301! From 9c4092dd1b8ad9d5d26455a02f685074fe960f0b Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Wed, 23 Mar 2022 10:42:01 +0100 Subject: [PATCH 10/10] cleanup: fix some more links, including old toolkit.f.i Signed-off-by: Daniel Holbach --- content/en/blog/2021-01-06-january-update.md | 2 +- content/en/blog/2021-03-01-march-update/index.md | 6 ++---- .../2021-03-08-flux-is-a-cncf-incubation-project/index.md | 5 +++-- content/en/blog/2021-03-31-april-update.md | 4 ---- content/en/blog/2021-04-29-may-update/index.md | 4 ++-- content/en/blog/2021-07-02-july-update/index.md | 3 +-- content/en/blog/2021-08-02-august-update/index.md | 4 ---- content/en/blog/2021-10-01-october-update.md | 2 +- content/en/blog/2022-01-31-january-update/index.md | 2 +- content/en/docs/installation/migration/timetable.md | 2 +- content/en/docs/installation/platforms/aws-codecommit.md | 6 +++--- content/en/roadmap.md | 4 ++-- static/_redirects | 3 +++ 13 files changed, 20 insertions(+), 27 deletions(-) diff --git a/content/en/blog/2021-01-06-january-update.md b/content/en/blog/2021-01-06-january-update.md index b2f89cfff..85d83f4b2 100644 --- a/content/en/blog/2021-01-06-january-update.md +++ b/content/en/blog/2021-01-06-january-update.md @@ -130,7 +130,7 @@ Upcoming events The Flux community is growing and we are in the middle of a quite a few big discussions: -- We have [a new guide which explains core concepts](/docs/concepts/) in the Flux world - please give feedback - and thanks Somtochi! +- We have a [new guide which explains core concepts](/docs/concepts) in the Flux world - please give feedback - and thanks Somtochi! - Flux applies to upgrade to CNCF Incubation status: [https://github.com/cncf/toc/pull/567](https://github.com/cncf/toc/pull/567) If you like what you read and would like to get involved, here are a few diff --git a/content/en/blog/2021-03-01-march-update/index.md b/content/en/blog/2021-03-01-march-update/index.md index b2e8996fc..7e07d9445 100644 --- a/content/en/blog/2021-03-01-march-update/index.md +++ b/content/en/blog/2021-03-01-march-update/index.md @@ -109,9 +109,8 @@ Capili](https://www.meetup.com/GitOps-Community/events/276539791/) > Flux v2. > > In this session, Leigh Capili, DX Engineer at Weaveworks, will demo -> including bootstrapping a cluster with Flux 1 and how to move it over > the [Flux guide on how to Migrate from Flux v1](/docs/installation/migration/flux-v1-migration), -> including boostrapping a cluster with Flux 1 and how to move it over +> including bootstrapping a cluster with Flux 1 and how to move it over > to Flux v2. > > If we don\'t get to everything in this session, we will have @@ -170,8 +169,7 @@ good ways to do that: - Talk to us in the `#flux` channel on [CNCF Slack](https://slack.cncf.io/) - Join the [planning discussions](https://github.com/fluxcd/flux2/discussions) - And if you are completely new to Flux v2, take a look at our - [Get Started guide](/docs/get-started/) and - give us feedback + [Get Started guide](/docs/get-started/) and give us feedback - Social media: Follow [Flux on Twitter](https://twitter.com/fluxcd), join the discussion in the [Flux LinkedIn group](https://www.linkedin.com/groups/8985374/). diff --git a/content/en/blog/2021-03-08-flux-is-a-cncf-incubation-project/index.md b/content/en/blog/2021-03-08-flux-is-a-cncf-incubation-project/index.md index c81e53178..5de5b6afd 100644 --- a/content/en/blog/2021-03-08-flux-is-a-cncf-incubation-project/index.md +++ b/content/en/blog/2021-03-08-flux-is-a-cncf-incubation-project/index.md @@ -68,8 +68,9 @@ toward a GA release, at which point we'll recommend that all Flux v1 users migrate to Flux v2. Now is the perfect time to familiarise yourself with [Flux -v2](/) - the Get Started guide only takes a couple of minutes to complete. -If you prefer a video, check out [our resources section](/#resources). +v2](/) - the Get Started guide only takes a +couple of minutes to complete. If you prefer a video, check out +[our resources section](/resources). Migrating from v1 will require some work, but it will definitely be worth it: in this iteration you are going to get diff --git a/content/en/blog/2021-03-31-april-update.md b/content/en/blog/2021-03-31-april-update.md index bc7d517f7..75be9d05b 100644 --- a/content/en/blog/2021-03-31-april-update.md +++ b/content/en/blog/2021-03-31-april-update.md @@ -67,11 +67,7 @@ Hot on the heels of this was `0.11.0` and v0.1.1 of the Terraform module. - SOPS in the `kustomize-controller` has been updated to v3.7.0, support for the newly added age encryption format is planned. :hourglass_flowing_sand: - All controllers do now record the suspend status of resources in a gotk_suspend_status Prometheus gauge metric. -<<<<<<< HEAD -πŸš€ Check out [the guide on how to automate image updates to Git](/docs/guides/image-update/). -======= πŸš€ Check out [the guide on how to automate image updates](/docs/workflows/image-update/) to Git. ->>>>>>> create workflows section Next up we will triage `image-*` issues and mark upcoming changes for v1alpha2. The proposal for v1alpha2 is under discussion at [https://github.com/fluxcd/flux2/discussions/1124](https://github.com/fluxcd/flux2/discussions/1124). diff --git a/content/en/blog/2021-04-29-may-update/index.md b/content/en/blog/2021-04-29-may-update/index.md index ab160f2fa..e34da7b3f 100644 --- a/content/en/blog/2021-04-29-may-update/index.md +++ b/content/en/blog/2021-04-29-may-update/index.md @@ -22,8 +22,8 @@ written by folks at Weaveworks. The Flux community has set itself very ambitious goals for version 2 and as it's a multi-month project, we strive to inform you each month about what has already landed, new possibilities which are available for -integration and where you can get involved. Read last month's update -[here](/blog/2021/03/april-2021-update/). +integration and where you can get involved. Read [last month's update +here](/blog/2021/03/april-2021-update). Let's recap what happened in April - there has been so much happening! diff --git a/content/en/blog/2021-07-02-july-update/index.md b/content/en/blog/2021-07-02-july-update/index.md index ce491b83e..1c47df135 100644 --- a/content/en/blog/2021-07-02-july-update/index.md +++ b/content/en/blog/2021-07-02-july-update/index.md @@ -265,8 +265,7 @@ pieces of infrastructure and came from different repositories. They were hard to update and some of our users got confused about which docs they were looking at. If you have any feedback about this, let us know. -πŸ”‹ We also just added a [Flux Integrations -page](/integrations/). If your extension +πŸ”‹ We also just added a [Flux Ecosystem page](/ecosystem/). If your extension or integration is not listed yet, please add yourself. We will make this page shine more in the future - we are also happy to work on joint blog posts, etc. Just come and talk to us! diff --git a/content/en/blog/2021-08-02-august-update/index.md b/content/en/blog/2021-08-02-august-update/index.md index 19e02d6be..6b03d4d00 100644 --- a/content/en/blog/2021-08-02-august-update/index.md +++ b/content/en/blog/2021-08-02-august-update/index.md @@ -130,11 +130,7 @@ to Scott Rigby on Slack. In last month's update we discussed how Flux's APIs are now stable. To clarify what this means for the Flux project as a whole, we added the following section to [our migration -<<<<<<< HEAD -timetable](/docs/migration/timetable/): -======= timetable](/docs/installation/migration/timetable/): ->>>>>>> Move migration under installation - Flux 1: Superseded - All existing projects encouraged to migrate to Flux 2, and diff --git a/content/en/blog/2021-10-01-october-update.md b/content/en/blog/2021-10-01-october-update.md index 9148df79b..639c81a9f 100644 --- a/content/en/blog/2021-10-01-october-update.md +++ b/content/en/blog/2021-10-01-october-update.md @@ -265,7 +265,7 @@ growing. Many small improvements to make the content more readable and correct. Go team! Apart from that we were able to add more [adopters](/adopters) and -[integrations](/integrations). Please add yourself if you haven't already. +[integrations](/ecosystem). Please add yourself if you haven't already. What to watch out next for: Alison Dowdney is working on restructuring the documentation to make it even easier to find things. Reach out to her, if you diff --git a/content/en/blog/2022-01-31-january-update/index.md b/content/en/blog/2022-01-31-january-update/index.md index 22b649f62..b1895af93 100644 --- a/content/en/blog/2022-01-31-january-update/index.md +++ b/content/en/blog/2022-01-31-january-update/index.md @@ -355,7 +355,7 @@ internal Kubernetes platform with minimal staff needed to do hands-on administration." Deutsche Telekom uses Flux in its [Das Schiff](https://github.com/telekom/das-schiff) project, you can also find this listed as an -[Integration](/integrations/) on our +[Integration](/ecosystem/) on our website. [Flux Multi-Cluster Multi-Tenant by Example diff --git a/content/en/docs/installation/migration/timetable.md b/content/en/docs/installation/migration/timetable.md index daa7479e5..42939c0d3 100644 --- a/content/en/docs/installation/migration/timetable.md +++ b/content/en/docs/installation/migration/timetable.md @@ -16,7 +16,7 @@ Please refer to the [Roadmap]({{< relref "/roadmap.md" >}}) for additional detai | -- | -- | -- | -- | | Oct 6, 2020 | [Maintenance Mode](https://github.com/fluxcd/website/pull/25)
  • Flux 1 releases only include critical bug fixes (which don’t require changing Flux 1 architecture), and security patches (for OS packages, Go runtime, and kubectl). No new features
  • Existing projects encouraged to test migration to Flux 2 pre-releases in non-production
| Development Mode
  • Working to finish parity with Flux 1
  • New projects encouraged to test Flux 2 pre-releases in non-production
| All Alpha[^2] | Feb 18, 2021 | Partial Migration Mode
  • Existing projects encouraged to migrate to `v1beta1`/`v2beta1` if you only use those features (Flux 1 read-only mode, and Helm Operator)
  • Existing projects encouraged to test image automation Alpha in non-production
| Feature Parity | Image Automation Alpha. All others reached Feature Parity, Beta | -| June 30, 2021 | Superseded
  • All existing projects encouraged to [migrate to Flux 2](/docs/migration/flux-v1-migration/), and [report any bugs](https://github.com/fluxcd/flux2/issues/new/choose)
  • Flux 1 Helm Operator code freeze – no further updates except CVEs
| Needs further testing, may get breaking changes
  • CLI needs further user testing during this migration period
| All Beta, Production Ready[^3]
  • All Flux 1 features stable and supported in Flux 2
  • Promoting Alpha versions to Beta makes this Production Ready
| +| June 30, 2021 | Superseded
  • All existing projects encouraged to [migrate to Flux 2](/docs/installation/migration/flux-v1-migration/), and [report any bugs](https://github.com/fluxcd/flux2/issues/new/choose)
  • Flux 1 Helm Operator code freeze – no further updates except CVEs
| Needs further testing, may get breaking changes
  • CLI needs further user testing during this migration period
| All Beta, Production Ready[^3]
  • All Flux 1 features stable and supported in Flux 2
  • Promoting Alpha versions to Beta makes this Production Ready
| | TBD | Migration and security support only
  • Flux 1 releases only include security patches (no bug fixes)
  • Maintainers support users with migration to Flux 2 only, no longer with Flux 1 issues
  • Flux 1 archive date announced
| Public release (GA), Production Ready
  • CLI commits to backwards compatibility moving forward
  • CLI follows kubectl style backwards compatibility support: +1 -1 MINOR version for server components (e.g., APIs, Controllers, validation webhooks)
| All Beta, Production Ready | | TBD | Archived
  • Flux 1 obsolete, no further releases or maintainer support
  • Flux 1 repo archived
| Continued active development | Continued active development | diff --git a/content/en/docs/installation/platforms/aws-codecommit.md b/content/en/docs/installation/platforms/aws-codecommit.md index 7d47a5130..4bb81e88b 100644 --- a/content/en/docs/installation/platforms/aws-codecommit.md +++ b/content/en/docs/installation/platforms/aws-codecommit.md @@ -25,9 +25,9 @@ For more details on how to create an EKS cluster with `eksctl` please see [eksct ## Flux Installation for AWS CodeCommit -The following replicates the [Flux bootstrap procedure](../installation/_index.md#bootstrap) and represents +The following replicates the [Flux bootstrap procedure](/docs/installation/_index.md#bootstrap) and represents the best practice for structuring the repository. For more information on the structure of the repository -please see [Ways of structuring your repositories](../installation/repository-structure.md). +please see [Ways of structuring your repositories](/docs/installation/repository-structure.md). Ensure you can login to [console.aws.amazon.com](https://console.aws.amazon.com) for your proper organization, and create a new repository to hold your Flux install and other Kubernetes resources. @@ -45,7 +45,7 @@ Create a directory inside the repository: mkdir -p ./clusters/my-cluster/flux-system ``` -Download the [Flux CLI](../installation/_index.md#install-the-flux-cli) and generate the manifests with: +Download the [Flux CLI](/docs/installation/_index.md#install-the-flux-cli) and generate the manifests with: ```sh flux install \ diff --git a/content/en/roadmap.md b/content/en/roadmap.md index 63d79b302..b3ea3f08f 100644 --- a/content/en/roadmap.md +++ b/content/en/roadmap.md @@ -101,8 +101,8 @@ Goals State | Item ----- | ---- -:heavy_check_mark: | [Offer a migration guide for those that are using Flux in read-only mode to synchronize plain manifests](/docs/migration/flux-v1-migration/) -:heavy_check_mark: | [Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays](/docs/migration/flux-v1-migration/) +:heavy_check_mark: | [Offer a migration guide for those that are using Flux in read-only mode to synchronize plain manifests](/docs/installation/migration/flux-v1-migration/) +:heavy_check_mark: | [Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays](/docs/installation/migration/flux-v1-migration/) :heavy_check_mark: | [Offer a dedicated component for forwarding events to external messaging platforms](/docs/operations/notifications/) Non-Goals diff --git a/static/_redirects b/static/_redirects index 329bf5086..17d7b26a1 100644 --- a/static/_redirects +++ b/static/_redirects @@ -25,11 +25,14 @@ /docs/guides/image-update /docs/workflows/image-update 301! /docs/guides/cron-job-image-auth /docs/workflows/cron-job-image-auth 301! /docs/guides/sortable-image-tags /docs/workflows/sortable-image-tags 301! +/docs/guides /docs 301! /docs/use-cases/jenkins /docs/workflows/jenkins 301! /docs/use-cases/gh-actions-auto-pr /docs/workflows/gh-actions-auto-pr 301! /docs/use-cases/gh-actions-manifest-generation /docs/workflows/gh-actions-manifest-generation 301! /docs/use-cases/helm /docs/installation/helm 301! +/docs/use-cases /docs 301! /docs/flux-e2e /docs/concepts/flux-e2e 301! +/docs/migration /docs/installation/migration 301! /docs/migration/helm-operator-migration /docs/installation/migration/helm-operator-migration 301! /docs/migration/timetable /docs/installation/migration/timetable 301! /docs/migration/faq-migration /docs/installation/migration/faq-migration 301!