Install KAAP Operator Helm chart

KAAP Operator is installed using Helm. You can install just the operator and the PulsarCluster CRDs, or you can install Kaap Stack, which includes the operator, CRDs, and the Prometheus monitoring stack.

Install KAAP Operator

Install the DataStax Helm repository:

helm repo add kaap https://datastax.github.io/kaap
helm repo update
  1. The KAAP Operator Helm chart is available for download (here.

  2. Install the KAAP operator Helm chart:

    helm install kaap kaap/kaap
    ...
    NAME: kaap
    LAST DEPLOYED: Wed Jun 28 11:37:45 2023
    NAMESPACE: pulsar-cluster
    STATUS: deployed
    REVISION: 1
    TEST SUITE: None
  3. Ensure KAAP operator is up and running:

    • Kubectl

    • Result

    kubectl get deployment
    NAME              READY   UP-TO-DATE   AVAILABLE   AGE
    kaap   1/1     1            1           13m
  4. Describe the deployment:

    • Kubectl

    • Result

    kubectl describe deployment kaap
    Name:                   kaap
    Namespace:              pulsar-cluster
    CreationTimestamp:      Wed, 28 Jun 2023 11:37:49 -0400
    Labels:                 app.kubernetes.io/managed-by=Helm
                            app.kubernetes.io/name=kaap
                            helm.sh/chart=kaap-0.1.0
    Annotations:            deployment.kubernetes.io/revision: 1
                            meta.helm.sh/release-name: kaap
                            meta.helm.sh/release-namespace: pulsar-cluster
                            prometheus.io/path: /q/metrics
                            prometheus.io/port: 8080
                            prometheus.io/scheme: http
                            prometheus.io/scrape: true
    Selector:               app.kubernetes.io/name=kaap
    Replicas:               1 desired | 1 updated | 1 total | 1 available | 0 unavailable
    StrategyType:           RollingUpdate
    MinReadySeconds:        0
    RollingUpdateStrategy:  25% max unavailable, 25% max surge
    Pod Template:
      Labels:           app.kubernetes.io/name=kaap
      Annotations:      checksum/config: bf2ad27453a7deeb74c2e0b177154649cb6cf292a31b80855c92d28f6a141134
                        prometheus.io/path: /q/metrics
                        prometheus.io/port: 8080
                        prometheus.io/scheme: http
                        prometheus.io/scrape: true
      Service Account:  kaap
      Containers:
       kaap:
        Image:      datastax/kaap:latest
        Port:       8080/TCP
        Host Port:  0/TCP
        Liveness:   http-get http://:8080/q/health/live delay=0s timeout=10s period=30s #success=1 #failure=3
        Readiness:  http-get http://:8080/q/health/ready delay=0s timeout=10s period=30s #success=1 #failure=3
        Environment Variables from:
          kaap  ConfigMap  Optional: false
        Environment:
          KUBERNETES_NAMESPACE:   (v1:metadata.namespace)
        Mounts:                  <none>
      Volumes:                   <none>
    Conditions:
      Type           Status  Reason
      ----           ------  ------
      Available      True    MinimumReplicasAvailable
      Progressing    True    NewReplicaSetAvailable
    OldReplicaSets:  <none>
    NewReplicaSet:   kaap-76dfd8ddf9 (1/1 replicas created)
    Events:
      Type    Reason             Age   From                   Message
      ----    ------             ----  ----                   -------
      Normal  ScalingReplicaSet  2m5s  deployment-controller  Scaled up replica set kaap-76dfd8ddf9 to 1
  5. You’ve now installed KAAP.

    By default, when KAAP is installed, the PulsarCluster CRDs are also created. This setting is defined in the Pulsar operator values.yaml file as crd: create: true.

  6. To see the available CRDs:

    • Kubectl

    • Result

    kubectl get crds | grep kaap
    autorecoveries.kaap.oss.datastax.com           2023-05-12T16:35:59Z
    bastions.kaap.oss.datastax.com                 2023-05-12T16:36:00Z
    bookkeepers.kaap.oss.datastax.com              2023-05-12T16:36:00Z
    brokers.kaap.oss.datastax.com                  2023-05-12T16:36:01Z
    functionsworkers.kaap.oss.datastax.com         2023-05-12T16:36:01Z
    proxies.kaap.oss.datastax.com                  2023-05-12T16:36:02Z
    pulsarclusters.kaap.oss.datastax.com           2023-05-12T16:36:04Z
    zookeepers.kaap.oss.datastax.com               2023-05-12T16:36:06Z

Uninstall

To uninstall the KAAP Operator:

  • Helm

  • Result

helm uninstall kaap
release "kaap" uninstalled

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com