mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
157 lines
3.5 KiB
Plaintext
157 lines
3.5 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * rest_api/understanding-api-support-tiers.adoc
|
|
|
|
:_mod-docs-content-type: REFERENCE
|
|
[id="api-support-tiers-mapping_{context}"]
|
|
= Mapping API tiers to API groups
|
|
|
|
For each API tier defined by Red Hat, we provide a mapping table for specific API groups where the upstream communities are committed to maintain forward compatibility. Any API group that does not specify an explicit compatibility level and is not specifically discussed below is assigned API tier 3 by default except for `v1alpha1` APIs which are assigned tier 4 by default.
|
|
|
|
[id="mapping-support-tiers-to-kubernetes-api-groups_{context}"]
|
|
== Support for Kubernetes API groups
|
|
|
|
API groups that end with the suffix `*.k8s.io` or have the form `version.<name>` with no suffix are governed by the Kubernetes deprecation policy and follow a general mapping between API version exposed and corresponding support tier unless otherwise specified.
|
|
|
|
[cols="2",options="header"]
|
|
|===
|
|
|API version example
|
|
|API tier
|
|
|
|
|`v1`
|
|
|Tier 1
|
|
|
|
|`v1beta1`
|
|
|Tier 2
|
|
|
|
|`v1alpha1`
|
|
|Tier 4
|
|
|
|
|===
|
|
|
|
ifndef::microshift[]
|
|
[id="mapping-support-tiers-to-openshift-api-groups_{context}"]
|
|
== Support for OpenShift API groups
|
|
|
|
API groups that end with the suffix `*.openshift.io` are governed by the {product-title} deprecation policy and follow a general mapping between API version exposed and corresponding compatibility level unless otherwise specified.
|
|
|
|
[cols="2",options="header"]
|
|
|===
|
|
|API version example
|
|
|API tier
|
|
|
|
|`apps.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`authorization.openshift.io/v1`
|
|
|Tier 1, some tier 1 deprecated
|
|
|
|
|`build.openshift.io/v1`
|
|
|Tier 1, some tier 1 deprecated
|
|
|
|
|`config.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`image.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`network.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`network.operator.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`oauth.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`imagecontentsourcepolicy.operator.openshift.io/v1alpha1`
|
|
|Tier 1
|
|
|
|
|`project.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`quota.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`route.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`quota.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`security.openshift.io/v1`
|
|
|Tier 1 except for `RangeAllocation` (tier 4) and `*Reviews` (tier 2)
|
|
|
|
|`template.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`console.openshift.io/v1`
|
|
|Tier 2
|
|
|
|
|===
|
|
endif::microshift[]
|
|
|
|
ifdef::microshift[]
|
|
[id="microshift-mapping-support-tiers-to-openshift-api-groups_{context}"]
|
|
== Support for OpenShift API groups
|
|
API groups that end with the suffix `*.openshift.io` are governed by the {product-title} deprecation policy and follow a general mapping between API version exposed and corresponding compatibility level unless otherwise specified.
|
|
|
|
[cols="2",options="header"]
|
|
|===
|
|
|API version example
|
|
|API tier
|
|
|
|
|`route.openshift.io/v1`
|
|
|Tier 1
|
|
|
|
|`security.openshift.io/v1`
|
|
|Tier 1 except for `RangeAllocation` (tier 4) and `*Reviews` (tier 2)
|
|
|
|
|===
|
|
endif::microshift[]
|
|
|
|
ifndef::microshift[]
|
|
[id="mapping-support-tiers-to-monitoring-api-groups_{context}"]
|
|
== Support for Monitoring API groups
|
|
|
|
API groups that end with the suffix `monitoring.coreos.com` have the following mapping:
|
|
|
|
[cols="2",options="header"]
|
|
|===
|
|
|API version example
|
|
|API tier
|
|
|
|
|`v1`
|
|
|Tier 1
|
|
|
|
|`v1alpha1`
|
|
|Tier 1
|
|
|
|
|`v1beta1`
|
|
|Tier 1
|
|
|
|
|===
|
|
endif::microshift[]
|
|
|
|
ifndef::microshift[]
|
|
[id="mapping-support-tiers-to-olm-api-groups_{context}"]
|
|
== Support for Operator Lifecycle Manager API groups
|
|
|
|
Operator Lifecycle Manager (OLM) provides APIs that include API groups with the suffix `operators.coreos.com`. These APIs have the following mapping:
|
|
|
|
[cols="2",options="header"]
|
|
|===
|
|
|API version example
|
|
|API tier
|
|
|
|
|`v2`
|
|
|Tier 1
|
|
|
|
|`v1`
|
|
|Tier 1
|
|
|
|
|`v1alpha1`
|
|
|Tier 1
|
|
|
|
|===
|
|
endif::microshift[] |