Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorg docs IA #845

Closed
wants to merge 10 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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/2020-12-01-december-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2021-01-06-january-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
9 changes: 4 additions & 5 deletions content/en/blog/2021-03-01-march-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
>
Expand All @@ -119,9 +119,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/).

Expand Down Expand Up @@ -169,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/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2021-03-31-april-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +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.

🚀 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.

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).
Expand Down
8 changes: 4 additions & 4 deletions content/en/blog/2021-04-29-may-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down Expand Up @@ -97,9 +97,9 @@ 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/),
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.
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2021-05-31-june-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ 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
an older version of Flux, check out our [migration
documentation](/docs/migration/).
documentation](/docs/installation/migration/).

## Flagger 1.11 is here

Expand Down
3 changes: 1 addition & 2 deletions content/en/blog/2021-07-02-july-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion 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,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
timetable](/docs/migration/timetable/):
timetable](/docs/installation/migration/timetable/):

- Flux 1: Superseded
- All existing projects encouraged to migrate to Flux 2, and
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2021-08-30-september-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2021-10-01-october-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2021-10-29-november-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
10 changes: 5 additions & 5 deletions content/en/blog/2022-01-31-january-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -416,11 +416,11 @@ 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/)
(ACR/ECR/GCR)](/docs/workflows/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
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2022-03-01-february-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,9 +278,9 @@ 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/)
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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Original file line number Diff line number Diff line change
Expand Up @@ -574,25 +574,25 @@ 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/
[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
[HelmRelease API]: /docs/components/helm/api/
[HelmRelease Guide]: /docs/guides/helmreleases/
[Helm Use Case]: /docs/use-cases/helm/
[HelmRelease Guide]: /docs/workflows/helmreleases/
[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
[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
10 changes: 5 additions & 5 deletions content/en/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/gitops-toolkit/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 0 additions & 6 deletions content/en/docs/guides/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -108,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)
Expand Down
Loading