Adding Telco hub cluster RDS 4.18 docs fixes #91599
Conversation
openshift-ci
bot
added
the
size/XXL
| [cols="4*", options="header", format=csv] | ||
| |==== | ||
| Component,Reference CR,Description,Optional | ||
| RHACM,`acmAgentServiceConfig.yaml`,Creates a policy to manage copying data from an object bucket claim into a secret for Observability to connect to Thanos.,No |
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.
| |==== | ||
| Component,Reference CR,Description,Optional | ||
| RHACM,`acmAgentServiceConfig.yaml`,Creates a policy to manage copying data from an object bucket claim into a secret for Observability to connect to Thanos.,No | ||
| RHACM,`acmMCH.yaml`,"Configures a MultiClusterHub with high availability, enabling various components and specifying installation settings for Open Cluster Management.",No |
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.
| Component,Reference CR,Description,Optional | ||
| RHACM,`acmAgentServiceConfig.yaml`,Creates a policy to manage copying data from an object bucket claim into a secret for Observability to connect to Thanos.,No | ||
| RHACM,`acmMCH.yaml`,"Configures a MultiClusterHub with high availability, enabling various components and specifying installation settings for Open Cluster Management.",No | ||
| RHACM,`acmMirrorRegistryCM.yaml`,"Defines the SSL certificates and mirror registry configuration for various Red Hat and OpenShift container registries used by the multicluster-engine in the multicluster-engine namespace.",No |
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.
| RHACM,`acmAgentServiceConfig.yaml`,Creates a policy to manage copying data from an object bucket claim into a secret for Observability to connect to Thanos.,No | ||
| RHACM,`acmMCH.yaml`,"Configures a MultiClusterHub with high availability, enabling various components and specifying installation settings for Open Cluster Management.",No | ||
| RHACM,`acmMirrorRegistryCM.yaml`,"Defines the SSL certificates and mirror registry configuration for various Red Hat and OpenShift container registries used by the multicluster-engine in the multicluster-engine namespace.",No | ||
| RHACM,`acmNS.yaml`,Defines the open-cluster-management namespace with a label to enable cluster monitoring.,No |
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.
| RHACM,`acmMCH.yaml`,"Configures a MultiClusterHub with high availability, enabling various components and specifying installation settings for Open Cluster Management.",No | ||
| RHACM,`acmMirrorRegistryCM.yaml`,"Defines the SSL certificates and mirror registry configuration for various Red Hat and OpenShift container registries used by the multicluster-engine in the multicluster-engine namespace.",No | ||
| RHACM,`acmNS.yaml`,Defines the open-cluster-management namespace with a label to enable cluster monitoring.,No | ||
| RHACM,`acmOperGroup.yaml`,"Defines an OperatorGroup for the open-cluster-management namespace, targeting the same namespace.",No |
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.
| RHACM,`acmMirrorRegistryCM.yaml`,"Defines the SSL certificates and mirror registry configuration for various Red Hat and OpenShift container registries used by the multicluster-engine in the multicluster-engine namespace.",No | ||
| RHACM,`acmNS.yaml`,Defines the open-cluster-management namespace with a label to enable cluster monitoring.,No | ||
| RHACM,`acmOperGroup.yaml`,"Defines an OperatorGroup for the open-cluster-management namespace, targeting the same namespace.",No | ||
| RHACM,`acmPerfSearch.yaml`,"Configures search for Open Cluster Management by defining various parameters and API settings.",No |
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.
| RHACM,`acmNS.yaml`,Defines the open-cluster-management namespace with a label to enable cluster monitoring.,No | ||
| RHACM,`acmOperGroup.yaml`,"Defines an OperatorGroup for the open-cluster-management namespace, targeting the same namespace.",No | ||
| RHACM,`acmPerfSearch.yaml`,"Configures search for Open Cluster Management by defining various parameters and API settings.",No | ||
| RHACM,`acmProvisioning.yaml`,Configures a provisioning resource in the metal3.io/v1alpha1 API version to watch all namespaces.,No |
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.
| RHACM,`acmOperGroup.yaml`,"Defines an OperatorGroup for the open-cluster-management namespace, targeting the same namespace.",No | ||
| RHACM,`acmPerfSearch.yaml`,"Configures search for Open Cluster Management by defining various parameters and API settings.",No | ||
| RHACM,`acmProvisioning.yaml`,Configures a provisioning resource in the metal3.io/v1alpha1 API version to watch all namespaces.,No | ||
| RHACM,`acmSubscription.yaml`,"Subscribes to the Advanced Cluster Management Operator using automatic install plan approval",No |
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.
| RHACM,`acmPerfSearch.yaml`,"Configures search for Open Cluster Management by defining various parameters and API settings.",No | ||
| RHACM,`acmProvisioning.yaml`,Configures a provisioning resource in the metal3.io/v1alpha1 API version to watch all namespaces.,No | ||
| RHACM,`acmSubscription.yaml`,"Subscribes to the Advanced Cluster Management Operator using automatic install plan approval",No | ||
| RHACM,`observabilityMCO.yaml`,Configures MultiClusterObservability in OpenShift for managing observability and alerting across multiple clusters.,No |
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.
| RHACM,`acmProvisioning.yaml`,Configures a provisioning resource in the metal3.io/v1alpha1 API version to watch all namespaces.,No | ||
| RHACM,`acmSubscription.yaml`,"Subscribes to the Advanced Cluster Management Operator using automatic install plan approval",No | ||
| RHACM,`observabilityMCO.yaml`,Configures MultiClusterObservability in OpenShift for managing observability and alerting across multiple clusters.,No | ||
| RHACM,`observabilityNS.yaml`,Creates an open-cluster-management-observability namespace.,No |
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.
| RHACM,`acmSubscription.yaml`,"Subscribes to the Advanced Cluster Management Operator using automatic install plan approval",No | ||
| RHACM,`observabilityMCO.yaml`,Configures MultiClusterObservability in OpenShift for managing observability and alerting across multiple clusters.,No | ||
| RHACM,`observabilityNS.yaml`,Creates an open-cluster-management-observability namespace.,No | ||
| RHACM,`observabilityOBC.yaml`,Creates an ObjectBucketClaim CR in the open-cluster-management-observability namespace.,No |
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.
| RHACM,`observabilityMCO.yaml`,Configures MultiClusterObservability in OpenShift for managing observability and alerting across multiple clusters.,No | ||
| RHACM,`observabilityNS.yaml`,Creates an open-cluster-management-observability namespace.,No | ||
| RHACM,`observabilityOBC.yaml`,Creates an ObjectBucketClaim CR in the open-cluster-management-observability namespace.,No | ||
| RHACM,`observabilitySecret.yaml`,Creates a Secret CR in the open-cluster-management-observability namespace for storing Docker configuration details.,No |
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.
| RHACM,`observabilityNS.yaml`,Creates an open-cluster-management-observability namespace.,No | ||
| RHACM,`observabilityOBC.yaml`,Creates an ObjectBucketClaim CR in the open-cluster-management-observability namespace.,No | ||
| RHACM,`observabilitySecret.yaml`,Creates a Secret CR in the open-cluster-management-observability namespace for storing Docker configuration details.,No | ||
| RHACM,`thanosSecret.yaml`,Creates a policy to copy data from an Object Bucket Claim into a secret for observability to connect to Thanos.,No |
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.
| ==== | ||
|
|
||
| Limits and requirements:: | ||
| * When upgrading a Telco hub cluster, the versions of {product-title} and Operators must meet the requirements of all relevant compatibility matrices. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'matrixes' rather than 'matrices'. For more information, see RedHat.TermsErrors.
| The SiteConfig Operator introduces a unified ClusterInstance API that decouples the parameters that define the cluster from the manner in which it is deployed. | ||
| The SiteConfig Operator uses a set of cluster templates that are instantiated using the data from a `ClusterInstance` CR to dynamically generate installation manifests. | ||
| Following the GitOps methodology, the `ClusterInstance` CR is sourced from a Git repository through ArgoCD. | ||
| The `ClusterInstance` CR can be used to initiate cluster installation by using either the multicluster engine, assisted installer, or the image-based installation methodologies. |
There was a problem hiding this comment.
🤖 [error] Vale.Terms: Use 'Assisted Installer' instead of 'assisted installer'.
| If the policy remediation action is set to "enforce" the violations are remediated according to the updated policy. | ||
| If the policy remediation action is set to "inform", the process ends with a non-compliant status report and responsibility to initiate the upgrade is left to the user to perform during an appropriate maintenance window. | ||
|
|
||
| The Topology Aware Lifecycle Manager ({cgu-operator}) extends {rh-rhacm} with features to manage the rollout of upgrades or configuration throughout the lifecycle of the fleet of clusters. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{cgu-operator-full}' rather than the plain text product term 'Topology Aware Lifecycle Manager', unless your use case is an exception.
|
|
||
| While it is not mandatory to have it on the hub cluster, it is highly recommended for cluster backup , disaster recovery and High availability architecture for the hub cluster. | ||
| The backup operator must be enabled to use the disaster recovery solutions for {rh-rhacm} for Kubernetes. | ||
| The reference configuration enables backup (OADP) through the MultiClusterHub CR provided by the RHACM Operator. |
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.
| @@ -0,0 +1,3 @@ | |||
| // Module included in the following assemblies: | |||
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.
| ** link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/scalability_and_performance/telco-ran-du-ref-design-specs[Telco RAN DU RDS] | ||
|
|
||
| * For more information about lifecycle management for the fleet of managed clusters see: | ||
| ** link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/edge_computing/image-based-upgrade-for-single-node-openshift-clusters#cnf-understanding-image-based-upgrade[Image-based upgrade for single-node OpenShift clusters] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{sno}' rather than the plain text product term 'single-node OpenShift', unless your use case is an exception.
|
|
||
| * For more information about lifecycle management for the fleet of managed clusters see: | ||
| ** link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/edge_computing/image-based-upgrade-for-single-node-openshift-clusters#cnf-understanding-image-based-upgrade[Image-based upgrade for single-node OpenShift clusters] | ||
| ** link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/edge_computing/cnf-talm-for-cluster-updates[Updating managed clusters with the Topology Aware Lifecycle Manager] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{cgu-operator-full}' rather than the plain text product term 'Topology Aware Lifecycle Manager', unless your use case is an exception.
| ** link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/edge_computing/day-2-operations-for-telco-core-cnf-clusters[Upgrading a telco core CNF cluster] | ||
|
|
||
| * For more information about declarative cluster provisioning with {ztp} see: | ||
| ** link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/edge_computing/ztp-deploying-far-edge-sites[Installing managed clusters with RHACM and SiteConfig resources] |
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.
| [role="_additional-resources"] | ||
| .Additional resources | ||
|
|
||
| * link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/scalability_and_performance/index[Scaling your OpenShift Container Platform cluster and tuning performance in production environments] |
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.
| .Additional resources | ||
|
|
||
| * link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/storage/understanding-persistent-storage#persistent-storage-overview_understanding-persistent-storage[Persistent storage overview] | ||
| * link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.18/html/red_hat_openshift_data_foundation_architecture/index[Red Hat OpenShift Data Foundation architecture] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-storage-first}' rather than the plain text product term 'Red Hat OpenShift Data Foundation', unless your use case is an exception.
| [role="_additional-resources"] | ||
| .Additional resources | ||
|
|
||
| * For more information about {rh-storage} and IPv4 addressing, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.13/html-single/4.13_release_notes/index#support_openshift_dual_stack_with_odf_using_ipv4[Support OpenShift dual stack with OpenShift Data Foundation using IPv4] |
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.
rohennes
force-pushed
the
TELCODOCS-1874-hub-rds
branch
2 times, most recently
from
511376c to
c1b330a
Compare
rohennes
force-pushed
the
TELCODOCS-1874-hub-rds
branch
from
c1b330a to
b01dcee
Compare
|
@rohennes: all tests passed! Full PR test history. Your PR dashboard. 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-sigs/prow repository. I understand the commands that are listed here. |
fixes
Version(s):
Issue:
Link to docs preview:
QE review:
Additional information: