This repository presents structure, ideas and best practices for managing clusters and apps using Flux available by default on Giant Swarm Management Clusters.
Warning: This repository is of a preview quality right now and still a work in progress. Please bear in mind that it might have some elements that are not strictly needed or left loose after we ported some ideas from other repositories.
A good starting point is the repository structure doc, which explains how this repository works.
To start creating and managing your infrastructure using this template, please fork a repo from it, then follow the docs below to learn how it works:
- add a new Management Cluster
- add a new Organization
- add a new Workload Cluster
- create a template for mass instantiation of clusters
- create a cluster instance using a template
- manage applications deployed to a cluster
To ensure your YAML and Markdown formatting is OK even before you push to the repository,
we have prepared pre-commit
config. To use it, make sure to:
- install
pre-commit
- when contributing to the repo for the first time, run
pre-commit install --install-hooks
Remember:
pre-commit
is optional and opt-in: you have to set it up yourself.- To check your code without doing git commit, you can run
pre-commit run -a
- To force a git commit without running
pre-commit
hook, rungit commit --no-verify ...