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

Reorganise and improve the installation docs #1573

Merged
merged 7 commits into from
Aug 24, 2023
Merged
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/blog/2021-01-06-january-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Azure DevOps users will have to specify to use libgit2 in their
GitRepository resources.

Follow [the generic git server
guide](/flux/installation/#generic-git-server)
guide](/flux/installation/bootstrap/generic-git-server/)
for further instructions in how to use Flux with Azure DevOps.

Upcoming events
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ 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).
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
4 changes: 2 additions & 2 deletions content/en/blog/2021-04-29-may-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The Flux v2 CLI and the GitOps Toolkit controllers are now CII Best
Practices certified.

Checkout the [new bootstrap
procedure](/flux/installation/_index.md#generic-git-server).
procedure](/flux/installation/bootstrap/generic-git-server/).

0.13 comes with **breaking changes to image automation** and has the
following highlights:
Expand Down Expand Up @@ -95,7 +95,7 @@ Please follow the [upgrade procedure for image
automation](https://github.com/fluxcd/flux2/discussions/1333).

Checkout the [new bootstrap customisation
feature](/flux/installation/_index.md#customize-flux-manifests).
feature](/flux/installation/configuration/boostrap-customization/).

The [Image automation guide](/flux/guides/image-update/) has been updated
to the new APIs, and also includes a reference to a
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 @@ -37,7 +37,7 @@ The highlights are:
Docs:

- 📔 [GitRepository include
documentation](/flux/components/source/gitrepositories/#including-gitrepository)
documentation](/flux/components/source/gitrepositories/#include)
- 🎁 Checkout the new [guide on ways of structuring your
repositories](/flux/guides/repository-structure/)

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 @@ -165,7 +165,7 @@ scheduling information available on the [CNCF Flux Dev
Calendar](https://lists.cncf.io/g/cncf-flux-dev/calendar),
usually scheduled opposite the CNCF Flux Project Meeting. You can
[subscribe to the
calendar](/community/#subscribing-to-the-flux-dev-calendar)
calendar](/community/#subscribing-to-the-flux-calendar)
to receive notifications about upcoming events and schedule changes. The
Bug Scrub is an opportunity to meet with other Flux contributors in
another setting besides the Dev meeting, where we try to identify "Good
Expand Down
6 changes: 3 additions & 3 deletions content/en/blog/2021-08-30-september-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Some of the highlights in this release are:
Prometheus Operator and others.
- The Notification controller can now send alerts to Telegram, Lark
and Matrix in addition to [many
others](/flux/components/notification/provider/#specification).
others](/flux/components/notification/provider/#writing-a-provider-spec).
- Kustomize controller has been updated to on a par with the latest
Kustomize release v4.3.0.

Expand Down Expand Up @@ -167,7 +167,7 @@ accessible than ever before.
The Zoom link is broadcast via Slack a few minutes before the
meeting start time. For more event details, subscribe to the [CNCF Flux
Dev
calendar](/community/#subscribing-to-the-flux-dev-calendar).
calendar](/community/#subscribing-to-the-flux-calendar).
Attendees all are asked to RSVP in advance, which can be done by posting
on the Slack thread for Bug Scrub, and introducing yourself briefly in
case you are new to the Flux contributor team.
Expand Down Expand Up @@ -201,7 +201,7 @@ section - directly on the home page:

For this we re-use Flux's calendar that is provided by CNCF
infrastructure, so if you [subscribed to
it](/community/#subscribing-to-the-flux-dev-calendar)
it](/community/#subscribing-to-the-flux-calendar)
in the past, you will continue to receive all the information there.

**🤝 Thanks everyone!** In the last month, 15 people contributed to the
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 @@ -234,7 +234,7 @@ Here is an update from Kingdon and the rest of the Flux team:
> calendar](/#calendar), which has the Zoom
> link and is in UTC time, or get reminded in your own time zone by
> [subscribing to the flux-dev
> calendar](/community/#subscribing-to-the-flux-dev-calendar).
> calendar](/community/#subscribing-to-the-flux-calendar).
>
> Hope to see you there!

Expand Down
6 changes: 3 additions & 3 deletions content/en/blog/2021-11-30-december-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ And finally **0.24** comes with security updates for Alpine CVEs. We are
also happy to bring you

- New bootstrap command for [Bitbucket Server and Data
Center](/flux/installation/#bitbucket-server-and-data-center)
Center](/flux/installation/bootstrap/bitbucket/)
repositories (CLI).
- Add support for self-signed certificates when bootstrapping Flux
with on-prem GitHub, GitLab and BitBucket servers (CLI).
- Improved performance when building Helm charts and introduced limits
for Helm index and chart files. (source-controller).
- Add support for [Slack Apps
bot](/flux/components/notification/provider/#slack-app)
bot](/flux/components/notification/provider/#slack)
alerting provider (notification-controller).

Please note that this version comes with breaking changes to Helm users.
Expand All @@ -98,7 +98,7 @@ Big shout-out to Soulé Ba for adding Bitbucket support to Flux. This
will make lots of Flux users happy. Thank you very much!

To find out how to bootstrap Flux on Bitbucket Server, please review
[our documentation](/flux/installation/#bitbucket-server-and-data-center).
[our documentation](/flux/installation/bootstrap/bitbucket/).
We love feedback, so please reach out if you have any questions or are
missing anything. We are also working on support for BitBucket Cloud,
for which we might need some help testing, documentation or wherever
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2022-01-31-january-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ previously the controllers ignored the service account.
#### :lock: Security enhancements

- Platform admins have the option to [lock down Flux on multi-tenant
clusters](/flux/installation/#multi-tenancy-lockdown)
clusters](/flux/installation/configuration/multitenancy/)
and enforce tenant isolation at namespace level without having to
use a 3rd party admission controller.
- The Flux installation conforms to the Kubernetes [restricted pod
Expand Down Expand Up @@ -289,7 +289,7 @@ are less random and we can attract more interest. Look to the schedule
for information about how to join at
[https://fluxcd.io/\#calendar](/#calendar)
or [add the Flux events to your own
calendar](/community/#subscribing-to-the-flux-dev-calendar)
calendar](/community/#subscribing-to-the-flux-calendar)
if you want to participate, and be sure you don't miss out on the new
Flux Bug Scrub, Special Edition!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ resources:

You don't get to re-architect a successful project very often, but we
did about two years ago. The Flux project was already off to a great
start and had [many happy adopters](/adopters/#flux-v1) and many of
start and had [many happy adopters](/adopters/#flux-legacy) and many of
its design principles we kept at the forefront of our mind:

- Pull vs Push: if you haven't read this [great blog
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2022-02-22-security-fuzzing.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ fuzzing for open source software](https://github.com/google/oss-fuzz).
## How we got here

When we [announced the results of the security
audit](/blog/2021-11-10-flux-security-audit/#flux-coming-to-oss-fuzz)
audit](/blog/2021/11/flux-security-audit/#flux-coming-to-oss-fuzz)
back in November, we already shared that the team at [ADA
Logics](https://adalogics.com/) had helped put together an initial
implementation of Fuzzing for some of the Flux controllers. In this
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2022-03-01-february-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ and improvements
using the Alert API `spec.eventSources[].matchLabels` field.
- Add support to `kustomize-controller` for making the Kubernetes
`Secrets` and `ConfigMaps` referenced in `postBuild.substituteFrom`
[optional](/flux/components/kustomize/kustomization/#variable-substitution).
[optional](/flux/components/kustomize/kustomization/#post-build-variable-substitution).
- Allow dot-prefixed paths to be used for bootstrap e.g. `flux
bootstrap --path=".flux/clusters/my-cluster"`.
- All Flux controllers and libraries are now tested by Google's
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](/flux/use-cases/openshift/#flux-installation-with-cli).
described in [these instructions](/flux/use-cases/openshift/).
{{% /note %}}

## `seccomp` and `RuntimeDefault`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ shortcomings. Things which "just work" in the Git CLI, any of the
implementations get subtly wrong, as they work on the ["plumbing"
level](https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain)
of Git. In the end we chose to make `gitImplementation` a [configurable
setting](/flux/components/source/gitrepositories/#git-implementation).
setting](/flux/components/source/api/v1beta2/#source.toolkit.fluxcd.io/v1beta2.GitRepository).

Just to illustrate what happens when you try to do things just right,
here's a couple of pieces of work we needed to get done along
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ multi-tenancy:
> example](https://github.com/fluxcd/flux2-multi-tenancy)
> to help users kick start their multi-tenancy deployments. And also how
> to implement control plane isolation with the*
> *[multi-tenancy-lockdown](/flux/cheatsheets/bootstrap/#multi-tenancy-lockdown).*
> *[multi-tenancy-lockdown](/flux/installation/configuration/multitenancy/).*
>
> ***What\'s next***
>
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2022-08-02-july-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ couple of small things we landed recently:
this document shows how to do just that.
- We expanded our documentation on Azure to include [Using Helm OCI
with Azure Container
Registry](/flux/use-cases/azure/#using-helm-oci-with-azure-container-registry).
Registry](/flux/components/source/helmrepositories/#provider).
- Flagger news! We updated the docs on our website to match the newest
version of Flagger (1.22). This adds a tutorial for how to do
[Canary analysis with KEDA
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The Flux CLI generates a single layer OCI image for storing things. As you can u

Today, we’ll leverage the OCI Repositories feature to apply Kyverno policies stored in an OCI registry into the Kubernetes cluster.

First, we need to install Flux CLI, please see the [installation](/docs/installation/) page for more details.
First, we need to install Flux CLI, please see the [installation](/flux/installation/) page for more details.

Next, we should have a Kubernetes cluster running. We’ll be using [KinD](https://kind.sigs.k8s.io/docs/user/quick-start#configuring-your-kind-cluster) for this purpose.

Expand Down Expand Up @@ -156,11 +156,11 @@ spec:
kind: ClusterPolicy
```

I'd like to highlight some key points about the resources above. Here in `OCIRepository` resource, we are using [SemVer](/docs/components/source/ocirepositories/#semver-example) to select the policies that we want to apply. `.spec.ref` is an optional field to specify the OCI reference to resolve and watch for changes. If not specified, the latest version of the repository will be used. You can reach out to the complete list of references supported in Flux, here is the [link](/docs/components/source/ocirepositories/#reference) for you.
I'd like to highlight some key points about the resources above. Here in `OCIRepository` resource, we are using [SemVer](/flux/components/source/ocirepositories/#semver-example) to select the policies that we want to apply. `.spec.ref` is an optional field to specify the OCI reference to resolve and watch for changes. If not specified, the latest version of the repository will be used. You can reach out to the complete list of references supported in Flux, here is the [link](/flux/components/source/ocirepositories/#reference) for you.

Also, in the `Kustomization` resource, we are using `.spec.patches` to apply patches to the policies that we want to enforce. We are using `op: replace` to replace the existing value of the field with the new one. `path` is the path to the field that we want to replace. `value` is the value of the field that we want to replace. To get more detail about the `Patches`, please see the [link](/docs/components/kustomize/kustomization/#patches).
Also, in the `Kustomization` resource, we are using `.spec.patches` to apply patches to the policies that we want to enforce. We are using `op: replace` to replace the existing value of the field with the new one. `path` is the path to the field that we want to replace. `value` is the value of the field that we want to replace. To get more detail about the `Patches`, please see the [link](/flux/components/kustomize/kustomization/#patches).

Last but not least, we are specifying an explicit dependencies for the `Kustomization` resource by using `dependsOn` keyword that ensures the Kyverno deployment is ready before applying the policies. This is important because Kyverno needs to be installed before applying the policies. Otherwise, the policies won't be used because CRD (Custom Resource Definitions) won't exist until Kyverno works. You can learn more about the dependencies of `Kustomization` resource, [here](/flux/components/kustomize/kustomization/#kustomization-dependencies).
Last but not least, we are specifying an explicit dependencies for the `Kustomization` resource by using `dependsOn` keyword that ensures the Kyverno deployment is ready before applying the policies. This is important because Kyverno needs to be installed before applying the policies. Otherwise, the policies won't be used because CRD (Custom Resource Definitions) won't exist until Kyverno works. You can learn more about the dependencies of `Kustomization` resource, [here](/flux/components/kustomize/kustomization/#dependencies).

Now, we can apply these manifests by committing and pushing them to the repository and letting Flux take care of the rest but still, one little step left that we need to do, which is authentication.

Expand Down
20 changes: 10 additions & 10 deletions content/en/blog/2022-09-05-august-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Let's go through the major changes one by one.
- Enable contextual login to container registries when pulling Helm
charts from Amazon Elastic Container Registry, Azure Container
Registry and Google Artifact Registry using
[`HelmRepository.spec.provider`](/docs/components/source/helmrepositories/#provider).
[`HelmRepository.spec.provider`](/flux/components/source/helmrepositories/#provider).
- Select which layer contains the Kubernetes configs by specifying a
matching OCI media type using
[`OCIRepository.spec.layerSelector`](/flux/components/source/ocirepositories/#layer-selector).
Expand All @@ -51,7 +51,7 @@ Let's go through the major changes one by one.
The big news was of course that we added support for distributing
Kubernetes manifests, Kustomize overlays and Terraform code as OCI
artifacts. For more information on OCI support please see the [Flux
documentation](/docs/cheatsheets/oci-artifacts/).
documentation](/flux/cheatsheets/oci-artifacts/).

Big thanks to the Flux contributors that helped us along the way. It
took us almost 4 months, from the first RFC version to shipping OCI
Expand Down Expand Up @@ -244,20 +244,20 @@ We are constantly improving our documentation and website - here are a
couple of small things we landed recently:

- New security docs on [Secrets
Management](/docs/security/secrets-management/)
Management](/flux/security/secrets-management/)
and [Contextual
Authorization](/docs/security/contextual-authorization/).
Authorization](/flux/security/contextual-authorization/).
- New blog post: [Managing Kyverno Policies as OCI Artifacts with
OCIRepository
Sources](/blog/2022/08/manage-kyverno-policies-as-ocirepositories)
- Cheatsheet news
- [OCI
Artifacts](/docs/cheatsheets/oci-artifacts/)
Artifacts](/flux/cheatsheets/oci-artifacts/)
- Bootstrap: [Git repository access via SOCKS5 ssh
proxy](/docs/cheatsheets/bootstrap/#git-repository-access-via-socks5-ssh-proxy)
proxy](/flux/installation/configuration/proxy-setting/#git-repository-access-via-socks5-ssh-proxy)
- Bootstrap: [Enable notifications for third party
controllers](/docs/cheatsheets/bootstrap/#enable-notifications-for-third-party-controllers)
- [Flux's Work Well With section](/docs/#flux-works-well-with): find out
controllers](https://weaveworks.github.io/tf-controller/how_to/flux_receiver_and_alert/#enable-notifications-for-third-party-controllers)
- [Flux's Work Well With section](/flux/#flux-works-well-with): find out
how to make Flux work with your favourite other OSS software
- Lots of new videos from GitOpsCon / KubeCon on [our resources
page](/resources/)
Expand Down Expand Up @@ -341,7 +341,7 @@ some Flux facts - they are sort of our mission statement with Flux.
assessments, alerting to external systems and external events
handling. Just "git push", and get notified on Slack and [other
chat
systems](https://github.com/fluxcd/notification-controller/blob/main/docs/spec/v1beta1/provider.md).
systems](https://github.com/fluxcd/notification-controller/blob/main/docs/spec/v1beta1/providers.md).
1. 👍 Users trust Flux: Flux is a CNCF Incubating project
and was categorised as \"Adopt\" on the [CNCF CI/CD Tech
Radar](https://radar.cncf.io/2020-06-continuous-delivery)
Expand All @@ -364,7 +364,7 @@ good ways to do that:
- Join the [planning
discussions](https://github.com/fluxcd/flux2/discussions)
- And if you are completely new to Flux, take a look at our [Get
Started guide](/docs/get-started/)
Started guide](/flux/get-started/)
and give us feedback
- Social media: Follow [Flux on
Twitter](https://twitter.com/fluxcd), join the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ resources:
---

Welcome to the second [blog post in our Flux Ecosystem category](/tags/ecosystem/)!
This time we are talking about one of the [Flux UIs](/ecosystem/#flux-uis): it's
This time we are talking about one of the [Flux UIs](/ecosystem/#flux-uis--guis): it's
the [VS Code GitOps Extension](https://github.com/weaveworks/vscode-gitops-tools).

If you already use VS Code, this extension will be straight up your alley: it
Expand All @@ -32,7 +32,7 @@ the Install button away.
Additionally, you will need to

- [Install Kubectl](https://kubectl.docs.kubernetes.io/installation/kubectl/)
- [Install Flux CLI](/docs/installation/#install-the-flux-cli)
- [Install Flux CLI](/flux/installation/#install-the-flux-cli)
- [Install git](https://git-scm.com/downloads)

Optionally, if available, the extension will make use of the `az` tool
Expand Down
Loading