From 4d71b60d3d7fa9b6a8bcc920a2f2e7d563e32179 Mon Sep 17 00:00:00 2001 From: Chinmayi Chandrasekar Date: Mon, 6 Sep 2021 16:58:09 +0530 Subject: [PATCH] BZ1904396: add reference info for the machine approver and the config operators --- modules/cluster-config-operator.adoc | 21 +++++++++++++++++++ .../cluster-machine-approver-operator.adoc | 21 +++++++++++++++++++ operators/operator-reference.adoc | 2 ++ 3 files changed, 44 insertions(+) create mode 100644 modules/cluster-config-operator.adoc create mode 100644 modules/cluster-machine-approver-operator.adoc diff --git a/modules/cluster-config-operator.adoc b/modules/cluster-config-operator.adoc new file mode 100644 index 0000000000..a2635eb7f3 --- /dev/null +++ b/modules/cluster-config-operator.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * operators/operator-reference.adoc + +[id="cluster-config-operator_{context}"] += Cluster Config Operator + +[discrete] +== Purpose + +The Cluster Config Operator performs the following tasks related to `config.openshift.io`: + +* Creates CRDs. +* Renders the initial custom resources. +* Handles migrations. + + +[discrete] +== Project + +link:https://github.com/openshift/cluster-config-operator[cluster-config-operator] diff --git a/modules/cluster-machine-approver-operator.adoc b/modules/cluster-machine-approver-operator.adoc new file mode 100644 index 0000000000..e1a3953c68 --- /dev/null +++ b/modules/cluster-machine-approver-operator.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * operators/operator-reference.adoc + +[id="cluster-machine-approver-operator_{context}"] += Cluster Machine Approver Operator + +[discrete] +== Purpose + +The Cluster Machine Approver Operator automatically approves the CSRs requested for a new worker node after cluster installation. + +[NOTE] +==== +For the control plane node, the `approve-csr` service on the bootstrap node automatically approves all CSRs during the cluster bootstrapping phase. +==== + +[discrete] +== Project + +link:https://github.com/openshift/cluster-machine-approver[cluster-machine-approver-operator] diff --git a/operators/operator-reference.adoc b/operators/operator-reference.adoc index 40c2ad123a..a7950ae1ba 100644 --- a/operators/operator-reference.adoc +++ b/operators/operator-reference.adoc @@ -13,9 +13,11 @@ include::modules/cloud-credential-operator.adoc[leveloffset=+1] * xref:../rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[CredentialsRequest custom resource] * xref:../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc[About the Cloud Credential Operator] +include::modules/cluster-config-operator.adoc[leveloffset=+1] include::modules/cluster-authentication-operator.adoc[leveloffset=+1] include::modules/cluster-autoscaler-operator.adoc[leveloffset=+1] include::modules/cluster-image-registry-operator.adoc[leveloffset=+1] +include::modules/cluster-machine-approver-operator.adoc[leveloffset=+1] include::modules/cluster-monitoring-operator.adoc[leveloffset=+1] include::modules/cluster-network-operator.adoc[leveloffset=+1] include::modules/cluster-openshift-controller-manager-operators.adoc[leveloffset=+1]