Skip to content

Commit fba171a

Browse files
authored
Merge pull request #61662 from abrennan89/RHDEVDOCS-2831
RHDEVDOCS-2831: Improvements for deployment docs
2 parents 1291747 + 4c00dff commit fba171a

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

applications/deployments/deployment-strategies.adoc

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,14 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
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.
9+
_Deployment strategies_ are used to change or upgrade applications without downtime so that users barely notice a change.
1010

11-
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.
11+
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.
1212

13-
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.
13+
Most deployment strategies are supported through the `DeploymentConfig` object, and some additional strategies are supported through router features.
1414

15-
16-
////
17-
This link keeps breaking Travis for some reason.
18-
19-
[NOTE]
20-
====
21-
See
22-
xref:../../applications/deployments/route-based-deployment-strategies.adoc#route-based-deployment-strategies[Using route-based deployment strategies] for more on these additional strategies.
23-
====
24-
////
25-
26-
*Choosing a deployment strategy*
15+
[id="choosing-deployment-strategies"]
16+
== Choosing a deployment strategy
2717

2818
Consider the following when choosing a deployment strategy:
2919

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

3626
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`.
3727

28+
// Rolling strategies
3829
include::modules/deployments-rolling-strategy.adoc[leveloffset=+1]
3930
include::modules/deployments-canary-deployments.adoc[leveloffset=+2]
4031
include::modules/deployments-creating-rolling-deployment.adoc[leveloffset=+2]
@@ -45,13 +36,15 @@ include::modules/odc-starting-rolling-deployment.adoc[leveloffset=+2]
4536
* 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]
4637
* 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]
4738

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

5143
[role="_additional-resources"]
5244
.Additional resources
5345
* 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]
5446
* 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]
5547

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

0 commit comments

Comments
 (0)