Skip to content

Commit 57077a8

Browse files
authored
Merge pull request #55590 from Amrita42/BZ2038282new
BZ2038282:adds correct definition of annotation
2 parents 88070c0 + 322154c commit 57077a8

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

modules/osdk-csv-manual-annotations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following table lists Operator metadata annotations that can be manually def
1818
|Provide custom resource definition (CRD) templates with a minimum set of configuration. Compatible UIs pre-fill this template for users to further customize.
1919

2020
|`operatorframework.io/initialization-resource`
21-
|Specify a single required custom resource that must be created at the time that the Operator is installed. Must include a template that contains a complete YAML definition.
21+
|Specify a single required custom resource by adding `operatorframework.io/initialization-resource` annotation to the cluster service version (CSV) during Operator installation. The user is then prompted to create the custom resource through a template provided in the CSV. Must include a template that contains a complete YAML definition.
2222

2323
|`operatorframework.io/suggested-namespace`
2424
|Set a suggested namespace where the Operator should be deployed.

modules/osdk-init-resource.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
An Operator might require the user to instantiate a custom resource before the Operator can be fully functional. However, it can be challenging for a user to determine what is required or how to define the resource.
1010

11-
As an Operator developer, you can specify a single required custom resource that must be created at the time that the Operator is installed by adding the `operatorframework.io/initialization-resource` annotation to the cluster service version (CSV). The annotation must include a template that contains a complete YAML definition that is required to initialize the resource during installation.
11+
As an Operator developer, you can specify a single required custom resource by adding `operatorframework.io/initialization-resource` to the cluster service version (CSV) during Operator installation. You are then prompted prompted to create the custom resource through a template that is provided in the CSV.
12+
The annotation must include a template that contains a complete YAML definition that is required to initialize the resource during installation.
1213

1314
If this annotation is defined, after installing the Operator from the {product-title} web console, the user is prompted to create the resource using the template provided in the CSV.
1415

0 commit comments

Comments
 (0)