Skip to content

OSDOCS-17161-1:(CQA) APP-2: Deployments - Attachment2 - #117380

Open
tedaveryredhat wants to merge 1 commit into
openshift:mainfrom
tedaveryredhat:OSDOCS-17161-1
Open

OSDOCS-17161-1:(CQA) APP-2: Deployments - Attachment2#117380
tedaveryredhat wants to merge 1 commit into
openshift:mainfrom
tedaveryredhat:OSDOCS-17161-1

Conversation

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 5, 2026
@openshift-ci-robot

openshift-ci-robot commented Aug 5, 2026

Copy link
Copy Markdown

@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.

Details

In response to this:

Version(s):
4.20+

Issue:
https://redhat.atlassian.net/browse/OSDOCS-17161

Link to docs preview:

QE review:
N/A

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.

@openshift-ci openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Aug 5, 2026
Comment thread modules/deployments-ab-lb-web.adoc Outdated

:_mod-docs-content-type: PROCEDURE
[id="deployments-ab-testing-lb-web_{context}"]
= Managing weights of an existing route using the web console

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.

@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 6, 2026
@openshift-ci

openshift-ci Bot commented Aug 6, 2026

Copy link
Copy Markdown

@tedaveryredhat: all tests passed!

Full PR test history. Your PR dashboard.

Details

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 kubernetes-sigs/prow repository. I understand the commands that are listed here.

@tedaveryredhat

Copy link
Copy Markdown
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci Bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Aug 7, 2026
@lahinson lahinson added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Aug 13, 2026

@lahinson lahinson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Short descriptions must not exceed 300 characters in order to be migrated to DITA successfully.

Suggested change
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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Suggested change
= 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
= 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
= 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The short description needs to be fewer than 300 characters to be successfully migrated to DITA.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants