mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
82 lines
4.2 KiB
Plaintext
82 lines
4.2 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * operators/operator_sdk/osdk-generating-csvs.adoc
|
|
|
|
:_mod-docs-content-type: REFERENCE
|
|
[id="osdk-csv-annotations-infra_{context}"]
|
|
= Infrastructure features annotations
|
|
|
|
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.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
The `features.operators.openshift.io` infrastructure feature annotations deprecate the `operators.openshift.io/infrastructure-features` annotations used in earlier versions of {product-title}. See "Deprecated infrastructure feature annotations" for more information.
|
|
====
|
|
|
|
.Infrastructure features annotations
|
|
[cols="4a,5a,3a,options="header"]
|
|
|===
|
|
|Annotation |Description |Valid values^[1]^
|
|
|
|
|`features.operators.openshift.io/disconnected`
|
|
|Specify whether an Operator supports being mirrored into disconnected catalogs, including all dependencies, and does not require internet access. The Operator leverages the `spec.relatedImages` CSV field to refer to any related image by its digest.
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/fips-compliant`
|
|
|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.
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/proxy-aware`
|
|
|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).
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/tls-profiles`
|
|
|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).
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/token-auth-aws`
|
|
|Specify whether an Operator supports configuration for tokenized authentication with AWS APIs via AWS Secure Token Service (STS) by using the Cloud Credential Operator (CCO).
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/token-auth-azure`
|
|
|Specify whether an Operator supports configuration for tokenized authentication with Azure APIs via Azure Managed Identity by using the Cloud Credential Operator (CCO).
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/token-auth-gcp`
|
|
|Specify whether an Operator supports configuration for tokenized authentication with Google Cloud APIs via GCP Workload Identity Foundation (WIF) by using the Cloud Credential Operator (CCO).
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/cnf`
|
|
|Specify whether an Operator provides a Cloud-Native Network Function (CNF) Kubernetes plugin.
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/cni`
|
|
|Specify whether an Operator provides a Container Network Interface (CNI) Kubernetes plugin.
|
|
|`"true"` or `"false"`
|
|
|
|
|`features.operators.openshift.io/csi`
|
|
|Specify whether an Operator provides a Container Storage Interface (CSI) Kubernetes plugin.
|
|
|`"true"` or `"false"`
|
|
|
|
|===
|
|
[.small]
|
|
--
|
|
1. Valid values are shown intentionally with double quotes, because Kubernetes annotations must be strings.
|
|
--
|
|
|
|
.Example CSV with infrastructure feature annotations
|
|
[source,yaml]
|
|
----
|
|
apiVersion: operators.coreos.com/v1alpha1
|
|
kind: ClusterServiceVersion
|
|
metadata:
|
|
annotations:
|
|
features.operators.openshift.io/disconnected: "true"
|
|
features.operators.openshift.io/fips-compliant: "false"
|
|
features.operators.openshift.io/proxy-aware: "false"
|
|
features.operators.openshift.io/tls-profiles: "false"
|
|
features.operators.openshift.io/token-auth-aws: "false"
|
|
features.operators.openshift.io/token-auth-azure: "false"
|
|
features.operators.openshift.io/token-auth-gcp: "false"
|
|
----
|