Skip to content

Commit

Permalink
Add section on rollouts CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
gnunn1 committed Oct 23, 2023
1 parent 98f38eb commit 035ef36
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 2 deletions.
1 change: 0 additions & 1 deletion documentation/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
* xref:03-bluegreen-rollout.adoc[3. Blue-Green Rollout]
** xref:03-bluegreen-rollout.adoc#deploy-blue-green-rollout[Deploy Blue-Green Rollout]
** xref:03-bluegreen-rollout.adoc#argo-rollouts-dashboard[Argo Rollouts Dashboard]
** xref:03-bluegreen-rollout.adoc#promote-image[Promote Image]
** xref:03-bluegreen-rollout.adoc#enable-auto-promotion[Enable Auto-Promotion]
** xref:03-bluegreen-rollout.adoc#cleanup[Clean-up]
Expand Down
61 changes: 60 additions & 1 deletion documentation/modules/ROOT/pages/03-bluegreen-rollout.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,67 @@ oc get rs -l app=rollouts-demo -n user%USERNUM%-prod -o yaml | oc neat

Note the `rollouts-pod-template-hash` in `spec.template.metadata.labels` field in the ReplicaSet.

[#argo-rollouts-cli]
=== Argo Rollouts CLI

Argo Rollouts provides a link:https://kubernetes.io/docs/reference/kubectl/[kubectl,window='_blank'] extension to support
working with rollouts. link:https://argo-rollouts.readthedocs.io/en/stable/installation/#kubectl-plugin-installation[Instructions, window='blank']
for installing the extension are available here however note that this has already been done for you in this workshop.

The extension is well link:https://argo-rollouts.readthedocs.io/en/stable/features/kubectl-plugin/[documented,window='_blank']
and provides a number of commands and these can be used with our currently deployed rollout.

To view the rollout we just deployed, run the following command:

[.console-input]
[source,bash,subs="attributes+,+macros"]
----
oc argo rollouts get rollout rollouts-demo -n user%USERNUM%-prod
----

This command should output something similar to the following:

[.console-output]
[source,bash,subs="attributes+,+macros"]
----
Name: rollouts-demo
Namespace: user1-prod
Status: ✔ Healthy
Strategy: BlueGreen
Images: quay.io/openshiftdemos/rollouts-demo:blue (stable, active)
Replicas:
Desired: 2
Current: 2
Updated: 2
Ready: 2
Available: 2

NAME KIND STATUS AGE INFO
⟳ rollouts-demo Rollout ✔ Healthy 6m46s
└──# revision:1
└──⧉ rollouts-demo-66d84bcd76 ReplicaSet ✔ Healthy 6m46s stable,active
├──□ rollouts-demo-66d84bcd76-dxv4x Pod ✔ Running 6m46s ready:1/1
└──□ rollouts-demo-66d84bcd76-k67q4 Pod ✔ Running 6m46s ready:1/1
----

With this command we can view the status of the rollout, `Healthy` here, as well as
the ReplicaSets and Pods that are associated with the rollout.

To view the status of the rollout by itself you can use the following command:

[.console-input]
[source,bash,subs="attributes+,+macros"]
----
oc argo rollouts status rollouts-demo -n user%USERNUM%-prod
----

This should return a simple `Healthy` in the output. Other commands are available to perform
actions on the rollout such as a promoting a rollout, aborting a rollout, etc. A complete
list of commands can be viewed with the `--help` switch and we will look at some of them
during the course of this workshop.

[#argo-rollouts-dashboard]
== Argo Rollouts Dashboard
=== Argo Rollouts Dashboard

The Argo Rollouts dashboard has been deployed in the `user%USERNUM%-tools` namespace on the cluster for this workshop. To access the dashboard,
run the following command to get the URL for the dashboard for your specific user:
Expand Down

0 comments on commit 035ef36

Please sign in to comment.