TELCODOCS-2823: Update telco core RDS for 4.21#109941
TELCODOCS-2823: Update telco core RDS for 4.21#109941kquinn1204 wants to merge 2 commits intoopenshift:mainfrom
Conversation
Regenerated telco core RDS modules from the monolithic source using the telco-rds pipeline (strip internal content, split by section IDs, generate modular docs headers). Assembly file preserved with existing additional resources and CR reference sections. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
openshift-ci-robot
added
the
jira/valid-reference
|
@kquinn1204: This pull request references TELCODOCS-2823 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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
bot
added
the
size/L
|
🤖 Mon Apr 13 08:42:01 - Prow CI generated the docs preview: |
| :_mod-docs-content-type: CONCEPT | ||
| [id="telco-core-agent-based-installer_{context}"] | ||
| = Agent-based Installer | ||
| = Agent-based installer |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
| :_mod-docs-content-type: REFERENCE | ||
| [id="telco-core-cert-manager-operator_{context}"] | ||
| = cert-manager Operator | ||
| = Cert-Manager Operator |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
| ** When EgressIP is configured with multiple egress nodes, the failover time is expected to be on the order of seconds or longer. | ||
| ** On nodes with additional network interfaces EgressIP traffic will egress through the interface on which the EgressIP address has been assigned. | ||
| For more information, see "Configuring an egress IP address". | ||
| See the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/ovn-kubernetes_network_plugin/configuring-egress-ips-ovn[EgressIP documentation]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
|
|
||
| * A schedulable control plane variant, which allows for user workloads to run on master nodes to optimize resource utilization. This variant is only applicable to bare-metal control plane nodes and must be configured at installation time. | ||
| + | ||
| * A schedulable control plane variant, which allows for user workloads to run on master nodes to optimize resource utilization. This variant is only applicable to bare metal control plane nodes and must be configured at installation time. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'bare-metal control' rather than 'bare metal control'. For more information, see RedHat.TermsErrors.
| :_mod-docs-content-type: REFERENCE | ||
| :_mod-docs-content-type: CONCEPT | ||
| [id="telco-core-deployment-planning_{context}"] | ||
| = Deployment planning |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
| :_mod-docs-content-type: REFERENCE | ||
| [id="telco-core-gitops-operator-and-ztp-plugins_{context}"] | ||
| = GitOps Operator and {ztp} plugins | ||
| = GitOps Operator and ZTP plugins |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
| Cluster definitions and configuration are maintained in a Git repository. | ||
|
|
||
| The SiteConfig Operator generates installation CRs from `ClusterInstance` CRs. | ||
| ZTP plugins provide support for generating `Installation` CRs from `SiteConfig` CRs and automatically wrapping configuration CRs in policies based on RHACM `PolicyGenerator` CRs. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.
| :_mod-docs-content-type: CONCEPT | ||
| [id="telco-core-openshift-data-foundation_{context}"] | ||
| = {rh-storage} | ||
| = OpenShift Data Foundation |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
| :_mod-docs-content-type: CONCEPT | ||
| [id="telco-core-openshift-data-foundation_{context}"] | ||
| = {rh-storage} | ||
| = OpenShift Data Foundation |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-storage}' rather than the plain text product term 'OpenShift Data Foundation', unless your use case is an exception.
| :_mod-docs-content-type: REFERENCE | ||
| [id="telco-core-rds-product-version-use-model-overview_{context}"] | ||
| = Telco core RDS use model overview | ||
| = Telco core RDS 4.21 use model overview |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
| Limits and requirements:: | ||
|
|
||
| * Hub cluster sizing is discussed in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html-single/install/index#sizing-your-cluster[Sizing your cluster]. | ||
| * Hub cluster sizing is discussed in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.15/html-single/install/index#sizing-your-cluster[Sizing your cluster]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| * Hub cluster sizing is discussed in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.15/html-single/install/index#sizing-your-cluster[Sizing your cluster]. | ||
|
|
||
| * {rh-rhacm} scaling limits are described in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html-single/install/index#performance-and-scalability[Performance and Scalability]. | ||
| * {rh-rhacm} scaling limits are described in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.15/html-single/install/index#performance-and-scalability[Performance and Scalability]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| Description:: | ||
| Scale clusters as described in "Limits and requirements". | ||
| Scaling of workloads is described in "Application workloads". | ||
| Scaling of workloads is described in <<Application workloads>>. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
|
|
||
| NUMA-aware scheduling can be enabled through the NUMA Resources Operator. | ||
| For more information, see "Scheduling NUMA-aware workloads". | ||
| For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/scalability_and_performance/cnf-numa-aware-scheduling[Scheduling NUMA-aware workloads] |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| It only knows about the sum of all free resources on a worker node. | ||
| This might cause workloads to be rejected when scheduled to a node with the topology manager policy set to single-numa-node or restricted. | ||
| For more information, see "Topology Manager policies".. | ||
| See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/scalability_and_performance/using-cpu-manager#topology-manager-policies_using-cpu-manager-and-topology-manager[Topology Manager policies]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| The node local admission fails, as there are only 4 CPUs available in each of the NUMA nodes. | ||
| * All clusters with multi-NUMA nodes are required to use the NUMA Resources Operator. | ||
| See "Installing the NUMA Resources Operator" for more information. | ||
| See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/scalability_and_performance/cnf-numa-aware-scheduling#cnf-about-numa-aware-scheduling_numa-aware[NUMA resources operator] for more information. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| Engineering considerations:: | ||
| * Pods might require annotations for correct scheduling and isolation. | ||
| For more information about annotations, see "CPU partitioning and performance tuning". | ||
| For more information about annotations, see <<CPU partitioning and performance tuning>>. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
modules/telco-core-security.adoc
Outdated
| See the "Storage" section for additional details. | ||
|
|
||
| See the Red Hat Knowledgebase solution article link:https://access.redhat.com/articles/7090422[Custom nftable firewall rules in {product-title}] for a supported method for implementing custom nftables firewall rules in {product-title} cluster nodes. This article is intended for cluster administrators who are responsible for managing network security policies in {product-title} environments. | ||
| Refer to link:https://access.redhat.com/articles/7090422[Custom nftable firewall rules in OpenShift] for a supported method for implementing custom nftables firewall rules in OpenShift cluster nodes. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
modules/telco-core-security.adoc
Outdated
| * External endpoints: {product-title} requires access to external endpoints to function. | ||
| For more information about the firewall allowlist, see "Configuring your firewall for {product-title}". Ensure that cluster nodes are permitted access to those endpoints. Ensure that cluster nodes are permitted access to those endpoints. | ||
| * External endpoints: OpenShift requires access to external endpoints to function. | ||
| For more information about the firewall allowlist, see link:https://docs.openshift.com/container-platform/4.21/installing/install_config/configuring-firewall.html#configuring-firewall_configuring-firewall[Configuring your firewall for OpenShift Container Platform]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
modules/telco-core-security.adoc
Outdated
| * External endpoints: {product-title} requires access to external endpoints to function. | ||
| For more information about the firewall allowlist, see "Configuring your firewall for {product-title}". Ensure that cluster nodes are permitted access to those endpoints. Ensure that cluster nodes are permitted access to those endpoints. | ||
| * External endpoints: OpenShift requires access to external endpoints to function. | ||
| For more information about the firewall allowlist, see link:https://docs.openshift.com/container-platform/4.21/installing/install_config/configuring-firewall.html#configuring-firewall_configuring-firewall[Configuring your firewall for OpenShift Container Platform]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| ==== | ||
|
|
||
| * Network flow matrix: For more information about managing ingress traffic, see {product-title} network flow matrix. | ||
| * Network flow matrix: For more information about managing ingress traffic, see link:https://docs.openshift.com/container-platform/4.21/installing/install_config/configuring-firewall.html#network-flow-matrix_configuring-firewall[Network flow matrix]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| * Orchestration of an upgrade, including OpenShift, day-2 OLM operators and custom configuration can be done using a ClusterGroupUpgrade (CGU) CR containing policies describing these updates. | ||
| ** An EUS to EUS upgrade can be orchestrated using chained CGU CRs | ||
| ** Control of MCP pause can be managed through policy in the CGU CRs for a full control plane and worker node rollout of upgrades. | ||
| ** A full procedure is provided in https://docs.openshift.com/container-platform/4.21/edge_computing/<location is TBD>[Automated EUS-EUS] documentation. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| This is crucial because telco-grade services might otherwise be affected if careful planning is not considered. | ||
|
|
||
| During cluster upgrades, you can pause MCPs while you upgrade the control plane. See "Performing a canary rollout update" for more information. This ensures that worker nodes are not rebooted and running workloads remain unaffected until the MCP is unpaused. | ||
| During cluster upgrades, MCPs can be paused while the control plane is upgraded (see https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/updating_clusters/performing-a-cluster-update#update-using-custom-machine-config-pools[canary upgrade]). |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
|
|
||
| Using careful MCP planning, you can control the timing and order of which set of nodes are upgraded at any time. For more information on how to use MCPs to plan telco upgrades, see "Applying MachineConfigPool labels to nodes before the update". | ||
| Using careful MCP planning, you can control the timing and order of which set of nodes are upgraded at any time. | ||
| For more information on how to use MCPs to plan telco upgrades, see https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/edge_computing/day-2-operations-for-telco-core-cnf-clusters#telco-update-applying-mcp-labels-to-nodes-before-the-update_ocp-update-prep[Applying MachineConfigPool labels to nodes before the update]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| ** Desired `maxUnavailable` (number of nodes updated concurrently) for the MCP. | ||
| * CNF requirements for worker nodes, in terms of: | ||
| ** Minimum availability per Pod required during an upgrade, configured with a pod disruption budget (PDB). PDBs are crucial to maintain telco service level Agreements (SLAs) during upgrades. For more information about PDB, see "Understanding how to use pod disruption budgets to specify the number of pods that must be up". | ||
| ** Minimum availability per Pod required during an upgrade, configured with a Pod Disruption Budget (PDB). link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/nodes/working-with-pods#nodes-pods-pod-distruption-about_nodes-pods-configuring[PDBs] are crucial to maintain Telco Service level Agreements (SLAs) during upgrades. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| ** Minimum availability per Pod required during an upgrade, configured with a Pod Disruption Budget (PDB). link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/nodes/working-with-pods#nodes-pods-pod-distruption-about_nodes-pods-configuring[PDBs] are crucial to maintain Telco Service level Agreements (SLAs) during upgrades. | ||
| ** Minimum true high availability required per Pod, such that each replica runs on separate hardware. | ||
| ** Pod affinity and anti-affinity link: For more information about how to use pod affinity and anti-affinity, see "Placing pods relative to other pods using affinity and anti-affinity rules". | ||
| ** Pod affinity and anti-affinity [rules]link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/nodes/controlling-pod-placement-onto-nodes-scheduling#nodes-scheduler-pod-affinity[rules] |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.
|
@kquinn1204: This pull request references TELCODOCS-2823 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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. |
… modules
Replace hardcoded product names with build-time attributes:
- "OpenShift" -> {product-title}
- "OpenShift Data Foundation" -> {rh-storage}
- "ACM" -> {rh-rhacm-first}
Also fix "poll" -> "pool" typo and stray opening quote.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
| See the "Storage" section for additional details. | ||
|
|
||
| See the Red Hat Knowledgebase solution article link:https://access.redhat.com/articles/7090422[Custom nftable firewall rules in {product-title}] for a supported method for implementing custom nftables firewall rules in {product-title} cluster nodes. This article is intended for cluster administrators who are responsible for managing network security policies in {product-title} environments. | ||
| Refer to link:https://access.redhat.com/articles/7090422[Custom nftable firewall rules in {product-title}] for a supported method for implementing custom nftables firewall rules in {product-title} cluster nodes. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| Thoroughly test your rules in a non-production environment before deploying them to your main cluster. | ||
| * External endpoints: {product-title} requires access to external endpoints to function. | ||
| For more information about the firewall allowlist, see "Configuring your firewall for {product-title}". Ensure that cluster nodes are permitted access to those endpoints. Ensure that cluster nodes are permitted access to those endpoints. | ||
| For more information about the firewall allowlist, see link:https://docs.openshift.com/container-platform/4.21/installing/install_config/configuring-firewall.html#configuring-firewall_configuring-firewall[Configuring your firewall for {product-title}]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
|
@kquinn1204: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
4 participants
Summary
[id=""]section markers, adds modular docs headersPreview
https://109941--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/telco-core-rds.html
Pipeline used
Source:
gitlab.cee.redhat.com/reference-configurations/reference-design-specifications(main branch)Test plan
asciibinder buildinclude::directives in the assembly resolve🤖 Generated with Claude Code