From d045a6794f28f1b36908552221693dd214735724 Mon Sep 17 00:00:00 2001 From: Alex Dellapenta Date: Mon, 27 Apr 2020 01:46:10 -0400 Subject: [PATCH] Add Unmanaged Operators support statement --- architecture/architecture-installation.adoc | 4 +- modules/unmanaged-operators.adoc | 56 ++++++++++++++++++++ modules/update-service-overview.adoc | 3 ++ updating/updating-cluster-between-minor.adoc | 3 ++ updating/updating-cluster-cli.adoc | 3 ++ updating/updating-cluster-rhel-compute.adoc | 3 ++ updating/updating-cluster.adoc | 3 ++ 7 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 modules/unmanaged-operators.adoc diff --git a/architecture/architecture-installation.adoc b/architecture/architecture-installation.adoc index 64e6c8868d..dcc842019f 100644 --- a/architecture/architecture-installation.adoc +++ b/architecture/architecture-installation.adoc @@ -6,4 +6,6 @@ toc::[] include::modules/installation-overview.adoc[leveloffset=+1] -include::modules/update-service-overview.adoc[leveloffset=+1] \ No newline at end of file +include::modules/update-service-overview.adoc[leveloffset=+1] + +include::modules/unmanaged-operators.adoc[leveloffset=+1] diff --git a/modules/unmanaged-operators.adoc b/modules/unmanaged-operators.adoc new file mode 100644 index 0000000000..112c0fab85 --- /dev/null +++ b/modules/unmanaged-operators.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * architecture/architecture-installation.adoc +// * updating/updating-cluster-between-minor.adoc + +[id="unmanaged-operators_{context}"] += Support policy for unmanaged Operators + +The _management state_ of an Operator determines whether an Operator is actively +managing the resources for its related component in the cluster as designed. If +an Operator is set to an _unmanaged_ state, it does not respond to changes in +configuration nor does it receive updates. + +While this can be helpful in non-production clusters or during debugging, +Operators in an unmanaged state are unsupported and the cluster administrator +assumes full control of the individual component configurations and upgrades. + +An Operator can be set to an unmanaged state using the following methods: + +* **Individual Operator configuration** ++ +Individual Operators have a `managementState` parameter in their configuration. +This can be accessed in different ways, depending on the Operator. For example, +the Cluster Logging Operator accomplishes this by modifying a Custom Resource +(CR) that it manages, while the Samples Operator uses a cluster-wide +configuration resource. ++ +Changing the `managementState` parameter to `Unmanaged` means that the Operator +is not actively managing its resources and will take no action related to the +related component. Some Operators might not support this management state as it +might damage the cluster and require manual recovery. ++ +[WARNING] +==== +Changing individual Operators to the `Unmanaged` state renders that particular +component and functionality unsupported. Reported issues must be reproduced in +`Managed` state for support to proceed. +==== + +* **Cluster Version Operator (CVO) overrides** ++ +The `spec.overrides` parameter can be added to the CVO's configuration to allow +administrators to provide a list of overrides to the CVO's behavior for a +component. Setting the `spec.overrides[].unmanaged` parameter to `true` for a +component blocks cluster upgrades and alerts the administrator after a CVO +override has been set: ++ +---- +Disabling ownership via cluster version overrides prevents upgrades. Please remove overrides before continuing. +---- ++ +[WARNING] +==== +Setting a CVO override puts the entire cluster in an unsupported state. Reported +issues must be reproduced after removing any overrides for support to proceed. +==== diff --git a/modules/update-service-overview.adoc b/modules/update-service-overview.adoc index e1d6b333c3..b57e0e2965 100644 --- a/modules/update-service-overview.adoc +++ b/modules/update-service-overview.adoc @@ -1,9 +1,12 @@ // Module included in the following assemblies: // // * architecture/architecture-installation.adoc +// * architecture/control-plane.adoc +// * updating/updating-cluster-between-minor.adoc // * updating/updating-cluster-cli.adoc // * updating/updating-cluster-rhel-compute.adoc // * updating/updating-cluster.adoc +// * updating/updating-disconnected-cluster.adoc [id="update-service-overview_{context}"] = About the {product-title} update service diff --git a/updating/updating-cluster-between-minor.adoc b/updating/updating-cluster-between-minor.adoc index 920f805b25..b065a55bfb 100644 --- a/updating/updating-cluster-between-minor.adoc +++ b/updating/updating-cluster-between-minor.adoc @@ -29,6 +29,9 @@ After this one-time manual restart, subsequent upgrades and rotations will ensur ==== include::modules/update-service-overview.adoc[leveloffset=+1] +.Additional resources + +* xref:../architecture/architecture-installation.adoc#unmanaged-operators_architecture-installation[Support policy for unmanaged Operators] include::modules/understanding-upgrade-channels.adoc[leveloffset=+1] diff --git a/updating/updating-cluster-cli.adoc b/updating/updating-cluster-cli.adoc index 8a320bc024..bb25669b11 100644 --- a/updating/updating-cluster-cli.adoc +++ b/updating/updating-cluster-cli.adoc @@ -14,6 +14,9 @@ See xref:../authentication/using-rbac.adoc[Using RBAC to define and apply permis * Have a recent xref:../backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd backup] in case your upgrade fails and you must xref:../backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore your cluster to a previous state]. include::modules/update-service-overview.adoc[leveloffset=+1] +.Additional resources + +* xref:../architecture/architecture-installation.adoc#unmanaged-operators_architecture-installation[Support policy for unmanaged Operators] include::modules/understanding-upgrade-channels.adoc[leveloffset=+1] diff --git a/updating/updating-cluster-rhel-compute.adoc b/updating/updating-cluster-rhel-compute.adoc index 59517643b4..b762daadeb 100644 --- a/updating/updating-cluster-rhel-compute.adoc +++ b/updating/updating-cluster-rhel-compute.adoc @@ -26,6 +26,9 @@ After this one-time manual restart, subsequent upgrades and rotations will ensur ==== include::modules/update-service-overview.adoc[leveloffset=+1] +.Additional resources + +* xref:../architecture/architecture-installation.adoc#unmanaged-operators_architecture-installation[Support policy for unmanaged Operators] include::modules/understanding-upgrade-channels.adoc[leveloffset=+1] diff --git a/updating/updating-cluster.adoc b/updating/updating-cluster.adoc index db81a74a19..fa9eee594f 100644 --- a/updating/updating-cluster.adoc +++ b/updating/updating-cluster.adoc @@ -14,6 +14,9 @@ See xref:../authentication/using-rbac.adoc[Using RBAC to define and apply permis * Have a recent xref:../backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd backup] in case your upgrade fails and you must xref:../backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore your cluster to a previous state]. include::modules/update-service-overview.adoc[leveloffset=+1] +.Additional resources + +* xref:../architecture/architecture-installation.adoc#unmanaged-operators_architecture-installation[Support policy for unmanaged Operators] include::modules/understanding-upgrade-channels.adoc[leveloffset=+1]