diff --git a/content/en/flux/flux-e2e.md b/content/en/flux/flux-e2e.md index fc82e3831..2013a0652 100644 --- a/content/en/flux/flux-e2e.md +++ b/content/en/flux/flux-e2e.md @@ -621,9 +621,9 @@ The health checking feature is called [Health Checks][] in the Flux Kustomizatio [Helm Use Case]: /flux/use-cases/helm/ [HelmRepository API]: /flux/components/source/helmrepositories/ [HelmChart API]: /flux/components/source/helmcharts/ -[HelmChartTemplate.spec.reconcileStrategy]: /flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate +[HelmChartTemplate.spec.reconcileStrategy]: /flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate [Setup Notifications]: /flux/guides/notifications/ [Alert API]: /flux/components/notification/alert/ [Event API]: /flux/components/notification/event/ [Setup Git Commit Status Notications]: /flux/guides/notifications/#git-commit-status -[Health Checks]: /flux/components/kustomize/kustomization/#health-checks +[Health Checks]: /flux/components/kustomize/kustomizations/#health-checks diff --git a/content/en/flux/get-started.md b/content/en/flux/get-started.md index 8dd05986a..24f72cac4 100644 --- a/content/en/flux/get-started.md +++ b/content/en/flux/get-started.md @@ -153,7 +153,7 @@ podinfo is a tiny web application made with Go. Configure Flux to build and apply the [kustomize](https://github.com/stefanprodan/podinfo/tree/master/kustomize) directory located in the podinfo repository. -1. Use the `flux create` command to create a [Kustomization](../components/kustomize/kustomization/) that applies the podinfo deployment. +1. Use the `flux create` command to create a [Kustomization](/flux/components/kustomize/kustomizations/) that applies the podinfo deployment. ```sh flux create kustomization podinfo \ @@ -262,7 +262,7 @@ To resume updates run the command `flux resume kustomization `. ## Customize podinfo deployment To customize a deployment from a repository you don't control, you can use Flux -[in-line patches](/flux/components/kustomize/kustomization/#patches). The following example shows how to use in-line patches to change the podinfo deployment. +[in-line patches](/flux/components/kustomize/kustomizations/#patches). The following example shows how to use in-line patches to change the podinfo deployment. 1. Add the following to the field `spec` of your `podinfo-kustomization.yaml` file: diff --git a/content/en/flux/guides/helmreleases.md b/content/en/flux/guides/helmreleases.md index da6c1f506..44a3d4083 100644 --- a/content/en/flux/guides/helmreleases.md +++ b/content/en/flux/guides/helmreleases.md @@ -382,7 +382,7 @@ spec: {{% alert color="info" title="Garbage Collection" %}} Stale `ConfigMaps`, previously generated by Kustomize, will be removed from the cluster by kustomize-controller if -[pruning](/flux/components/kustomize/kustomization/#prune) is enabled. +[pruning](/flux/components/kustomize/kustomizations/#prune) is enabled. {{% /alert %}} ## Refer to values in Secret generated with Kustomize and SOPS @@ -543,10 +543,10 @@ mongodb False failed to locate override values file: values-production.yaml ## Configure notifications The default toolkit installation configures the helm-controller to -broadcast events to the [notification-controller](../components/notification/_index.md). +broadcast events to the [notification-controller](/flux/components/notification). To receive the events as notifications, a `Provider` needs to be setup -first as described in the [notifications guide](notifications.md#define-a-provider). +first as described in the [notifications guide](/flux/monitoring/alerts/#define-a-provider). Once you have set up the `Provider`, create a new `Alert` resource in the `flux-system` to start receiving notifications about the Helm release: diff --git a/content/en/flux/guides/mozilla-sops.md b/content/en/flux/guides/mozilla-sops.md index 5c3398f2d..b2f611522 100644 --- a/content/en/flux/guides/mozilla-sops.md +++ b/content/en/flux/guides/mozilla-sops.md @@ -316,7 +316,7 @@ Note that when using `flux bootstrap` you can [set the annotation](/flux/install #### Azure -When using Azure Key Vault you need to authenticate kustomize-controller either with [aad-pod-identity](/flux/components/kustomize/kustomization/#aad-pod-identity) +When using Azure Key Vault you need to authenticate kustomize-controller either with [aad-pod-identity](/flux/components/kustomize/kustomizations/#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/flux/installation/configuration/multitenancy.md b/content/en/flux/installation/configuration/multitenancy.md index 8a4916f4a..d6cec5def 100644 --- a/content/en/flux/installation/configuration/multitenancy.md +++ b/content/en/flux/installation/configuration/multitenancy.md @@ -23,7 +23,7 @@ RBAC rules to Flux API objects. To give users control over the authorisation, the Flux controllers can _impersonate_ (assume the identity of) a service account mentioned in the apply specification (e.g., the field `.spec.serviceAccountName` in -a [`Kustomization` object](https://fluxcd.io/flux/components/kustomize/kustomization/#role-based-access-control) +a [`Kustomization` object](https://fluxcd.io/flux/components/kustomize/kustomizations/#role-based-access-control) or in a [`HelmRelease` object](https://fluxcd.io/flux/components/helm/helmreleases/#role-based-access-control)) for both accessing resources and applying configuration. This lets a user constrain the operations performed by the Flux controllers with RBAC. diff --git a/content/en/flux/migration/helm-operator-migration.md b/content/en/flux/migration/helm-operator-migration.md index 1eceb5cce..1748978e7 100644 --- a/content/en/flux/migration/helm-operator-migration.md +++ b/content/en/flux/migration/helm-operator-migration.md @@ -76,7 +76,7 @@ Getting similar behaviour is still possible [using a workaround that makes use o There was a long outstanding request for the Helm Operator to support merging single values at a given path. -With the Helm Controller this now possible by defining a [`targetPath` in the `ValuesReference`](/flux/components/helm/api.md#helm.toolkit.fluxcd.io/v2beta1.ValuesReference), which supports the same formatting as you would supply as an argument to the `helm` binary using `--set [path]=[value]`. In addition to this, the referred value can contain the same value formats (e.g. `{a,b,c}` for a list). You can read more about the available formats and limitations in the [Helm documentation](https://helm.sh/docs/intro/using_helm/#the-format-and-limitations-of---set). +With the Helm Controller this now possible by defining a [`targetPath` in the `ValuesReference`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.ValuesReference), which supports the same formatting as you would supply as an argument to the `helm` binary using `--set [path]=[value]`. In addition to this, the referred value can contain the same value formats (e.g. `{a,b,c}` for a list). You can read more about the available formats and limitations in the [Helm documentation](https://helm.sh/docs/intro/using_helm/#the-format-and-limitations-of---set). ### Support added for depends-on relationships @@ -220,7 +220,7 @@ spec: name: my-repository-creds ``` -In the `HelmRelease`, you then use a reference to the `HelmRepository` resource in the `spec.chart.spec` (for all available fields, consult the [Helm API reference](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate)): +In the `HelmRelease`, you then use a reference to the `HelmRepository` resource in the `spec.chart.spec` (for all available fields, consult the [Helm API reference](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate)): ```yaml --- @@ -288,7 +288,7 @@ spec: # The Git reference to checkout and monitor for changes # (defaults to master) # For all available options, see: - # https://fluxcd.io/flux/components/source/api/#source.toolkit.fluxcd.io/v1.GitRepositoryRef + # https://fluxcd.io/flux/components/source/api/v1#source.toolkit.fluxcd.io/v1.GitRepositoryRef ref: branch: master ``` @@ -322,7 +322,7 @@ spec: name: my-repository-creds ``` -In the `HelmRelease`, you then use a reference to the `GitRepository` resource in the `spec.chart.spec` (for all available fields, consult the [Helm API reference](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate)): +In the `HelmRelease`, you then use a reference to the `GitRepository` resource in the `spec.chart.spec` (for all available fields, consult the [Helm API reference](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.HelmChartTemplate)): ```yaml --- @@ -404,7 +404,7 @@ spec: optional: true ``` -In the new API spec the individual `configMapKeyRef` and `secretKeyRef` objects are bundled into a single [`ValuesReference`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.ValuesReference) which [does no longer allow refering to resources in other namespaces](#values-from-external-source-references-urls-are-no-longer-supported): +In the new API spec the individual `configMapKeyRef` and `secretKeyRef` objects are bundled into a single [`ValuesReference`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.ValuesReference) which [does no longer allow refering to resources in other namespaces](#values-from-external-source-references-urls-are-no-longer-supported): ```yaml --- @@ -588,7 +588,7 @@ spec: With the Helm Operator the release options used to be configured in the `spec` of the `HelmRelease` and applied to both Helm install and upgrade actions. -This has changed for the Helm Controller, where some defaults can be defined in the [`spec`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmReleaseSpec), but specific action configurations and overwrites for the defaults can be defined in the [`spec.install`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Install), [`spec.upgrade`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Upgrade) and [`spec.test`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Test) sections of the `HelmRelease`. +This has changed for the Helm Controller, where some defaults can be defined in the [`spec`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.HelmReleaseSpec), but specific action configurations and overwrites for the defaults can be defined in the [`spec.install`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Install), [`spec.upgrade`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Upgrade) and [`spec.test`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Test) sections of the `HelmRelease`. ### Defining a rollback / uninstall configuration @@ -613,11 +613,11 @@ spec: timeout: 300 ``` -The Helm Controller offers an extensive set of configuration options to remediate when a Helm release fails, using [`spec.install.remediation`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.InstallRemediation), [`spec.upgrade.remediation`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.UpgradeRemediation), [`spec.rollback`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Rollback) and [`spec.uninstall`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Uninstall). Some of the new features include the option to remediate with an uninstall after an upgrade failure, and the option to keep a failed release for debugging purposes when it has run out of retries. +The Helm Controller offers an extensive set of configuration options to remediate when a Helm release fails, using [`spec.install.remediation`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.InstallRemediation), [`spec.upgrade.remediation`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.UpgradeRemediation), [`spec.rollback`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Rollback) and [`spec.uninstall`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Uninstall). Some of the new features include the option to remediate with an uninstall after an upgrade failure, and the option to keep a failed release for debugging purposes when it has run out of retries. #### Automated uninstalls -The configuration below mimics the uninstall behavior of the Helm Operator (for all available fields, consult the [`InstallRemediation`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.InstallRemediation) and [`Uninstall`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Uninstall) API references): +The configuration below mimics the uninstall behavior of the Helm Operator (for all available fields, consult the [`InstallRemediation`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.InstallRemediation) and [`Uninstall`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Uninstall) API references): ```yaml apiVersion: helm.toolkit.fluxcd.io/v2beta1 @@ -643,7 +643,7 @@ spec: #### Automated rollbacks -The configuration below shows an automated rollback configuration that equals [the configuration for the Helm Operator showed above](#defining-a-rollback--uninstall-configuration) (for all available fields, consult the [`UpgradeRemediation`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.UpgradeRemediation) and [`Rollback`](/flux/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Rollback) API references): +The configuration below shows an automated rollback configuration that equals [the configuration for the Helm Operator showed above](#defining-a-rollback--uninstall-configuration) (for all available fields, consult the [`UpgradeRemediation`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.UpgradeRemediation) and [`Rollback`](/flux/components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Rollback) API references): ```yaml apiVersion: helm.toolkit.fluxcd.io/v2beta1 diff --git a/content/en/flux/monitoring/alerts.md b/content/en/flux/monitoring/alerts.md index baf7d7895..9c186bc4d 100644 --- a/content/en/flux/monitoring/alerts.md +++ b/content/en/flux/monitoring/alerts.md @@ -49,7 +49,7 @@ spec: {{% alert color="info" title="Providers" %}} Flux supports various providers such as Discord, PagerDuty, Teams, Telegram, Sentry and many others. -For a complete list please see the [Provider `.spec.type` documentation](/flux/components/notification/provider/#type). +For a complete list please see the [Provider `.spec.type` documentation](/flux/components/notification/providers/#type). {{% /alert %}} ## Define an alert @@ -139,7 +139,7 @@ event source, as it is the only resource which includes this data. First follow the [get started guide](/flux/get-started) if you do not have a Kubernetes cluster with Flux installed in it. You will need a authentication token to communicate with the API. The authentication method depends on -the git provider used, refer to the [Provider CRD](/flux/components/notification/provider/#git-commit-status-updates) +the git provider used, refer to the [Provider CRD](/flux/components/notification/providers/#git-commit-status-updates) for details about how to get the correct token. The guide will use GitHub, but the other providers will work in a very similar manner. The token will need to have write access to the repository it is going to update the commit status in. Store the generated token in a Secret with the following data format in the cluster. @@ -333,4 +333,4 @@ spec: ``` For more details on how to integrate Flux with Grafana API please see the -[Grafana provider documentation](/flux/components/notification/provider/#grafana). +[Grafana provider documentation](/flux/components/notification/providers/#grafana). diff --git a/content/en/flux/security/secrets-management.md b/content/en/flux/security/secrets-management.md index da7ac840f..411f3e343 100644 --- a/content/en/flux/security/secrets-management.md +++ b/content/en/flux/security/secrets-management.md @@ -92,7 +92,7 @@ could impact your solution. Flux supports the two main names in Encrypted Secrets and has specific how-to guides for them: - [Mozilla SOPS Guide](/flux/guides/mozilla-sops/) -- [Secrets decryption](/flux/components/kustomize/kustomization/#decryption) +- [Secrets decryption](/flux/components/kustomize/kustomizations/#decryption) #### Secrets Synchronized by Operators @@ -279,5 +279,5 @@ scenarios are considered. [Buckets]: /flux/components/source/buckets/ [OCI Repositories]: /flux/components/source/ocirepositories/ [stakater/Reloader]: https://github.com/stakater/Reloader -[kustomize-secretgenerator]: /flux/components/kustomize/kustomization/#kustomize-secretgenerator -[kustomization-secretgenerator]: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/#secretgenerator +[kustomize-secretgenerator]: /flux/components/kustomize/kustomizations/#kustomize-secretgenerator +[kustomization-secretgenerator]: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomizations/#secretgenerator diff --git a/content/en/flux/use-cases/gh-actions-helm-promotion.md b/content/en/flux/use-cases/gh-actions-helm-promotion.md index a6599b244..d890dadd3 100644 --- a/content/en/flux/use-cases/gh-actions-helm-promotion.md +++ b/content/en/flux/use-cases/gh-actions-helm-promotion.md @@ -220,4 +220,4 @@ to the repositories used with `flux bootstrap github`. - [Guides > Manage Helm Releases](/flux/guides/helmreleases.md) - [Toolkit Components > Helm Repository API](/flux/components/source/helmrepositories.md) - [Toolkit Components > Helm Release API](/flux/components/helm/helmreleases.md) -- [Toolkit Components > Notification API > GitHub Dispatch](/flux/components/notification/provider/#github-dispatch) +- [Toolkit Components > Notification API > GitHub Dispatch](/flux/components/notification/providers/#github-dispatch) diff --git a/content/en/flux/use-cases/helm.md b/content/en/flux/use-cases/helm.md index f407d0751..5f443e38d 100644 --- a/content/en/flux/use-cases/helm.md +++ b/content/en/flux/use-cases/helm.md @@ -156,7 +156,7 @@ to a chart. The Flux Kustomize Controller method allows you to accomplish this on any chart without additional templated annotations. You may also use Kustomize Controller -built-in [Mozilla SOPS integration](/flux/components/kustomize/kustomization/#decryption) +built-in [Mozilla SOPS integration](/flux/components/kustomize/kustomizations/#decryption) to securely manage your encrypted secrets stored in git. See the [Flux SOPS guide](/flux/guides/mozilla-sops/) for step-by-step instructions through various use cases. @@ -177,10 +177,10 @@ documentation. ## Automatic Uninstalls and Rollback The Helm Controller offers an extensive set of configuration options to remediate when a Helm release fails, -using [spec.install.remediation](../components/helm/api.md#helm.toolkit.fluxcd.io/v2beta1.InstallRemediation), -[spec.upgrade.remediation](../components/helm/api.md#helm.toolkit.fluxcd.io/v2beta1.UpgradeRemediation), -[spec.rollback](../components/helm/api.md#helm.toolkit.fluxcd.io/v2beta1.Rollback) -and [spec.uninstall](../components/helm/api.md#helm.toolkit.fluxcd.io/v2beta1.Uninstall). +using [spec.install.remediation](../components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.InstallRemediation), +[spec.upgrade.remediation](../components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.UpgradeRemediation), +[spec.rollback](../components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Rollback) +and [spec.uninstall](../components/helm/api/v2beta1#helm.toolkit.fluxcd.io/v2beta1.Uninstall). Features include the option to remediate with an uninstall after an upgrade failure, and the option to keep a failed release for debugging purposes when it has run out of retries.