Skip to content

Commit f872916

Browse files
authored
Add High availability documentation section for eventing (#6401)
I have copy-pasted from the Knative Serving documentation page the block as I found it missing when configuring it.
1 parent ba2c938 commit f872916

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/versioned/install/operator/configuring-eventing-cr.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,39 @@ spec:
301301
defaultBrokerClass: MTChannelBasedBroker
302302
```
303303

304+
## High availability
305+
306+
By default, Knative Eventing runs a single instance of each deployment. The `spec.high-availability` field allows you to configure the number of replicas for all deployments managed by the operator.
307+
308+
The following configuration specifies a replica count of 3 for the workloads:
309+
310+
```yaml
311+
apiVersion: operator.knative.dev/v1beta1
312+
kind: KnativeEventing
313+
metadata:
314+
name: knative-eventing
315+
namespace: knative-eventing
316+
spec:
317+
high-availability:
318+
replicas: 3
319+
```
320+
321+
The `replicas` field also configures the `HorizontalPodAutoscaler` resources based on the `spec.high-availability`. Let's say the operator includes the following HorizontalPodAutoscaler:
322+
323+
```yaml
324+
apiVersion: autoscaling/v2beta2
325+
kind: HorizontalPodAutoscaler
326+
metadata:
327+
...
328+
spec:
329+
minReplicas: 3
330+
maxReplicas: 5
331+
```
332+
333+
If you configure `replicas: 2`, which is less than `minReplicas`, the operator transforms `minReplicas` to `1`.
334+
335+
If you configure `replicas: 6`, which is more than `maxReplicas`, the operator transforms `maxReplicas` to `maxReplicas + (replicas - minReplicas)` which is `8`.
336+
304337
## Override system deployments
305338

306339
If you would like to override some configurations for a specific deployment, you can override the configuration by using `spec.deployments` in the CR.

0 commit comments

Comments
 (0)