Installation

Procedures to install, configure, and run CortexOps across various environments.

Prerequisites

Before installing CortexOps, ensure your environment meets the following requirements:

Docker & Docker Compose: Required for local development and testing.
Kubernetes Cluster: (v1.26+) For production deployments (e.g., Minikube, kind, GKE, EKS).
kubectl: Configured to communicate with your cluster.
Helm: (v3.0+) For deploying the CortexOps charts.
GNU Make: To run deployment commands via the provided Makefile.

Local Development (Docker Compose)

The fastest way to run CortexOps on your local machine is using Docker Compose. This spins up the stateful dependencies (Postgres, NATS, Temporal) locally.

1. Clone the Repository

git clone https://github.com/cortexops/cortexops.git
cd cortexops

2. Start Infrastructure

Initialize all backing services in detached mode.

make dev-up

3. Verify the Runtime

Ensure that NATS, Temporal, and PostgreSQL are healthy.

make verify-runtime

Kubernetes Installation (Helm)

Deploy CortexOps into an existing Kubernetes cluster for production workloads or staging environments.

1. Add the Helm Repository

helm repo add cortexops https://charts.cortexops.io
helm repo update

2. Create Namespace

kubectl create namespace cortexops

3. Deploy the Chart

Deploy the control plane using the default configuration values.

helm install cortexops cortexops/cortexops -n cortexops

GitOps & Managed Environments

ArgoCD / Flux

We highly recommend deploying CortexOps via GitOps controllers. You can find pre-configured Application manifests in the /deploy/gitops directory of the repository.

Cloud Providers (GKE / EKS)

For managed Kubernetes platforms, ensure that your node pools have sufficient capacity (minimum 4vCPU and 16GB RAM total) to host the stateful layer (Temporal + Postgres).