Flux Kustomize Template

This is an opinionated Kustomize template to use as a starting point for new projects.

Features

• Linting (via CI) using kubeconform, pluto and istioctl.
  • Automated with GitHub Actions
• Commits must meet Conventional Commits
  • Automated with GitHub Actions (commit-lint)
• Pull Request titles must meet Conventional Commits
  • Automated with GitHub Actions (pr-lint)
• Commits must be signed with Developer Certificate of Origin (DCO)
  • Automated with GitHub App (DCO)

Directory Structure

kustomize
├── _base                               # Base Kustomize resources (non-cluster specific)
├── us-west-2-platform-engineering-prd  # Kustomize overlays for specific cluster (prd)
└── us-west-2-platform-engineering-sbx  # Kustomize overlays for specific cluster (sbx)

Getting started

Before working with the repository it is mandatory to execute the following command:

make initialise

The above command will install the pre-commit package and setup pre-commit checks for this repository including conventional-pre-commit to make sure your commits match the conventional commit convention.

Contributing to the repository

To contribute, please read the contribution guidelines. You may also report an issue.

How does this repository work?

This repo is driven by Flux.

Continuous Integration

For more information on how CI for this repo works, please see here

Local CI

To run the CI checks locally, you can use the following command:

make local-check-duplicate-release-name
make local-kubeconform-checks
make local-pluto-checks
make local-istio-checks
make local-kustomization-yaml-fix