1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00

Add suggested namespace anno to CSV doc

This commit is contained in:
Alex Dellapenta
2020-04-23 23:47:16 -04:00
committed by openshift-cherrypick-robot
parent cd8b79db1d
commit 8a5d6096a7
2 changed files with 31 additions and 1 deletions

View File

@@ -0,0 +1,30 @@
// Module included in the following assemblies:
//
// * operators/operator_sdk/osdk-generating-csvs.adoc
[id="osdk-suggested-namespace_{context}"]
= Setting a suggested namespace
Some Operators must be deployed in a specific namespace, or with ancillary
resources in specific namespaces, in order to work properly. If resolved from a
Subscription, OLM defaults the namespaced resources of an Operator to the
namespace of its Subscription.
As an Operator author, you can instead express a desired target namespace as
part of your CSV to maintain control over the final namespaces of the resources
installed for their Operators. When adding the Operator to a cluster using
OperatorHub, this enables the web console to autopopulate the suggested
namespace for the cluster administrator during the installation process.
.Procedure
* In your CSV, set the `operatorframework.io/suggested-namespace` annotation to
your suggested namespace:
+
[source,yaml]
----
metadata:
annotations:
operatorframework.io/suggested-namespace: <namespace> <1>
----
<1> Set your suggested namespace.

View File

@@ -48,7 +48,7 @@ include::modules/osdk-manually-defined-csv-fields.adoc[leveloffset=+1]
include::modules/osdk-generating-a-csv.adoc[leveloffset=+1]
include::modules/olm-enabling-operator-restricted-network.adoc[leveloffset=+1]
include::modules/osdk-suggested-namespace.adoc[leveloffset=+1]
include::modules/osdk-crds.adoc[leveloffset=+1]
include::modules/osdk-owned-crds.adoc[leveloffset=+2]
include::modules/osdk-required-crds.adoc[leveloffset=+2]