Skip to content

Commit 8182cf6

Browse files
authored
Merge pull request #42270 from abrennan89/SRVCOM-1701
SRVCOM-1701: General doc fixes and improvements to Operator docs
2 parents 6dbacf0 + 0bf6f03 commit 8182cf6

9 files changed

+24
-27
lines changed

modules/olm-deleting-operators-from-a-cluster-using-cli.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * operators/admin/olm-deleting-operators-from-a-cluster.adoc
4+
// * serverless/install/removing-openshift-serverless.adoc
45

56
:_content-type: PROCEDURE
67
[id="olm-deleting-operator-from-a-cluster-using-cli_{context}"]

modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * operators/admin/olm-deleting-operators-from-a-cluster.adoc
44
// * backup_and_restore/application_backup_and_restore/installing/uninstalling-oadp.adoc
5+
// * serverless/install/removing-openshift-serverless.adoc
56

67
:_content-type: PROCEDURE
78
[id="olm-deleting-operators-from-a-cluster-using-web-console_{context}"]

modules/olm-refresh-subs.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * support/troubleshooting/troubleshooting-operator-issues.adoc
4+
// * serverless/install/removing-openshift-serverless.adoc
45

56
:_content-type: PROCEDURE
67
[id="olm-refresh-subs_{context}"]

modules/serverless-config-replicas-eventing.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
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.
9+
You can scale Knative Eventing components by modifying the `spec.high-availability.replicas` value in the `KnativeEventing` custom resource (CR).
1010

1111
.Prerequisites
1212

@@ -25,7 +25,7 @@ You can scale Knative Eventing components by modifying the `spec.high-availabili
2525
+
2626
image::eventing-YAML-HA.png[Knative Eventing YAML]
2727

28-
. Modify the number of replicas in the `KnativeEventing` CRD:
28+
. Modify the number of replicas in the `KnativeEventing` CR:
2929
+
3030
.Example YAML
3131
[source,yaml]
@@ -41,11 +41,6 @@ spec:
4141
----
4242
<1> Sets the number of replicas to `3`.
4343
+
44-
[IMPORTANT]
45-
====
46-
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.
47-
====
48-
+
4944
* The `replicas` value sets the replica count for all HA controllers.
5045
* The default `replicas` value is `2`.
5146
* 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.
9+
You can scale Knative Kafka components by modifying the `spec.high-availability.replicas` value in the `KnativeKafka` custom resource (CR).
1010

1111
.Prerequisites
1212

@@ -25,7 +25,7 @@ You can scale Knative Kafka components by modifying the `spec.high-availability.
2525
+
2626
image::kafka-YAML-HA.png[Knative Kafka YAML]
2727

28-
. Modify the number of replicas in the `KnativeKafka` CRD:
28+
. Modify the number of replicas in the `KnativeKafka` CR:
2929
+
3030
.Example YAML
3131
[source,yaml]
@@ -41,11 +41,6 @@ spec:
4141
----
4242
<1> Sets the number of replicas to `3`.
4343
+
44-
[IMPORTANT]
45-
====
46-
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.
47-
====
48-
+
4944
* The `replicas` value sets the replica count for all HA controllers.
5045
* The default `replicas` value is `2`.
5146
* 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.
9+
You can scale Knative Serving components by modifying the `spec.high-availability.replicas` value in the `KnativeServing` custom resource (CR).
1010

1111
.Prerequisites
1212

@@ -25,7 +25,7 @@ You can scale Knative Serving components by modifying the `spec.high-availabilit
2525
+
2626
image::serving-YAML-HA.png[Knative Serving YAML]
2727

28-
. Modify the number of replicas in the `KnativeServing` CRD:
28+
. Modify the number of replicas in the `KnativeServing` CR:
2929
+
3030
.Example YAML
3131
[source,yaml]
@@ -41,11 +41,6 @@ spec:
4141
----
4242
<1> Sets the number of replicas to `3`.
4343
+
44-
[IMPORTANT]
45-
====
46-
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.
47-
====
48-
+
4944
* The `replicas` value sets the replica count for all HA controllers.
5045
* The default `replicas` value is `2`.
5146
* You can increase the number of replicas by changing the value to `3` or more.

serverless/install/install-serverless-operator.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,6 @@ Read the following information about supported configurations and prerequisites
1818

1919
* {ServerlessProductName} currently cannot be used in a multi-tenant configuration on a single cluster.
2020

21-
[IMPORTANT]
22-
====
23-
Before upgrading to the latest Serverless release, you must remove the community Knative Eventing Operator if you have previously installed it. Having the Knative Eventing Operator installed prevents you from being able to install the latest version of Knative Eventing using the {ServerlessOperatorName}.
24-
====
25-
2621
include::modules/serverless-cluster-sizing-req.adoc[leveloffset=+2]
2722

2823
[id="install-serverless-operator-scaling-with-machinesets"]

serverless/install/installing-knative-eventing.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,8 @@ This guide provides information about installing Knative Eventing using the defa
1313

1414
include::modules/serverless-install-eventing-web-console.adoc[leveloffset=+1]
1515
include::modules/serverless-install-eventing-yaml.adoc[leveloffset=+1]
16+
17+
[id="next-steps_installing-knative-eventing"]
18+
== Next steps
19+
20+
* If you want to use Knative services you can xref:../../serverless/install/installing-knative-serving.adoc#installing-knative-serving[install Knative Serving].

serverless/install/removing-openshift-serverless.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,16 @@ include::modules/serverless-uninstalling-knative-eventing.adoc[leveloffset=+1]
2222
[id="removing-openshift-serverless-removing-the-operator"]
2323
== Removing the {ServerlessOperatorName}
2424

25-
You can remove the {ServerlessOperatorName} from the host cluster by following the documentation on xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster].
25+
You can remove the {ServerlessOperatorName} from the host cluster by using the web console or the `oc` CLI.
26+
27+
[NOTE]
28+
====
29+
Before you can remove the {ServerlessOperatorName}, you must remove Knative Serving and Knative Eventing.
30+
====
31+
32+
include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+2]
33+
include::modules/olm-deleting-operators-from-a-cluster-using-cli.adoc[leveloffset=+2]
34+
include::modules/olm-refresh-subs.adoc[leveloffset=+2]
2635

2736
// deleting serverless CRDs
2837
include::modules/serverless-deleting-crds.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)