Skip to content

Commit 560fd6e

Browse files
committed
Add quotes to Operator infra annotations
1 parent 4eee0c8 commit 560fd6e

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

modules/osdk-csv-annotations-infra.adoc

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
//
33
// * operators/operator_sdk/osdk-generating-csvs.adoc
44

5+
:_mod-docs-content-type: REFERENCE
56
[id="osdk-csv-annotations-infra_{context}"]
67
= Infrastructure features annotations
78

8-
Annotations in the `features.operators.openshift.io` group detail the infrastructure features that an Operator might support, specified by setting a `true` or `false` value. Users can view and filter by these features when discovering Operators through OperatorHub in the web console or on the link:https://catalog.redhat.com/software/search?deployed_as=Operator[Red Hat Ecosystem Catalog]. These annotations are supported in {product-title} 4.10 and later.
9+
Annotations in the `features.operators.openshift.io` group detail the infrastructure features that an Operator might support, specified by setting a `"true"` or `"false"` value. Users can view and filter by these features when discovering Operators through OperatorHub in the web console or on the link:https://catalog.redhat.com/software/search?deployed_as=Operator[Red Hat Ecosystem Catalog]. These annotations are supported in {product-title} 4.10 and later.
910

1011
[IMPORTANT]
1112
====
@@ -15,49 +16,53 @@ The `features.operators.openshift.io` infrastructure feature annotations depreca
1516
.Infrastructure features annotations
1617
[cols="4a,5a,3a,options="header"]
1718
|===
18-
|Annotation |Description |Valid values
19+
|Annotation |Description |Valid values^[1]^
1920

2021
|`features.operators.openshift.io/disconnected`
2122
|Specify whether an Operator leverages the `spec.relatedImages` CSV field and can run without an internet connection by referring to any related image by its digest.
22-
|`true` or `false`
23+
|`"true"` or `"false"`
2324

2425
|`features.operators.openshift.io/fips-compliant`
2526
|Specify whether an Operator accepts the FIPS-140 configuration of the underlying platform and works on nodes that are booted into FIPS mode. In this mode, the Operator and any workloads it manages (operands) are solely calling the {op-system-base-full} cryptographic library submitted for FIPS-140 validation.
26-
|`true` or `false`
27+
|`"true"` or `"false"`
2728

2829
|`features.operators.openshift.io/proxy-aware`
2930
|Specify whether an Operator supports running on a cluster behind a proxy by accepting the standard `HTTP_PROXY` and `HTTPS_PROXY` proxy environment variables. If applicable, the Operator passes this information to the workload it manages (operands).
30-
|`true` or `false`
31+
|`"true"` or `"false"`
3132

3233
|`features.operators.openshift.io/tls-profiles`
3334
|Specify whether an Operator implements well-known tunables to modify the TLS cipher suite used by the Operator and, if applicable, any of the workloads it manages (operands).
34-
|`true` or `false`
35+
|`"true"` or `"false"`
3536

3637
|`features.operators.openshift.io/token-auth-aws`
3738
|Specify whether an Operator supports configuration for tokenzied authentication with AWS APIs via AWS Secure Token Service (STS) by using the Cloud Credential Operator (CCO).
38-
|`true` or `false`
39+
|`"true"` or `"false"`
3940

4041
|`features.operators.openshift.io/token-auth-azure`
4142
|Specify whether an Operator supports configuration for tokenzied authentication with Azure APIs via Azure Managed Identity by using the Cloud Credential Operator (CCO).
42-
|`true` or `false`
43+
|`"true"` or `"false"`
4344

4445
|`features.operators.openshift.io/token-auth-gcp`
4546
|Specify whether an Operator supports configuration for tokenzied authentication with Google Cloud APIs via GCP Workload Identity Foundation (WIF) by using the Cloud Credential Operator (CCO).
46-
|`true` or `false`
47+
|`"true"` or `"false"`
4748

4849
|`features.operators.openshift.io/cnf`
4950
|Specify whether an Operator provides a Cloud-Native Network Function (CNF) Kubernetes plugin.
50-
|`true` or `false`
51+
|`"true"` or `"false"`
5152

5253
|`features.operators.openshift.io/cni`
5354
|Specify whether an Operator provides a Container Network Interface (CNI) Kubernetes plugin.
54-
|`true` or `false`
55+
|`"true"` or `"false"`
5556

5657
|`features.operators.openshift.io/csi`
5758
|Specify whether an Operator provides a Container Storage Interface (CSI) Kubernetes plugin.
58-
|`true` or `false`
59+
|`"true"` or `"false"`
5960

6061
|===
62+
[.small]
63+
--
64+
1. Valid values are shown intentionally with double quotes, because Kubernetes annotations must be strings.
65+
--
6166

6267
.Example CSV with infrastructure feature annotations
6368
[source,yaml]

0 commit comments

Comments
 (0)