Skip to content

Commit

Permalink
Add consistent 'you wil learn..' headers to all modules
Browse files Browse the repository at this point in the history
  • Loading branch information
gnunn1 committed Nov 2, 2023
1 parent f91ab8b commit 8e2ffca
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 3 deletions.
5 changes: 4 additions & 1 deletion documentation/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,26 @@
** xref:01-getting-started.adoc#open-web-terminal[Open the Web Terminal]
* xref:02-workshop-overview.adoc[2. Workshop Overview]
** xref:02-workshop-overview.adoc#workshop-layout[Workshop Layout]
** xref:02-workshop-overview.adoc#workshop-namespaces[Workshop Namespaces]
** xref:02-workshop-overview.adoc#review-rollout-manager[Review RolloutManager]
** xref:02-workshop-overview.adoc#deploy-application[Deploy Application]
* xref:03-bluegreen-rollout.adoc[3. Blue-Green Rollout]
** xref:03-bluegreen-rollout.adoc#blue-green-strategy[Blue-Green Strategy
** xref:03-bluegreen-rollout.adoc#deploy-blue-green-rollout[Deploy Blue-Green Rollout]
** 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#perform-rollback[Perform Rollback]
** xref:03-bluegreen-rollout.adoc#cleanup[Clean-up]
* xref:04-analysis.adoc[4. Analysis]
** xref:04-analysis.adoc#analysis-overview[Overview]
** xref:04-analysis.adoc#analysis-deployment[Analysis Deployment]
** xref:04-analysis.adoc#analysis-promotion[Promotion with Analysis]
** xref:04-analysis.adoc#cleanup[Clean-up]
* xref:05-canary-rollout.adoc[5. Canary Rollout]
** xref:05-canary-rollout.adoc#canary-strategy[Canary Strategy]
** xref:05-canary-rollout.adoc#deploy-canary-rollout[Deploy Canary Rollout]
** xref:05-canary-rollout.adoc#promote-image[Promote Image]
** xref:05-canary-rollout.adoc#inline-analysis[Inline Analysis]
Expand Down
4 changes: 2 additions & 2 deletions documentation/modules/ROOT/pages/02-workshop-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ In this module we will:
* Review how Rollouts was deployed with OpenShift GitOps
* Deploy the application in the Development environment
[#workshop-layout]
== Workshop Layout
[#workshop-namespaces]
== Workshop Namespaces

image::openshift-projects.png[]

Expand Down
10 changes: 10 additions & 0 deletions documentation/modules/ROOT/pages/03-bluegreen-rollout.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
= Blue-Green Rollout
include::_attributes.adoc[]

In this module we will:

* Review and understand the Blue-Green Strategy
* Deploy the Blue-Green Rollout to the production namespace
* Deploy a new image and observe the Rollout promotion process
* Perform a Rollback of a promotion
[#blue-green-strategy]
== Blue-Green Strategy

In a blue-green deployment we deploy a new version of the application in a separate stack from the current version with
the two versions running in parallel for a period of time. This enables testing on the new version while users continue
to access the current version of the application until a cut-over of traffic occurs.
Expand Down
10 changes: 10 additions & 0 deletions documentation/modules/ROOT/pages/04-analysis.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
= Analysis
include::_attributes.adoc[]

In this module we will:

* Review and understand the concept of an Analysis
* Deploy a Blue-Green rollout with an Analysis
* Perform a successful promotion of an image tested by an Analysis
* Perform and observe a promotion that fails an Analysis
[#analysis-overview]
== Analysis Overview

When performing upgrades of services there is a need to test the new version
that is being deployed to ensure functionality is not being negatively impacted. The
link:https://argo-rollouts.readthedocs.io/en/stable/features/analysis[Analysis,window='_blank'] feature
Expand Down
10 changes: 10 additions & 0 deletions documentation/modules/ROOT/pages/05-canary-rollout.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
= Canary
include::_attributes.adoc[]

In this module we will:

* Review and understand the Canary Strategy
* Deploy the Canary Rollout to the production namespace
* Promote a new image and observe the Canary behavior
* Replace a manual pause step for testing with an Analysis
[#canary-strategy]
== Canary Strategy

link:https://argo-rollouts.readthedocs.io/en/stable/features/canary/[Canary, window='_blank'] can be
thought of as an advanced version of blue-green where instead of an abrupt cut-over
of live traffic between a current and new revision traffic is instead gradually increased to the new
Expand Down

0 comments on commit 8e2ffca

Please sign in to comment.