Skip to content

NO-JIRA: Fix oc-mirror v2 verification command typo - #119252

Open
hongkailiu wants to merge 1 commit into
openshift:mainfrom
hongkailiu:fix-oc-mirror-typo
Open

NO-JIRA: Fix oc-mirror v2 verification command typo#119252
hongkailiu wants to merge 1 commit into
openshift:mainfrom
hongkailiu:fix-oc-mirror-typo

Conversation

@hongkailiu

Copy link
Copy Markdown
Member

Use the hyphenated oc-mirror binary name for the v2 --help verification command, consistent with other oc-mirror v2 docs.

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

Use the hyphenated oc-mirror binary name for the v2 --help
verification command, consistent with other oc-mirror v2 docs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@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

Copy link
Copy Markdown

@hongkailiu: This pull request explicitly references no jira issue.

Details

In response to this:

Use the hyphenated oc-mirror binary name for the v2 --help verification command, consistent with other oc-mirror v2 docs.

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 2, 2026

@wking wking left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Confirming precedence:

$ git log --oneline -1 origin/main
a798ea8be4d (origin/main, origin/HEAD) Merge pull request #118580 from mburke5678/mco-boot-image-update-aws-mktplace
$ git grep -oh 'oc.mirror' a798ea8be4d | sort | uniq -c | sort -n
      4 oc_mirror
      8 oc#mirror
     77 oc mirror
    706 oc-mirror

If folks want to look at some of the other oc mirror references, in this pull or follow-up work, here's the start of an audit:

$ git grep 'oc mirror' a798ea8be4d | sed 's/^[^:]*:\([^:]*\):.*/\1/' | sort | uniq -c | sort -n | tail
      2 modules/telco-core-disconnected-environment.adoc
      3 modules/hcp-dc-image-mirror.adoc
      3 modules/installation-initializing-manual.adoc
      3 modules/oc-mirror-command-reference-v2.adoc
      3 modules/oc-mirror-disk-to-mirror.adoc
      4 modules/microshift-oc-mirror-list-ops-catalogs.adoc
      4 modules/oc-mirror-command-reference.adoc
      4 modules/oc-mirror-creating-image-set-config.adoc
      4 modules/preparing-an-initial-cluster-deployment-for-mce-disconnected.adoc
      5 modules/oc-mirror-enclave-support.adoc
$ git grep 'oc mirror' a798ea8be4d -- modules/oc-mirror-enclave-support.adoc
a798ea8be4d:modules/oc-mirror-enclave-support.adoc:The central registry is situated within a secure network, specifically a disconnected environment, and is not directly linked to the public internet. But the user must execute `oc mirror` in an environment with access to the public internet.
a798ea8be4d:modules/oc-mirror-enclave-support.adoc:$ oc mirror --v2 -c isc.yaml file://<file_path>/enterprise-content
a798ea8be4d:modules/oc-mirror-enclave-support.adoc:$ oc mirror --v2 -c isc.yaml --from file://<disconnected_environment_file_path>/enterprise-content docker://<enterprise_registry.in>/
a798ea8be4d:modules/oc-mirror-enclave-support.adoc:$ oc mirror --v2 -c isc-enclave.yaml
a798ea8be4d:modules/oc-mirror-enclave-support.adoc:$ oc mirror --v2 -c isc-enclave.yaml --from file://local-disk docker://registry.enc1.in

But I don't see a reason to make a completely clean audit a prereq for incremental improvement:

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Sep 2, 2026
@kalexand-rh

Copy link
Copy Markdown
Contributor

@snarayan-redhat, will you PTAL?

@openshift-ci

openshift-ci Bot commented Sep 2, 2026

Copy link
Copy Markdown

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

@hongkailiu

Copy link
Copy Markdown
Member Author

I realized that there are more of oc mirror without the hyphen while reading further in the doc and found the nice summary in @wking 's comment. ❤️

If the associates in the docs team want to fix them with one shot, I am fine to close this pull.

@snarayan-redhat

snarayan-redhat commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

@ all
This has come up a few times before. Our installation procedure installs oc-mirror as an oc CLI plugin. We can use oc-mirror as a binary and execute commands with hyphen but per discussion with all docs stakeholders we have decided to keep it aligned with the installation steps and use oc mirror without hyphens.

We can probably try adding a note in docs if this needs to be clarified.

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. lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants