actions/fluxcd-flux2
3
0
Fork 0
mirror of https://github.com/fluxcd/flux2.git synced 2026-02-08 00:37:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #51 from fluxcd/docs-guide

Browse source 
Add get started guide
This commit is contained in:
Stefan Prodan 2020-06-22 17:19:05 +03:00 committed by GitHub
commit b8bddf6a39
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 186 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

222
docs/get-started/index.md
View file

@ -2,17 +2,20 @@
## Prerequisites
* Kubernetes >= 1.14
* kubectl >= 1.18
* git
You will need to have Kubernetes set up.
For a quick local test, you can use `minikube`, `kubeadm` or `kind`.
You will need two Kubernetes clusters version 1.14 or newer and kubectl version 1.18.
For a quick local test, you can use [Kubernetes kind](https://kind.sigs.k8s.io/docs/user/quick-start/).
Any other Kubernetes setup will work as well though.
In order to follow the guide you'll need a GitHub account and a
[personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
that can create repositories.
that can create repositories (check all permissions under `repo`).
Export your GitHub personal access token and username:
```sh
export GITHUB_TOKEN=<your-token>
export GITHUB_USER=<your-username>
```
## Install the toolkit CLI
@ -33,40 +36,51 @@ To configure your shell to load tk completions add to your bash profile:
. <(tk completion)
```
Verify that your cluster satisfies the prerequisites with:
## GitOps workflow
You'll be using a dedicated Git repository e.g. `fleet-infra` to manage one or more Kubernetes clusters.
This guide assumes that you have two clusters, one for staging and one for production.
Using the toolkit CLI you'll do the following:
- configure each cluster to synchronise with a directory inside the fleet repository
- register app sources (git repositories) that contain plain Kubernetes manifests or Kustomize overlays
- configure app deployments on both clusters (pre-releases on staging, semver releases on production)
## Staging bootstrap
Create the staging cluster using Kubernetes kind or set the kubectl context to an existing cluster:
```sh
kind create cluster --name staging
kubectl cluster-info --context kind-staging
```
Verify that your staging cluster satisfies the prerequisites with:
```text
$ tk check --pre
► checking prerequisites
✔ kubectl 1.18.3 >=1.18.0
✔ kubernetes 1.16.8-eks-e16311 >=1.14.0
✔ kubernetes 1.18.2 >=1.14.0
✔ prerequisites checks passed
```
## Bootstrap
You'll be using a dedicated Git repository e.g. `fleet-infra` to manage one or more Kubernetes clusters.
First export your GitHub personal access token and GitHub username:
```sh
export GITHUB_TOKEN=<your-token>
export GITHUB_USER=<your-username>
```
The bootstrap command creates a repository if one doesn't exist and
commits the toolkit components manifests to the master branch at the specified path.
Then it configures the target cluster to synchronize with the specified path inside the repository.
Run the bootstrap command:
```sh
tk bootstrap github \
--owner=$GITHUB_USER \
--repository=fleet-infra \
--path=dev-cluster \
--path=staging-cluster \
--personal
```
The bootstrap command creates a repository if one doesn't exist and
commits the toolkit components manifests to the master branch at the specified path.
Then it configures the target cluster to synchronize with the specified path inside the repository.
If you wish to create the repository under a GitHub organization:
```sh
@ -75,13 +89,13 @@ tk bootstrap github \
--repository=<repo-name> \
--team=<team1-slug> \
--team=<team2-slug> \
--path=dev-cluster
--path=staging-cluster
```
Example output:
```text
$ tk bootstrap github --owner=gitopsrun --repository=fleet-infra --path=dev-cluster --team=devs
$ tk bootstrap github --owner=gitopsrun --repository=fleet-infra --path=staging-cluster --team=devs
► connecting to github.com
✔ repository created
@ -118,11 +132,14 @@ deployment "kustomize-controller" successfully rolled out
If you prefer GitLab, export `GITLAB_TOKEN` env var and use the command [tk bootstrap gitlab](../cmd/tk_bootstrap_gitlab.md).
It is safe to run the bootstrap command as many times as you want.
If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
!!! hint "Idempotency"
It is safe to run the bootstrap command as many times as you want.
If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
You can target a specific toolkit [version](https://github.com/fluxcd/toolkit/releases)
with `tk bootstrap --version=<semver>`.
## Create a GitOps workflow
## Staging workflow
Clone the repository with:
@ -131,14 +148,14 @@ git clone https://github.com/$GITHUB_USER/fleet-infra
cd fleet-infra
```
Create a git source pointing to a public repository:
Create a git source pointing to a public repository master branch:
```sh
tk create source git webapp \
--url=https://github.com/stefanprodan/podinfo \
--branch=master \
--interval=30s \
--export > ./dev-cluster/webapp-source.yaml
--export > ./staging-cluster/webapp-source.yaml
```
Create a kustomization for synchronizing the common manifests on the cluster:
@ -150,7 +167,7 @@ tk create kustomization webapp-common \
--prune=true \
--validate=client \
--interval=1h \
--export > ./dev-cluster/webapp-common.yaml
--export > ./staging-cluster/webapp-common.yaml
```
Create a kustomization for the backend service that depends on common:
@ -165,7 +182,7 @@ tk create kustomization webapp-backend \
--interval=10m \
--health-check="Deployment/backend.webapp" \
--health-check-timeout=2m \
--export > ./dev-cluster/webapp-backend.yaml
--export > ./staging-cluster/webapp-backend.yaml
```
Create a kustomization for the frontend service that depends on backend:
@ -180,13 +197,13 @@ tk create kustomization webapp-frontend \
--interval=10m \
--health-check="Deployment/frontend.webapp" \
--health-check-timeout=2m \
--export > ./dev-cluster/webapp-frontend.yaml
--export > ./staging-cluster/webapp-frontend.yaml
```
Push changes to origin:
```sh
git add -A && git commit -m "add webapp" && git push
git add -A && git commit -m "add staging webapp" && git push
```
In about 30s the synchronization should start:
@ -214,3 +231,136 @@ service/backend ClusterIP 10.52.10.22 <none> 9898/TCP,9999/TCP 4
service/frontend ClusterIP 10.52.9.85 <none> 80/TCP 3m31s
```
!!! tip
From this moment forward, any changes made to the webapp
Kubernetes manifests in the master branch will be synchronised with the staging cluster.
If a Kubernetes manifest is removed from the webapp repository, the reconciler will remove it from your cluster.
If you delete a kustomization from the `fleet-infra` repo, the reconciler will remove all Kubernetes objects that
were previously applied from that kustomization.
If you alter the webapp deployment using `kubectl edit`, the changes will be reverted to match
the state described in git. When dealing with an incident, you can pause the recitation of a
kustomization with `tk suspend kustomization <name>`. Once the debugging session
is over, you can re-enable the reconciliation with `tk resume kustomization <name>`.
## Production bootstrap
On production clusters, you may wish to deploy stable releases of an application.
When creating a git source instead of a branch, you can specify a git tag or a semver expression.
Create the production cluster using Kubernetes kind or set the kubectl context to an existing cluster:
```sh
kind create cluster --name production
kubectl cluster-info --context kind-production
```
Run the bootstrap for the production environment:
```sh
tk bootstrap github \
--owner=$GITHUB_USER \
--repository=fleet-infra \
--path=prod-cluster \
--personal
```
Pull the changes locally:
```sh
git pull
```
## Production workflow
Create a git source using a semver range to target stable releases:
```sh
tk create source git webapp \
--url=https://github.com/stefanprodan/podinfo \
--tag-semver=">=4.0.0 <4.0.2" \
--interval=30s \
--export > ./prod-cluster/webapp-source.yaml
```
Create a kustomization for webapp pointing to the production overlay:
```sh
tk create kustomization webapp \
--source=webapp \
--path="./deploy/overlays/production" \
--prune=true \
--validate=client \
--interval=10m \
--health-check="Deployment/frontend.production" \
--health-check="Deployment/backend.production" \
--health-check-timeout=2m \
--export > ./prod-cluster/webapp-production.yaml
```
Push changes to origin:
```sh
git add -A && git commit -m "add prod webapp" && git push
```
List git sources:
```text
$ tk get sources git
✔ gitops-system last fetched revision master/99072ee132abdead8b7799d7891eae2f524eb73d
✔ webapp last fetched revision 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27
```
The kubectl equivalent is `kubectl -n gitops-system get gitrepositories`.
List kustomization:
```text
$ tk get kustomizations
✔ gitops-system last applied revision master/99072ee132abdead8b7799d7891eae2f524eb73d
✔ webapp last applied revision 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27
```
The kubectl equivalent is `kubectl -n gitops-system get kustomizations`.
If you want to upgrade to the latest 4.x version, you can change the semver expression to:
```sh
tk create source git webapp \
--url=https://github.com/stefanprodan/podinfo \
--tag-semver=">=4.0.0 <5.0.0" \
--interval=30s \
--export > ./prod-cluster/webapp-source.yaml
git add -A && git commit -m "update prod webapp" && git push
```
Trigger a git sync:
```text
$ tk sync ks gitops-system --with-source
► annotating source gitops-system
✔ source annotated
◎ waiting for git sync
✔ git sync completed
✔ fetched revision master/d751ea264d48bf0db8b588d1d08184834ac8fec9
◎ waiting for kustomization sync
✔ kustomization sync completed
✔ applied revision master/d751ea264d48bf0db8b588d1d08184834ac8fec9
```
The kubectl equivalent is `kubectl -n gitops-system annotate gitrepository/gitops-system source.fluxcd.io/syncAt="$(date +%s)"`.
Wait for the webapp to be upgraded:
```text
$ watch tk get kustomizations
✔ gitops-system last applied revision master/d751ea264d48bf0db8b588d1d08184834ac8fec9
✔ webapp last applied revision 4.0.5/f43f9b2eb6766e07f318d266a99d2ec7c940b0cf
```