From de3e3e1813c37c1345dfee4b8e1d7c233b305daa Mon Sep 17 00:00:00 2001 From: Stephan Feurer Date: Wed, 6 Sep 2023 16:24:17 +0200 Subject: [PATCH] Update documentation --- docs/modules/ROOT/pages/references/component-library.adoc | 4 ++++ docs/modules/ROOT/pages/references/parameters.adoc | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/references/component-library.adoc b/docs/modules/ROOT/pages/references/component-library.adoc index 004b4bd..f0ee01a 100644 --- a/docs/modules/ROOT/pages/references/component-library.adoc +++ b/docs/modules/ROOT/pages/references/component-library.adoc @@ -36,6 +36,8 @@ This function creates a `subscriptions.operators.coreos.com` resource in a names The result of this function can be used in the same way as resources created by `kube.libjsonnet`. +By default the components sets the nodeAffinity to infra nodes, this can be overwritten. See https://docs.openshift.com/container-platform/latest/nodes/scheduling/nodes-scheduler-node-affinity.html#nodes-scheduler-node-affinity-configuring-required_nodes-scheduler-node-affinity[Official Documentation] + -- .Arguments `instance`:: Name of the component instance in which to create the subscription @@ -63,6 +65,8 @@ When using this function, the caller is responsible to ensure that an `OperatorG The result of this function can be used in the same way as resources created by `kube.libjsonnet`. +By default the components sets the nodeAffinity to infra nodes, this can be overwritten. See https://docs.openshift.com/container-platform/latest/nodes/scheduling/nodes-scheduler-node-affinity.html#nodes-scheduler-node-affinity-configuring-required_nodes-scheduler-node-affinity[Official Documentation] + -- .Arguments `instance`:: Name of the component instance in which to create the subscription diff --git a/docs/modules/ROOT/pages/references/parameters.adoc b/docs/modules/ROOT/pages/references/parameters.adoc index eb2521e..67d83d4 100644 --- a/docs/modules/ROOT/pages/references/parameters.adoc +++ b/docs/modules/ROOT/pages/references/parameters.adoc @@ -20,7 +20,7 @@ default:: + [source,yaml] ---- -openshift.io/node-selector: node-role.kubernetes.io/infra= +openshift.io/node-selector: '' ---- Annotations to be applied to the created namespace. @@ -76,6 +76,7 @@ If this parameter is set to `true`, the component will allow using namespace nam This parameter allows users of the component to configure one subscription per instance. The component explicitly doesn't allow configuring multiple instances in the same namespace, since we've seen various issues with conflicting upgrades when multiple subscriptions are created in the same namespace, especially when `installPlanApproval=Manual` is required for some reason. +By default the components sets the nodeAffinity to infra nodes, this can be overwritten. See https://docs.openshift.com/container-platform/latest/nodes/scheduling/nodes-scheduler-node-affinity.html#nodes-scheduler-node-affinity-configuring-required_nodes-scheduler-node-affinity[Official Documentation] === `subscription.name`