Skip to content

Conversation

subhtk
Copy link
Contributor

@subhtk subhtk commented Apr 10, 2024

Version(s): 4.16+

Issue: OSDOCS 8197

Link to docs preview: v2

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 10, 2024
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 12, 2024
@subhtk subhtk force-pushed the ocm-4.16 branch 3 times, most recently from 3ea6c34 to c138ad1 Compare April 15, 2024 10:39
@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 15, 2024
@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 Apr 15, 2024

The CatalogSource resource is used by Operator Lifecycle Manager (OLM) to retrieve information about the available Operators in the mirror registry.

Apply the YAML files from the results directory to the cluster by running the following command -> not right and command under it is incorrect No newline at end of file

Choose a reason for hiding this comment

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

@subhtk not right and command under it is incorrect ? Hope you missed to add , could you please help check again ?

+
[source,terminal]
----
$ oc mirror --config <imageset-Config.yaml> <1>
Copy link

@kasturinarra kasturinarra May 31, 2024

Choose a reason for hiding this comment

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

@subhtk command should be oc-mirror --config <imageset-config.yaml> file://<oc-mirror workspace path> --v2 do not see --v2 which is important. Also dry-run for v2 explantaion should be a little different. you can read and capture about this from the doc here https://docs.google.com/document/d/1NoRR_pG4W10Q1KiOZ_LaCUuYuAxgVlrv_4BPu-6K-5s/edit#heading=h.vmuf853hmqmh Question no:6

$ cd <oc-mirror workspace path>
----

. Review the `mapping.txt` file that was generated. This file contains a list of all images that would be mirrored.

Choose a reason for hiding this comment

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

There will be a missing.txt as well that will be generated and you could talk about it as well.



["oc-mirror-dry-run-workflow"]
== Use-case scenarios for dry run
Copy link

@kasturinarra kasturinarra May 31, 2024

Choose a reason for hiding this comment

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

@subhtk do not understand this and the above section, which is correct ? Again looks like duplication to me.

[NOTE]
====
When the image set configuration file contains images that are not present in the oc-mirror cache, these images will be added to the missing.txt file. This file can be found in the dry-run folder.
====

Choose a reason for hiding this comment

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

dry-run folder or the oc-mirror workspace path ? In --v2 are we calling oc-mirror workspace path similar to v1 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes

When the image set configuration file contains images that are not present in the oc-mirror cache, these images will be added to the missing.txt file. This file can be found in the dry-run folder.
====

.Disk to Mirror

Choose a reason for hiding this comment

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

should not we have mirror to Disk first and then Disk to mirror ?


[source,terminal]
----
$ oc mirror -c <image_set_config.yaml> --workspace <oc-mirror workspace path> docker://<mirror-registry-url> --dry-run --v2
Copy link

@kasturinarra kasturinarra May 31, 2024

Choose a reason for hiding this comment

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

we should have --workspace file://< mirror workspace path>


[source,terminal]
----
$ oc mirror -c <image_set_config.yaml> --from <oc-mirror workspace path> docker://<mirror-registry-url> --dry-run --v2

Choose a reason for hiding this comment

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

Better to give accurate example format :
oc mirror -c <image_set_config.yaml> --from file://<oc-mirror workspace path> docker://<mirror-registry-url> --dry-run --v2

[source,terminal]
----
oc-mirror --v2 -c isc-enclave.yaml
--from /local-disk docker://registry.enc1.in
Copy link

@zhouying7780 zhouying7780 Jun 5, 2024

Choose a reason for hiding this comment

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

here the command is invalid , should be
oc-mirror --v2 -c isc-enclave.yaml --from file://local-disk docker://registry.enc1.in

mirror:
operators:
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.10
- package: elastic-search-operator
Copy link

@zhouying7780 zhouying7780 Jun 5, 2024

Choose a reason for hiding this comment

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

here package is array of objects , must like :

packages: 
- name: compliance-operator

mirror:
operators:
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.10
- package: elastic-search-operator

Choose a reason for hiding this comment

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

same too, package is array of objects

mirror:
operators:
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.10
- package: elastic-search-operator

Choose a reason for hiding this comment

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

same too, package is array of objects

operators:
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.10
full: true
- package: elastic-search-operator

Choose a reason for hiding this comment

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

same too, package is array of objects

operators:
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.10
full: true
- package: elastic-search-operator

Choose a reason for hiding this comment

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

same too, package is array of objects


|`mirror.blockedImages`
|The full tag, digest, or pattern of images to block from mirroring.
|Array of strings. For example: `docker.io/library/alpine`

Choose a reason for hiding this comment

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

better to use correct example for the array.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you provide me the example?

Choose a reason for hiding this comment

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

@subhtk this pr closed, which is the new one ?


[source,terminal]
----
$ oc mirror delete --config delete-image-set-config.yaml --workspace file://<previously-mirrored-work-folder> --v2 --generate docker://<remote-registry>

Choose a reason for hiding this comment

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

better to give an example for the delete-image-set-config.yaml

@subhtk
Copy link
Contributor Author

subhtk commented Jun 10, 2024

Closing due to Merge Conflicts.

@subhtk subhtk closed this Jun 10, 2024
@subhtk subhtk changed the title OSDOCS 8197: Restructured oc-mirror section to include V2 changes Restructured oc-mirror section to include V2 changes Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants