Skip to main content

Overview

Helm chart simplifies the deployment of the platform using already pre-defined templates that are parsed as Kubernetes manifests and managed by Helm.

Prerequisites​

  • Kubernetes 1.19+
  • Helm 3.8.0+
  • PostgreSQL 12+
  • PV provisioner support in the underlying infrastructure

In case you want to enable Ingress you need to have installed Ingress Controller, for example:

kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.7.0/deploy/static/provider/cloud/deploy.yaml

If you are using internal CA for Ingress and Administrator certificate, you also need to have installed cert-manager.

cert-manager is only required to use certificates issued by internally generated CA:

  • ingress.certificate.source=internal for internally generated Ingress certificate
  • ingress.certificate.source=letsEncrypt for Ingress Let’s Encrypt issued certificate
  • registerAdmin.source=generated for internally generated certificate for first administrator

Using this Chart​

Installation​

Create namespace

We’ll need to define a Kubernetes namespace where the resources created by the Chart should be installed:

kubectl create namespace czertainly

Create czertainly-values.yaml

Copy the default values.yaml from the CZERTAINLY Helm chart and modify the values accordingly:

helm show values oci://harbor.3key.company/czertainly-helm/czertainly > czertainly-values.yaml

Now edit the czertainly-values.yaml according to your desired stated, see Configurable parameters for more information.

Prepare list of trusted CA certificates

Create new file called trusted-certificates.pem and add to the file PEM certificates of all certification authorities that should be trusted by the platform. No worries, you can always change the list of trusted certificates in the future.

The list of trusted certificates is need for the installation of the CZERTAINLY using Helm chart.

Note Trusted certificates can be defined globally for the CZERTAINLY chart and all of its sub-charts, or it can be applied only for specific sub-chart, see global parameters. For global, set global.trusted.certificates, otherwise set trusted.certificates.

Install CZERTAINLY

There are couple of options to install CZERTAINLY based on you TLS configuration and administrator certificate handling. See the Configurable parameters for more information.

For the basic installation, run:

helm install --namespace czertainly -f czertainly-values.yaml --set-file global.trusted.certificates=trusted-certificates.pem czertainly-tlm oci://harbor.3key.company/czertainly-helm/czertainly

Save your configuration

Always make sure you save the czertainly-values.yaml and all --set and --set-file options you used. You will need to use the same options when you upgrade CZERTAINLY to new versions with Helm. In case you are changing the configuration, save the new configuration.

Upgrade​

Warning Be sure that you always save your previous configuration!

For upgrading the CZERTAINLY installation, update your configuration and run:

helm upgrade --namespace czertainly -f czertainly-values.yaml --set-file global.trusted.certificates=trusted-certificates.pem czertainly-tlm oci://harbor.3key.company/czertainly-helm/czertainly

Uninstall​

You can use the helm uninstall command to uninstall the CZERTAINLY:

helm uninstall --namespace czertainly czertainly-tlm
Helm chart

See CZERTAINLY-Helm-Charts for description of all charts and sub-charts that are available for the platform.

Persistence​

Internal services can use Persistence Volume Claims to store the data. The PVC is created dynamically by default, but different behaviour can be configured.

The following sub-charts requires persistence:

  • Messaging RabbitMQ