Skip to content

Commit 459d4f1

Browse files
slovernslovern
authored
Merge pull request #101056 from rohennes/TELCODOCS-2345
TELCODOCS-2345: Adding 4.19 Hub container to RDS and removing rendered CRs
2 parents b1febbb + 46dc283 commit 459d4f1

9 files changed

+263
-492
lines changed

‎modules/hub-cluster-ref-config-crs.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="hub-cluster-ref-config-crs_{context}"]
7+
= Hub cluster reference configuration CRs
8+
9+
The following sections briefly describe each custom resource (CR) for the telco management hub reference configuration in 4.19.

‎modules/telco-hub-crs-advanced-cluster-management.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="advanced-cluster-management-crs_{context}"]
7+
= {rh-rhacm-first} CRs
8+
9+
.{rh-rhacm} CRs
10+
[cols="4*", options="header", format=csv]
11+
|====
12+
Component,Reference CR,Description,Optional
13+
{rh-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
14+
{rh-rhacm},`acmMCE.yaml`,Defines the MultiCluster Engine configuration required by ACM.,No
15+
{rh-rhacm},`acmMCH.yaml`,"Configures a `MultiClusterHub` CR with high availability, enabling various components and specifying installation settings.",No
16+
{rh-rhacm},`acmMirrorRegistryCM.yaml`,Defines the SSL certificates and mirror registry configuration for various Red Hat and {product-title} registries used by the `multicluster-engine` in the `multicluster-engine` namespace.,No
17+
{rh-rhacm},`acmNS.yaml`,Defines the `open-cluster-management` namespace with a label to enable cluster monitoring.,No
18+
{rh-rhacm},`acmOperGroup.yaml`,"Defines an OperatorGroup for the `open-cluster-management`` namespace, targeting the same namespace.",No
19+
{rh-rhacm},`acmPerfSearch.yaml`,Configures search for Open Cluster Management by defining various parameters and API settings.,No
20+
{rh-rhacm},`acmProvisioning.yaml`,Configures a provisioning resource in the metal3.io/v1alpha1 API version to watch all namespaces.,No
21+
{rh-rhacm},`acmSubscription.yaml`,Subscribes to the {rh-rhacm} Operator using automatic install plan approval.,No
22+
{rh-rhacm},`observabilityMCO.yaml`,Configures `MultiClusterObservability` for managing observability and alerting across multiple clusters.,No
23+
{rh-rhacm},`observabilityNS.yaml`,Creates an `open-cluster-management-observability` namespace.,No
24+
{rh-rhacm},`observabilityOBC.yaml`,Creates an `ObjectBucketClaim` CR in the `open-cluster-management-observability` namespace.,No
25+
{rh-rhacm},`observabilitySecret.yaml`,Creates a Secret CR in the `open-cluster-management-observability` namespace for storing Docker configuration details.,No
26+
{rh-rhacm},`pull-secret-copy.yaml`,Creates a policy to copy the global pull secret into observability namespaces.,No
27+
{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
28+
{cgu-operator},`talmSubscription.yaml`,Creates a `Subscription` CR for {cgu-operator}.,No
29+
|====

‎modules/telco-hub-crs-container-registry.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="container-registry-crs_{context}"]
7+
= Container registry reference CRs
8+
9+
.Container registry CRs
10+
[cols="4*", options="header", format=csv]
11+
|====
12+
Component,Reference CR,Description,Optional
13+
Registry,`catalog-source.yaml`,Defines a `CatalogSource` CR for mirrored Operator catalogs.,No
14+
Registry,`idms-operator.yaml`,Defines an image digest `MirrorSet` Operator CR for mirrored Operator images.,No
15+
Registry,`idms-release.yaml`,Defines an image digest `MirrorSet` CR for {product-title} release images.,No
16+
Registry,`image-config.yaml`,Defines an image configuration CR to manage image registries and policies.,No
17+
Registry,`itms-generic.yaml`,Defines an image tag `MirrorSet` CR for mirrored images in a disconnected registry.,No
18+
Registry,`itms-release.yaml`,Defines an image tag `MirrorSet` CR for {product-title} release images.,No
19+
Registry,`kustomization.yaml`,Defines a `Kustomization` manifest for registry-related CRs.,No
20+
Registry,`operator-hub.yaml`,Configures the `OperatorHub` CR for offline catalog sources.,No
21+
Registry,`registry-ca.yaml`,Defines a `ConfigMap` CR containing registry CA certificates.,No
22+
|====

‎modules/telco-hub-crs-gitops-ztp.adoc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="gitops-ztp-crs_{context}"]
7+
= {ztp-first} reference CRs
8+
9+
.[ztp] CRs
10+
[cols="4*", options="header", format=csv]
11+
|====
12+
Component,Reference CR,Description,Optional
13+
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
14+
GitOps Operator,`addPluginsPolicy.yaml`,Defines a policy to add ArgoCD custom plugins to the GitOps controller.,No
15+
GitOps Operator,`argocd-application.yaml`,Defines the ArgoCD Application for GitOps management.,No
16+
GitOps Operator,`argocd-tls-certs-cm.yaml`,Defines a `ConfigMap` CR for ArgoCD TLS certificate management.,No
17+
GitOps Operator,`clusterrole.yaml`,Defines the `ClusterRole` CR that grants permissions to the GitOps Operator.,No
18+
GitOps Operator,`clusterrolebinding.yaml`,Binds the `ClusterRole` CR to the ArgoCD controller `ServiceAccount` CR.,No
19+
GitOps Operator,`gitopsNS.yaml`,Defines an `openshift-gitops-operator` namespace with a label for cluster monitoring.,No
20+
GitOps Operator,`gitopsOperatorGroup.yaml`,Defines an OperatorGroup in the `openshift-gitops-operator` namespace with a default upgrade strategy.,No
21+
GitOps Operator,`gitopsSubscription.yaml`,"Defines a subscription for the {product-title} GitOps Operator, specifying automatic install plan approval and source details.",No
22+
GitOps Operator,`ztp-repo.yaml`,Defines the Git repository for ZTP manifests and configurations.,No
23+
GitOps applications,`app-project.yaml`,Defines an ArgoCD `AppProject` CR specifying resource whitelists and destination rules for cluster and namespace resources.,No
24+
GitOps applications,`clusters-app.yaml`,Defines a namespace and an ArgoCD application for managing the deployment of cluster configurations from the specified Git repository.,No
25+
GitOps applications,`gitops-cluster-rolebinding.yaml`,Defines a `ClusterRoleBinding` CR that grants the `cluster-admin` role to the openshift-gitops-argocd-application-controller service account in the `openshift-gitops` namespace.,No
26+
GitOps applications,`gitops-policy-rolebinding.yaml`,Binds the `cluster-manager-admin` cluster role to the ArgoCD application controller `ServiceAccount` CR.,No
27+
GitOps applications,`kustomization.yaml`,"Defines a Kustomization configuration for the {ztp} application installations, listing various YAML resources to be included.",No
28+
GitOps applications,`policies-app-project.yaml`,"Defines an Argo CD AppProject resource, specifying cluster and namespace resource whitelists and destinations.",No
29+
GitOps applications,`policies-app.yaml`,Defines the ArgoCD `Application` CR for policy management.,No
30+
|====

‎modules/telco-hub-crs-installation.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="installation-crs_{context}"]
7+
= Installation reference CRs
8+
9+
.Installation CRs
10+
[cols="4*", options="header", format=csv]
11+
|====
12+
Component,Reference CR,Description,Optional
13+
Agent-based install,`agent-config.yaml`,"Use this example template `AgentConfig` CR to configure the Agent-based installer, specifying network and device settings for your target hosts.",No
14+
Agent-based install,`install-config.yaml`,"Use this example `install-config.yaml` template to configure your hub cluster installation for networking, control plane, compute nodes, mirror registries, and other environment-specific settings.",No
15+
|====

‎modules/telco-hub-crs-logging.adoc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="logging-crs_{context}"]
7+
= Logging reference CRs
8+
9+
.Logging CRs
10+
[cols="4*", options="header", format=csv]
11+
|====
12+
Component,Reference CR,Description,Optional
13+
Cluster Logging Operator,`clusterLogForwarder.yaml`,Defines the `ClusterLogForwarder` CR to send logs to configured outputs.,Yes
14+
Cluster Logging Operator,`clusterLogNS.yaml`,Configures a namespace for the Cluster Logging Operator.,Yes
15+
Cluster Logging Operator,`clusterLogOperGroup.yaml`,Configures an Operator group for the Cluster Logging Operator.,Yes
16+
Cluster Logging Operator,`clusterLogServiceAccount.yaml`,Defines the `ServiceAccount` CR used by Cluster Logging Operator components.,Yes
17+
Cluster Logging Operator,`clusterLogServiceAccountAuditBinding.yaml`,Binds the Cluster Logging `ServiceAccount` CR to audit log roles.,Yes
18+
Cluster Logging Operator,`clusterLogServiceAccountInfrastructureBinding.yaml`,Binds the Cluster Logging `ServiceAccount` CR to infrastructure log roles.,Yes
19+
Cluster Logging Operator,`clusterLogSubscription.yaml`,Defines a subscription for installing and managing the Cluster Logging Operator.,Yes
20+
|====

‎modules/telco-hub-crs-storage.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="storage-crs_{context}"]
7+
= Storage reference CRs
8+
9+
.Storage CRs
10+
[cols="4*", options="header", format=csv]
11+
|====
12+
Component,Reference CR,Description,Optional
13+
Local Storage Operator,`lsoLocalVolume.yaml`,Defines a `LocalVolume` CR specifying local storage configuration and node selection criteria.,Yes
14+
Local Storage Operator,`lsoNS.yaml`,Defines the `openshift-local-storage` namespace.,Yes
15+
Local Storage Operator,`lsoOperatorGroup.yaml`,Defines an `OperatorGroup` for the `openshift-local-storage` namespace.,Yes
16+
Local Storage Operator,`lsoSubscription.yaml`,Defines a `Subscription` CR for the Local Storage Operator.,Yes
17+
{rh-storage},`odfNS.yaml`,Defines the `openshift-storage namespace` with specific annotations and labels for workload management and cluster monitoring.,Yes
18+
{rh-storage},`odfOperatorGroup.yaml`,Defines an `OperatorGroup` for the `openshift-storage` namespace.,Yes
19+
{rh-storage},`odfReady.yaml`,Defines a resource to verify readiness of the ODF deployment.,Yes
20+
{rh-storage},`odfSubscription.yaml`,"Configures an {product-title} subscription to the {rh-storage} Operator, specifying installation details such as the Operator's name, namespace, channel, and approval strategy.",Yes
21+
{rh-storage},`storageCluster.yaml`,"Defines a `StorageCluster` CR with specific resource requests and limits, storage device sets, and annotations for Argo CD synchronization.",No
22+
|====

‎modules/telco-hub-rds-container.adoc‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability-and-performance/telco-hub-rds.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="telco-hub-rds-container_{context}"]
7+
= Extracting the telco hub reference design configuration CRs
8+
9+
You can extract the complete set of custom resources (CRs) for the telco hub profile from the `openshift-telco-hub-rds-rhel9` container image.
10+
The container image has both the required CRs, and the optional CRs, for the telco hub profile.
11+
12+
.Prerequisites
13+
14+
* You have installed `podman`.
15+
16+
.Procedure
17+
18+
. Log on to the container image registry with your credentials by running the following command:
19+
+
20+
[source,terminal]
21+
----
22+
$ podman login registry.redhat.io
23+
----
24+
25+
. Extract the content from the `openshift-telco-hub-rds-rhel9` container image by running the following commands:
26+
+
27+
[source,terminal]
28+
----
29+
$ mkdir -p ./out
30+
----
31+
+
32+
[source,terminal]
33+
----
34+
$ podman run -it registry.redhat.io/openshift4/openshift-telco-hub-rds-rhel9:v4.19 | base64 -d | tar xv -C out
35+
----
36+
37+
.Verification
38+
39+
* The `out` directory has the following directory structure. You can view the telco hub CRs in the `out/telco-hub-rds/` directory by running the following command:
40+
+
41+
[source,terminal]
42+
----
43+
$ tree -L 4 out/telco-hub-rds/
44+
----
45+
+
46+
.Example output
47+
[source,text]
48+
----
49+
out/telco-hub-rds/
50+
├── configuration
51+
│ ├── example-overlays-config
52+
│ │ ├── acm
53+
│ │ │ ├── acmMirrorRegistryCM-patch.yaml
54+
│ │ │ ├── kustomization.yaml
55+
│ │ │ ├── options-agentserviceconfig-patch.yaml
56+
│ │ │ └── storage-mco-patch.yaml
57+
│ │ ├── gitops
58+
│ │ │ ├── argocd-tls-certs-cm-patch.yaml
59+
│ │ │ ├── init-argocd-app.yaml
60+
│ │ │ └── kustomization.yaml
61+
│ │ ├── logging
62+
│ │ │ ├── cluster-log-forwarder-patch.yaml
63+
│ │ │ ├── kustomization.yaml
64+
│ │ │ └── README.md
65+
│ │ ├── lso
66+
│ │ │ ├── kustomization.yaml
67+
│ │ │ └── local-storage-disks-patch.yaml
68+
│ │ ├── odf
69+
│ │ │ ├── kustomization.yaml
70+
│ │ │ └── options-storage-cluster.yaml
71+
│ │ └── registry
72+
│ │ ├── catalog-source-image-patch.yaml
73+
│ │ ├── idms-operator-mirrors-patch.yaml
74+
│ │ ├── idms-release-mirrors-patch.yaml
75+
│ │ ├── itms-generic-mirrors-patch.yaml
76+
│ │ ├── itms-release-mirrors-patch.yaml
77+
│ │ ├── kustomization.yaml
78+
│ │ └── registry-ca-patch.yaml
79+
│ ├── kustomization.yaml
80+
│ ├── README.md
81+
│ └── reference-crs
82+
│ ├── kustomization.yaml
83+
│ ├── optional
84+
│ │ ├── logging
85+
│ │ ├── lso
86+
│ │ └── odf-internal
87+
│ └── required
88+
│ ├── acm
89+
│ ├── gitops
90+
│ ├── registry
91+
│ └── talm
92+
├── install
93+
│ ├── mirror-registry
94+
│ │ ├── imageset-config.yaml
95+
│ │ └── README.md
96+
│ └── openshift
97+
│ ├── agent-config.yaml
98+
│ └── install-config.yaml
99+
└── scripts
100+
└── check_current_versions.sh
101+
----

0 commit comments

Comments
 (0)