Getting Started

Required Tools

• helm
• helmfile
• kubectl
• minikube or k3d or other accessible Kubernetes cluster
• pre-commit (use with pre-commit install to set up hooks)
• kyverno CLI (for testing policies)
• copier (only when adding components)
• k9s (optional but recommended)

Overview

Civitas Core V2 is deployed via Helmfile.

Repository structure:

├── .ci/                  # CI/CD configurations and security policies
├── components/           # Components configurations
├── defaults/             # Default helm values, global settings, and default component environments
├── deployment/           # Deployments can be defined here (deployment-specific; not part of this repository)
│   ├── addons/           # Additional components not included in the core for the deployment
│   ├── environments/     # Environment-specific configuration for each environment
│   └── helmfile.yaml     # Entry Helmfile for the deployment
├── template-component/   # Copier template for new components
└── tests/                # Test cases for components and deployments