From 5b0fd326ee29a3eb56b0fb9dd4b844c529090a6f Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Fri, 27 Mar 2020 11:58:34 +0100 Subject: [PATCH 1/2] docs: make index look more like an actual page By removing the (duplicated) menu and copying some sections from the `README.md` in. --- docs/index.md | 61 ++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 32 deletions(-) diff --git a/docs/index.md b/docs/index.md index 856e2309c..c0a0a434a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,46 +1,43 @@ -# Welcome to the Flux documentation! +# Flux documentation ![](_files/flux-cd-diagram.png) -## Flux +Flux is a tool that automatically ensures that the state of a cluster matches +the config in git. It uses [an operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) +in the cluster to trigger deployments inside Kubernetes, which means you don't +need a separate CD tool. It monitors all relevant image repositories, detects +new images, triggers deployments and updates the desired running configuration +based on that (and a configurable policy). -- [Introducing Flux](introduction.md) -- [Requirements and limitations](requirements.md) -- [Get Started](get-started/index.md) -- [Frequently asked questions](faq.md) -- [Troubleshooting](troubleshooting.md) +The benefits are: you don't need to grant your CI access to the cluster, every +change is atomic and transactional, git has your audit log. Each transaction +either fails or succeeds cleanly. You're entirely code centric and don't need +new infrastructure. -### References +## Get started -- [Blueprint](references/blueprint.md) -- [Daemon (fluxd)](references/daemon.md) -- [fluxctl](references/fluxctl.md) -- [Manifest generation through `.flux.yaml` configuration files](references/fluxyaml-config-files.md) -- [Garbage collection](references/garbagecollection.md) -- [Git commit signing and verification](references/git-gpg.md) -- [Automated deployment of new container images](references/automated-image-update.md) -- [Integration with the Helm operator](references/helm-operator-integration.md) -- [Monitoring Flux](references/monitoring.md) +With the following tutorials: -### Guides +- [Get started with Flux](tutorials/get-started.md) +- [Get started with Flux using Helm](tutorials/get-started-helm.md) -- [Providing your own SSH key](guides/provide-own-ssh-key.md) -- [Using Git over HTTPS](guides/use-git-https.md) -- [Using a private Git host](guides/use-private-git-host.md) -- [Upgrading to Flux v1](guides/upgrading-to-1.0.md) +Making use of Helm charts in your cluster? Combine Flux with the [Helm +Operator](https://github.com/fluxcd/helm-operator) to declaratively manage chart +releases using `HelmRelease` custom resources. -### Tutorials +For progressive delivery patterns like Canary Releases, A/B Testing and Blue/Green, +Flux can be used together with [Flagger](https://github.com/weaveworks/flagger). -- [Get started](tutorials/get-started.md) -- [Get started using Helm](tutorials/get-started-helm.md) -- [How to bootstrap Flux using Kustomize](tutorials/get-started-kustomize.md) -- [Automations, locks and annotations](tutorials/driving-flux.md) +## Getting help -## Helm Operator +If you have any questions about Flux and continuous delivery: -- [Documentation](https://docs.fluxcd.io/projects/helm-operator/) +- Invite yourself to the CNCF community + slack and ask a question on the [#flux](https://cloud-native.slack.com/messages/flux/) + channel. +- To be part of the conversation about Flux's development, join the + [flux-dev mailing list](https://lists.cncf.io/g/cncf-flux-dev). +- [File an issue.](https://github.com/fluxcd/flux/issues/new/choose) -## Contributing +Your feedback is always welcome! -- [Get started developing](contributing/get-started-developing.md) -- [Building Flux](contributing/building.md) From cf0bcad6449fdffc1e1ec6c60380f5c95fa23a86 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Fri, 27 Mar 2020 12:05:12 +0100 Subject: [PATCH 2/2] docs: 'Helm operator' -> 'Helm Operator' --- docs/references/automated-image-update.md | 2 +- docs/references/helm-operator-integration.md | 4 ++-- docs/tutorials/get-started-helm.md | 2 +- internal/docs/releasing.md | 2 +- mkdocs.yml | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/references/automated-image-update.md b/docs/references/automated-image-update.md index 8ae315177..33cb299ee 100644 --- a/docs/references/automated-image-update.md +++ b/docs/references/automated-image-update.md @@ -15,7 +15,7 @@ Every image tag must be unique, for this you can use the Git commit SHA or semve ## Examples What follows is a list of examples on how you can control the image update automation. If you're using Helm releases -please see the [Helm operator integration docs](helm-operator-integration.md). +please see the [Helm Operator integration docs](helm-operator-integration.md). Turn on automation based on timestamp: diff --git a/docs/references/helm-operator-integration.md b/docs/references/helm-operator-integration.md index 5d76bb0a3..744986cac 100644 --- a/docs/references/helm-operator-integration.md +++ b/docs/references/helm-operator-integration.md @@ -1,7 +1,7 @@ -# Integration with the Helm operator +# Integration with the Helm Operator You can release charts to your cluster via "GitOps", by combining Flux -and the [Helm operator](https://github.com/fluxcd/helm-operator). +and the [Helm Operator](https://github.com/fluxcd/helm-operator). The essential mechanism is this: the declaration of a Helm release is represented by a custom resource, specifying the chart and its diff --git a/docs/tutorials/get-started-helm.md b/docs/tutorials/get-started-helm.md index 308a2569c..9fdc1f539 100644 --- a/docs/tutorials/get-started-helm.md +++ b/docs/tutorials/get-started-helm.md @@ -73,7 +73,7 @@ In this next step you install Flux using `helm`. Simply kubectl create namespace flux ``` - 1. Install Flux and the Helm operator by specifying your fork URL: + 1. Install Flux and the Helm Operator by specifying your fork URL: *Just make sure you replace `YOURUSER` with your GitHub username in the command below:* diff --git a/internal/docs/releasing.md b/internal/docs/releasing.md index 84f2df32a..e51982766 100644 --- a/internal/docs/releasing.md +++ b/internal/docs/releasing.md @@ -1,4 +1,4 @@ -# How to release Flux and the Helm operator +# How to release Flux The release process needs to do these things: diff --git a/mkdocs.yml b/mkdocs.yml index 7922279c1..e83bde4dd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -50,7 +50,7 @@ nav: - Garbage collection: references/garbagecollection.md - Git commit signing and verification: references/git-gpg.md - Automated deployment of new container images: references/automated-image-update.md - - Integration with the Helm operator: references/helm-operator-integration.md + - Integration with the Helm Operator: references/helm-operator-integration.md - Monitoring Flux: references/monitoring.md - Guides: - Providing your own SSH key: guides/provide-own-ssh-key.md