Skip to content

Commit ddad707

Browse files
authored
Merge pull request #91058 from openshift-cherrypick-robot/cherry-pick-90659-to-service-mesh-docs-3.0
[service-mesh-docs-3.0] OSSM-8733 Add IstioRevisionTags to list of OSSM resources
2 parents d05533e + 7a37e3d commit ddad707

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

modules/ossm-about-concepts-resources.adoc

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77

88
{SMProductName} Operator manages the lifecycle of your Istio control planes. Instead of creating a new configuration schema, {SMProduct} Operator APIs are built around Istio's Helm chart APIs.
99

10-
//All installation and configuration options that are exposed by Istio's Helm charts are available through the {SMProduct} Operator Custom Resource Definition (CRD) `values` fields.
11-
1210
[NOTE]
1311
====
1412
* Though {SMProductName} APIs are built around Istio's Helm chart APIs, Helm charts are not supported.
@@ -78,6 +76,35 @@ You can think of the relationship between the `Istio` and `IstioRevision` resour
7876

7977
Similarly, users create an `Istio` resource which instructs the {SMProduct} Operator to create a matching `IstioRevision` resource, which then in turn triggers the creation of the Istio control plane. To do that, the {SMProduct} Operator will copy all of your relevant configuration from the `Istio` resource to the `IstioRevision` resource.
8078

79+
[id="istiorevisiontag-resource_{context}"]
80+
== IstioRevisionTag resource
81+
82+
The `IstioRevisionTag` resource represents a stable revision tag that functions as an alias for Istio control plane revisions. With the stable tag, `prod`, you can use the label `istio.io/rev=prod` to inject proxies into your workloads. When you perform an upgrade to a control plane with a new revision name, you can update your tag to point to the new revision instead of having to relabel your workloads and namespaces. For more information, see link:https://istio.io/latest/docs/setup/upgrade/canary/#stable-revision-labels[Stable revision labels] (Istio documentation).
83+
84+
You can use the `IstioRevisionTag` resource with the {SMProduct} Operator. Therefore you can reference both an `IstioRevision` and an `Istio` resource. When using an `Istio` resource, after you update your control plane, the underlying `IstioRevision` resource changes, and the {SMProduct} Operator automatically updates your revision tag. You only need to restart your deployments to re-inject the new proxies.
85+
86+
The `IstioRevisionTag` has one field in its `spec:` field, `targetRef`, which can reference an `Istio` or `IstioRevision` resource. After deploying the `IstioRevisionTag`, you can use both the `istio.io/rev=default` and `istio-injection=enabled` labels to inject proxies into your workloads.
87+
88+
[Important]
89+
====
90+
The `istio-injection` label can only be used for revisions and revision tags that have the name `default`, like the `IstioRevisionTag` resource in the following example:
91+
92+
.Example `IstioRevisionTag` resource
93+
[source,yaml]
94+
----
95+
apiVersion: sailoperator.io/v1
96+
kind: IstioRevisionTag
97+
metadata:
98+
name: default
99+
spec:
100+
targetRef:
101+
kind: Istio <1>
102+
name: prod <2>
103+
----
104+
<1> This value can be either `Istio` or `IstioRevision`.
105+
<2> The name of the `Istio` or `IstioRevision` resource.
106+
====
107+
81108
[id="istiocni-resource_{context}"]
82109
== IstioCNI resource
83110

@@ -102,9 +129,11 @@ spec:
102129
- kube-system
103130
----
104131

105-
//[role=_additional-resources]
132+
//commenting out in case it is needed when more resources are added
133+
//[role="_additional-resources"]
134+
//[id="additional-resources_{context}"]
106135
//== Additional resources
107-
//builds keep failing due to xrefs so removed until this gets merged. May return to this prior to OSSM 3.x GA.
136+
108137

109138
//== Kiali --> own module
110139
//== Tracing --> own module

0 commit comments

Comments
 (0)