Skip to main content

Cloudentity on Kubernetes via Helm Quickstart

Get started with Cloudentity deployment on Kubernetes using Helm Charts.

Overview

Deploy Cloudentity using Helm charts. We offer two distinct Helm charts tailored to different deployment preferences:

acp

  • Bare Cloudentity installation with core components only.

  • With this chart, you'll need to manually set up any additional dependencies, such as databases.

kube-acp-stack

  • A comprehensive installation that includes the Cloudentity platform and the necessary databases (Redis, CockroachDB, and TimescaleDB).

Recommended Installation Method

Though our quickstart installation remains available, we now recommend our enhanced GitOps-based installation for Cloudentity on K8s. This new approach offers a tailored experience with three distinct installation modes: 'dev', 'base', and 'full', ensuring a more streamlined and customizable setup for your specific needs.

Choose the chart that best fits your deployment needs.

Prerequisites

  • Kubernetes cluster v1.16+

  • Helm v3.0+

  • Access to Cloudentity Private Docker Repository. If you're a customer, refer to your Support Portal for credentials. If you're not yet a customer, contact us.

  • kubeconfig configured. See example below:

$HOME/.kube/config
apiVersion: v1
kind: Config
clusters:
- cluster:
   certificate-authority-data: <CERTIFICATE_DATA>
   server: <SERVER_URL>
name: <CLUSTEER_NAME>
contexts:
- context:
   cluster: <CLUSTER_NAME>
   user: <USER_NAME>
name: <CONTEXT_NAME>
current-context: <CONTEXT_NAME>
users:
- name: <USER_NAME>
user: <AUTHENTICATION_DATA>

Add Cloudentity Helm Repository

Execute the following commands in your terminal:

helm repo add acp https://charts.cloudentity.io
helm repo update

Add Docker Credentials

Cloudentity uses docker images from private repository. Docker credentials must be added before installing Cloudentity charts.

kubectl create secret docker-registry docker.cloudentity.io --docker-server=docker.cloudentity.io --docker-username=<your-name> --docker-password=<your-password>

Install Chart

Install the Helm chart with RELEASE_NAME set to a value of your choice.

helm install RELEASE_NAME acp/kube-acp-stack

Result: Congratulations! Your Cloudentity platform instance is now up and running! If you want, you may now move to applying Advanced Configuration or installing Additonal Dependencies.

Install Additional Dependencies

Even though your Cloudentity deployment is up and running, to get it fully working you need to install some additional dependencies:

  • Fission to be able to execute Cloudentity Extensions in a secure environment

  • TimescaleDB to be able to store Audit Events.

Fission

For instructions on how to install and configure fission, refer to the FaaS: Set Up Functions as a Service article.

TimescaleDB

For instructions on how to install and configure TimescaleDB, refer to the Set Up TimescaleDB for Storing Audit Data article.

In this section: