Create IstioRevisionTag documentation #511

dgn · 2024-12-06T12:48:05Z

This adds a section to the README.md about the IstioRevisionTag API and updates the SEP. I also fixed some typos and minor problems in the existing docs.

codecov · 2024-12-06T12:57:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.30%. Comparing base (02d1c8a) to head (40da26f).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #511   +/-   ##
=======================================
  Coverage   78.30%   78.30%           
=======================================
  Files          38       38           
  Lines        2272     2272           
=======================================
  Hits         1779     1779           
  Misses        403      403           
  Partials       90       90

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Daniel Grimm <[email protected]>

istio-testing · 2024-12-10T14:14:09Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

FilipB · 2024-12-17T12:53:45Z

docs/README.md

+    name: prod    # the name of the Istio/IstioRevision resource
+```
+
+As you can see in the YAML above, `IstioRevisionTag` really only has one field in its spec: `targetRef`. With this field, you can reference an `Istio` or `IstioRevision` resource. So after deploying this, you will be able to use both the `istio.io/rev=default` and also `istio-injection=enabled` labels to inject proxies into your workloads. The `istio-injection` label can only be used for revisions named `default` - and this tag is called `default`.


"for revisions named default - and this tag is called default"
It might be a little bit confusing.
Maybe something like "can only be used for revisions named default or when you create a IstioRevisionTag named default."

FilipB · 2024-12-17T12:57:55Z

docs/README.md

+#### Conditions
+All resources have a `Ready` condition which is set to `true` as soon as all child resource have been created and are deemed Ready by their respective controllers. To see additional conditions for each of the resources, check the [API reference documentation](https://github.com/istio-ecosystem/sail-operator/tree/main/docs/api-reference/sailoperator.io.md).
+
+#### InUse Detection


Could you please add a few sentences when this is useful from user point of view?

Ah, ok, it's used in the example below. So maybe just one sentence: "See the example bellow for proper usage."

FilipB · 2024-12-17T13:04:28Z

docs/README.md

@@ -413,11 +449,11 @@ Steps:
 10. Verify the `Istio` and `IstioRevision` resources. There will be a new revision created with the new version.

    ```console
-    $ kubectl get istio -n istio-system
+    $ kubectl get istio


Why removing the namespace here?

FilipB · 2024-12-17T13:04:35Z

docs/README.md

    NAME      REVISIONS   READY   IN USE   ACTIVE REVISION   STATUS    VERSION   AGE
    default   2           2       1        default-v1-23-2   Healthy   v1.23.2   9m23s

-    $ kubectl get istiorevision -n istio-system
+    $ kubectl get istiorevision


Why removing the namespace here?

FilipB · 2024-12-17T13:30:03Z

docs/README.md

+      updateStrategy:
+        type: RevisionBased
+        inactiveRevisionDeletionGracePeriodSeconds: 30
+      version: v1.22.5


Suggested change

version: v1.22.5

version: v1.23.3

FilipB · 2024-12-17T13:30:43Z

docs/README.md

+    ```console
+    $ kubectl get istio
+    NAME      REVISIONS   READY   IN USE   ACTIVE REVISION   STATUS    VERSION   AGE
+    default   1           1       1        default-v1-22-5   Healthy   v1.22.5   52s


Suggested change

default 1 1 1 default-v1-22-5 Healthy v1.22.5 52s

default 1 1 1 default-v1-23-3 Healthy v1.23.3 52s

FilipB · 2024-12-17T13:31:47Z

docs/README.md

+    ```console
+    $ kubectl get istiorevisiontags
+    NAME      STATUS                    IN USE   REVISION          AGE
+    default   NotReferencedByAnything   False    default-v1-22-5   52s


Suggested change

default NotReferencedByAnything False default-v1-22-5 52s

default NotReferencedByAnything False default-v1-23-3 52s

FilipB · 2024-12-17T13:32:03Z

docs/README.md

+    ```console
+    $ kubectl get istiorevisiontag
+    NAME      STATUS    IN USE   REVISION          AGE
+    default   Healthy   True     default-v1-22-5   2m46s


Suggested change

default Healthy True default-v1-22-5 2m46s

default Healthy True default-v1-23-3 2m46s

FilipB · 2024-12-17T13:32:25Z

docs/README.md

+9. Update the control plane to a new version.
+
+    ```bash
+    kubectl patch istio default -n istio-system --type='merge' -p '{"spec":{"version":"v1.23.2"}}'


Suggested change

kubectl patch istio default -n istio-system --type='merge' -p '{"spec":{"version":"v1.23.2"}}'

kubectl patch istio default -n istio-system --type='merge' -p '{"spec":{"version":"v1.24.1"}}'

FilipB · 2024-12-17T13:32:44Z

docs/README.md

+    ```console
+    $ kubectl get istio
+    NAME      REVISIONS   READY   IN USE   ACTIVE REVISION   STATUS    VERSION   AGE
+    default   2           2       1        default-v1-23-2   Healthy   v1.23.2   9m23s


Suggested change

default 2 2 1 default-v1-23-2 Healthy v1.23.2 9m23s

default 2 2 1 default-v1-24-1 Healthy v1.24.1 9m23s

FilipB · 2024-12-17T13:33:03Z

docs/README.md

+
+    $ kubectl get istiorevision
+    NAME              TYPE    READY   STATUS    IN USE   VERSION   AGE
+    default-v1-22-5   Local   True    Healthy   True     v1.22.5   10m


Suggested change

default-v1-22-5 Local True Healthy True v1.22.5 10m

default-v1-23-3 Local True Healthy True v1.23.3 10m

FilipB · 2024-12-17T13:33:21Z

docs/README.md

+    $ kubectl get istiorevision
+    NAME              TYPE    READY   STATUS    IN USE   VERSION   AGE
+    default-v1-22-5   Local   True    Healthy   True     v1.22.5   10m
+    default-v1-23-2   Local   True    Healthy   True    v1.23.2   66s


Suggested change

default-v1-23-2 Local True Healthy True v1.23.2 66s

default-v1-24-1 Local True Healthy True v1.24.1 66s

FilipB · 2024-12-17T13:33:33Z

docs/README.md

+
+    $ kubectl get istiorevisiontag
+    NAME      STATUS    IN USE   REVISION          AGE
+    default   Healthy   True     default-v1-23-2   10m44s


Suggested change

default Healthy True default-v1-23-2 10m44s

default Healthy True default-v1-24-1 10m44s

FilipB · 2024-12-17T13:34:22Z

docs/README.md

+    NAME      STATUS    IN USE   REVISION          AGE
+    default   Healthy   True     default-v1-23-2   10m44s
+    ```
+    Now, both our IstioRevisions and the IstioRevisionTag are considered in use. The old revision default-v1-22-5 because it is being used by proxies, the new revision default-v1-23-2 because it is referenced by the tag, and lastly the tag because it is referenced by the bookinfo namespace.


Suggested change

Now, both our IstioRevisions and the IstioRevisionTag are considered in use. The old revision default-v1-22-5 because it is being used by proxies, the new revision default-v1-23-2 because it is referenced by the tag, and lastly the tag because it is referenced by the bookinfo namespace.

Now, both our IstioRevisions and the IstioRevisionTag are considered in use. The old revision default-v1-23-3 because it is being used by proxies, the new revision default-v1-24-1 because it is referenced by the tag, and lastly the tag because it is referenced by the bookinfo namespace.

FilipB · 2024-12-17T13:34:36Z

docs/README.md

+    ```console
+    $ kubectl get pods -n istio-system
+    NAME                                      READY   STATUS    RESTARTS   AGE
+    istiod-default-v1-22-5-c98fd9675-r7bfw    1/1     Running   0          10m


Suggested change

istiod-default-v1-22-5-c98fd9675-r7bfw 1/1 Running 0 10m

istiod-default-v1-23-3-c98fd9675-r7bfw 1/1 Running 0 10m

FilipB · 2024-12-17T13:34:48Z

docs/README.md

+    $ kubectl get pods -n istio-system
+    NAME                                      READY   STATUS    RESTARTS   AGE
+    istiod-default-v1-22-5-c98fd9675-r7bfw    1/1     Running   0          10m
+    istiod-default-v1-23-2-7495cdc7bf-v8t4g   1/1     Running   0          113s


Suggested change

istiod-default-v1-23-2-7495cdc7bf-v8t4g 1/1 Running 0 113s

istiod-default-v1-24-1-7495cdc7bf-v8t4g 1/1 Running 0 113s

FilipB · 2024-12-17T13:36:30Z

docs/README.md

+6. Deploy bookinfo application.
+
+    ```bash
+    kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/release-1.22/samples/bookinfo/platform/kube/bookinfo.yaml


Suggested change

kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/release-1.22/samples/bookinfo/platform/kube/bookinfo.yaml

kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/release-1.23/samples/bookinfo/platform/kube/bookinfo.yaml

dgn requested a review from a team as a code owner December 6, 2024 12:48

istio-testing added needs-rebase size/L labels Dec 6, 2024

dgn force-pushed the istiorevisiontag-docs branch from 91ee1df to 956cbb2 Compare December 6, 2024 12:50

istio-testing removed the needs-rebase label Dec 6, 2024

Create IstioRevisionTag documentation

40da26f

Signed-off-by: Daniel Grimm <[email protected]>

dgn force-pushed the istiorevisiontag-docs branch from 956cbb2 to 40da26f Compare December 6, 2024 13:59

istio-testing added the needs-rebase label Dec 10, 2024

FilipB reviewed Dec 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create IstioRevisionTag documentation #511

Create IstioRevisionTag documentation #511

dgn commented Dec 6, 2024

codecov bot commented Dec 6, 2024 •

edited

Loading

istio-testing commented Dec 10, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024 •

edited

Loading

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

FilipB Dec 17, 2024

	default 1 1 1 default-v1-22-5 Healthy v1.22.5 52s
	default 1 1 1 default-v1-23-3 Healthy v1.23.3 52s

	default NotReferencedByAnything False default-v1-22-5 52s
	default NotReferencedByAnything False default-v1-23-3 52s

	default Healthy True default-v1-22-5 2m46s
	default Healthy True default-v1-23-3 2m46s

	kubectl patch istio default -n istio-system --type='merge' -p '{"spec":{"version":"v1.23.2"}}'
	kubectl patch istio default -n istio-system --type='merge' -p '{"spec":{"version":"v1.24.1"}}'

	default 2 2 1 default-v1-23-2 Healthy v1.23.2 9m23s
	default 2 2 1 default-v1-24-1 Healthy v1.24.1 9m23s

	default-v1-22-5 Local True Healthy True v1.22.5 10m
	default-v1-23-3 Local True Healthy True v1.23.3 10m

	default-v1-23-2 Local True Healthy True v1.23.2 66s
	default-v1-24-1 Local True Healthy True v1.24.1 66s

	default Healthy True default-v1-23-2 10m44s
	default Healthy True default-v1-24-1 10m44s

	Now, both our IstioRevisions and the IstioRevisionTag are considered in use. The old revision default-v1-22-5 because it is being used by proxies, the new revision default-v1-23-2 because it is referenced by the tag, and lastly the tag because it is referenced by the bookinfo namespace.
	Now, both our IstioRevisions and the IstioRevisionTag are considered in use. The old revision default-v1-23-3 because it is being used by proxies, the new revision default-v1-24-1 because it is referenced by the tag, and lastly the tag because it is referenced by the bookinfo namespace.

	istiod-default-v1-22-5-c98fd9675-r7bfw 1/1 Running 0 10m
	istiod-default-v1-23-3-c98fd9675-r7bfw 1/1 Running 0 10m

	istiod-default-v1-23-2-7495cdc7bf-v8t4g 1/1 Running 0 113s
	istiod-default-v1-24-1-7495cdc7bf-v8t4g 1/1 Running 0 113s

	kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/release-1.22/samples/bookinfo/platform/kube/bookinfo.yaml
	kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/release-1.23/samples/bookinfo/platform/kube/bookinfo.yaml

Create IstioRevisionTag documentation #511

Are you sure you want to change the base?

Create IstioRevisionTag documentation #511

Conversation

dgn commented Dec 6, 2024

codecov bot commented Dec 6, 2024 • edited Loading

Codecov Report

istio-testing commented Dec 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FilipB Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Dec 6, 2024 •

edited

Loading

FilipB Dec 17, 2024 •

edited

Loading