Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,7 @@ title: 'Kubernetes Autoscaling for Apache Pulsar'
start_page: 'index.adoc'

nav:
- modules/getting-started/nav.adoc
- modules/migration/nav.adoc
- modules/authentication/nav.adoc
- modules/scaling-components/nav.adoc
- modules/resource-sets/nav.adoc
- modules/crd-spec/nav.adoc
- modules/ROOT/nav.adoc

asciidoc:
attributes:
Expand Down
37 changes: 37 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.Get started
* xref:ROOT:index.adoc[]
* xref:getting-started:index.adoc[]
* xref:getting-started:operator.adoc[]
* xref:getting-started:stack.adoc[]
* xref:getting-started:upgrades.adoc[]

.Migrate
* xref:migration:migrate-cluster.adoc[]

.Authentication
* xref:authentication:index.adoc[]
* xref:authentication:auth-jwt.adoc[]
* xref:authentication:auth-tls.adoc[]

.Scaling components
* xref:scaling-components:index.adoc[]
* xref:scaling-components:autoscale-bookies.adoc[]
* xref:scaling-components:autoscale-brokers.adoc[]
* xref:scaling-components:kafka.adoc[]

.Resource sets
* xref:resource-sets:index.adoc[]
* xref:resource-sets:bookies.adoc[]
* xref:resource-sets:pods.adoc[]
* xref:resource-sets:proxies.adoc[]
* xref:resource-sets:racks.adoc[]

.CRD spec
* xref:crd-spec:Autorecovery.openapi.adoc[]
* xref:crd-spec:Bastion.openapi.adoc[]
* xref:crd-spec:BookKeeper.openapi.adoc[]
* xref:crd-spec:Broker.openapi.adoc[]
* xref:crd-spec:FunctionsWorker.openapi.adoc[]
* xref:crd-spec:Proxy.openapi.adoc[]
* xref:crd-spec:PulsarCluster.openapi.adoc[]
* xref:crd-spec:ZooKeeper.openapi.adoc[]
1 change: 1 addition & 0 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= {pulsar-operator-full-name}
:navtitle: About {pulsar-operator-full-name}

{pulsar-operator-full-name} simplifies running https://pulsar.apache.org[Apache Pulsar] on Kubernetes by applying the familiar https://kubernetes.io/docs/concepts/extend-kubernetes/operator/[Operator pattern] to Pulsar's components, and horizonally scaling resources up or down based on CPU and memory workloads.

Expand Down
4 changes: 0 additions & 4 deletions modules/authentication/nav.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion modules/authentication/pages/auth-jwt.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= JWT authentication

To enable https://pulsar.apache.org/docs/2.11.x/security-jwt/[[JWT Authentication], set authentication to `true`:
To enable https://pulsar.apache.org/docs/2.11.x/security-jwt/[JWT Authentication], set authentication to `true`:
[source,yaml]
----
global:
Expand Down
9 changes: 0 additions & 9 deletions modules/crd-spec/nav.adoc

This file was deleted.

17 changes: 0 additions & 17 deletions modules/crd-spec/partials/functionworker.adoc

This file was deleted.

14 changes: 0 additions & 14 deletions modules/crd-spec/partials/pulsarCluster.adoc

This file was deleted.

5 changes: 0 additions & 5 deletions modules/getting-started/nav.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion modules/getting-started/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Getting started
= Get started

{pulsar-operator} can be installed in two ways.

Expand Down
73 changes: 23 additions & 50 deletions modules/getting-started/pages/operator.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
= Install {pulsar-operator} Helm chart

// Operator Hub
// The install will be updated when chart is available publicly

{pulsar-operator} is installed using Helm.
You can install just the operator and the PulsarCluster CRDs, or you can install xref:stack.adoc[Kaap Stack], which includes the operator, CRDs, and the Prometheus monitoring stack.

Expand All @@ -16,6 +13,7 @@ helm repo update
----

. The KAAP Operator Helm chart is available for download (https://github.com/datastax/kaap/releases/latest)[here].

. Install the KAAP operator Helm chart:
+
[source,shell]
Expand All @@ -29,45 +27,34 @@ STATUS: deployed
REVISION: 1
TEST SUITE: None
----

. Ensure KAAP operator is up and running:
+
[tabs]
====
Kubectl::
+
--
[source,shell]
----
kubectl get deployment
----
--

Result::
+
--
.Result
[%collapsible]
====
[source,console]
----
NAME READY UP-TO-DATE AVAILABLE AGE
kaap 1/1 1 1 13m
----
--
====

. Describe the deployment:
+
[tabs]
====
Kubectl::
+
--
[source,shell]
----
kubectl describe deployment kaap
----
--

Result::
+
--
.Result
[%collapsible]
====
[source,console]
----
Name: kaap
Expand Down Expand Up @@ -106,7 +93,7 @@ Pod Template:
Environment Variables from:
kaap ConfigMap Optional: false
Environment:
KUBERNETES_NAMESPACE: (v1:metadata.namespace)
KUBERNETES_NAMESPACE: (v1:metadata.namespace)
Mounts: <none>
Volumes: <none>
Conditions:
Expand All @@ -121,30 +108,23 @@ Events:
---- ------ ---- ---- -------
Normal ScalingReplicaSet 2m5s deployment-controller Scaled up replica set kaap-76dfd8ddf9 to 1
----
--
====

. You've now installed KAAP.
+
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`.

. Get the available CRDs:
+
. To see the available CRDs:
+
[tabs]
====
Kubectl::
+
--
[source,shell]
----
kubectl get crds | grep kaap
----
--

Result::
+
--
.Result
[%collapsible]
====
[source,console]
----
autorecoveries.kaap.oss.datastax.com 2023-05-12T16:35:59Z
Expand All @@ -156,34 +136,27 @@ 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 {pulsar-operator}:
[tabs]
====
Helm::
+
--
Uninstall the {pulsar-operator}:

[source,shell]
----
helm uninstall kaap
----
--

Result::
+
--
.Result
[%collapsible]
====
[source,console]
----
release "kaap" uninstalled
----
--
====

== What's next?
== Next steps

* xref:authentication:index.adoc[]
* xref:scaling-components:autoscale-bookies.adoc[]
Expand Down
Loading