Skip to content

Commit 955db23

Browse files
committed
Add docs on setting HA for Eventing
Lowercase "serverless-HA.adoc" and all references to it Serving & Eventing: improve screenshots for changing replicas # in YAML Add docs on setting HA for Kafka Include the setting HA for Kafka module Improve wording Give more precise info, remove stale files, improve wording Remove claim that HA can be disabled; improve style Update the list of components scaled with HA Add intros to modules, make info more precise, improve wording Delete a rogue old assembly
1 parent 714d01e commit 955db23

12 files changed

+128
-9
lines changed

images/eventing-YAML-HA.png

175 KB
Loading

images/eventing-tab-created.png

31 KB
Loading

images/kafka-YAML-HA.png

157 KB
Loading
100 KB
Loading

images/kafka-tab-created.png

85.6 KB
Loading

images/serving-YAML-HA.png

1.6 KB
Loading
16 KB
Loading

images/serving-tab-created.png

28.5 KB
Loading
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// serverless/serverless-ha.adoc
4+
5+
[id="serverless-config-replicas-eventing_{context}"]
6+
= Configuring high availability replicas for Eventing
7+
8+
You can scale Knative Eventing components by modifying the `spec.high-availability.replicas` value in the KnativeEventing custom resource.
9+
10+
.Prerequisites
11+
* You have access to an {product-title} cluster with cluster administrator permissions.
12+
* The {ServerlessOperatorName} and Knative Eventing are installed on your cluster.
13+
14+
.Procedure
15+
16+
. In the {product-title} web console *Administrator* perspective, navigate to *OperatorHub* -> *Installed Operators*.
17+
+
18+
image::serving-installed-operator.png[Installed Operators page]
19+
+
20+
. Select the `knative-eventing` namespace.
21+
+
22+
. Click *Knative Eventing* in the list of *Provided APIs* for the {ServerlessOperatorName} to go to the *Knative Eventing* tab.
23+
+
24+
image::eventing-tab-created.png[Knative Eventing tab]
25+
+
26+
. Click *knative-eventing*, then go to the *YAML* tab in the *knative-eventing* page.
27+
+
28+
image::eventing-YAML-HA.png[Knative Eventing YAML]
29+
+
30+
. Modify the number of replicas in the `KnativeEventing` CRD:
31+
+
32+
.Example YAML
33+
[source,yaml]
34+
----
35+
apiVersion: operator.knative.dev/v1alpha1
36+
kind: KnativeEventing
37+
metadata:
38+
name: knative-eventing
39+
namespace: knative-eventing
40+
spec:
41+
high-availability:
42+
replicas: 3 <1>
43+
----
44+
<1> Sets the number of replicas to `3`.
45+
+
46+
[IMPORTANT]
47+
====
48+
Do not modify any YAML contained inside the `config` field. Some of the configuration values in this field are injected by the {ServerlessOperatorName}, and modifying them will cause your deployment to become unsupported.
49+
====
50+
+
51+
* The `replicas` value sets the replica count for all HA controllers.
52+
* The default `replicas` value is `2`.
53+
* You can increase the number of replicas by changing the value to `3` or more.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[id="serverless-config-replicas-kafka_{context}"]
2+
= Configuring high availability replicas for Kafka
3+
4+
You can scale Knative Kafka components by modifying the `spec.high-availability.replicas` value in the KnativeKafka custom resource.
5+
6+
.Prerequisites
7+
* You have access to an {product-title} cluster with cluster administrator permissions.
8+
* The {ServerlessOperatorName} and Knative Kafka are installed on your cluster.
9+
10+
.Procedure
11+
12+
. In the {product-title} web console *Administrator* perspective, navigate to *OperatorHub* -> *Installed Operators*.
13+
+
14+
image::kafka-installed-operator.png[Installed Operators page]
15+
16+
. Select the `knative-eventing` namespace.
17+
+
18+
. Click *Knative Kafka* in the list of *Provided APIs* for the {ServerlessOperatorName} to go to the *Knative Kafka* tab.
19+
+
20+
image::kafka-tab-created.png[Knative Eventing tab]
21+
+
22+
. Click *knative-kafka*, then go to the *YAML* tab in the *knative-kafka* page.
23+
+
24+
image::kafka-YAML-HA.png[Knative Kafka YAML]
25+
+
26+
. Modify the number of replicas in the `KnativeKafka` CRD:
27+
+
28+
.Example YAML
29+
[source,yaml]
30+
----
31+
apiVersion: operator.serverless.openshift.io/v1alpha1
32+
kind: KnativeKafka
33+
metadata:
34+
name: knative-kafka
35+
namespace: knative-eventing
36+
spec:
37+
high-availability:
38+
replicas: 3 <1>
39+
----
40+
<1> Sets the number of replicas to `3`.
41+
+
42+
[IMPORTANT]
43+
====
44+
Do not modify any YAML contained inside the `config` field. Some of the configuration values in this field are injected by the {ServerlessOperatorName}, and modifying them will cause your deployment to become unsupported.
45+
====
46+
+
47+
* The `replicas` value sets the replica count for all HA controllers.
48+
* The default `replicas` value is `2`.
49+
* You can increase the number of replicas by changing the value to `3` or more.

0 commit comments

Comments
 (0)