Skip to content

Commit 0feab51

Browse files
committed
OSDOCS-16988-3-CQA1: CQA PR 3.2 for INSTALL-1: Core Installation Concepts and Customizations
1 parent b80b15e commit 0feab51

9 files changed

Lines changed: 73 additions & 82 deletions

installing/overview/cluster-capabilities.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,23 @@ include::snippets/capabilities-table.adoc[]
1818

1919
[role="_additional-resources"]
2020
.Additional resources
21+
2122
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations]
2223
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[Installing a cluster on {gcp-short} with customizations]
2324
2425
include::modules/explanation-of-capabilities.adoc[leveloffset=+1]
2526

2627
[role="_additional-resources"]
2728
.Additional resources
29+
2830
* xref:../../operators/operator-reference.adoc#cluster-operator-reference[Cluster Operators reference]
2931
3032
// Bare-metal capability
3133
include::modules/cluster-bare-metal-operator.adoc[leveloffset=+2]
3234

3335
[role="_additional-resources"]
3436
.Additional resources
37+
3538
* xref:../../installing/installing_bare_metal/ipi/ipi-install-overview.adoc#ipi-install-overview[Deploying installer-provisioned clusters on bare metal]
3639
* xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#preparing-to-install-on-bare-metal[Preparing for bare metal cluster installation]
3740
* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
@@ -47,51 +50,72 @@ include::modules/cloud-credential-operator.adoc[leveloffset=+2]
4750

4851
[role="_additional-resources"]
4952
.Additional resources
53+
5054
* xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator]
5155
5256
// Cluster Image Registry capability
5357
include::modules/cluster-image-registry-operator.adoc[leveloffset=+2]
5458

5559
[role="_additional-resources"]
5660
.Additional resources
61+
5762
* xref:../../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}]
5863
* xref:../../nodes/pods/nodes-pods-secrets.adoc#auto-generated-sa-token-secrets_nodes-pods-secrets[Automatically generated secrets]
64+
* link:https://github.com/openshift/cluster-image-registry-operator[cluster-image-registry-operator]
5965
6066
// Cluster storage capability
6167
include::modules/cluster-storage-operator.adoc[leveloffset=+2]
6268

69+
[role="_additional-resources"]
70+
.Additional resources
71+
72+
* link:https://github.com/openshift/cluster-storage-operator[cluster-storage-operator]
73+
6374
// Console capability
6475
include::modules/console-operator.adoc[leveloffset=+2]
6576

6677
[role="_additional-resources"]
6778
.Additional resources
79+
6880
* xref:../../web_console/web-console-overview.adoc#web-console-overview[Web console overview]
81+
* link:https://github.com/openshift/console-operator[console-operator]
6982
7083
// CSI snapshot controller capability
7184
include::modules/cluster-csi-snapshot-controller-operator.adoc[leveloffset=+2]
7285

7386
[role="_additional-resources"]
7487
.Additional resources
88+
7589
* xref:../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI volume snapshots]
90+
* link:https://github.com/openshift/cluster-csi-snapshot-controller-operator[cluster-csi-snapshot-controller-operator]
7691
7792
// DeploymentConfig capability
7893
include::modules/deployment-config-capability.adoc[leveloffset=+2]
7994

8095
// Ingress capability
8196
include::modules/ingress-operator.adoc[leveloffset=+2]
8297

98+
[role="_additional-resources"]
99+
.Additional resources
100+
101+
* link:https://github.com/openshift/cluster-ingress-operator[openshift-ingress-operator]
102+
83103
// Insights capability
84104
include::modules/insights-operator.adoc[leveloffset=+2]
85105

86106
[role="_additional-resources"]
87107
.Additional resources
108+
88109
* xref:../../support/remote_health_monitoring/using-insights-operator.adoc#using-insights-operator[Using {insights-operator}]
110+
* link:https://console.redhat.com/[{hybrid-console}]
111+
* link:https://github.com/openshift/insights-operator[insights-operator]
89112
90113
// Machine API capability
91114
include::modules/machine-api-capability.adoc[leveloffset=+2]
92115

93116
[role="_additional-resources"]
94117
.Additional resources
118+
95119
* xref:../../machine_management/index.adoc#index[Overview of machine management]
96120
* xref:../../operators/operator-reference.adoc#machine-api-operator_operator-reference[Machine API Operator]
97121
* xref:../../operators/operator-reference.adoc#cluster-autoscaler-operator_operator-reference[Cluster Autoscaler Operator]
@@ -102,34 +126,42 @@ include::modules/operator-marketplace.adoc[leveloffset=+2]
102126

103127
[role="_additional-resources"]
104128
.Additional resources
129+
105130
* xref:../../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red Hat-provided Operator catalogs]
131+
* link:https://github.com/operator-framework/operator-marketplace[operator-marketplace]
106132
107133
// Node Tuning capability
108134
include::modules/node-tuning-operator.adoc[leveloffset=+2]
109135

110136
[role="_additional-resources"]
111137
.Additional resources
138+
112139
* xref:../../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[Using the Node Tuning Operator]
140+
* link:https://github.com/openshift/cluster-node-tuning-operator[cluster-node-tuning-operator]
113141
114142
// OpenShift samples capability
115143
include::modules/cluster-samples-operator.adoc[leveloffset=+2]
116144

117145
[role="_additional-resources"]
118146
.Additional resources
147+
119148
* xref:../../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Configuring the Cluster Samples Operator]
149+
* link:https://github.com/openshift/cluster-samples-operator[cluster-samples-operator]
120150
121151
// OperatorLifecycleManager capability
122152
include::modules/olm-overview.adoc[leveloffset=+2]
123153

124154
[role="_additional-resources"]
125155
.Additional resources
156+
126157
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
127158
128159
// Operator Lifecycle Manager v1 capability
129160
include::modules/olmv1-clusteroperator.adoc[leveloffset=+2]
130161

131162
[role="_additional-resources"]
132163
.Additional resources
164+
133165
* xref:../../extensions/index.adoc#olmv1-about[Extensions overview]
134166
135167
include::modules/viewing-cluster-capabilities.adoc[leveloffset=+1]

modules/cluster-csi-snapshot-controller-operator.adoc

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,21 @@ endif::[]
1616
ifdef::operator-ref[= Cluster CSI Snapshot Controller Operator]
1717
ifdef::cluster-caps[= CSI snapshot controller capability]
1818

19+
[role="_abstract"]
1920
ifdef::operator-ref[]
20-
21-
[NOTE]
22-
====
2321
The Cluster CSI Snapshot Controller Operator is an optional cluster capability that can be disabled by cluster administrators during installation. For more information about optional cluster capabilities, see "Cluster capabilities" in _Installing_.
24-
====
25-
2622
endif::operator-ref[]
2723

2824
ifdef::cluster-caps[]
29-
3025
The Cluster CSI Snapshot Controller Operator provides the features for the `CSISnapshot` capability.
31-
3226
endif::cluster-caps[]
3327

3428
The Cluster CSI Snapshot Controller Operator installs and maintains the CSI Snapshot Controller. The CSI Snapshot Controller is responsible for watching the `VolumeSnapshot` CRD objects and manages the creation and deletion lifecycle of volume snapshots.
3529

3630
ifdef::operator-ref[]
37-
38-
39-
== Project
40-
41-
link:https://github.com/openshift/cluster-csi-snapshot-controller-operator[cluster-csi-snapshot-controller-operator]
42-
31+
Project::
32+
+
33+
`cluster-csi-snapshot-controller-operator`
4334
endif::operator-ref[]
4435

4536
ifeval::["{context}" == "operator-reference"]

modules/cluster-samples-operator.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,9 @@ endif::[]
1818
ifdef::operator-ref[= Cluster Samples Operator]
1919
ifdef::cluster-caps[= OpenShift samples capability]
2020

21+
[role="_abstract"]
2122
ifdef::operator-ref[]
22-
23-
[NOTE]
24-
====
2523
The Cluster Samples Operator is an optional cluster capability that can be disabled by cluster administrators during installation. For more information about optional cluster capabilities, see "Cluster capabilities" in _Installing_.
26-
====
27-
2824
endif::operator-ref[]
2925

3026
ifdef::cluster-caps[]
@@ -57,10 +53,9 @@ The samples resource includes a finalizer, which cleans up the following upon it
5753
5854
Upon deletion of the samples resource, the Cluster Samples Operator recreates the resource using the default configuration.
5955

60-
61-
== Project
62-
63-
link:https://github.com/openshift/cluster-samples-operator[cluster-samples-operator]
56+
Project::
57+
+
58+
`cluster-samples-operator`
6459
endif::operator-ref[]
6560

6661
ifeval::["{context}" == "operator-reference"]

modules/deployment-config-capability.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,11 @@
66
[id="deployment-config-capability_{context}"]
77
= DeploymentConfig capability
88

9-
10-
== Purpose
11-
9+
[role="_abstract"]
1210
The `DeploymentConfig` capability enables and manages the `DeploymentConfig` API.
1311

1412
[IMPORTANT]
1513
====
16-
1714
If you disable the `DeploymentConfig` capability, the following resources will not be available in the cluster:
1815
1916
* `DeploymentConfig` resources

modules/ingress-operator.adoc

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ endif::[]
1616
ifdef::operator-ref[= Ingress Operator]
1717
ifdef::cluster-caps[= Ingress Capability]
1818

19+
[role="_abstract"]
1920
ifdef::cluster-caps[]
2021
The Ingress Operator provides the features for the Ingress Capability. The Ingress Capability is enabled by default.
2122

@@ -24,25 +25,21 @@ The Ingress Operator provides the features for the Ingress Capability. The Ingre
2425
If you set the `baselineCapabilitySet` field to `None`, you must explicitly enable the Ingress Capability, because the installation of a cluster fails if the Ingress Capability is disabled.
2526
====
2627
endif::cluster-caps[]
27-
2828
The Ingress Operator configures and manages the {product-title} router.
2929

30+
Project::
31+
+
32+
`openshift-ingress-operator`
3033

31-
== Project
32-
33-
link:https://github.com/openshift/cluster-ingress-operator[openshift-ingress-operator]
34-
35-
36-
== CRDs
37-
34+
CRDs::
35+
+
3836
* `clusteringresses.ingress.openshift.io`
3937
** Scope: Namespaced
4038
** CR: `clusteringresses`
4139
** Validation: No
4240

43-
44-
== Configuration objects
45-
41+
Configuration objects::
42+
+
4643
* Cluster config
4744
** Type Name: `clusteringresses.ingress.openshift.io`
4845
** Instance Name: `default`
@@ -53,25 +50,24 @@ link:https://github.com/openshift/cluster-ingress-operator[openshift-ingress-ope
5350
$ oc get clusteringresses.ingress.openshift.io -n openshift-ingress-operator default -o yaml
5451
----
5552

56-
57-
== Notes
58-
53+
Notes::
54+
+
5955
The Ingress Operator sets up the router in the `openshift-ingress` project and creates the deployment for the router:
60-
56+
+
6157
[source,terminal]
6258
----
6359
$ oc get deployment -n openshift-ingress
6460
----
65-
61+
+
6662
The Ingress Operator uses the `clusterNetwork[].cidr` from the `network/cluster` status to determine what mode (IPv4, IPv6, or dual stack) the managed Ingress Controller (router) should operate in. For example, if `clusterNetwork` contains only a v6 `cidr`, then the Ingress Controller operates in IPv6-only mode.
67-
63+
+
6864
In the following example, Ingress Controllers managed by the Ingress Operator will run in IPv4-only mode because only one cluster network exists and the network is an IPv4 `cidr`:
69-
65+
+
7066
[source,terminal]
7167
----
7268
$ oc get network/cluster -o jsonpath='{.status.clusterNetwork[*]}'
7369
----
74-
70+
+
7571
.Example output
7672
[source,terminal]
7773
----

modules/insights-operator.adoc

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,29 @@ endif::[]
1616
ifdef::operator-ref[= Insights Operator]
1717
ifdef::cluster-caps[= Insights capability]
1818

19+
[role="_abstract"]
1920
ifdef::operator-ref[]
20-
21-
[NOTE]
22-
====
2321
The {insights-operator} is an optional cluster capability that can be disabled by cluster administrators during installation. For more information about optional cluster capabilities, see "Cluster capabilities" in _Installing_.
24-
====
25-
2622
endif::operator-ref[]
2723

2824
ifdef::cluster-caps[]
29-
3025
The {insights-operator} provides the features for the `Insights` capability.
31-
3226
endif::cluster-caps[]
3327

3428
The {insights-operator} gathers {product-title} configuration data and sends it to Red{nbsp}Hat. The data is used to produce proactive insights recommendations about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators through the {red-hat-lightspeed} advisor service on link:https://console.redhat.com/[console.redhat.com].
3529

3630
ifdef::operator-ref[]
31+
Project::
32+
+
33+
`insights-operator`
3734

38-
39-
== Project
40-
41-
link:https://github.com/openshift/insights-operator[insights-operator]
42-
43-
44-
== Configuration
45-
35+
Configuration::
36+
+
4637
No configuration is required.
47-
4838
endif::operator-ref[]
4939

50-
51-
== Notes
52-
40+
Notes::
41+
+
5342
{insights-operator} complements {product-title} Telemetry.
5443

5544
ifeval::["{context}" == "operator-reference"]

modules/machine-api-capability.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="machine-api-capability_{context}"]
77
= Machine API capability
88

9+
[role="_abstract"]
910
The `machine-api-operator`, `cluster-autoscaler-operator`, and `cluster-control-plane-machine-set-operator` Operators provide the features for the `MachineAPI` capability. You can disable this capability only if you install a cluster with user-provisioned infrastructure.
1011

1112
The Machine API capability is responsible for all machine configuration and management in the cluster. If you disable the Machine API capability during installation, you need to manage all machine-related tasks manually.

modules/node-tuning-operator.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,11 @@ ifdef::perf[]
2626

2727
endif::perf[]
2828
ifdef::cluster-caps[= Node Tuning capability]
29-
29+
[role="_abstract"]
3030
ifdef::cluster-caps[]
3131
The Node Tuning Operator provides features for the `NodeTuning` capability.
3232
endif::cluster-caps[]
3333
34-
[role="_abstract"]
3534
The Node Tuning Operator helps you manage node-level tuning by orchestrating the TuneD daemon and achieves low latency performance by using the Performance Profile controller. The majority of high-performance applications require some level of kernel tuning. The Node Tuning Operator provides a unified management interface to users of node-level sysctls and more flexibility to add custom tuning specified by user needs.
3635
3736
ifdef::cluster-caps[]
@@ -60,8 +59,7 @@ In earlier versions of {product-title}, the Performance Addon Operator was used
6059
endif::cluster-caps[]
6160
6261
ifdef::operators[]
63-
64-
== Project
65-
66-
link:https://github.com/openshift/cluster-node-tuning-operator[cluster-node-tuning-operator]
62+
Project::
63+
+
64+
`cluster-node-tuning-operator`
6765
endif::operators[]

0 commit comments

Comments
 (0)