charts/bitnami/ejbca

EJBCA

EJBCA is a free software public key infrastructure certificate authority software package.

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/ejbca

Introduction

This chart bootstraps a EJBCA deployment on a Kubernetes cluster using the Helm package manager.

It also packages Bitnami MariaDB as the required databases for the EJBCA application.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Prerequisites

• Kubernetes 1.12+
• Helm 3.1.0
• PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name my-release:

$ helm install my-release bitnami/ejbca

The command deploys EJBCA on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

The following table lists the configurable parameters of the EJBCA chart and their default values.

Parameter	Description	Default
global.imageRegistry	Global Docker image registry	nil
global.imagePullSecrets	Global Docker registry secret names as an array	[] (does not add image pull secrets to deployed pods)
global.storageClass	Global storage class for dynamic provisioning	nil

Common & Pod-specific parameters

Parameter	Description	Default
image.registry	EJBCA image registry	docker.io
image.repository	EJBCA image name	bitnami/ejbca
image.tag	EJBCA image tag	{TAG_NAME}
image.pullPolicy	EJBCA image pull policy	IfNotPresent
image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
nameOverride	String to partially override discourse.fullname	nil
fullnameOverride	String to fully override discourse.fullname	nil
replicaCount	Number of EJBCA replicas	1
extraVolumes	Array of extra volumes to be added deployment. Requires setting extraVolumeMounts	[] (evaluated as a template)
podAnnotations	Additional pod annotations	{}
podLabels	Additional pod labels	{} (evaluated as a template)
commonAnnotations	Annotations to be added to all deployed resources	{} (evaluated as a template)
podSecurityContext.enabled	Enable security context for EJBCA pods	true
podSecurityContext.fsGroup	Group ID for the volumes of the pod	1001
podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
nodeAffinityPreset.key	Node label key to match Ignored if affinity is set.	""
nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set.	[]
affinity	Affinity for pod assignment	{} (evaluated as a template)
nodeSelector	Node labels for pod assignment	{} (evaluated as a template)
tolerations	Tolerations for pod assignment	[] (evaluated as a template)
sidecars	Attach additional sidecar containers to the pod	[] (evaluated as a template)
initContainers	Additional init containers to add to the pods	[] (evaluated as a template)
persistence.enabled	Whether to enable persistence based on Persistent Volume Claims	true
persistence.storageClass	PVC Storage Class	nil
persistence.existingClaim	Name of an existing PVC to reuse	nil
persistence.accessMode	PVC Access Mode (RWO, ROX, RWX)	ReadWriteOnce
persistence.size	Size of the PVC to request	2Gi
kubeVersion	Force target Kubernetes version (using Helm capabilities if not set)	nil

Service parameters

Parameter	Description	Default
service.type	Kubernetes Service type	LoadBalancer
service.port	Service HTTP port	8080
service.httpsPort	Service HTTPS port	8443
service.advertisedHttpsPort	Port used for the administration's urls	443
service.httpsTargetPort	Service Target HTTPS port	https
service.nodePorts.http	Kubernetes http node port	""
service.nodePorts.https	Kubernetes https node port	""
service.externalTrafficPolicy	Enable client source IP preservation	Cluster
service.annotations	Service annotations	{} (evaluated as a template)
service.loadBalancerSourceRanges	Restricts access for LoadBalancer (only with service.type: LoadBalancer)	[]
service.extraPorts	Extra ports to expose in the service (normally used with the sidecar value)	nil

EJBCA parameters

Parameter	Description	Default
ejbcaAdminUsername	EJBCA administrator username	bitnami
ejbcaAdminPassword	EJBCA administrator password	random 10 character long alphanumeric string
existingSecret	Name of an existing secret containing EJBCA admin password ('ejbca-admin-password' key)	nil
ejbcaJavaOpts	Options used to launch the WildFly server	nil
ejbcaCA.name	Name of the CA EJBCA will instantiate by default	ManagementCA
ejbcaCA.baseDN	Base DomainName of the CA EJBCA will instantiate by default	nil
ejbcaKeystoreExistingSecret	Existing Secret containing a Keystore to be imported by EBJCA	nil
extraEnvVars	An array to add extra env vars	[] (evaluated as a template)
command	Custom command to override image cmd	nil (evaluated as a template)
args	Custom args for the custom command	nil (evaluated as a template)
extraVolumeMounts	Additional volume mounts (used along with extraVolumes)	[] (evaluated as a template)
resources	EJBCA container's resource requests and limits	{}
podSecurityContext.enabled	Enable security context for EJBCA container	true
podSecurityContext.runAsUser	User ID for the EJBCA container	1001
hostAliases	Add deployment host aliases	[]
livenessProbe.enabled	Enable/disable livenessProbe	true
livenessProbe.initialDelaySeconds	Delay before liveness probe is initiated	500
livenessProbe.periodSeconds	How often to perform the probe	10
livenessProbe.timeoutSeconds	When the probe times out	5
livenessProbe.failureThreshold	Minimum consecutive failures for the probe	6
livenessProbe.successThreshold	Minimum consecutive successes for the probe	1
readinessProbe.enabled	Enable/disable readinessProbe	true
readinessProbe.initialDelaySeconds	Delay before readiness probe is initiated	500
readinessProbe.periodSeconds	How often to perform the probe	10
readinessProbe.timeoutSeconds	When the probe times out	5
readinessProbe.failureThreshold	Minimum consecutive failures for the probe	6
readinessProbe.successThreshold	Minimum consecutive successes for the probe	1
customLivenessProbe	Custom liveness probe to execute (when the main one is disabled)	{} (evaluated as a template)
customReadinessProbe	Custom readiness probe to execute (when the main one is disabled)	{} (evaluated as a template)
containerPorts.http	Port to open for HTTP traffic in EJBCA	8080
containerPorts.https	Port to open for HTTPS traffic in EJBCA	8443
extraEnvVarsCM	Array to add extra configmaps	[]
extraEnvVarsSecret	Array to add extra environment from a Secret	nil

Ingress parameters

Parameter	Description	Default
ingress.enabled	Enable ingress controller resource	false
ingress.certManager	Add annotations for cert-manager	false
ingress.hostname	Default host for the ingress resource	ejbca.local
ingress.path	Default path for the ingress resource	/
ingress.tls	Create TLS Secret	false
ingress.annotations	Ingress annotations	[] (evaluated as a template)
ingress.extraHosts[0].name	Additional hostnames to be covered	nil
ingress.extraHosts[0].path	Additional hostnames to be covered	nil
ingress.extraPaths	Additional arbitrary path/backend objects	nil
ingress.extraTls[0].hosts[0]	TLS configuration for additional hostnames to be covered	nil
ingress.extraTls[0].secretName	TLS configuration for additional hostnames to be covered	nil
ingress.secrets[0].name	TLS Secret Name	nil
ingress.secrets[0].certificate	TLS Secret Certificate	nil
ingress.secrets[0].key	TLS Secret Key	nil

Database parameters

Parameter	Description	Default
mariadb.enabled	Deploy MariaDB container(s)	true
mariadb.architecture	MariaDB architecture (standalone or replication)	standalone
mariadb.auth.rootPassword	Password for the MariaDB root user	random 10 character alphanumeric string
mariadb.auth.database	Database name to create	bitnami_ejbca
mariadb.auth.username	Database user to create	bn_ejbca
mariadb.auth.password	Password for the database	random 10 character long alphanumeric string
mariadb.primary.persistence.enabled	Enable database persistence using PVC	true
mariadb.primary.persistence.existingClaim	Name of an existing PersistentVolumeClaim for MariaDB primary replicas	nil
mariadb.primary.persistence.accessModes	Database Persistent Volume Access Modes	[ReadWriteOnce]
mariadb.primary.persistence.size	Database Persistent Volume Size	8Gi
mariadb.primary.persistence.hostPath	Set path in case you want to use local host path volumes (not recommended in production)	nil
mariadb.primary.persistence.storageClass	MariaDB primary persistent volume storage Class	nil
externalDatabase.host	Host of the external database	localhost
externalDatabase.username	Existing username in the external db	bn_ejbca
externalDatabase.password	Password for the above username	nil
externalDatabase.existingSecret	Name of an existing secret resource containing the DB password in a 'mariadb-password' key	nil
externalDatabase.database	Name of the existing database	bitnami_ejbca
externalDatabase.port	Database port number	3306

The above parameters map to the env variables defined in bitnami/ejbca. For more information please refer to the bitnami/ejbca image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
  --set ejbcaAdminUsername=admin,ejbcaAdminPassword=password,mariadb.auth.password=secretpassword \
    bitnami/discourse

The above command sets the EJBCA administrator account username and password to admin and password respectively. Additionally, it sets the MariaDB bn_ejbca user password to secretpassword.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/ejbca

Tip

: You can use the default values.yaml

Configuration and installation details

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Setting up replication

By default, this Chart only deploys a single pod running EJBCA. Should you want to increase the number of replicas, you may follow these simple steps to ensure everything works smoothly:

1. Create a conventional release with only one replica, that will be scaled later.
2. Wait for the release to complete and EJBCA to be running successfully. You may verify you have access to the main page in order to do this.
3. Perform an upgrade specifying the number of replicas and the credentials that were previously used. Set the parameters replicaCount, ejbcaAdminPassword and mariadb.auth.password accordingly.

For example, for a release using secretPassword and dbPassword to scale up to a total of 2 replicas, the aforementioned parameters should hold these values replicaCount=2, ejbcaAdminPassword=secretPassword, mariadb.auth.password=dbPassword.

Tip

: You can modify the file values.yaml

Sidecars

If you have a need for additional containers to run within the same pod as EJBCA (e.g. metrics or logging exporter), you can do so via the sidecars config parameter. Simply define your container according to the Kubernetes container spec.

sidecars:
- name: your-image-name
  image: your-image
  imagePullPolicy: Always
  ports:
  - name: portname
   containerPort: 1234

If these sidecars export extra ports, you can add extra port definitions using the service.extraPorts value:

service:
...
  extraPorts:
  - name: extraPort
    port: 11311
    targetPort: 11311

Using an external database

Sometimes you may want to have EJBCA connect to an external database rather than installing one inside your cluster, e.g. to use a managed database service, or use run a single database server for all your applications. To do this, the chart allows you to specify credentials for an external database under the externalDatabase parameter. You should also disable the MariaDB installation with the mariadb.enabled option. For example with the following parameters:

mariadb.enabled=false
externalDatabase.host=myexternalhost
externalDatabase.user=myuser
externalDatabase.password=mypassword
externalDatabase.database=mydatabase
externalDatabase.port=3306

Note also that if you disable MariaDB per above you MUST supply values for the externalDatabase connection.

Setting Pod's affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod's affinity in the kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Persistence

The Bitnami EJBCA image stores the EJBCA data and configurations at the /bitnami path of the container.

Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Parameters section to configure the PVC or to disable persistence.

Image

The image parameter allows specifying which image will be pulled for the chart.

Private registry

If you configure the image value to one in a private registry, you will need to specify an image pull secret.

1. Manually create image pull secret(s) in the namespace. See this YAML example reference. Consult your image registry's documentation about getting the appropriate secret.
2. Note that the imagePullSecrets configuration value cannot currently be passed to helm using the --set parameter, so you must supply these using a values.yaml file, such as:

imagePullSecrets:
  - name: SECRET_NAME

3. Install the chart

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

To 2.0.0

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

What changes were introduced in this major version?

• Previous versions of this Helm Chart use apiVersion: v1 (installable by both Helm 2 and 3), this Helm Chart was updated to apiVersion: v2 (installable by Helm 3 only). Here you can find more information about the apiVersion field.
• Move dependency information from the requirements.yaml to the Chart.yaml
• After running helm dependency update, a Chart.lock file is generated containing the same structure used in the previous requirements.lock
• The different fields present in the Chart.yaml file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

Considerations when upgrading to this version

• If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
• If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
• If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the official Helm documentation about migrating from Helm v2 to v3

Useful links

• https://docs.bitnami.com/tutorials/resolve-helm2-helm3-post-migration-issues/
• https://helm.sh/docs/topics/v2_v3_migration/
• https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/

To 1.0.0

MariaDB dependency version was bumped to a new major version that introduces several incompatilibites. Therefore, backwards compatibility is not guaranteed unless an external database is used. Check MariaDB Upgrading Notes for more information.

To upgrade to 1.0.0, you have two alternatives:

• Install a new EJBCA chart, and migrate your EJBCA following the official documentation.
• Reuse the PVC used to hold the MariaDB data on your previous release. To do so, follow the instructions below (the following example assumes that the release name is ejbca):

NOTE: Please, create a backup of your database before running any of those actions. The steps below would be only valid if your application (e.g. any plugins or custom code) is compatible with MariaDB 10.5.x

Obtain the credentials and the name of the PVC used to hold the MariaDB data on your current release:

export EJBCA_ADMIN_PASSWORD=$(kubectl get secret --namespace default ejbca -o jsonpath="{.data.ejbca-admin-password}" | base64 --decode)
export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default ejbca-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 --decode)
export MARIADB_PASSWORD=$(kubectl get secret --namespace default ejbca-mariadb -o jsonpath="{.data.mariadb-password}" | base64 --decode)
export MARIADB_PVC=$(kubectl get pvc -l app=mariadb,component=master,release=ejbca -o jsonpath="{.items[0].metadata.name}")

Upgrade your release (maintaining the version) disabling MariaDB and scaling EJBCA replicas to 0:

$ helm upgrade ejbca bitnami/ejbca --set ejbcaAdminPassword=$EJBCA_ADMIN_PASSWORD --set replicaCount=0 --set mariadb.enabled=false --version 0.4.0

Finally, upgrade you release to 1.0.0 reusing the existing PVC, and enabling back MariaDB:

$ helm upgrade ejbca bitnami/ejbca --set mariadb.primary.persistence.existingClaim=$MARIADB_PVC --set mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD --set mariadb.auth.password=$MARIADB_PASSWORD --set ejbcaAdminPassword=$EJBCA_ADMIN_PASSWORD

You should see the lines below in MariaDB container logs:

$ kubectl logs $(kubectl get pods -l app.kubernetes.io/instance=ejbca,app.kubernetes.io/name=mariadb,app.kubernetes.io/component=primary -o jsonpath="{.items[0].metadata.name}")
...
mariadb 12:13:24.98 INFO  ==> Using persisted data
mariadb 12:13:25.01 INFO  ==> Running mysql_upgrade
...