Separate the part related to the annotation from the env. var. design.
@@ -72,26 +72,13 @@ worker nodes instead of master nodes.
### Design
-A cluster profile is specified to the CVO as an identifier in an environment
-variable. For a given cluster, only one CVO profile may be in effect.
-
-NOTE: The mechanism by which the environment variable is set on the CVO deployment is
-out of the scope of this design.
-
-```
-CLUSTER_PROFILE=[identifier]
-```
-This environment variable would have to be specified in the CVO deployment. When
-no `CLUSTER_PROFILE=[identifier]` variable is specified, the `default` cluster profile
-is in effect.
+#### Cluster profile annotation
The following annotation may be used to include manifests for a given profile:
```
include.release.openshift.io/[identifier]=true
```
-This would make the CVO render this manifest only when `CLUSTER_PROFILE=[identifier]`
-has been specified.
Manifests may support inclusion in multiple profiles by including as many of these annotations
as needed.
@@ -105,6 +92,24 @@ the required manifests while keeping a single master source.
The current installation profile is called `self-managed-high-availability`. All current
manifests must specify it. Future profiles may choose.
+#### Environment variable
+
+A cluster profile is specified to the CVO as an identifier in an environment
+variable. For a given cluster, only one CVO profile may be in effect.
+
+NOTE: The mechanism by which the environment variable is set on the CVO deployment is
+out of the scope of this design.
+
+```
+CLUSTER_PROFILE=[identifier]
+```
+This environment variable would have to be specified in the CVO deployment. When
+no `CLUSTER_PROFILE=[identifier]` variable is specified, the `default` cluster profile
+is in effect.
+
+`include.release.openshift.io/[identifier]=true` would make the CVO render this manifest only when `CLUSTER_PROFILE=[identifier]`
+has been specified.
+
## Implementation History
* Teach cluster-version operator about profiles, [cvo#404](https://github.com/openshift/cluster-version-operator/pull/404), in flight.
