OSDOCS-17161-1:(CQA) APP-2: Deployments - Attachment2 - #117380
OSDOCS-17161-1:(CQA) APP-2: Deployments - Attachment2#117380tedaveryredhat wants to merge 1 commit into
Conversation
|
@tedaveryredhat: This pull request references OSDOCS-17161 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="deployments-ab-testing-lb-web_{context}"] | ||
| = Managing weights of an existing route using the web console |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
fe45c6d to
02a3b84
Compare
|
@tedaveryredhat: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. I understand the commands that are listed here. |
|
/label merge-review-needed |
lahinson
left a comment
There was a problem hiding this comment.
@tedaveryredhat Thanks for your work on this! Just a few small things to address before this one is merged.
|
|
||
| Deployment strategies provide a way for the application to evolve. Some strategies use `Deployment` objects to make changes that are seen by users of all routes that resolve to the application. Other advanced strategies, such as the ones described in this section, use router features in conjunction with `Deployment` objects to impact specific routes. | ||
| [role="_abstract"] | ||
| To roll out application changes to selected traffic in {product-title}, you can use route-based deployment strategies with the router and `Deployment` objects. These advanced strategies, including blue-green, A/B, and canary, affect specific routes rather than every route that resolves to the application. |
There was a problem hiding this comment.
Short descriptions must not exceed 300 characters in order to be migrated to DITA successfully.
| To roll out application changes to selected traffic in {product-title}, you can use route-based deployment strategies with the router and `Deployment` objects. These advanced strategies, including blue-green, A/B, and canary, affect specific routes rather than every route that resolves to the application. | |
| [role="_abstract"] | |
| To roll out application changes to selected traffic in {product-title}, you can use route-based deployment strategies with the router and `Deployment` objects. | |
| These advanced strategies, including blue-green, A/B, and canary, affect specific routes rather than every route that resolves to the application. |
| See | ||
| xref:../../applications/deployments/deployment-strategies.adoc#deployment-strategies[Using deployment strategies] | ||
| for more on the basic strategy types. | ||
| for more on the basic strategy types.:_mod-docs-content-type: PROCEDURE |
There was a problem hiding this comment.
Not sure why this mod-docs text is here.
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="deployments-ab-one-service-multi-dc_{context}"] | ||
| = One service, multiple `Deployment` objects |
There was a problem hiding this comment.
Per the OCP docs guidelines, use a gerund for the title of a procedure: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#writing-procedures
Also, module titles should not be formatted with backticks: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#writing-procedures
| = One service, multiple `Deployment` objects | |
| = Create multiple Deployment objects that use one service |
| = One service, multiple `Deployment` objects | ||
|
|
||
| [role="_abstract"] | ||
| To serve multiple application versions through a single service in {product-title}, you can create multiple `Deployment` objects that share a common label selector. Expose one service for those pods so you can scale or update each shard independently while users reach them through the same route. |
There was a problem hiding this comment.
| To serve multiple application versions through a single service in {product-title}, you can create multiple `Deployment` objects that share a common label selector. Expose one service for those pods so you can scale or update each shard independently while users reach them through the same route. | |
| [role="_abstract] | |
| To serve multiple application versions through a single service in {product-title}, you can create multiple `Deployment` objects that share a common label selector. | |
| Expose one service for those pods so you can scale or update each shard independently while users reach them through the same route. |
Short descriptions cannot be longer than 300 characters in order to successfully be migrated to DITA.
| + | ||
| [NOTE] | ||
| ==== | ||
| Not all routers may support multiple or weighted backends. |
There was a problem hiding this comment.
| Not all routers may support multiple or weighted backends. | |
| Not all routers support multiple or weighted backends. |
IBM Style warns against the use of "may" in technical content.
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="deployments-ab-testing-lb-web-new-route_{context}"] | ||
| = Managing weights of an new route using the web console |
There was a problem hiding this comment.
| = Managing weights of an new route using the web console | |
| = Managing weights of a new route by using the web console |
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="deployments-ab-testing-lb-web_{context}"] | ||
| = Managing weights of an existing route using the web console |
There was a problem hiding this comment.
| = Managing weights of an existing route using the web console | |
| = Managing weights of an existing route by using the web console |
|
|
||
| Blue-green deployments involve running two versions of an application at the same time and moving traffic from the in-production version (the blue version) to the newer version (the green version). You can use a rolling strategy or switch services in a route. | ||
| [role="_abstract"] | ||
| To switch users from a stable application version to a new one in {product-title}, you can set up a blue-green deployment. Run both versions at once, then point the production route at the new (green) service when you are ready, with the option to switch back to the blue version if needed. |
There was a problem hiding this comment.
The short description needs to be fewer than 300 characters to be successfully migrated to DITA.
| To switch users from a stable application version to a new one in {product-title}, you can set up a blue-green deployment. Run both versions at once, then point the production route at the new (green) service when you are ready, with the option to switch back to the blue version if needed. | |
| [role="_abstract"] | |
| To switch users from a stable application version to a new one in {product-title}, you can set up a blue-green deployment. | |
| Run both versions at once, then point the production route at the new (green) service when you are ready, with the option to switch back to the blue version if needed. |
Version(s):
4.20+
Issue:
https://redhat.atlassian.net/browse/OSDOCS-17161
Link to docs preview:
https://117380--ocpdocs-pr.netlify.app/openshift-dedicated/latest/applications/deployments/route-based-deployment-strategies.html
https://117380--ocpdocs-pr.netlify.app/openshift-enterprise/latest/applications/deployments/route-based-deployment-strategies.html
https://117380--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/applications/deployments/route-based-deployment-strategies.html
https://117380--ocpdocs-pr.netlify.app/openshift-rosa/latest/applications/deployments/route-based-deployment-strategies.html
QE review:
N/A