Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datastax/kaap
KAAP, Kubernetes Autoscaling for Apache Pulsar
https://github.com/datastax/kaap
apache-pulsar kubernetes kubernetes-operators pulsar
Last synced: about 1 month ago
JSON representation
KAAP, Kubernetes Autoscaling for Apache Pulsar
- Host: GitHub
- URL: https://github.com/datastax/kaap
- Owner: datastax
- License: apache-2.0
- Created: 2022-10-19T16:05:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T12:31:21.000Z (4 months ago)
- Last Synced: 2024-09-05T13:01:18.573Z (4 months ago)
- Topics: apache-pulsar, kubernetes, kubernetes-operators, pulsar
- Language: Java
- Homepage: https://datastax.github.io/kaap/
- Size: 3.25 MB
- Stars: 45
- Watchers: 8
- Forks: 15
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kubernetes Autoscaling for Apache Pulsar (KAAP)
Kubernetes Autoscaling for Apache Pulsar (KAAP) simplifies running [Apache Pulsar](https://pulsar.apache.org) on Kubernetes by applying the familiar [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to Pulsar's components, and horizonally scaling resources up or down based on CPU and memory workloads.
KAAP operator's broker autoscaling integrates with the Pulsar broker's load balancer, which has insight into all other brokers' workloads. With this information, KAAP can make smarter resource management decisions than the Kubernetes HorizontalPodAutoscaler.
KAAP's Bookkeeper autoscaling solution is similarly Pulsar-native. Bookkeeper nodes are scaled up in response to running low on storage, and because of Bookkeeper's segment-based design, the new storage is available immediately for use by the cluster, with no log stream rebalancing required.
When KAAP sees low storage usage on a Bookkeeper node, the node is automatically scaled down (decommissioned) to free up volume usage and reduce storage costs. This scale-down is done in a safe, controlled manner which ensures no data loss and guarantees the configured replication factor for all messages. For example, if your replication factor is 3 (write and ack quorum of 3), 3 replicas are maintained at all times during the scale down to ensure data can be recovered, even if there is a failure during the scale-down phase. Scaling down bookies has been a consistent pain point in Pulsar, and KAAP automates this without sacrifing Pulsar's data guarantees.
Operating and maintaining Apache Pulsar clusters traditionally involves complex manual configurations, making it challenging for developers and operators to effectively manage the system's lifecycle. However, with the KAAP operator, these complexities are abstracted away, enabling developers to focus on their applications rather than the underlying infrastructure.
Some of the key features and benefits of the KAAP operator include:
- **Easy Deployment**: Deploying an Apache Pulsar cluster on Kubernetes is simplified through declarative configurations and automation provided by the operator.
- **Scalability**: The KAAP operator enables effortless scaling of Pulsar clusters by automatically handling the creation and configuration of new Pulsar brokers and bookies as per defined rules. The broker autoscaling is integrated with the Pulsar broker load balancer to make smart resource management decisions, and bookkeepers are scaled up and down based on storage usage in a safe, controlled manner.
- **High Availability**: The operator implements best practices for high availability, ensuring that Pulsar clusters are fault-tolerant and can sustain failures without service disruptions.
- **Lifecycle Management**: The operator takes care of common Pulsar cluster lifecycle tasks, such as cluster creation, upgrade, configuration updates, and graceful shutdowns.
We also offer the KAAP Stack if you're looking for more Kubernetes-native tooling deployed with your Pulsar cluster. Along with the PulsarCluster CRDs, KAAP stack also includes:
* Pulsar Operator
* Prometheus Stack (Grafana)
* Pulsar Grafana dashboards
* Cert Manager
* Keycloak
The KAAP Stack is also included in this repository.
Whether you are a developer looking to leverage the power of Apache Pulsar in your Kubernetes environment, or an operator seeking to streamline the management of Pulsar clusters, the KAAP Operator provides a robust and user-friendly solution.
If you're running [Luna Streaming](https://www.datastax.com/products/luna-streaming), the DataStax distribution of Apache Pulsar, KAAP is 100% compatible with your existing Pulsar cluster.
## Documentation
Full documentation is available in the [DataStax Streaming Documentation](https://docs.datastax.com/en/streaming/kaap-operator/latest/index.html) or at [this repo's GitHub Pages site](https://datastax.github.io/kaap/docs/).
## Install KAAP Operator
This example installs only the KAAP operator.
See the KAAP Stack below to install KAAP with an operator, a Pulsar cluster, and the Prometheus monitoring stack.
1. Install the DataStax KAAP Helm repository:
```
helm repo add kaap https://datastax.github.io/kaap
helm repo update
```
2. Install the KAAP operator Helm chart:
```
helm install kaap kaap/kaap
```
Result:
```
NAME: kaap
LAST DEPLOYED: Wed Jun 28 11:37:45 2023
NAMESPACE: pulsar-cluster
STATUS: deployed
REVISION: 1
TEST SUITE: None
```
3. Ensure the operator is up and running:
```
kubectl get deployment
```
Result:
```
NAME READY UP-TO-DATE AVAILABLE AGE
kaap 1/1 1 1 52m
```
4. You've now installed the KAAP operator.
By default, when KAAP is installed, the PulsarCluster CRDs are also created.
This setting is defined in the KAAP values.yaml file as `crd: {create: true}`.
5. To see available CRDs:
```
kubectl get crds | grep kaap
```
Result:
```
autorecoveries.kaap.oss.datastax.com 2023-06-28T15:37:39Z
bastions.kaap.oss.datastax.com 2023-06-28T15:37:39Z
bookkeepers.kaap.oss.datastax.com 2023-06-28T15:37:39Z
brokers.kaap.oss.datastax.com 2023-06-28T15:37:40Z
functionsworkers.kaap.oss.datastax.com 2023-06-28T15:37:40Z
proxies.kaap.oss.datastax.com 2023-06-28T15:37:40Z
pulsarclusters.kaap.oss.datastax.com 2023-06-28T15:37:41Z
zookeepers.kaap.oss.datastax.com 2023-06-28T15:37:41Z
```
For more, see the [DataStax Streaming Documentation](https://docs.datastax.com/en/streaming/kaap-operator/latest/index.html) or [this repo's GitHub Pages site](https://datastax.github.io/kaap/docs/).
## Install KAAP Stack Operator with a Pulsar cluster
This example deploys a KAAP stack operator, and also deploys a minimally-sized Pulsar cluster for development testing.
1. Install the DataStax KAAP Helm repository:
```
helm repo add kaap https://datastax.github.io/kaap
helm repo update
```
2. Install the KAAP Stack operator Helm chart with the custom `dev-cluster` values file:
```
helm install pulsar kaap/kaap-stack --values helm/examples/dev-cluster/values.yaml
```
Result:
```
NAME: pulsar
LAST DEPLOYED: Thu Jun 29 14:30:20 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
```
3. Ensure the operator is up and running:
```
kubectl get deployment
```
Result:
```
NAME READY UP-TO-DATE AVAILABLE AGE
kaap 1/1 1 1 5m19s
pulsar-autorecovery 1/1 1 1 3m19s
pulsar-bastion 1/1 1 1 3m19s
pulsar-grafana 1/1 1 1 5m19s
pulsar-kube-prometheus-sta-operator 1/1 1 1 5m19s
pulsar-kube-state-metrics 1/1 1 1 5m19s
pulsar-proxy 1/1 1 1 3m19s
```
4. You've now installed KAAP Stack operator with a Pulsar cluster.
By default, when KAAP is installed, the PulsarCluster CRDs are also created.
This setting is defined in the KAAP values.yaml file as `crd: {create: true}`.
5. To see available CRDs:
```
kubectl get crds | grep kaap
```
Result:
```
autorecoveries.kaap.oss.datastax.com 2023-06-28T15:37:39Z
bastions.kaap.oss.datastax.com 2023-06-28T15:37:39Z
bookkeepers.kaap.oss.datastax.com 2023-06-28T15:37:39Z
brokers.kaap.oss.datastax.com 2023-06-28T15:37:40Z
functionsworkers.kaap.oss.datastax.com 2023-06-28T15:37:40Z
proxies.kaap.oss.datastax.com 2023-06-28T15:37:40Z
pulsarclusters.kaap.oss.datastax.com 2023-06-28T15:37:41Z
zookeepers.kaap.oss.datastax.com 2023-06-28T15:37:41Z
```
For more, see the [DataStax Streaming Documentation](https://docs.datastax.com/en/streaming/kaap-operator/latest/index.html) or [this repo's GitHub Pages site](https://datastax.github.io/kaap/docs/).
## Uninstall KAAP
To uninstall KAAP:
```
helm delete kaap
```
Result:
```
release "kaap" uninstalled
```
For more, see the [DataStax Streaming Documentation](https://docs.datastax.com/en/streaming/kaap-operator/latest/index.html) or [this repo's GitHub Pages site](https://datastax.github.io/kaap/docs/).
## Resources
For more, see the [DataStax Streaming Documentation](https://docs.datastax.com/en/streaming/kaap-operator/latest/index.html) or [this repo's GitHub Pages site](https://datastax.github.io/kaap/docs/).