Skip to content

USHIFT-4317: review and update docs/user/getting_started.md - #7121

Merged
openshift-merge-bot[bot] merged 2 commits into
openshift:mainfrom
copejon:ushift-4317-review-getting-started
Jul 30, 2026
Merged

USHIFT-4317: review and update docs/user/getting_started.md#7121
openshift-merge-bot[bot] merged 2 commits into
openshift:mainfrom
copejon:ushift-4317-review-getting-started

Conversation

@copejon

@copejon copejon commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Update product documentation URL from access.redhat.com to docs.redhat.com (old URL returns 301)
  • Update RHEL version references from 9.4 to 9.8 (matching devenv_setup.md and current targets)
  • Parameterize rhocp repo version with USHIFT_VER variable instead of hardcoding 4.16
  • Remove redundant openshift-clients from dnf install (it is a hard Requires of the microshift RPM)
  • Fix "Confgure" typo → "Configure"
  • Add missing sudo chmod 600 /etc/crio/openshift-pull-secret after pull secret copy (every other doc and template in the repo sets this)

Test plan

  • Verify docs.redhat.com/en/documentation/red_hat_build_of_microshift resolves
  • Confirm openshift-clients is still a hard dependency of microshift RPM (rpm -qR microshift | grep openshift-clients)
  • Walk through the document end-to-end on a fresh RHEL 9.8 VM

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the getting-started guide to target RHEL 9.8 instead of RHEL 9.4, including refreshed MicroShift references and VM OS guidance.
    • Adjusted prerequisites to use the RHEL 9.8 DVD ISO, along with revised constraints and ISO naming details.
    • Updated the “Access MicroShift” workflow to parameterize the MicroShift minor version, install only MicroShift, correct firewall setup wording, and tighten pull-secret permissions after copying.

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

openshift-ci-robot commented Jul 29, 2026

Copy link
Copy Markdown

@copejon: This pull request references USHIFT-4317 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:

Summary

  • Update product documentation URL from access.redhat.com to docs.redhat.com (old URL returns 301)
  • Update RHEL version references from 9.4 to 9.8 (matching devenv_setup.md and current targets)
  • Parameterize rhocp repo version with USHIFT_VER variable instead of hardcoding 4.16
  • Remove redundant openshift-clients from dnf install (it is a hard Requires of the microshift RPM)
  • Fix "Confgure" typo → "Configure"
  • Add missing sudo chmod 600 /etc/crio/openshift-pull-secret after pull secret copy (every other doc and template in the repo sets this)

Test plan

  • Verify docs.redhat.com/en/documentation/red_hat_build_of_microshift resolves
  • Confirm openshift-clients is still a hard dependency of microshift RPM (rpm -qR microshift | grep openshift-clients)
  • Walk through the document end-to-end on a fresh RHEL 9.8 VM

🤖 Generated with Claude Code

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 requested review from kasturinarra and pacevedom July 29, 2026 22:16
@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 29, 2026
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

The getting-started guide now targets RHEL 9.8, updates the DVD ISO bootstrap reference, parameterizes MicroShift repository setup, installs only microshift, revises firewall instructions, and restricts CRI-O pull-secret permissions.

Changes

Getting Started Documentation

Layer / File(s) Summary
RHEL 9.8 prerequisites and bootstrap
docs/user/getting_started.md
Updates documentation links, OS and ISO references, supported architectures, and the DVDISO filename for RHEL 9.8.
MicroShift access and runtime setup
docs/user/getting_started.md
Parameterizes repository enablement with USHIFT_VER, installs only microshift, revises firewall guidance, and adds chmod 600 for the CRI-O pull secret.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: kasturinarra, pacevedom

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly references the updated getting_started.md documentation and is related to the main change set.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed Only docs/user/getting_started.md changed; no Ginkgo test titles were added or modified.
Test Structure And Quality ✅ Passed Only docs/user/getting_started.md changed; no Ginkgo test code was touched, so the test-quality check is not applicable.
Microshift Test Compatibility ✅ Passed Only docs/user/getting_started.md changed; no Ginkgo e2e tests were added, so MicroShift API compatibility check is not applicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed Only docs/user/getting_started.md changed; no new Ginkgo tests or topology assumptions were added.
Topology-Aware Scheduling Compatibility ✅ Passed Only docs/user/getting_started.md changed; diff updates the USHIFT_VER value and no manifests, controllers, or scheduling constraints were added.
Ote Binary Stdout Contract ✅ Passed Only docs/user/getting_started.md changed; no process-level code or stdout writes were added, so the OTE stdout contract is unaffected.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed Only docs/user/getting_started.md changed; no Go/Ginkgo tests were added, so IPv6/disconnected test compatibility is not applicable.
No-Weak-Crypto ✅ Passed PR only updates docs; the changed file has no MD5/SHA1/DES/RC4/3DES/ECB usage, custom crypto, or secret comparisons.
Container-Privileges ✅ Passed PR only changes docs/user/getting_started.md; no container/K8s manifests were modified, so no privileged settings are introduced.
No-Sensitive-Data-In-Logs ✅ Passed No log statements or debug output were added; the change is docs-only and does not expose sensitive data in logs.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/user/getting_started.md`:
- Around line 84-91: Update the getting-started installation example’s
USHIFT_VER assignment from 4.19 to 4.22 so it matches the documented RHEL 9.8
environment; leave the repository enablement and installation commands
unchanged.
- Around line 84-92: Add the MicroShift 4.19 `oc` CLI download and link step
immediately after `sudo dnf install -y microshift` in the getting-started
instructions, before any MicroShift verification commands. Ensure the documented
CLI installation supports running `oc get pods -A` on the RHEL 9 path.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: d3c7863b-8f8a-4f3d-8de4-9c0520df740b

📥 Commits

Reviewing files that changed from the base of the PR and between fef2239 and 7295ad5.

📒 Files selected for processing (1)
  • docs/user/getting_started.md

Comment thread docs/user/getting_started.md
Comment thread docs/user/getting_started.md
copejon added a commit to copejon/microshift that referenced this pull request Jul 30, 2026
- docs/user/getting_started.md:87: Update USHIFT_VER from 4.19 to 4.22
  to match RHEL 9.8 compatibility matrix

Co-Authored-By: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@copejon
copejon force-pushed the ushift-4317-review-getting-started branch from 7295ad5 to 579bdd2 Compare July 30, 2026 15:01
@copejon

copejon commented Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

/verified by ci

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Jul 30, 2026
@openshift-ci-robot

Copy link
Copy Markdown

@copejon: This PR has been marked as verified by ci.

Details

In response to this:

/verified by ci

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.

copejon and others added 2 commits July 30, 2026 10:51
- Update product documentation URL (access.redhat.com → docs.redhat.com)
- Update RHEL version references from 9.4 to 9.8
- Parameterize rhocp repo version with USHIFT_VER variable
- Remove redundant openshift-clients from dnf install (already a
  hard dependency of the microshift RPM)
- Fix "Confgure" typo
- Add chmod 600 for pull secret to match all other docs and templates

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- docs/user/getting_started.md:87: Update USHIFT_VER from 4.19 to 4.22
  to match RHEL 9.8 compatibility matrix

Co-Authored-By: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@copejon
copejon force-pushed the ushift-4317-review-getting-started branch from 579bdd2 to d719d5d Compare July 30, 2026 15:51
@openshift-ci-robot openshift-ci-robot removed the verified Signifies that the PR passed pre-merge verification criteria label Jul 30, 2026
@copejon

copejon commented Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

/verified by ci

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Jul 30, 2026
@openshift-ci-robot

Copy link
Copy Markdown

@copejon: This PR has been marked as verified by ci.

Details

In response to this:

/verified by ci

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-robot

openshift-ci-robot commented Jul 30, 2026

Copy link
Copy Markdown

@copejon: This pull request references USHIFT-4317 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:

Summary

  • Update product documentation URL from access.redhat.com to docs.redhat.com (old URL returns 301)
  • Update RHEL version references from 9.4 to 9.8 (matching devenv_setup.md and current targets)
  • Parameterize rhocp repo version with USHIFT_VER variable instead of hardcoding 4.16
  • Remove redundant openshift-clients from dnf install (it is a hard Requires of the microshift RPM)
  • Fix "Confgure" typo → "Configure"
  • Add missing sudo chmod 600 /etc/crio/openshift-pull-secret after pull secret copy (every other doc and template in the repo sets this)

Test plan

  • Verify docs.redhat.com/en/documentation/red_hat_build_of_microshift resolves
  • Confirm openshift-clients is still a hard dependency of microshift RPM (rpm -qR microshift | grep openshift-clients)
  • Walk through the document end-to-end on a fresh RHEL 9.8 VM

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
  • Updated the getting-started guide to target RHEL 9.8 instead of RHEL 9.4, including refreshed MicroShift references and VM OS guidance.
  • Adjusted prerequisites to use the RHEL 9.8 DVD ISO, along with revised constraints and ISO naming details.
  • Updated the “Access MicroShift” workflow to parameterize the MicroShift minor version, install only MicroShift, correct firewall setup wording, and tighten pull-secret permissions after copying.

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.

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/user/getting_started.md`:
- Around line 84-92: Update the MicroShift installation instructions around
USHIFT_VER and the subscription-manager repo commands to set the RHEL release to
9.8 immediately after registration and before enabling the RPM repositories.
Preserve the existing repository enablement and package installation steps.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: a35e8cf2-f5b7-45ef-b6ef-669500f49cea

📥 Commits

Reviewing files that changed from the base of the PR and between 579bdd2 and d719d5d.

📒 Files selected for processing (1)
  • docs/user/getting_started.md

Comment thread docs/user/getting_started.md
@ggiguash

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 30, 2026
@openshift-ci

openshift-ci Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: copejon, ggiguash

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci

openshift-ci Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

@copejon: 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-merge-bot
openshift-merge-bot Bot merged commit ea9ff1a into openshift:main Jul 30, 2026
7 checks passed
@copejon
copejon deleted the ushift-4317-review-getting-started branch July 30, 2026 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants