README.md

GitOps on Kubernetes

A sample K8s project template following GitOps mindset.

Table of Contents

• Prerequisites
• Tutorials
• Environments
• Secrets management

Prerequisites

The following tools are required to use this project:

• Git
• Kubernetes cluster
• Helm
• Sealed Secrets & Sealed Secrets Updater
• git-crypt
• yq

Please refer to each tool's installation instructions to setup your environment.

Tutorials

Please refer to tutorials section for detailed instructions on how to use this project.

Environments

This project template assumes you're using two different environments (two different K8s clusters) to deploy your services:

• Production cluster: public cluster for production workloads.
• Staging cluster: internal cluster for validating new features and fixes.

You can find the chart values & k8s manifests used to deploy the services on each environment under the environments/charts-values & environments/manifests directories, respectively.

Secrets management

This project uses Sealed Secrets & the Sealed Secrets Updater in combination with git-crypt to adopt a GitOps approach & ensuring everything is committed in the Git repository. You can find more information about this setup in the tutorials below:

• Using file inputs encrypted with git-crypt.
• Using Sealed Secrets Updater in your CI pipeline.

Note: you can find the Sealed Secrets Updater config files used for each environment the .sealed-secrets-updater directory.