TELCODOCS-597: Adding a local registry to a Single Node OpenShift DU profile #50904

tmulquee · 2022-09-27T10:56:05Z

Versions:

PR applies to all releases from 4.12.

Issue:
https://issues.redhat.com/browse/TELCODOCS-597

Link to docs preview:
https://50904--docspreview.netlify.app/openshift-enterprise/latest/scalability_and_performance/ztp_far_edge/ztp-advanced-policy-config.html#ztp-add-local-reg-for-sno-duprofile_ztp-advanced-policy-config

SME: Nahian Pathan
QE assignee: Marius Cornea

ocpdocs-previewbot · 2022-09-27T11:03:05Z

🤖 Updated build preview is available at:
https://50904--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/4452

mcornea · 2022-11-03T13:38:22Z

modules/ztp-add-local-reg-for-sno-duprofile.adoc

+
+This is unavoidable for the initial deployment. Over time, there is a risk that `crio` will wipe `/var/lib/containers/storage` in the case of a disorderly shutdown.
+
+To address this, you need a local registry on the SNO. The cluster images need to be  mirrored to this registry along with being used as the registry for the applications.


I think it's important to clarify that the image registry can only be used for user application images and cannot be used for the OpenShift release or OLM operators images, see https://issues.redhat.com/browse/RFE-2488

I have addressed this comment in the current preview.

tmulquee · 2022-11-09T10:21:56Z

/label telco

mcornea · 2022-11-15T14:04:14Z

modules/ztp-add-local-reg-for-sno-duprofile.adoc

+
+This is unavoidable for the initial deployment. Over time, there is a risk that `crio` will wipe `/var/lib/containers/storage` in the case of a disorderly shutdown.
+
+To address this, you need a local image registry on the SNO. The cluster images need to be  mirrored to this local image registry along with being used as the registry for the applications. This is useful in Edge scenarios where an SNO is deployed on the Far Edge. The SNO cannot access the internet, just its own resources and eventually the internal network.


I think we should remove The cluster images need to be mirrored to this local image registry since it's in contradiction with the NOTE section.

mcornea · 2022-11-15T14:05:40Z

modules/ztp-configuring-pgt-image-registry.adoc

+[id="ztp-configuring-pgt-image-registry_{context}"]
+= Configuring the image registry using PolicyGenTemplate CRs
+
+You can configure PTP fast events for vRAN clusters that are deployed using the GitOps Zero Touch Provisioning (ZTP) pipeline. Use `PolicyGenTemplate` custom resources (CRs) as the basis to create a hierarchy of configuration files tailored to your specific site requirements.


I don't think PTP fast events are related to this section.

mcornea · 2022-11-15T14:06:17Z

modules/ztp-configuring-pgt-image-registry.adoc

+       annotations:
+         ran.openshift.io/ztp-deploy-wave: "100" <1>
+  # persistent volume claim
+  - fileName: StoragePVC.yaml


This line doesn't have the same indentation level with line 28

@tmulquee it needs an additional space. It does not render correctly in your preview.

tmulquee · 2022-11-16T13:33:34Z

Marius edits implemented.

mcornea · 2022-11-16T13:41:30Z

modules/ztp-configuring-disk-partitioning.adoc

+[id="ztp-configuring-disk-partitioning_{context}"]
+= Configuring disk partitioning with SiteConfig
+
+You can use the `SiteConfig` YAML file to generate the `MachineConfig` CR used for disk partitioning. You need to to modify values in the `MachineConfig` CR to reflect dependencies on the underlying disk.


You need to to modify values in the MachineConfig CR to reflect dependencies on the underlying disk. - imo this statement is not clear. The user entrypoint is the SiteConfig and that's where the disk related values are added. The user doesn't edit MachineConfig directly as they get generated from the SiteConfig.

mcornea · 2022-11-16T14:13:53Z

modules/ztp-add-local-reg-for-sno-duprofile.adoc

+
+[NOTE]
+====
+The local image registry can only be used for user application images and cannot be used for the {product-title} or 	Operator Lifecycle Manager operator images. For details on working with these, see the information on the Topology Aware Lifecycle Manager (TAWLM) in Additional resources.


Topology Aware Lifecycle Manager (TAWLM) - we usually refer to it as TALM, not TAWLM

pixelsoccupied · 2022-11-16T14:17:13Z

modules/ztp-add-local-reg-for-sno-duprofile.adoc

+The local image registry can only be used for user application images and cannot be used for the {product-title} or 	Operator Lifecycle Manager operator images. For details on working with these, see the information on the Topology Aware Lifecycle Manager (TAWLM) in Additional resources.
+====
+
+You can use the `SiteConfig` YAML file to generate the `MachineConfig` CR used for disk partitioning. Then use `PolicyGenTemplate` to apply to create the PV and PVC and patch `imageregistry` configuration.


Can we be a little more explicit here? Start with "This involves 2 steps: step1: Siteconfig... step 2: PGT"

I rephrased as:
The first phase of setting up a local image registry is configuring disk partitioning with SiteConfig. You can use the SiteConfig YAML file to generate the MachineConfig CR used for disk partitioning.
Then next phase is to configure the image registry using PolicyGenTemplate CRs. You can use PolicyGenTemplate to apply to create the PV and PVC and patch imageregistry configuration.

pixelsoccupied · 2022-11-16T14:19:18Z

modules/ztp-configuring-disk-partitioning.adoc

+         size: 102500 <2>
+         start: 344844 <3>
+----
+<1> Depends on the hardware. The setting can also be a serial number or device name, for example `wwn`. The value must match with the `win` entry for `rootDeviceHint`.


1 - the example is already using wwn (remove "for example wwn")
2- "The value must match with the win entry for rootDeviceHint" change to "The value must match with the entry for rootDeviceHint" (drop 'win')

pixelsoccupied · 2022-11-16T14:20:36Z

modules/ztp-configuring-pgt-image-registry.adoc

+----
+<1> Remove this when moved to the correct PGT (`site/group/common`).
+<2> Remove this when moved to the correct PGT (`site/group/common`).
+<3> This assumes that `mount_point` is set to `/var/imageregistry` in `SiteConfig` using StorageClass `image-registry-sc` (see the first sc-file).


Change "see the first sc-file" to something like See "StieConfig from Step 1"

Changed to (see the topic on configuring disk partitioning with SiteConfig)

pixelsoccupied · 2022-11-16T14:22:12Z

modules/ztp-configuring-pgt-image-registry.adoc

+
+You can use `PolicyGenTemplate` to apply to create the PV and PVC and patch `imageregistry` configuration. Select the appropriate `PolicyGenTemplate` for each `source-cr`. See Additional Resources for more help.
+
+.Prerequisites


Generally....the pre req is that the user has ZTP setup

Added "* You have installed and configured Zero Touch Provisioning (ZTP)."

pixelsoccupied · 2022-11-16T14:24:19Z

scalability_and_performance/ztp-deploying-disconnected.adoc

+include::modules/ztp-configuring-pgt-image-registry.adoc[leveloffset=+3]
+
+[role="_additional-resources"]
+.Additional resources


Include ZTP setup process doc here (along with the existing TALM and Image Registry doc)

Added "For further information on this, see the topic on ZTP in Additional resources. "

and

For more information about Zero Touch Provisioning (ZTP) setup, see href: https://docs.openshift.com/container-platform/4.11/scalability_and_performance/ztp-deploying-disconnected.html#about-ztp-and-distributed-units-on-openshift-clusters_ztp-deploying-disconnected[About ZTP and distributed units on OpenShift clusters].

aireilly

Added xrefs based on your suggestions :)

scalability_and_performance/ztp_far_edge/ztp-advanced-policy-config.adoc

aireilly

Added 2 comments on the size and start field descriptions :)

modules/ztp-configuring-disk-partitioning.adoc

tmulquee · 2022-12-01T14:09:49Z

All comments implemented.

tmulquee · 2022-12-01T14:10:35Z

/label merge-review-needed

tmulquee · 2022-12-01T14:24:55Z

Sorry, needed one more push to implement final edits.

aireilly

Hey Tony, noticed an xref is causing the build to fail, also spotted a few more things.

modules/ztp-configuring-pgt-image-registry.adoc

scalability_and_performance/ztp_far_edge/ztp-advanced-policy-config.adoc

tmulquee · 2022-12-02T10:37:56Z

Edits complete. Applying once more for merge.

tmulquee · 2022-12-02T10:38:51Z

/label merge-review-needed

mjpytlak · 2022-12-05T15:56:12Z

@tmulquee I noticed the do not merge-hold label. Just looking to confirm you want this merged. Thanks.

tmulquee · 2022-12-05T16:36:08Z

Yes please Mike. I didn't know whether I had the rights to move that hold label. All edits are done.

mjpytlak · 2022-12-05T17:05:08Z

/cherrypick enterprise-4.12

openshift-cherrypick-robot · 2022-12-05T17:05:53Z

@mjpytlak: new pull request created: #53480

In response to this:

/cherrypick enterprise-4.12

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/test-infra repository.

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 27, 2022

tmulquee force-pushed the TELCODOCS-597 branch from 4a1f078 to 15ec0de Compare September 27, 2022 12:46

pixelsoccupied mentioned this pull request Oct 6, 2022

Bug 2087219: ztp: Renames the partition template and moves diskPartition to cluster spec openshift-kni/cnf-features-deploy#1166

Open

tmulquee force-pushed the TELCODOCS-597 branch 2 times, most recently from 7f7e51d to 68a19ef Compare October 12, 2022 15:00

tmulquee changed the title ~~TELCODOCS-597:~~ TELCODOCS-597: Adding a local registry to a Single Node OpenShift DU profile Oct 13, 2022

tmulquee force-pushed the TELCODOCS-597 branch 2 times, most recently from 444a494 to 00c41bd Compare October 13, 2022 13:44

tmulquee force-pushed the TELCODOCS-597 branch from 00c41bd to 53f6dfd Compare November 1, 2022 14:40

mcornea reviewed Nov 3, 2022

View reviewed changes

tmulquee force-pushed the TELCODOCS-597 branch 5 times, most recently from 966e074 to 345c6b7 Compare November 8, 2022 10:42

openshift-ci bot added the telco Label for all Telco PRs label Nov 9, 2022

tmulquee force-pushed the TELCODOCS-597 branch from 345c6b7 to 300d38f Compare November 11, 2022 12:01

mcornea reviewed Nov 15, 2022

View reviewed changes

tmulquee force-pushed the TELCODOCS-597 branch from 300d38f to b8aeedf Compare November 16, 2022 13:32

mcornea reviewed Nov 16, 2022

View reviewed changes

pixelsoccupied reviewed Nov 16, 2022

View reviewed changes

tmulquee force-pushed the TELCODOCS-597 branch 3 times, most recently from dc1a6a6 to 4f87fe6 Compare November 16, 2022 14:46

aireilly reviewed Nov 30, 2022

View reviewed changes

tmulquee force-pushed the TELCODOCS-597 branch 2 times, most recently from 8359522 to 74244d8 Compare November 30, 2022 14:19

aireilly reviewed Nov 30, 2022

View reviewed changes

modules/ztp-configuring-disk-partitioning.adoc Outdated Show resolved Hide resolved

modules/ztp-configuring-disk-partitioning.adoc Outdated Show resolved Hide resolved

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 1, 2022

mburke5678 added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR labels Dec 1, 2022

tmulquee force-pushed the TELCODOCS-597 branch from 74244d8 to 890dc4b Compare December 1, 2022 14:24

aireilly reviewed Dec 1, 2022

View reviewed changes

mburke5678 removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Dec 1, 2022

tmulquee force-pushed the TELCODOCS-597 branch from 890dc4b to 698b9af Compare December 2, 2022 10:17

TELCODOCS-597: Adding new files to assembly

ed059d2

tmulquee force-pushed the TELCODOCS-597 branch from 698b9af to ed059d2 Compare December 2, 2022 10:28

mjpytlak added this to the Planned for 4.12 GA milestone Dec 5, 2022

mjpytlak added the branch/enterprise-4.12 label Dec 5, 2022

mjpytlak merged commit d38ec9f into openshift:main Dec 5, 2022

openshift-cherrypick-robot mentioned this pull request Dec 5, 2022

[enterprise-4.12] TELCODOCS-597: Adding a local registry to a Single Node OpenShift DU profile #53480

Merged


		This is unavoidable for the initial deployment. Over time, there is a risk that `crio` will wipe `/var/lib/containers/storage` in the case of a disorderly shutdown.

		To address this, you need a local registry on the SNO. The cluster images need to be mirrored to this registry along with being used as the registry for the applications.


		This is unavoidable for the initial deployment. Over time, there is a risk that `crio` will wipe `/var/lib/containers/storage` in the case of a disorderly shutdown.

		To address this, you need a local image registry on the SNO. The cluster images need to be mirrored to this local image registry along with being used as the registry for the applications. This is useful in Edge scenarios where an SNO is deployed on the Far Edge. The SNO cannot access the internet, just its own resources and eventually the internal network.


		You can use `PolicyGenTemplate` to apply to create the PV and PVC and patch `imageregistry` configuration. Select the appropriate `PolicyGenTemplate` for each `source-cr`. See Additional Resources for more help.

		.Prerequisites

TELCODOCS-597: Adding a local registry to a Single Node OpenShift DU profile #50904

TELCODOCS-597: Adding a local registry to a Single Node OpenShift DU profile #50904

Conversation

tmulquee commented Sep 27, 2022 • edited

ocpdocs-previewbot commented Sep 27, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tmulquee commented Nov 9, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tmulquee commented Nov 16, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aireilly left a comment

Choose a reason for hiding this comment

aireilly left a comment

Choose a reason for hiding this comment

tmulquee commented Dec 1, 2022

tmulquee commented Dec 1, 2022

tmulquee commented Dec 1, 2022

aireilly left a comment

Choose a reason for hiding this comment

tmulquee commented Dec 2, 2022

tmulquee commented Dec 2, 2022

mjpytlak commented Dec 5, 2022

tmulquee commented Dec 5, 2022

mjpytlak commented Dec 5, 2022

openshift-cherrypick-robot commented Dec 5, 2022

tmulquee commented Sep 27, 2022 •

edited

ocpdocs-previewbot commented Sep 27, 2022 •

edited