Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephan Feurer committed Sep 6, 2023
1 parent a45653f commit de3e3e1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/modules/ROOT/pages/references/component-library.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/references/parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`

Expand Down

0 comments on commit de3e3e1

Please sign in to comment.