[TELCODOCS-2249]: Telco Hub RDS update for 420#108989
[TELCODOCS-2249]: Telco Hub RDS update for 420#108989lcavalle wants to merge 1 commit intoopenshift:enterprise-4.20from
Conversation
openshift-ci
bot
added
the
size/XL
|
🤖 Wed Mar 25 21:41:48 - Prow CI generated the docs preview: https://108989--ocpdocs-pr.netlify.app/ |
openshift-ci
bot
added
size/L
lcavalle
force-pushed
the
TELCODOCS-2249-RDSHubUpdate
branch
4 times, most recently
from
1dc3999 to
65bfecf
Compare
lcavalle
force-pushed
the
TELCODOCS-2249-RDSHubUpdate
branch
from
1d56a35 to
7ad075d
Compare
|
@lcavalle: 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. |
There was a problem hiding this comment.
Hi Lluis, a few minor style things, but also noticed some content changes between upstream and downstream. Did you bring across all the modules that the script outputted into the OCP repo? When I ran the script, it outputted some modules that I can see were not updated accordingly in your PR. Here's a Claude report that finds main differences:
Based on my comparison of the upstream draft (/home/rohennes/Downloads/telco-hub-rds.adoc) with your repo's telco-hub-rds.adoc assembly and its included modules, I found the following significant content differences:
Major Content Differences
1. Assisted Service Storage Requirements (Significant Value Differences)
Your repo (modules/telco-hub-assisted-service.adoc):
| Resource | Size |
|---|---|
imageStorage |
50 GB |
filesystemStorage |
700 GB |
dataBaseStorage |
20 GB |
Upstream draft:
| Resource | Size |
|---|---|
imageStorage^[1]^ |
30 GB |
filesystemStorage^[2]^ |
709 GB |
dataBaseStorage^[3]^ |
0.7 GB |
The upstream also includes:
- Footnotes explaining the calculations
- A NOTE about values being estimates with +20% engineering margin guidance
- Additional explanation that
dataBaseStorageis based on empirical estimation (~200KB per host)
2. ACM Observability - Object Bucket Storage (Different Assumptions)
Your repo (modules/telco-hub-acm-observability.adoc):
- Object bucket: 15 GiB per day, 101 GiB total
- Footnote: "For the object bucket, it is assumed that downsampling is disabled"
Upstream draft:
- Object bucket: 310 GiB total (no per-day breakdown)
- Footnote: "Considering we enable downsampling"
This is a significant semantic difference - your repo assumes downsampling is disabled (less storage), while upstream assumes downsampling is enabled (more storage).
3. Storage Considerations - Missing ODF Disk Cleaning Info
Missing from repo (modules/telco-hub-storage-considerations.adoc):
Upstream includes this additional content:
"Using {rh-storage} requires storage disks to be clean. Specially before a re-install procedure."
And this additional resource link:
* link:https://access.redhat.com/solutions/7114870[ODF disks cleaning procedure]
4. Managed Cluster Deployment - Missing Infrastructure Requirements
Missing from repo (modules/telco-hub-managed-cluster-deployment.adoc):
Upstream includes these additional Limits and requirements:
- "An HTTP server hosting root filesystem and RHCOS live ISO images is required for cluster deployment. These images are release specific. ISO images for each OpenShift release to be deployed must be reachable by the hub cluster and each deployed spoke cluster. Only include ISO images which exist on the HTTP server in the AgentServiceConfig CR."
- "A container registry hosting all OpenShift and day-2 OLM operator images must be reachable from all deployed spoke clusters. The hub configuration includes kustomize overlay which can be used to provide the TLS certificates and credentials for a disconnected container registry."
5. Hub Cluster Networking - Missing Image Mirroring Details
Missing from repo (modules/telco-hub-networking.adoc):
Upstream includes this additional text under the image registry requirements:
"All OpenShift releases and OLM Operator release images needed in your deployment must be mirrored to the registry. An example mirroring configuration is given in the reference as
imageset-config.yamlwhich must be updated to include your needed versions. OnlyClusterImageSetCRs which reference mirrored versions can be used for deploying clusters."
6. Software Stack Versions (Expected Difference)
Your repo: Shows 4.19 versions consistently (OCP 4.19, LSO 4.19, ODF 4.18, RHACM 2.13, GitOps 1.16, ZTP plugins 4.19, etc.)
Upstream draft: Shows 4.20 versions (OCP 4.20, ACM 2.15, LSO 4.20, ODF 4.20, GitOps 1.18, ZTP plugins 4.20, MCE PolicyGenerator plugin 2.10, TALM 4.20)
Summary
The most critical differences that would affect readers are:
- Storage values for Assisted Service (50/700/20 vs 30/709/0.7)
- Downsampling assumption for observability storage (disabled vs enabled, resulting in 101 GiB vs 310 GiB)
- Missing guidance about ODF disk cleaning procedures
- Missing infrastructure requirements for HTTP server and container registry in managed cluster deployment
- Missing details about image mirroring requirements in networking section
| // Module included in the following assemblies: | ||
| // | ||
| // * scalability-and-performance/telco-hub-rds.adoc | ||
| // * |
There was a problem hiding this comment.
Any reason why this line was removed?
| = {rh-rhacm-first} CRs | ||
|
|
||
| .{rh-rhacm} CRs | ||
| .{rh-rhacm-first} CRs |
There was a problem hiding this comment.
Line 7 already uses {rh-rhacm-first}. Shouldn't {rh-rhacm} be ok for subsequent uses.
| {rh-rhacm},`pull-secret-copy.yaml`,Creates a policy to copy the global pull secret into observability namespaces.,No | ||
| {rh-rhacm},`thanosSecret.yaml`,Creates a policy to copy data from an object bucket claim into a secret for observability to connect to Thanos.,No | ||
| {cgu-operator},`talmSubscription.yaml`,Creates a `Subscription` CR for {cgu-operator}.,No | ||
| {rh-rhacm},`observabilitySecret.yaml`,Creates a Secret CR in the `open-cluster-management-observability` namespace for storing containers configuration details.,No |
There was a problem hiding this comment.
Add backticks to resources such as Secret, ManagedClusterSetBinding, PlacementBinding etc. in the newly added content and include the object - CR - after each
| // Module included in the following assemblies: | ||
| // | ||
| // * scalability-and-performance/telco-hub-rds.adoc | ||
| // * |
There was a problem hiding this comment.
Why removing this? Same question for each instance in this PR
| :_mod-docs-content-type: REFERENCE | ||
| [id="gitops-ztp-crs_{context}"] | ||
| = {ztp-first} reference CRs | ||
| = {ztp-first} ZTP reference CRs |
There was a problem hiding this comment.
Revert this change, this will render as GitOps Zero Touch Provisioning (ZTP) ZTP reference CRs
| = {ztp-first} ZTP reference CRs | ||
|
|
||
| .[ztp] CRs | ||
| .{ztp-first} ZTP CRs |
| |==== | ||
| Component,Reference CR,Description,Optional | ||
| GitOps Operator,`argocd-ssh-known-hosts-cm.yaml`,Defines a `ConfigMap` CR to store SSH known hosts used by ArgoCD in a disconnected environment.,No | ||
| GitOps Operator,`addPluginsMCSB.yaml`,Defines the ManagedClusterSetBinding for policy used to patch GitOps operator.,No |
There was a problem hiding this comment.
Add backticks around resources and add CR object, as elsewhere
| @@ -0,0 +1,8 @@ | |||
| // Module included in the following assemblies: | |||
There was a problem hiding this comment.
What are these files?
modules/telco-hub-gitopsztp-ref-crs.adoc
modules/telco-hub-logging-ref-crs.adoc
modules/telco-hub-reference-design-specification.adoc
modules/telco-hub-registry-ref-crs_{context}.adoc
modules/telco-hub-rhacm-ref-crs.adoc
modules/telco-hub-storage-ref-crs.adoc
modules/telco-hub-ztp-ref-crs.adoc
3 participants
Version(s): 4.20
Issue: TELCODOCS-2249
Link to docs preview:
QE review:
Additional information: