Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[enterprise-4.11] RHDEVDOCS-2831: Improvements for deployment docs #61676

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 9 additions & 16 deletions applications/deployments/deployment-strategies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,14 @@ include::_attributes/common-attributes.adoc[]

toc::[]

A _deployment strategy_ is a way to change or upgrade an application. The aim is to make the change without downtime in a way that the user barely notices the improvements.
_Deployment strategies_ are used to change or upgrade applications without downtime so that users barely notice a change.

Because the end user usually accesses the application through a route handled by a router, the deployment strategy can focus on `DeploymentConfig` object features or routing features. Strategies that focus on the deployment impact all routes that use the application. Strategies that use router features target individual routes.
Because users generally access applications through a route handled by a router, deployment strategies can focus on `DeploymentConfig` object features or routing features. Strategies that focus on `DeploymentConfig` object features impact all routes that use the application. Strategies that use router features target individual routes.

Many deployment strategies are supported through the `DeploymentConfig` object, and some additional strategies are supported through router features. Deployment strategies are discussed in this section.
Most deployment strategies are supported through the `DeploymentConfig` object, and some additional strategies are supported through router features.


////
This link keeps breaking Travis for some reason.

[NOTE]
====
See
xref:../../applications/deployments/route-based-deployment-strategies.adoc#route-based-deployment-strategies[Using route-based deployment strategies] for more on these additional strategies.
====
////

*Choosing a deployment strategy*
[id="choosing-deployment-strategies"]
== Choosing a deployment strategy

Consider the following when choosing a deployment strategy:

Expand All @@ -35,6 +25,7 @@ Consider the following when choosing a deployment strategy:

A deployment strategy uses readiness checks to determine if a new pod is ready for use. If a readiness check fails, the `DeploymentConfig` object retries to run the pod until it times out. The default timeout is `10m`, a value set in `TimeoutSeconds` in `dc.spec.strategy.*params`.

// Rolling strategies
include::modules/deployments-rolling-strategy.adoc[leveloffset=+1]
include::modules/deployments-canary-deployments.adoc[leveloffset=+2]
include::modules/deployments-creating-rolling-deployment.adoc[leveloffset=+2]
Expand All @@ -45,13 +36,15 @@ include::modules/odc-starting-rolling-deployment.adoc[leveloffset=+2]
* xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating and deploying applications on {product-title} using the *Developer* perspective]
* xref:../../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[Viewing the applications in your project, verifying their deployment status, and interacting with them in the *Topology* view]

// Recreate strategies
include::modules/deployments-recreate-strategy.adoc[leveloffset=+1]
include::modules/odc-starting-recreate-deployment.adoc[leveloffset=+1]
include::modules/odc-starting-recreate-deployment.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating and deploying applications on {product-title} using the *Developer* perspective]
* xref:../../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[Viewing the applications in your project, verifying their deployment status, and interacting with them in the *Topology* view]

// Custom strategies
include::modules/deployments-custom-strategy.adoc[leveloffset=+1]
include::modules/deployments-lifecycle-hooks.adoc[leveloffset=+1]