Skip to content

Commit 15d2787

Browse files
committed
[SRVCOM-1829] Update structure and abstracts for HA docs
1 parent 860c82d commit 15d2787

File tree

6 files changed

+14
-39
lines changed

6 files changed

+14
-39
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3479,7 +3479,7 @@ Topics:
34793479
- Name: Serverless administrator metrics
34803480
File: serverless-admin-metrics
34813481
# HA
3482-
- Name: High availability on OpenShift Serverless
3482+
- Name: High availability
34833483
File: serverless-ha
34843484
- Name: Monitor
34853485
Dir: monitor

_topic_maps/_topic_map_osd.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Topics:
290290
File: serverless-ossm-setup
291291
- Name: Serverless administrator metrics
292292
File: serverless-admin-metrics
293-
- Name: High availability on OpenShift Serverless
293+
- Name: High availability
294294
File: serverless-ha
295295
- Name: Monitor
296296
Dir: monitor

modules/serverless-config-replicas-eventing.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@
66
[id="serverless-config-replicas-eventing_{context}"]
77
= Configuring high availability replicas for Knative Eventing
88

9-
You can scale Knative Eventing components by modifying the `spec.high-availability.replicas` value in the `KnativeEventing` custom resource (CR).
9+
High availability (HA) is available by default for the Knative Eventing `eventing-controller`, `eventing-webhook`, `imc-controller`, `imc-dispatcher`, `mt-broker-controller`, and `sugar-controller` components, which are configured to have two replicas each by default. You can change the number of replicas for these components by modifying the `spec.high-availability.replicas` value in the `KnativeEventing` custom resource (CR).
10+
11+
[NOTE]
12+
====
13+
For Knative Eventing, the `mt-broker-filter` and `mt-broker-ingress` deployments are not scaled by HA. If multiple deployments are needed, scale these components manually.
14+
====
1015

1116
.Prerequisites
1217

@@ -44,10 +49,5 @@ metadata:
4449
namespace: knative-eventing
4550
spec:
4651
high-availability:
47-
replicas: 3 <1>
52+
replicas: 3
4853
----
49-
<1> Sets the number of replicas to `3`.
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.

modules/serverless-config-replicas-kafka.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="serverless-config-replicas-kafka_{context}"]
77
= Configuring high availability replicas for Knative Kafka
88

9-
You can scale Knative Kafka components by modifying the `spec.high-availability.replicas` value in the `KnativeKafka` custom resource (CR).
9+
High availability (HA) is available by default for the Knative Kafka `kafka-controller` and `kafka-webhook-eventing` components, which are configured to have two each replicas by default. You can change the number of replicas for these components by modifying the `spec.high-availability.replicas` value in the `KnativeKafka` custom resource (CR).
1010

1111
.Prerequisites
1212

@@ -44,10 +44,5 @@ metadata:
4444
namespace: knative-eventing
4545
spec:
4646
high-availability:
47-
replicas: 3 <1>
47+
replicas: 3
4848
----
49-
<1> Sets the number of replicas to `3`.
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.

modules/serverless-config-replicas-serving.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="serverless-config-replicas-serving_{context}"]
77
= Configuring high availability replicas for Knative Serving
88

9-
You can scale Knative Serving components by modifying the `spec.high-availability.replicas` value in the `KnativeServing` custom resource (CR).
9+
High availability (HA) is available by default for the Knative Serving `activator`, `autoscaler`, `autoscaler-hpa`, `controller`, `webhook`, `kourier-control`, and `kourier-gateway` components, which are configured to have two replicas each by default. You can change the number of replicas for these components by modifying the `spec.high-availability.replicas` value in the `KnativeServing` custom resource (CR).
1010

1111
.Prerequisites
1212

@@ -44,10 +44,5 @@ metadata:
4444
namespace: knative-serving
4545
spec:
4646
high-availability:
47-
replicas: 3 <1>
47+
replicas: 3
4848
----
49-
<1> Sets the number of replicas to `3`.
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: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:_content-type: ASSEMBLY
22
include::_attributes/common-attributes.adoc[]
33
[id="serverless-ha"]
4-
= High availability on {ServerlessProductName}
4+
= High availability
55
:context: serverless-ha
66

77
toc::[]
@@ -11,21 +11,6 @@ High availability (HA) is a standard feature of Kubernetes APIs that helps to en
1111
HA in {ServerlessProductName} is available through leader election, which is enabled by default after the Knative Serving or Eventing control plane is installed. When using a leader election HA pattern, instances of controllers are already scheduled and running inside the cluster before they are required.
1212
These controller instances compete to use a shared resource, known as the leader election lock. The instance of the controller that has access to the leader election lock resource at any given time is called the leader.
1313

14-
[id="serverless-ha-configuring-replicas"]
15-
== Configuring high availability replicas on {ServerlessProductName}
16-
17-
High availability (HA) functionality is available by default on {ServerlessProductName} for Knative Serving, Knative Eventing, and Knative Kafka. These are the components scaled for each of them:
18-
19-
* Knative Serving: `activator`, `autoscaler`, `autoscaler-hpa`, `controller`, `webhook`, `kourier-control`, `kourier-gateway`.
20-
* Knative Eventing: `eventing-controller`, `eventing-webhook`, `imc-controller`, `imc-dispatcher`, `mt-broker-controller`, `sugar-controller`.
21-
* Knative Kafka: `kafka-ch-controller`, `kafka-controller-manager`, `kafka-webhook`.
22-
23-
These components are configured with two replicas by default.
24-
25-
For Knative Eventing, the `mt-broker-filter` and `mt-broker-ingress` deployments are not scaled by HA. If multiple deployments are needed, scale these components manually.
26-
27-
You modify the number of replicas that are created per component by changing the configuration of `spec.high-availability.replicas` in the KnativeServing custom resource (CR), the KnativeEventing CR, or the KnativeKafka CR.
28-
2914
include::modules/serverless-config-replicas-serving.adoc[leveloffset=+2]
3015
include::modules/serverless-config-replicas-eventing.adoc[leveloffset=+2]
3116
include::modules/serverless-config-replicas-kafka.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)