Install Axual Streaming
This guide shows you how to write the Axual Streaming values file, choose which streaming components to enable, install the chart, confirm the components came up, and uninstall it again.
Type |
How-to guide |
Goal |
Get Apicurio Registry and the Rest Proxy running against your Kafka cluster. |
Audience |
Platform Operator with Helm access to the target namespace and credentials for the Axual registry. |
When to use |
Stage 3 of The installation order, after a Kafka cluster exists and before the governance layer. |
The Axual Streaming chart installs the components that carry and describe the data on top of an existing Kafka cluster:
Apache Kafka itself is a separate, standalone chart; see How to Deploy Axual Kafka if it is not already running.
Prerequisites
Confirm the following before you begin.
Access and permissions required
You need the following access and permissions:
-
Credentials for the Axual chart registry,
registry.axual.io. Contact Axual support if you have none. -
Permission to install Helm releases and create workloads in the target namespace.
Tools and versions required
You need the following tools:
-
helm>= 3.12, with OCI registry support. -
kubectl>= 1.28, configured for the target cluster.
Resources that must exist before starting
The following must already exist:
-
A Kubernetes cluster meeting Infrastructure Requirements.
-
The cluster-level dependencies the charts expect, in particular an ingress controller. See Dependencies.
-
A running Axual Kafka cluster. See How to Deploy Axual Kafka.
-
The certificates and TLS Secrets the components read. See Certificates, TLS and DNS.
-
The image pull Secret named
axualdockercred, and the namespace itself. Both are created in Preparations.
The examples below install into a namespace called kafka, which is the convention the quick-setup guides use for the streaming layer. Substitute your own namespace throughout. The governance layer conventionally goes into a separate namespace, axual, but the two layers can share one if you prefer.
|
Create a Helm values file
Create the values.yaml that configures your installation. Start with the pull Secret, so the chart can fetch the component images.
global:
# -- Globally override the list of ImagePullSecrets provided.
imagePullSecrets:
- name: axualdockercred
The name must match the Secret created in Preparations. A mismatch here fails at image pull, which surfaces as pods stuck in ImagePullBackOff rather than as a values error.
|
Enable the components
Each component is enabled independently, so you can install a subset and add the rest later.
global:
rest-proxy:
enabled: true
apicurio-registry-v3:
enabled: trueInstall Axual Streaming
Log in to the registry, then install the chart with your values.
Replace every <VALUE> placeholder with your own value before running a command.
|
-
Log in to the Axual registry that holds the charts.
helm registry login registry.axual.io --username <YOUR_USERNAME> -
Install Axual Streaming with your
values.yaml.helm install streaming oci://registry.axual.io/axual-charts/axual-streaming \ --version <STREAMING_CHART_VERSION> -f ./values.yaml -n kafka
Verify the installation
Confirm the release succeeded and every enabled component reached a running state before installing the governance layer on top of it.
helm status streaming -n kafka
kubectl get pods -n kafkaEvery pod should read Running, except the initialisation pods, which correctly finish as Completed.
Then confirm the Apicurio Registry endpoint answers, using the hostname from your values:
curl -sSf https://<APICURIO_HOST>/apis/registry/v3/system/infoIf a pod does not start, How to Inspect Kubernetes Workloads covers reading its events and logs.
Uninstall Axual Streaming
Uninstalling removes the release, not the data. It leaves the Kafka cluster untouched, since it is a separate release; see How to Deploy Axual Kafka to remove that as well.
helm uninstall streaming -n kafka