Skip to content

Latest commit

 

History

History
169 lines (130 loc) · 4.8 KB

README.md

File metadata and controls

169 lines (130 loc) · 4.8 KB
Raw

Delivery using Flux

Resources

For more detailed information about Flux installation see the flux documentation here

Guide

This guide is adapted from the Getting Started guide in the Flux documentation.

By the end of this guide you will have

  • Deployed Flux in Cluster
  • Configured Flux to deploy manifests from a Git Repository

Prerequisites

You will need

Bootstrapping flux

Export your GitHub personal access token and username:

$ export GITHUB_TOKEN=<your-token>
$ export GITHUB_USER=<your-username>

Run the bootstrap command:

$ flux bootstrap github \
  --owner=$GITHUB_USER \
  --repository=podtato-test \
  --personal \
  --private=false

The bootstrap command creates a repository if one doesn't exist, commits manifests for Flux Components to the default branch, and installs the flux components. Then it configures the target cluster to synchronize with the repository.

Clone the git repository

We are going to drive app deployments in a GitOps manner, using the Git repository as the desired state for our cluster. Instead of applying the manifests directly to the cluster, Flux will apply it for us instead.

Therefore, we need to clone the repository to our local machine:

$ git clone https://github.com/$GITHUB_USER/podtato-test
$ cd podtato-test

Adding Podtato repository to Flux

Create a GitRepository manifest helloservice pointing to podtato-head repository's main branch:

 flux create source git helloservice \
--url=https://github.com/cncf/podtato-head \
--branch=main \
--interval=30s \
--export > ./helloservice-source.yaml

The above command generates the following manifest:

---
apiVersion: source.toolkit.fluxcd.io/v1beta1
kind: GitRepository
metadata:
  name: helloservice
  namespace: flux-system
spec:
  interval: 30s
  ref:
    branch: main
  url: https://github.com/cncf/podtato-head

Commit and push the manifest to the podtato-test repository:

$ git add helloservice-source.yaml 
$ git commit -m "Add GitRepository Source for helloservice"
$ git push

Deploying helloservice

We will create a Flux Kustomization manifest for helloservice. This configures Flux to build and apply the manifest directory located in the podtato-head repository.

$ flux create kustomization helloservice \
--source=helloservice \
--path="./delivery/manifest" \
--prune=true \
--validation=client \
--interval=5m \
--export > ./helloservice-kustomization.yaml

The above command generates the following manifest:

---
apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
kind: Kustomization
metadata:
  name: helloservice
  namespace: flux-system
spec:
  interval: 5m0s
  path: ./delivery/manifest
  prune: true
  sourceRef:
    kind: GitRepository
    name: helloservice
  validation: client

Commit and push the Kustomization manifest to the repository:

$ git add helloservice-kustomization.yaml 
$ git commit -m "Add helloservice Kustomization"
$ git push

The structure of your repository should look like this

├── README.md
├── flux-system
│   ├── gotk-components.yaml
│   ├── gotk-sync.yaml
│   └── kustomization.yaml
├── helloservice-kustomization.yaml
└── helloservice-source.yaml

Watch Flux sync the application

In about 30s the synchronization should start:

$ watch flux get kustomizations
NAME            READY   MESSAGE                                                         REVISION                                        SUSPENDED 
flux-system     True    Applied revision: main/4c2a9d272176a36fec9acf9eab75447410fe5573 main/4c2a9d272176a36fec9acf9eab75447410fe5573   False    
helloservice    True    Applied revision: main/0e3e9cffa177185c57d01d9bc067950dce221c7c main/0e3e9cffa177185c57d01d9bc067950dce221c7c   False

When the synchronization finishes you can check that helloservice has been deployed on your cluster:

$ kubectl -n demospace get deployments,services 
NAME                           READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/helloservice   1/1     1            1           40m

NAME                   TYPE           CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE
service/helloservice   LoadBalancer   10.96.124.100   <pending>     9000:30579/TCP   40m