Skip to content

Commit

Permalink
Move migration under installation
Browse files Browse the repository at this point in the history
	Ref: #718

Not 100% happy with this yet, but let's see...

Signed-off-by: Daniel Holbach <daniel@weave.works>
  • Loading branch information
Daniel Holbach committed May 11, 2022
1 parent 65c5717 commit 1b2651a
Show file tree
Hide file tree
Showing 15 changed files with 56 additions and 60 deletions.
2 changes: 1 addition & 1 deletion content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ <h2 class="section-label">Other Flux projects</h2>
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 %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2021-05-31-june-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions content/en/blog/2021-08-02-august-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,18 +451,18 @@ condition, and can be updated through configuration in `/etc/dphys-swapfile`: [a
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
Expand Down
5 changes: 5 additions & 0 deletions content/en/docs/installation/migration/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Migration from v1"
description: "Migration guides for Flux Legacy (v1) and Helm Operator users."
weight: 60
---
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
6 changes: 0 additions & 6 deletions content/en/docs/migration/_index.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/en/docs/use-cases/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
14 changes: 4 additions & 10 deletions content/en/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -87,7 +87,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)
Expand Down Expand Up @@ -143,22 +143,16 @@ Tasks
- [x] <span style="color:grey">Design the automation component</span>
- [x] <span style="color:grey">Implement the image scan/patch/push workflow</span>
- [x] <span style="color:grey">Integrate the new components in the Flux CLI [fluxcd/flux2#538](https://github.com/fluxcd/flux2/pull/538)</span>
<<<<<<< HEAD
- [x] <span style="color:grey">Write a guide for how to use image automation ([guide here](/docs/guides/image-update/))</span>
- [x] <span style="color:grey">ACR/ECR/GCR integration ([guide here](/docs/guides/image-update/#imagerepository-cloud-providers-authentication))</span>
- [x] <span style="color:grey">Write a migration guide from Flux v1 annotations ([guide here](/docs/migration/flux-v1-automation-migration/))</span>
=======
- [x] <span style="color:grey">Write a guide for how to use image automation ([guide here](/docs/workflows/image-update/))</span>
- [x] <span style="color:grey">ACR/ECR/GCR integration ([guide here](/docs/workflows/image-update/#imagerepository-cloud-providers-authentication))</span>
- [x] <span style="color:grey">Write a migration guide from Flux v1 annotations ([guide here](/docs/installation/migration/flux-v1-automation-migration/))</span>
>>>>>>> 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

Expand All @@ -184,4 +178,4 @@ Tasks
- [x] <span style="color:grey">Implement support for Helm charts from Git</span>
- [x] <span style="color:grey">Implement support for referring to an alternative chart values file</span>
- [x] <span style="color:grey">Stabilize API</span>
- [x] <span style="color:grey">[Create a migration guide for Helm Operator users](docs/migration/helm-operator-migration.md)</span>
- [x] <span style="color:grey">[Create a migration guide for Helm Operator users](docs/installation/migration/helm-operator-migration.md)</span>
2 changes: 1 addition & 1 deletion layouts/partials/docs/legacy-warning.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ <h2>Upgrade Advisory</h2>
<p>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
<a href="/docs/migration/">start looking at your migration path</a>.</p>
<a href="/docs/installation/migration/">start looking at your migration path</a>.</p>
<p>For documentation regarding the latest Flux, please refer to
<a href="/docs/">this section</a>.</p>
</div>
61 changes: 30 additions & 31 deletions static/_redirects
Original file line number Diff line number Diff line change
@@ -1,34 +1,33 @@
/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!
/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!
/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!
Expand Down

0 comments on commit 1b2651a

Please sign in to comment.