Skip to content

[RHACS] [Docs] [rhacs-docs-main] ROX-23586: Updating docs related to Quay.io registry integration with robot - #119227

Merged
agantony merged 1 commit into
openshift:rhacs-docs-mainfrom
agantony:ROX23586-rhacs-docs-main
Sep 4, 2026
Merged

[RHACS] [Docs] [rhacs-docs-main] ROX-23586: Updating docs related to Quay.io registry integration with robot#119227
agantony merged 1 commit into
openshift:rhacs-docs-mainfrom
agantony:ROX23586-rhacs-docs-main

Conversation

@agantony

@agantony agantony commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Version(s):
4.10+

Issue:
https://redhat.atlassian.net/browse/ROX-23586

Link to docs preview:

SME review:

  • SME has approved this change.

Additional information:

  • Cherrypick to:
    • rhacs-docs-4.11
    • rhacs-docs-4.10

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

openshift-ci-robot commented Sep 2, 2026

Copy link
Copy Markdown

@agantony: This pull request references ROX-23586 which is a valid jira issue.

Details

In response to this:

Version(s):
4.10+

Issue:
https://redhat.atlassian.net/browse/ROX-23586

Link to docs preview:

SME review:

  • SME has approved this change.

Additional information:

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/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 2, 2026
@agantony agantony added rhacs-docs-4.10 rhacs-docs-4.11 Label for PRs that apply to RHACS 4.11 and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. labels Sep 2, 2026
@openshift-ci openshift-ci Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 2, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Sep 2, 2026

Copy link
Copy Markdown

@agantony
agantony force-pushed the ROX23586-rhacs-docs-main branch from 50acac0 to 776809d Compare September 2, 2026 16:07
@agantony

agantony commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

PR Review Summary

Changes Made

  • Purpose: Clarify the Quay Container Registry integration credential guidance so it matches the current product UI, which uses generic Username and Password fields rather than robot-specific labels. The change makes it explicit that either Quay.io account credentials or Quay robot account credentials are valid, and clarifies when an OAuth token is required.
  • Scope: 3 files changed (+8 / −7): 1 assembly and 2 procedure modules.
  • Change categories:
    • Content accuracy updates: credential field relabeling and clarification (Robot username/password → Username/Password).
    • OAuth token guidance: clarified as not required for a Registry-only integration and deprecated for registry access.
    • Additional resources: added a reference link to the Red{nbsp}Hat Quay Robot Account overview.
    • Style compliance: passive voice removed from the robot account recommendation.

Summary of Changes

File Location / role Changes Before → After
integration/integrate-with-image-registries.adoc Assembly (parent of the Quay registry procedure) Added a Red{nbsp}Hat Quay Robot Account overview link to the existing Additional resources list. +1 / −0
modules/manual-configuration-image-registry-qcr.adoc Procedure module: Manually configuring Quay Container Registry Intro method bullet retitled from "By using a robot account" to "By using a username and password" and rewritten to state both credential types are accepted, with a robot account recommended (active voice); robot account reference converted to free-text pointer; prerequisite updated to reference Quay.io or robot credentials; registry fields relabeled Robot username/Robot password → Username/Password; OAuth token field clarified as not required for Registry type and deprecated for registry access. +6 / −5
modules/integrate-with-qcr-scanner.adoc Procedure module: Integrating with Quay Container Registry to scan images Merged the two optional Robot username / Robot password field bullets into a single Username and Password bullet for the Scanner + Registry case, stating both credential types are valid. +1 / −2

Navigation Guide - Review Changes

Step 1 — Review the registry configuration procedure and Additional resources link
Open the registries assembly preview:

Jump directly to the changed module:

Verify:

  • The integration methods list shows By using a username and password with the statement that Quay.io or Quay robot account credentials are accepted, followed by the free-text robot account pointer.
  • The Prerequisites reference Quay.io or Quay robot account credentials.
  • Under the procedure, the private registry fields render as Username and Password, and the OAuth token entry states it is not required for a Registry type and is deprecated for registry access.
  • In Additional resources, the Red{nbsp}Hat Quay Robot Account overview link is present and resolves.

Step 2 — Review the scanner integration procedure
Open the vulnerability scanners assembly preview:

Jump directly to the changed module:

Verify:

  • For the Scanner + Registry type, the optional field bullet renders as a single Username and Password entry stating both credential types are valid.
  • The OAuth token field guidance for the scanner type is unchanged and still present.

Verification Checklists

Structural verification

  • Both assemblies render without build errors and include their Quay modules.
  • Section anchors resolve: #manual-configuration-image-registry-qcr_integrate-with-image-registries and #integrate-with-qcr-scanner_integrate-with-image-vulnerability-scanners.
  • The + list continuation under the "username and password" bullet renders as attached body text, not a broken list item.
  • Numbered procedure steps and nested field bullets keep correct indentation.

Content verification

  • Credential fields read Username and Password (no residual "Robot username" / "Robot password").
  • Both credential types (Quay.io account and Quay robot account) are described as valid.
  • OAuth token is described as not required for a Registry-only integration and deprecated for registry access.
  • Robot account username format _<namespace>+<accountname>_ is preserved.
  • The Red{nbsp}Hat Quay Robot Account overview link points to a valid Quay documentation page.

DITA compliance verification

  • Each module retains a single title and its :_mod-docs-content-type: PROCEDURE attribute.
  • Additional resources block uses the [role="_additional-resources"] role and contains links only.
  • No unsupported nested sections or callouts introduced by the changes.
  • Cross-reference to the scanner module remains valid.

Quick Visual Review Guide

  • Confirm the Username / Password field labels display in both procedures.
  • Confirm the OAuth token clarification sentence displays cleanly in the registry procedure.
  • Confirm the free-text robot account pointer appears as a continuation under the "username and password" method bullet.
  • Confirm the Additional resources section lists the Red{nbsp}Hat Quay Robot Account overview link alongside the existing entries, with correct spacing and a working hyperlink.
  • Confirm "Red Hat" renders with a non-breaking space in all new text.

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

Couple of things; otherwise lgtm!

Comment thread integration/integrate-with-image-registries.adoc Outdated
Comment thread modules/manual-configuration-image-registry-qcr.adoc Outdated
@agantony agantony added the peer-review-done Signifies that the peer review team has reviewed this PR label Sep 3, 2026

@dcaravel dcaravel left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM overall - if keeping the "Red Hat recommends..", maybe back that up with Quay.io docs? Not so sure ACS has a strong opinion on it as long as the creds are valid.

…obot

ROX23586 Incorporating Vale fixes

ROX-23586 Address review: update Quay link to 3.18, drop robot account recommendation

- Update Red Hat Quay Robot Account overview link from 3.14 to 3.18 (per Kerry Carmichael)
- Remove "Red Hat recommends using a robot account" per SME David Caravello, since
  either credential set is valid and the preferred type depends on the user's needs

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@agantony
agantony force-pushed the ROX23586-rhacs-docs-main branch from 8a012ed to 36e4679 Compare September 4, 2026 06:40
@openshift-ci

openshift-ci Bot commented Sep 4, 2026

Copy link
Copy Markdown

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

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

openshift-ci-robot commented Sep 4, 2026

Copy link
Copy Markdown

@agantony: This pull request references ROX-23586 which is a valid jira issue.

Details

In response to this:

Version(s):
4.10+

Issue:
https://redhat.atlassian.net/browse/ROX-23586

Link to docs preview:

SME review:

  • SME has approved this change.

Additional information:

  • Cherrypick to:
    • rhacs-docs-4.11
    • rhacs-docs-4.10

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.

@agantony
agantony merged commit 02f0d10 into openshift:rhacs-docs-main Sep 4, 2026
2 checks passed
@agantony

agantony commented Sep 4, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick rhacs-docs-4.11

@agantony

agantony commented Sep 4, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick rhacs-docs-4.10

@openshift-cherrypick-robot

Copy link
Copy Markdown

@agantony: new pull request created: #119360

Details

In response to this:

/cherrypick rhacs-docs-4.11

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.

@openshift-cherrypick-robot

Copy link
Copy Markdown

@agantony: new pull request created: #119361

Details

In response to this:

/cherrypick rhacs-docs-4.10

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.

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

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR rhacs-docs-4.10 rhacs-docs-4.11 Label for PRs that apply to RHACS 4.11 size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants