bitnamicharts/keydb

Verified Publisher

By VMware

Updated about 9 hours ago

Bitnami Helm chart for KeyDB

Helm
Image
Databases & Storage

50K+

Bitnami package for KeyDB

KeyDB is a high performance fork of Redis with a focus on multithreading, memory efficiency, and high throughput.

Overview of KeyDB

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

helm install my-release oci://registry-1.docker.io/bitnamicharts/keydb

Looking to use KeyDB in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

Introduction

Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.

This chart bootstraps a KeyDB deployment in a Kubernetes cluster using the Helm package manager.

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

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.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 oci://REGISTRY_NAME/REPOSITORY_NAME/keydb

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

The command deploys KeyDB 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

Configuration and installation details

Cluster topologies

Default: Master - Replicas

When installing the chart with architecture=replication, it will deploy a KeyDB Master statefulset and a KeyDB Replica statefulset. The master is responsible for all write operations, while the replicas replicate the write operations from the master and serve read operations. Two services will be exposed:

  • KeyDB Master service: Points to the master, where read-write operations can be performed
  • KeyDB Replicas service: Points to the replicas, where only read operations are allowed by default.

In case the master crashes, the replicas will wait until the master node is respawned again by the Kubernetes Controller Manager.

Active Replicas

Similar to the Master-Replicas architecture, but with the ability to perform read and write operations on the replicas. This is achieved by setting replica.activeReplica=true. Find more information about how this mechanism works at the KeyDB documentation.

Standalone

When installing the chart with architecture=standalone, it will deploy a standalone KeyDB Master statefulset. A single service will be exposed:

  • KeyDB Master service: Points to the master, where read-write operations can be performed

Multi Master - Replicas

Similar to the Master-Replicas architecture, this architectures deploys both a KeyDB Master statefulset and a KeyDB Replica statefulset. However, in this architecture N Master replicas can be deployed, and KeyDB replicas are configured to follow multiple masters. This can be achieved by setting master.replicaCount to a value greater than 1 and setting replica.activeReplica=true (please note active replication is mandatory when using multi-master).

Find more information about how this mechanism works at the KeyDB documentation.

Prometheus metrics

This chart can be integrated with Prometheus by setting metrics.enabled to true. This will deploy a sidecar container with redis_exporter in all pods and a metrics service, which can be configured under the metrics.service section. This metrics service will have the necessary annotations to be automatically scraped by Prometheus.

Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.

Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true. Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.

Update credentials

The Bitnami KeyDB chart, when upgrading, reuses the secret previously rendered by the chart or the one specified in auth.existingSecret. To update credentials, use one of the following:

  • Run helm upgrade specifying a new password in auth.password
  • Run helm upgrade specifying a new secret in auth.existingSecret
Using a password file

To use a password file for KeyDB you need to create a secret containing the password and then deploy the chart using that secret. Follow these instructions:

  • Create the secret:
kubectl create secret generic keydb-password-secret --from-literal=keydb-password=KEYDB_PASSWORD

Note: the replace the KEYDB_PASSWORD placeholder with the actual password to use.

  • Deploy the Helm Chart using the secret name as parameter:
auth.enabled=true
auth.existingSecret=keydb-password-secret
auth.existingSecretPasswordKey=keydb-password
auth.usePasswordFiles=true
Securing traffic using TLS

This chart supports encrypting communications using TLS. To enable this feature, set the tls.enabled.

It is necessary to create a secret containing the TLS certificates and pass it to the chart via the tls.existingCASecret, tls.master.existingSecret and tls.replica.existingSecret (only for replication architecture) parameters. Every secret should contain a tls.crt and tls.key keys including the certificate and key files respectively. For example: create the CA secret with the certificates files:

kubectl create secret generic ca-tls-secret --from-file=./tls.crt --from-file=./tls.key

You can manually create the required TLS certificates or relying on the chart auto-generation capabilities. The chart supports two different ways to auto-generate the required certificates:

  • Using Helm capabilities. Enable this feature by setting tls.autoGenerated.enabled to true and tls.autoGenerated.engine to helm.
  • Relying on CertManager (please note it's required to have CertManager installed in your K8s cluster). Enable this feature by setting tls.autoGenerated.enabled to true and tls.autoGenerated.engine to cert-manager. Please note it's supported to use an existing Issuer/ClusterIssuer for issuing the TLS certificates by setting the tls.autoGenerated.certManager.existingIssuer and tls.autoGenerated.certManager.existingIssuerKind parameters.
Metrics

The chart optionally can start a metrics exporter for prometheus. Metrics can be scraped from within the cluster using something similar as the described in the example Prometheus scrape configuration. If metrics are to be scraped from outside the cluster, the Kubernetes API proxy can be utilized to access the endpoint.

If you have enabled TLS by specifying tls.enabled=true you also need to specify TLS options to the metrics exporter. You can do that via metrics.extraArgs. You can find the metrics exporter CLI flags for TLS here. For example:

You can either specify metrics.extraArgs.skip-tls-verification=true to skip TLS verification or providing the following values under metrics.extraArgs for TLS client authentication:

tls-client-key-file
tls-client-cert-file
tls-ca-cert-file
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.

Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.

Additional environment variables

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property.

master:
  extraEnvVars:
  - name: LOG_LEVEL
    value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values.

Sidecars

If additional containers are needed in the same pod as KeyDB (such as additional metrics or logging exporters), they can be defined using the sidecars parameter.

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

If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts parameter (where available), as shown in the example below:

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

NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by setting the metrics.enabled parameter to true at deployment time. The sidecars parameter should therefore only be used for any extra sidecar containers.

If additional init containers are needed in the same pod, they can be defined using the initContainers parameter. Here is an example:

master:
  initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Learn more about sidecar containers and init containers.

Pod affinity

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

As an alternative, use one 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.

Backup and restore

To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.

Persistence

The Bitnami KeyDB image stores the KeyDB data and configurations at the /bitnami/keydb/data path of the container. Persistent Volume Claims are used to keep the data across deployments.

If you encounter errors when working with persistent volumes, refer to our troubleshooting guide for persistent volumes.

Parameters

Global parameters
NameDescriptionValue
global.imageRegistryGlobal Docker image registry""
global.imagePullSecretsGlobal Docker registry secret names as an array[]
global.defaultStorageClassGlobal default StorageClass for Persistent Volume(s)""
global.keydb.passwordGlobal KeyDB password (overrides auth.password)""
global.security.allowInsecureImagesAllows skipping image verificationfalse
global.compatibility.openshift.adaptSecurityContextAdapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation)auto
Common parameters
NameDescriptionValue
kubeVersionOverride Kubernetes version""
nameOverrideString to partially override common.names.name""
fullnameOverrideString to fully override common.names.fullname""
namespaceOverrideString to fully override common.names.namespace""
commonLabelsLabels to add to all deployed objects{}
commonAnnotationsAnnotations to add to all deployed objects{}
clusterDomainKubernetes cluster domain namecluster.local
extraDeployArray of extra objects to deploy with the release[]
diagnosticMode.enabledEnable diagnostic mode (all probes will be disabled and the command will be overridden)false
diagnosticMode.commandCommand to override all containers in the chart release["sleep"]
diagnosticMode.argsArgs to override all containers in the chart release["infinity"]
KeyDB Image parameters
NameDescriptionValue
image.registryKeyDB image registryREGISTRY_NAME
image.repositoryKeyDB image repositoryREPOSITORY_NAME/keydb
image.digestKeyDB image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended)""
image.pullPolicyKeyDB image pull policyIfNotPresent
image.pullSecretsKeyDB image pull secrets[]
image.debugEnable KeyDB image debug modefalse
KeyDB common configuration parameters
NameDescriptionValue
architectureKeyDB architecture. Allowed values: standalone or replicationreplication
auth.enabledEnable password authenticationtrue
auth.passwordKeyDB password""
auth.existingSecretThe name of an existing secret with KeyDB credentials""
auth.existingSecretPasswordKeyPassword key to be retrieved from existing secret""
auth.usePasswordFilesMount credentials as files instead of using an environment variablefalse
tls.enabledEnable TLS communicationsfalse
tls.autoGenerated.enabledEnable automatic generation of certificates for TLStrue
tls.autoGenerated.engineMechanism to generate the certificates (allowed values: helm, cert-manager)helm
tls.autoGenerated.certManager.existingIssuerThe name of an existing Issuer to use for generating the certificates (only for cert-manager engine)""
tls.autoGenerated.certManager.existingIssuerKindExisting Issuer kind, defaults to Issuer (only for cert-manager engine)""
tls.autoGenerated.certManager.keyAlgorithmKey algorithm for the certificates (only for cert-manager engine)RSA
tls.autoGenerated.certManager.keySizeKey size for the certificates (only for cert-manager engine)2048
tls.autoGenerated.certManager.durationDuration for the certificates (only for cert-manager engine)2160h
tls.autoGenerated.certManager.renewBeforeRenewal period for the certificates (only for cert-manager engine)360h
tls.caCA certificate for TLS. Ignored if tls.existingCASecret is set""
tls.existingCASecretThe name of an existing Secret containing the CA certificate for TLS""
tls.master.certTLS certificate for KeyDB master nodes. Ignored if tls.master.existingSecret is set""
tls.master.keyTLS key for KeyDB master nodes. Ignored if tls.master.existingSecret is set""
tls.master.existingSecretThe name of an existing Secret containing the KeyDB master nodes certificates for TLS""
tls.replica.certTLS certificate for KeyDB replica nodes. Ignored if tls.replica.existingSecret is set""
tls.replica.keyTLS key for KeyDB replica nodes. Ignored if tls.replica.existingSecret is set""

Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/keydb/README.md

Docker Pull Command

docker pull bitnamicharts/keydb
Bitnami