Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makkes/flux-mc-control-plane
https://github.com/makkes/flux-mc-control-plane
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/makkes/flux-mc-control-plane
- Owner: makkes
- Created: 2021-06-01T14:26:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-27T09:31:25.000Z (over 2 years ago)
- Last Synced: 2024-10-11T00:31:04.151Z (2 months ago)
- Language: Go
- Size: 2.41 MB
- Stars: 31
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flux multi-cluster example repository
This repository demonstrates how Flux can be leveraged for centralized management of multiple clusters and multiple tenants per cluster. A management cluster is responsible for managing resource synchronization to workload clusters by means of applying Flux Kustomizations using each cluster's kubeconfig file.
## Terminology
### Roles
This implementation defines several roles that reflect different use cases and permissions:
* **Platform Administrator**: This is the most powerful role having access to the management cluster's repository. The platform admin creates workspaces and attaches clusters to be managed.
* **Workspace Administrator**: This role grants access to an individual workspace's repository, managing all applications deployed to clusters in that workspace.
* **Cluster Administrator**: This role grants access to a repository reconciled by a single cluster, allowing to deploy per-cluster applications.
### Workspace
A workspace is considered as the primary grouping of multiple clusters. One cluster can only be part of one workspace. All resources managed as part of a workspace (e.g. applications to be deployed) are synchronized across all clusters in that workspace, i.e. all clusters in a workspace will receive the same set of resources specific to that workspace.
### Tenant
The second layer of grouping is by tenants. Each cluster may host multiple tenants. Each tenant can only be part of one workspace.
### Management Cluster
This is the central cluster managing all attached workload clusters.
### Workload Cluster
This is a cluster attached to and managed by the management cluster.
## Quick Start
All of the following commands spin up kind clusters. Make sure you have the following commands installed:
* [kind](https://kind.sigs.k8s.io/)
* [flux](https://fluxcd.io/docs/get-started/#install-the-flux-cli)
First spin up the control plane cluster:
```sh
./create-management-cluster.sh
```
Then, create a workload cluster:
```sh
./create-and-attach-kind-cluster.sh -n attached -w dev
```
Now you have two clusters running, a management cluster and a workload cluster. Both are synchronized using (several branches of) this Git repository.
## Architecture
This is a diagram showing the various Flux resources created on the management cluster and on workload clusters.
###