Skip to content

Commit 24cd3a8

Browse files
authored
DOC-5439 doc cleanup (#32)
* unify nav, remove unused files, etc * peer review and more syntax
1 parent efcc069 commit 24cd3a8

22 files changed

Lines changed: 270 additions & 416 deletions

File tree

antora.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,7 @@ title: 'Kubernetes Autoscaling for Apache Pulsar'
44
start_page: 'index.adoc'
55

66
nav:
7-
- modules/getting-started/nav.adoc
8-
- modules/migration/nav.adoc
9-
- modules/authentication/nav.adoc
10-
- modules/scaling-components/nav.adoc
11-
- modules/resource-sets/nav.adoc
12-
- modules/crd-spec/nav.adoc
7+
- modules/ROOT/nav.adoc
138

149
asciidoc:
1510
attributes:

modules/ROOT/nav.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.Get started
2+
* xref:ROOT:index.adoc[]
3+
* xref:getting-started:index.adoc[]
4+
* xref:getting-started:operator.adoc[]
5+
* xref:getting-started:stack.adoc[]
6+
* xref:getting-started:upgrades.adoc[]
7+
* xref:getting-started:upgrade-0-2-0.adoc[]
8+
9+
.Migrate
10+
* xref:migration:migrate-cluster.adoc[]
11+
12+
.Authentication
13+
* xref:authentication:index.adoc[]
14+
* xref:authentication:auth-jwt.adoc[]
15+
* xref:authentication:auth-tls.adoc[]
16+
17+
.Scaling components
18+
* xref:scaling-components:index.adoc[]
19+
* xref:scaling-components:autoscale-bookies.adoc[]
20+
* xref:scaling-components:autoscale-brokers.adoc[]
21+
* xref:scaling-components:kafka.adoc[]
22+
23+
.Resource sets
24+
* xref:resource-sets:index.adoc[]
25+
* xref:resource-sets:bookies.adoc[]
26+
* xref:resource-sets:pods.adoc[]
27+
* xref:resource-sets:proxies.adoc[]
28+
* xref:resource-sets:racks.adoc[]
29+
30+
.CRD spec
31+
* xref:crd-spec:Autorecovery.openapi.adoc[]
32+
* xref:crd-spec:Bastion.openapi.adoc[]
33+
* xref:crd-spec:BookKeeper.openapi.adoc[]
34+
* xref:crd-spec:Broker.openapi.adoc[]
35+
* xref:crd-spec:FunctionsWorker.openapi.adoc[]
36+
* xref:crd-spec:Proxy.openapi.adoc[]
37+
* xref:crd-spec:PulsarCluster.openapi.adoc[]
38+
* xref:crd-spec:ZooKeeper.openapi.adoc[]

modules/ROOT/pages/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= {pulsar-operator-full-name}
2+
:navtitle: About {pulsar-operator-full-name}
23

34
{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.
45

modules/authentication/nav.adoc

Lines changed: 0 additions & 4 deletions
This file was deleted.

modules/crd-spec/nav.adoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

modules/crd-spec/partials/functionworker.adoc

Lines changed: 0 additions & 17 deletions
This file was deleted.

modules/crd-spec/partials/pulsarCluster.adoc

Lines changed: 0 additions & 14 deletions
This file was deleted.

modules/getting-started/nav.adoc

Lines changed: 0 additions & 6 deletions
This file was deleted.

modules/getting-started/pages/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Getting started
1+
= Get started
22

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

Lines changed: 28 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
= Install {pulsar-operator} Helm chart
22

3-
// Operator Hub
4-
// The install will be updated when chart is available publicly
5-
63
{pulsar-operator} is installed using Helm.
74
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.
85

96
[#operator]
107
== Install {pulsar-operator}
8+
119
Install the DataStax Helm repository:
10+
1211
[source,shell]
1312
----
1413
helm repo add kaap https://datastax.github.io/kaap
1514
helm repo update
1615
----
1716

18-
. The KAAP Operator Helm chart is available for download https://github.com/datastax/kaap/releases/latest[here].
17+
. Download the https://github.com/datastax/kaap/releases/latest[KAAP Operator Helm chart].
18+
1919
. Install the KAAP operator Helm chart:
2020
+
2121
[source,shell]
@@ -29,45 +29,34 @@ STATUS: deployed
2929
REVISION: 1
3030
TEST SUITE: None
3131
----
32+
3233
. Ensure KAAP operator is up and running:
3334
+
34-
[tabs]
35-
====
36-
Kubectl::
37-
+
38-
--
3935
[source,shell]
4036
----
4137
kubectl get deployment
4238
----
43-
--
44-
45-
Result::
4639
+
47-
--
40+
.Result
41+
[%collapsible]
42+
====
4843
[source,console]
4944
----
5045
NAME READY UP-TO-DATE AVAILABLE AGE
5146
kaap 1/1 1 1 13m
5247
----
53-
--
5448
====
49+
5550
. Describe the deployment:
5651
+
57-
[tabs]
58-
====
59-
Kubectl::
60-
+
61-
--
6252
[source,shell]
6353
----
6454
kubectl describe deployment kaap
6555
----
66-
--
67-
68-
Result::
6956
+
70-
--
57+
.Result
58+
[%collapsible]
59+
====
7160
[source,console]
7261
----
7362
Name: kaap
@@ -95,7 +84,7 @@ Pod Template:
9584
prometheus.io/port: 8080
9685
prometheus.io/scheme: http
9786
prometheus.io/scrape: true
98-
Service Account: kaap
87+
Service Account: kaap
9988
Containers:
10089
kaap:
10190
Image: datastax/kaap:latest
@@ -106,7 +95,7 @@ Pod Template:
10695
Environment Variables from:
10796
kaap ConfigMap Optional: false
10897
Environment:
109-
KUBERNETES_NAMESPACE: (v1:metadata.namespace)
98+
KUBERNETES_NAMESPACE: (v1:metadata.namespace)
11099
Mounts: <none>
111100
Volumes: <none>
112101
Conditions:
@@ -121,30 +110,23 @@ Events:
121110
---- ------ ---- ---- -------
122111
Normal ScalingReplicaSet 2m5s deployment-controller Scaled up replica set kaap-76dfd8ddf9 to 1
123112
----
124-
--
125113
====
126-
127-
. You've now installed KAAP.
114+
+
115+
You've now installed KAAP.
128116
+
129117
By default, when KAAP is installed, the PulsarCluster CRDs are also created.
130118
This setting is defined in the Pulsar operator values.yaml file as `crd: create: true`.
119+
120+
. Get the available CRDs:
131121
+
132-
. To see the available CRDs:
133-
+
134-
[tabs]
135-
====
136-
Kubectl::
137-
+
138-
--
139122
[source,shell]
140123
----
141124
kubectl get crds | grep kaap
142125
----
143-
--
144-
145-
Result::
146126
+
147-
--
127+
.Result
128+
[%collapsible]
129+
====
148130
[source,console]
149131
----
150132
autorecoveries.kaap.oss.datastax.com 2023-05-12T16:35:59Z
@@ -156,35 +138,28 @@ proxies.kaap.oss.datastax.com 2023-05-12T16:36:02Z
156138
pulsarclusters.kaap.oss.datastax.com 2023-05-12T16:36:04Z
157139
zookeepers.kaap.oss.datastax.com 2023-05-12T16:36:06Z
158140
----
159-
--
160141
====
161142
162143
== Uninstall
163144
164-
To uninstall the {pulsar-operator}:
165-
[tabs]
166-
====
167-
Helm::
168-
+
169-
--
145+
Uninstall the {pulsar-operator}:
146+
170147
[source,shell]
171148
----
172149
helm uninstall kaap
173150
----
174-
--
175151
176-
Result::
177-
+
178-
--
152+
.Result
153+
[%collapsible]
154+
====
179155
[source,console]
180156
----
181157
release "kaap" uninstalled
182158
----
183-
--
184159
====
185160
186-
== What's next?
161+
== Next steps
187162
188163
* xref:authentication:index.adoc[]
189164
* xref:scaling-components:autoscale-bookies.adoc[]
190-
* xref:resource-sets:index.adoc[]
165+
* xref:resource-sets:index.adoc[]

0 commit comments

Comments
 (0)