Skip to main content
Version: 1.0

Quick Start: Local Cluster Setup Script

Once you have installed all the necessary tools, you can proceed with setting up your Kubernetes environment for the local platform deployment. This cluster is your local environment for running the CIVITAS platform.

If you want to use the provided certificate (to enable secure communication within your cluster using HTTPS), you can run the startup.sh script.

Windows Users: Since the startup.sh script is a Unix shell script, you must use a terminal that supports Unix-like commands, such as:

These terminals simulate a Linux-like environment on Windows, making it possible to run the necessary commands.

Clone the Civitas Repository​

First, clone the repository to your local machine. This repository contains all the necessary files.

git clone https://gitlab.com/civitas-connect/civitas-core/civitas-core.git
cd civitas-core

The necessary files for local Kubernetes deployment are located in the local_deployment folder within the repository.

You can explore the folder directly by navigating to this link.

Definition of the Custom Domain​

You must first define a custom domain for your local environment. Set the DOMAIN environment variable as follows:

export DOMAIN=civitas.test

Run the startup.sh Script​

Run the script based on the cluster you're using:

  • For help:

    ./startup.sh -h

  • For installation with existing cluster:

    ./startup.sh

  • For Minikube:

    ./startup.sh -m

After Running startup.sh:​

The startup.sh script automates the setup of key components for platform deployment:

  1. Ingress-nginx: Manages external access to your services.
  2. MetalLB: Assigns external IPs to services.
  3. Cert-Manager: Manages SSL/TLS certificates.

After the setup completes, access the platform at http://civitas.test after running

minikube tunnel

Next, proceed with deploying the Civitas/CORE platform as described in the following sections for local deployment.