openshift-docs
openshift-docs copied to clipboard
openshift
TELCODOCS-522 - ZTP content reorg
This PR updates the existing monolithic ZTP docs assembly into a number of smaller more coherent assemblies. There is some content updates too, but for the most part this just breaks up ZTP into smaller assemblies.
Addresses https://issues.redhat.com/browse/TELCODOCS-522
Preview: https://49805--docspreview.netlify.app/openshift-enterprise/latest/scalability_and_performance/ztp-far-edge/ztp-deploying-far-edge-clusters-at-scale.html
Merge to main, enterprise-4.10+
🤖 Updated build preview is available at: https://49805--docspreview.netlify.app
Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/3825
Just want to clarify the ztp container image tag changes with z releases. Currently for 4.11, the latest is v4.11.1, but for 4.10, it's a different tag.
So hardcoding it to .1 like below might be misleading.
$ podman run -it --rm -v pwd/out/argocd/example/policygentemplates:/resources:Z -v pwd/ref:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version}.1 generator config -N . /output
@imiller0 do you know if there is an easy way to get the latest released version for a y stream?
Just want to clarify the ztp container image tag changes with z releases. Currently for 4.11, the latest is v4.11.1, but for 4.10, it's a different tag.
So hardcoding it to .1 like below might be misleading.
$ podman run -it --rm -vpwd/out/argocd/example/policygentemplates:/resources:Z -vpwd/ref:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version}.1 generator config -N . /output@imiller0 do you know if there is an easy way to get the latest released version for a y stream?
Why can't we just do (for example):
$ podman pull registry.redhat.io/openshift4/ztp-site-generate-rhel8:v4.11
Trying to pull registry.redhat.io/openshift4/ztp-site-generate-rhel8:v4.11...
Doesn't the above pull the latest image on 4.11?
We can use {product-version} in place of the 4.11 string.
Just want to clarify the ztp container image tag changes with z releases. Currently for 4.11, the latest is v4.11.1, but for 4.10, it's a different tag.
So hardcoding it to .1 like below might be misleading.
$ podman run -it --rm -vpwd/out/argocd/example/policygentemplates:/resources:Z -vpwd/ref:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version}.1 generator config -N . /output@imiller0 do you know if there is an easy way to get the latest released version for a y stream?
@yliu127, yes the registry includes y-stream tags (at least for 4.11) as well as z-stream tags (can see them here). So I think we can leave off the .1.
One small correction for the change from out/ to update/ but otherwise looks good to me
Thanks I made these changes. @yliu127 this is ready for final review now.
@aireilly: The label(s) /remove-label branch/enterprise-4.10 cannot be applied. These labels are supported: platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, downstream-change-needed, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, cnv, dev-tools, distributed-tracing, ims, jira/valid-bug, merge-review-in-progress, merge-review-needed, mtc, multi-arch, oadp, peer-review-done, peer-review-in-progress, peer-review-needed, rhacs, rhv, serverless, service-mesh, staff-eng-approved, telco. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?
In response to this:
/remove-label branch/enterprise-4.10
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] avatar](https://avatars.githubusercontent.com/in/91280?v=4 "Published by a pub.dev verified publisher"){kind=small}
@aireilly: The label(s) `/remove-label enterprise-4.10
cannot be applied. These labels are supported:platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, downstream-change-needed, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, cnv, dev-tools, distributed-tracing, ims, jira/valid-bug, merge-review-in-progress, merge-review-needed, mtc, multi-arch, oadp, peer-review-done, peer-review-in-progress, peer-review-needed, rhacs, rhv, serverless, service-mesh, staff-eng-approved, telco. Is this label configured under labels -> additional_labelsorlabels -> restricted_labelsinplugin.yaml`?
In response to this:
/remove-label enterprise-4.10
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.
@skrthomas: #49805 failed to apply on top of branch "enterprise-4.11":
Applying: latest updates for TELCODOCS-522
Using index info to reconstruct a base tree...
M _attributes/common-attributes.adoc
M _topic_maps/_topic_map.yml
A installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc
M modules/ztp-acm-adding-images-to-mirror-registry.adoc
M modules/ztp-deploying-a-site.adoc
M modules/ztp-du-bios-config-reference.adoc
M modules/ztp-manually-install-a-single-managed-cluster.adoc
M modules/ztp-ztp-custom-resources.adoc
M scalability_and_performance/cnf-low-latency-tuning.adoc
M scalability_and_performance/ztp-deploying-disconnected.adoc
Falling back to patching base and 3-way merge...
Removing scalability_and_performance/ztp-vdu-validating-cluster-tuning.adoc
CONFLICT (modify/delete): scalability_and_performance/ztp-deploying-disconnected.adoc deleted in latest updates for TELCODOCS-522 and modified in HEAD. Version HEAD of scalability_and_performance/ztp-deploying-disconnected.adoc left in tree.
Removing scalability_and_performance/ztp-configuring-single-node-cluster-deployment-during-installation.adoc
Removing scalability_and_performance/cnf-provisioning-and-deploying-a-distributed-unit.adoc
Auto-merging scalability_and_performance/cnf-low-latency-tuning.adoc
CONFLICT (content): Merge conflict in scalability_and_performance/cnf-low-latency-tuning.adoc
CONFLICT (modify/delete): modules/ztp-ztp-custom-resources.adoc deleted in latest updates for TELCODOCS-522 and modified in HEAD. Version HEAD of modules/ztp-ztp-custom-resources.adoc left in tree.
Removing modules/ztp-validating-the-generation-of-installation-crs.adoc
Removing modules/ztp-upgrading-gitops-ztp.adoc
Removing modules/ztp-troubleshooting-gitops-ztp.adoc
Removing modules/ztp-topology-aware-lifecycle-manager.adoc
Removing modules/ztp-the-gitops-approach.adoc
Removing modules/ztp-support-for-deployment-of-multi-node-clusters.adoc
Removing modules/ztp-single-node-clusters.adoc
Removing modules/ztp-querying-the-policy-compliance-status-for-each-cluster.adoc
Removing modules/ztp-provisioning-edge-sites-at-scale.adoc
Removing modules/ztp-node-tuning-operator.adoc
Removing modules/ztp-monitoring-deployment-progress.adoc
Auto-merging modules/ztp-manually-install-a-single-managed-cluster.adoc
CONFLICT (content): Merge conflict in modules/ztp-manually-install-a-single-managed-cluster.adoc
Removing modules/ztp-low-latency-for-distributed-units-dus.adoc
Removing modules/ztp-installing-the-gitops-ztp-pipeline.adoc
Removing modules/ztp-how-to-plan-your-ran-policies.adoc
Removing modules/ztp-generating-ran-policies.adoc
Removing modules/ztp-du-host-bios-requirements.adoc
Auto-merging modules/ztp-du-firmware-config-reference.adoc
Auto-merging modules/ztp-deploying-a-site.adoc
CONFLICT (content): Merge conflict in modules/ztp-deploying-a-site.adoc
Removing modules/ztp-creating-ztp-custom-resources-for-multiple-managed-clusters.adoc
Removing modules/ztp-creating-the-policygentemplate-cr.adoc
Removing modules/ztp-configuring-uefi-secure-boot.adoc
Removing modules/ztp-configuring-ipv6.adoc
Removing modules/ztp-configuring-a-static-ip.adoc
Removing modules/ztp-ai-install-ocp-clusters-on-bare-metal.adoc
Removing modules/ztp-acm-preparing-to-install-disconnected-acm.adoc
Auto-merging modules/ztp-acm-adding-images-to-mirror-registry.adoc
CONFLICT (content): Merge conflict in modules/ztp-acm-adding-images-to-mirror-registry.adoc
Removing modules/sno-du-removing-the-console-operator.adoc
Removing modules/sno-du-configuring-the-distributed-units.adoc
Removing modules/sno-du-configuring-performance-addons.adoc
Removing modules/sno-du-applying-the-post-install-configuration-custom-resources.adoc
Removing modules/sno-du-applying-the-extra-installation-manifests.adoc
Removing modules/sno-du-applying-the-distributed-unit-configuration-to-sno.adoc
Removing modules/cnf-topology-aware-lifecycle-manager.adoc
Removing modules/cnf-du-workload-partitioning-pod-mutation.adoc
Removing modules/cnf-du-required-annotations-for-workload-partitioning.adoc
Removing modules/cnf-du-partitioning-management-workloads.adoc
Removing modules/cnf-du-crio-configuration-for-workload-partitioning.adoc
Removing modules/cnf-du-creating-a-machine-config-manifest-for-workload-partitioning.adoc
Removing modules/cnf-du-configuring-workload-partitioning.adoc
Removing modules/cnf-deploying-the-du-infrastructure-profile.adoc
Removing modules/about-ztp-and-distributed-units-on-openshift-clusters.adoc
CONFLICT (modify/delete): installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc deleted in HEAD and modified in latest updates for TELCODOCS-522. Version latest updates for TELCODOCS-522 of installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc left in tree.
Auto-merging _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 latest updates for TELCODOCS-522
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
In response to this:
/cherry-pick enterprise-4.11
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.
@skrthomas: new pull request created: #53007
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.
@skrthomas: #49805 failed to apply on top of branch "enterprise-4.11":
Applying: latest updates for TELCODOCS-522
Using index info to reconstruct a base tree...
M _attributes/common-attributes.adoc
M _topic_maps/_topic_map.yml
A installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc
M modules/ztp-acm-adding-images-to-mirror-registry.adoc
M modules/ztp-deploying-a-site.adoc
M modules/ztp-du-bios-config-reference.adoc
M modules/ztp-manually-install-a-single-managed-cluster.adoc
M modules/ztp-ztp-custom-resources.adoc
M scalability_and_performance/cnf-low-latency-tuning.adoc
M scalability_and_performance/ztp-deploying-disconnected.adoc
Falling back to patching base and 3-way merge...
Removing scalability_and_performance/ztp-vdu-validating-cluster-tuning.adoc
CONFLICT (modify/delete): scalability_and_performance/ztp-deploying-disconnected.adoc deleted in latest updates for TELCODOCS-522 and modified in HEAD. Version HEAD of scalability_and_performance/ztp-deploying-disconnected.adoc left in tree.
Removing scalability_and_performance/ztp-configuring-single-node-cluster-deployment-during-installation.adoc
Removing scalability_and_performance/cnf-provisioning-and-deploying-a-distributed-unit.adoc
Auto-merging scalability_and_performance/cnf-low-latency-tuning.adoc
CONFLICT (content): Merge conflict in scalability_and_performance/cnf-low-latency-tuning.adoc
CONFLICT (modify/delete): modules/ztp-ztp-custom-resources.adoc deleted in latest updates for TELCODOCS-522 and modified in HEAD. Version HEAD of modules/ztp-ztp-custom-resources.adoc left in tree.
Removing modules/ztp-validating-the-generation-of-installation-crs.adoc
Removing modules/ztp-upgrading-gitops-ztp.adoc
Removing modules/ztp-troubleshooting-gitops-ztp.adoc
Removing modules/ztp-topology-aware-lifecycle-manager.adoc
Removing modules/ztp-the-gitops-approach.adoc
Removing modules/ztp-support-for-deployment-of-multi-node-clusters.adoc
Removing modules/ztp-single-node-clusters.adoc
Removing modules/ztp-querying-the-policy-compliance-status-for-each-cluster.adoc
Removing modules/ztp-provisioning-edge-sites-at-scale.adoc
Removing modules/ztp-node-tuning-operator.adoc
Removing modules/ztp-monitoring-deployment-progress.adoc
Auto-merging modules/ztp-manually-install-a-single-managed-cluster.adoc
CONFLICT (content): Merge conflict in modules/ztp-manually-install-a-single-managed-cluster.adoc
Removing modules/ztp-low-latency-for-distributed-units-dus.adoc
Removing modules/ztp-installing-the-gitops-ztp-pipeline.adoc
Removing modules/ztp-how-to-plan-your-ran-policies.adoc
Removing modules/ztp-generating-ran-policies.adoc
Removing modules/ztp-du-host-bios-requirements.adoc
Auto-merging modules/ztp-du-firmware-config-reference.adoc
Auto-merging modules/ztp-deploying-a-site.adoc
CONFLICT (content): Merge conflict in modules/ztp-deploying-a-site.adoc
Removing modules/ztp-creating-ztp-custom-resources-for-multiple-managed-clusters.adoc
Removing modules/ztp-creating-the-policygentemplate-cr.adoc
Removing modules/ztp-configuring-uefi-secure-boot.adoc
Removing modules/ztp-configuring-ipv6.adoc
Removing modules/ztp-configuring-a-static-ip.adoc
Removing modules/ztp-ai-install-ocp-clusters-on-bare-metal.adoc
Removing modules/ztp-acm-preparing-to-install-disconnected-acm.adoc
Auto-merging modules/ztp-acm-adding-images-to-mirror-registry.adoc
CONFLICT (content): Merge conflict in modules/ztp-acm-adding-images-to-mirror-registry.adoc
Removing modules/sno-du-removing-the-console-operator.adoc
Removing modules/sno-du-configuring-the-distributed-units.adoc
Removing modules/sno-du-configuring-performance-addons.adoc
Removing modules/sno-du-applying-the-post-install-configuration-custom-resources.adoc
Removing modules/sno-du-applying-the-extra-installation-manifests.adoc
Removing modules/sno-du-applying-the-distributed-unit-configuration-to-sno.adoc
Removing modules/cnf-topology-aware-lifecycle-manager.adoc
Removing modules/cnf-du-workload-partitioning-pod-mutation.adoc
Removing modules/cnf-du-required-annotations-for-workload-partitioning.adoc
Removing modules/cnf-du-partitioning-management-workloads.adoc
Removing modules/cnf-du-crio-configuration-for-workload-partitioning.adoc
Removing modules/cnf-du-creating-a-machine-config-manifest-for-workload-partitioning.adoc
Removing modules/cnf-du-configuring-workload-partitioning.adoc
Removing modules/cnf-deploying-the-du-infrastructure-profile.adoc
Removing modules/about-ztp-and-distributed-units-on-openshift-clusters.adoc
CONFLICT (modify/delete): installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc deleted in HEAD and modified in latest updates for TELCODOCS-522. Version latest updates for TELCODOCS-522 of installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc left in tree.
Auto-merging _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 latest updates for TELCODOCS-522
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
In response to this:
/cherrypick enterprise-4.11
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.
@aireilly looks like there's merge conflicts 😬 can you look into it before I proceed?