Codebase

Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.

Getting Started Commands

make: Generate the binary of the application

flux bootstrap: Bootstrap a new cluster with Flux

flux get kustomizations --watch: Monitor the status of Flux kustomizations

flux get sources git: Get the list of Git repositories configured in Flux

flux get sources helm: Get the list of Helm repositories configured in Flux

flux create tenant: Create a new tenant with the specified name and namespace

flux create source git: Create a new Git source in Flux

flux create kustomization: Create a new Kustomization in Flux

flux create helmrelease: Create a new Helm release in Flux

make test: Run the unit tests for the application

make e2e: Run the end-to-end tests for the application

flux create tenant: Create a new tenant with the specified name and namespace

flux create source git: Create a new Git source in Flux

flux create kustomization: Create a new Kustomization in Flux

flux create helmrelease: Create a new Helm release in Flux

make encrypt-secret: Encrypt a Kubernetes secret using SOPS

make decrypt-secret: Decrypt a Kubernetes secret using SOPS

make install-sops: Install SOPS and configure it for use with Flux

make install-gnupg: Install gnupg for use with SOPS

make install-kubernetes: Install kubectl for use with Flux

make install-flux: Install Flux on a cluster

make uninstall-flux: Uninstall Flux from a cluster

make delete-tenant: Delete a tenant and its associated resources from a cluster

make delete-source: Delete a Git source from Flux

make delete-kustomization: Delete a Kustomization from Flux

make delete-helmrelease: Delete a Helm release from Flux

make update-kustomization: Update a Kustomization in Flux

make update-helmrelease: Update a Helm release in Flux

make rollback-helmrelease: Rollback a Helm release to a previous revision in Flux

make rollback-kustomization: Rollback a Kustomization to a previous revision in Flux

make sync-cluster: Sync the latest changes from Flux to the cluster

make sync-tenant: Sync the latest changes from a tenant’s repository to the cluster

make prune-cluster: Prune unused resources from the cluster

make prune-tenant: Prune unused resources from a tenant’s namespace

make status-cluster: Get the status of the cluster and its resources

make status-tenant: Get the status of a tenant and its resources

make logs-cluster: Get the logs from the cluster

make logs-tenant: Get the logs from a tenant’s namespace

make delete-cluster: Delete a cluster and its associated resources

make delete-tenant-namespace: Delete a tenant’s namespace and its associated resources

make help: Display available commands and their usage.

Project Structure

Below is a short description of the key directories of the project to aid you when understanding where key files are located.

.git/ - This directory contains the Git repository data. It includes various subdirectories and files that Git uses to manage the version control system.

.git/branches/ - This directory contains all the local branches of the Git repository.

.git/hooks/ - This directory contains scripts that Git executes before or after events such as commit, push, or receive.

.git/info/ - This directory contains files that provide information about the current Git repository, such as the current branch and the commit hash.

.git/logs/ - This directory contains the commit history of the Git repository.

.git/logs/refs/ - This directory contains references to the commits in the Git repository.

.git/objects/ - This directory contains the actual object data for the Git repository, such as commits, trees, and blobs.

.github/ - This directory contains files related to GitHub, including workflows and configuration files for continuous integration and deployment.

clusters/ - This directory contains configuration and scripts for managing Kubernetes clusters.

clusters/production/ - This directory contains configuration and scripts for managing the production Kubernetes cluster.

clusters/production/flux-system/ - This directory contains configuration and scripts for the FluxCD system in the production cluster.

clusters/staging/ - This directory contains configuration and scripts for managing the staging Kubernetes cluster.

clusters/staging/flux-system/ - This directory contains configuration and scripts for the FluxCD system in the staging cluster.

infrastructure/ - This directory contains infrastructure-related configuration files and scripts.

infrastructure/kyverno-policies/ - This directory contains the actual policy files for Kyverno.

infrastructure/kyverno/ - This directory contains configuration files and scripts for Kyverno, an open-source Kubernetes policy engine.

scripts/ - This directory contains scripts used for various tasks, such as automation and deployment.

tenants/ - This directory contains configuration and scripts for managing tenants, which are separate namespaces or projects within the Kubernetes cluster.

tenants/base/ - This directory contains configuration and scripts for the base tenant.

tenants/base/dev-team/ - This directory contains configuration and scripts for the development team within the base tenant.

tenants/production/ - This directory contains configuration and scripts for the production tenant.

tenants/staging/ - This directory contains configuration and scripts for the staging tenant.