Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add high level documentation for disconnected envs #1253

Conversation

bshephar
Copy link
Contributor

@bshephar bshephar commented Jan 7, 2025

No description provided.

Copy link
Contributor

openshift-ci bot commented Jan 7, 2025

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci openshift-ci bot added the approved label Jan 7, 2025
Copy link
Contributor

@fao89 fao89 left a comment

Choose a reason for hiding this comment

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

@bshephar bshephar force-pushed the docs-for-disconnected branch 7 times, most recently from 433e914 to c3a3700 Compare January 9, 2025 04:40
@bshephar bshephar marked this pull request as ready for review January 9, 2025 11:42
@bshephar bshephar force-pushed the docs-for-disconnected branch from c3a3700 to c88aada Compare January 9, 2025 11:55

[,yaml]
----
edpm_podman_disconnected_ocp
Copy link
Contributor

Choose a reason for hiding this comment

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

Would not mentioning these ansible variables that are for internal use confuse the users? Though the section heading is Technical Overview i.e how it internally works, we should probably clearly mention that user does not have to do anything from OSP pov once OCP operataor catalog mirroring is done, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, true, don't wan to cause any confusion. I can make that more clear.

@bshephar bshephar force-pushed the docs-for-disconnected branch from c88aada to f9463df Compare January 9, 2025 12:08

The `openstack-operator` contains a list of related images that will ensure all required images for the deployment are mirrored following the above OpenShift process. Once images are mirrored, the `ImageContentSourcePolicy` custom resource (CR) is created. This process results in a `MachineConfig` called `99-master-genereted-registries` being updated in the cluster. The `99-master-generated-registries` `MachineConfig` contains a `registries.conf` file that is applied to all of the OpenShift nodes in the cluster.

In order to integrate cleanly with this process. The dataplane controller will check for the existence of an `ImageContentSourcePolicy`. If one is found, we will read the `registries.conf` file from the `99-master-generated-registries` `MachineConfig`. The dataplane controller will then set two variables in the Ansible inventory for the nodes.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/dataplane controller/openstack-operator ?

The first sentence is also a fragment:
In order to integrate cleanly with this process.

I would rewrite this as:

In order for EDPM to integrate cleanly with this process, openstack-operator checks for the existence of an `ImageContentSourcePolicy`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed all of the "we"'s as well. I just swapped EDPM for dataplane since I hadn't already referenced the acronym anywhere else, I just stuck with dataplane.

@bshephar bshephar force-pushed the docs-for-disconnected branch 3 times, most recently from 1e75371 to 5ae2550 Compare January 9, 2025 12:37
Copy link
Contributor

openshift-ci bot commented Jan 9, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bshephar, slagle

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

The pull request process is described here

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

@fao89
Copy link
Contributor

fao89 commented Jan 11, 2025

/retest

@bshephar bshephar force-pushed the docs-for-disconnected branch from 5ae2550 to 3be17a3 Compare January 12, 2025 22:45
@openshift-ci openshift-ci bot removed the lgtm label Jan 12, 2025
Copy link
Contributor

openshift-ci bot commented Jan 12, 2025

New changes are detected. LGTM label has been removed.

@bshephar
Copy link
Contributor Author

/retest

@fao89 fao89 added the lgtm label Jan 13, 2025
@openshift-merge-bot openshift-merge-bot bot merged commit 2afb680 into openstack-k8s-operators:main Jan 13, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants