diff --git a/content/patterns/telco-hub/_index.adoc b/content/patterns/telco-hub/_index.adoc new file mode 100644 index 000000000..9b4ee5f4f --- /dev/null +++ b/content/patterns/telco-hub/_index.adoc @@ -0,0 +1,131 @@ +--- +title: Telco Hub +date: 2025-10-01 +tier: sandbox +summary: The Telco Hub pattern is a GitOps-first validated pattern for deploying and operating a Telco-focused management hub. +rh_products: +- Red Hat OpenShift Container Platform +- Red Hat Advanced Cluster Management for Kubernetes (RHACM) +- Red Hat OpenShift GitOps (ArgoCD) +- Topology Aware Lifecycle Manager (TALM) +- Red Hat OpenShift Data Foundation (ODF) (Optional) +industries: +- Telecommunications +aliases: /telco-hub/ +# uncomment once this exists +# pattern_logo: telco-hub.png +links: + github: https://github.com/validatedpatterns/telco-hub-pattern + install: getting-started + bugs: https://github.com/validatedpatterns/telco-hub-pattern/issues + feedback: https://docs.google.com/forms/d/e/1FAIpQLScI76b6tD1WyPu2-d_9CCVDr3Fu5jYERthqLKJDUGwqBg7Vcg/viewform +ci: telco-hub +--- + +:toc: +:imagesdir: /images +:_mod-docs-content-type: ASSEMBLY +include::modules/comm-attributes.adoc[] + +[id="about-telco-hub-pattern"] += About the Telco Hub pattern + +The Telco Hub pattern is a GitOps-first validated pattern for deploying and operating a Telco-focused management hub on {rh-ocp}. It uses a GitOps approach to centralize multi-cluster operations, lifecycle management, and policy enforcement to simplify the deployment and Day 2 operations of Telco workloads and edge clusters. + +When the pattern installation is complete, the hub cluster provides: + +* A dedicated GitOps (ArgoCD) instance created to manage spoke clusters. This instance includes resource tuning for scalability and an ACM plugin for simplified creation of policies. +* Support for Zero Touch Provisioning (ZTP) workflows, which provide automated cluster installation and configuration. +* The Topology Aware Lifecycle Manager (TALM) for integrated cluster management and upgrade capabilities. +* Centralized management of distributed telco infrastructure. + +[id="telco-hub-pattern-background"] +== Background + +Telco networks and cloud-native network functions (CNFs) require fast, repeatable lifecycle operations, strict dependency management, and consistent configuration across many clusters and edge sites. +This pattern packages a production-ready, GitOps-based hub that uses validated upstream telco-reference CRs and applies environment-specific Kustomize overlays so Operators deploy and manage Telco platforms consistently. + + +[id="telco-hub-pattern-use-cases"] +== Use Cases + +* **Telco Edge Hub Management**: Deploy and manage multiple edge clusters from a central hub +* **Zero Touch Provisioning**: Automated cluster installation and configuration via ZTP workflow +* **Multi-Cluster Operations**: Centralized management of distributed telco infrastructure +* **GitOps Workflows**: Infrastructure-as-code with automated deployment and synchronization + +[id="telco-hub-pattern-technologies"] +== Red Hat technologies + +* {rh-ocp} +* {rh-rhacm-first} +* {gitops-title} (ArgoCD) +* Topology Aware Lifecycle Manager (TALM) +* Optional: Local Storage Operator (LSO) +* Optional: Red Hat OpenShift Data Foundation (ODF) +* Optional: Red Hat Cluster Logging Operator (CLO) + +[id="telco-hub-pattern-other-technologies"] +== Other technologies + +* Support for disconnected (air-gapped) environments through local registries, cluster proxy configuration, and image mirroring (`ImageSetConfiguration`). +* A dedicated GitOps (ArgoCD) instance that includes resource tuning for scalability and an ACM plugin for simplified creation of policies for managed clusters. + +[id="telco-hub-pattern-architecture"] +== Architecture + +The Telco Hub pattern architecture consists of the following key components: + +[source,terminal] +---- +telco-hub-pattern/ +├── kustomize/overlays/telco-hub/ # 🔧 Kustomize Overlay Configuration +│ └── kustomization.yaml # Component selection and patches +├── kustomize/air-gapped/ # 🛡️ Disconnected (air-gapped) assets +│ ├── imageset-config.yaml # Image mirroring (oc-mirror) +│ ├── prerequisites/ # Cluster proxy, catalogs, CAs +│ │ └── kustomization.yaml +│ └── README.md # Disconnected deployment guide +├── values-hub.yaml # Hub Cluster Definition +├── values-global.yaml # Global Pattern Settings +└── docs/ # Documentation + +# Consumed Remote Resources (via kustomize): +# https://github.com/openshift-kni/telco-reference/tree/main/telco-hub/configuration/reference-crs/ +├── required/ # 🔧 Essential Components +│ ├── acm/ # Advanced Cluster Management +│ ├── gitops/ # GitOps Operators & Configuration +│ ├── talm/ # Topology Aware Lifecycle Manager +│ └── registry/ # Local Registry (disconnected) +└── optional/ # 🔌 Optional Components + ├── lso/ # Local Storage Operator + ├── odf-internal/ # OpenShift Data Foundation + └── logging/ # Cluster Logging Stack +---- + +Design principles:: + +[cols="1,2,2"] +|=== + +|Principle +|Description +|Benefit + +|Reference-based +|Direct consumption of official telco-reference configurations +|Always use validated, upstream telco designs + +|GitOps-Native +|ArgoCD manages all deployments via validated patterns framework +|Automated, auditable infrastructure changes + +|Kustomize-First +|Environment-specific overlays without modifying upstream configs +|Customize while maintaining upstream compatibility + +|Component Selection +|Declarative component enablement via kustomize resources +|Granular control over telco-hub functionality + +|=== diff --git a/content/patterns/telco-hub/configuration.adoc b/content/patterns/telco-hub/configuration.adoc new file mode 100644 index 000000000..46d5bb33e --- /dev/null +++ b/content/patterns/telco-hub/configuration.adoc @@ -0,0 +1,168 @@ +--- +title: Configuration +weight: 20 +aliases: /telco-hub/configuration/ +--- + +:toc: +:imagesdir: /images +:_mod-docs-content-type: ASSEMBLY +include::modules/comm-attributes.adoc[] + +[id="telco-hub-pattern-configuration"] += Telco hub pattern configuration + +The Telco Hub pattern uses the following file hierarchy to control what runs in your hub. + +* `values-global.yaml`: global, cross-environment pattern settings. +* `values-hub.yaml`: hub-specific ArgoCD and cluster definitions. +* `kustomize/overlays/telco-hub/kustomization.yaml`: enable optional components and apply environment-specific patches. +* `kustomize/air-gapped/imageset-config.yaml`: image set config to mirror required images and catalogs (disconnected). +* `kustomize/air-gapped/prerequisites/kustomization.yaml`: prerequisites for air-gapped deployments, apply proxy, CA, and catalog sources (disconnected). + +[id="global-pattern-configuration"] +== Global pattern configuration + +The `values-global.yaml` file defines configuration values that apply across all clusters and environments in the pattern, establishing the overall pattern behavior. + +Key parameters within the global section include: + +* `pattern`: Defines the name of the validated pattern, set to `telco-hub-pattern`. +* `secretLoader`: Use it to disable the secret loading process. For example, `disabled: true`. +* `options`: Affects all clusters by defining default behaviors: + +** `syncPolicy`: Sets the default ArgoCD synchronization policy. Options include `Automatic` or `Manual`. +** `installPlanApproval`: Sets the default operator install plan approval. Options include `Automatic` or `Manual`. +** `useCSV`: Specifies whether to use specific `ClusterServiceVersions` for operators. The default value is `false`. +* `main`: Defines settings for the main cluster (hub) that manages the pattern, including the `clusterGroupName: hub`. +* Disconnected Configuration: This file also specifies sources for operators in disconnected environments, such as `patternsOperator: source: community-operators-disconnected` and `gitops: operatorSource: redhat-operators-disconnected`. + +[id="hub-cluster-configuration"] +== Hub cluster configuration +The `values-hub.yaml` file has configuration specific to the hub cluster within the Telco Hub pattern. It is crucial as it defines the hub cluster, which acts as the central management point for GitOps, cluster management, and policy enforcement across the infrastructure. + +Cluster group identification:: +The `clusterGroup` section identifies the cluster's role and name: +[source,terminal] +---- +clusterGroup: + name: hub # Name of this cluster group + isHubCluster: true # Designates this as the hub/management cluster +---- + +Management of the `subscriptions` and `projects` resources within this file is delegated to the `telco-hub` kustomization application to prevent systematic conflicts between the Pattern Operator and the Telco Hub Reference Design Specification. + +ArgoCD application configuration:: + +The `applications` section defines the core ArgoCD application for the Telco Hub pattern: + +* `telco-hub` application: Uses Kustomize for manifest processing `kustomize: true` and points to the overlay path `kustomize/overlays/telco-hub`. +* Synchronization Policy: The `syncPolicy` is configured to be automated `automated: prune: true` to remove resources not present in git. +* Retry Mechanism: The application uses a configured retry mechanism to handle temporary failures during synchronization: + ◦ `limit: 6`: maximum number of sync retries, adjusted for about 20 minutes total. + ◦ `backoff`: configured with an initial duration of `15s`, a factor of `2`, and a `maxDuration` of `15m`. + +[id="component-selection-and-environment-customization"] +== Component selection and environment customization + +Components are enabled by uncommenting the corresponding remote base resource declarations within the `resources:` array of the `kustomization.yaml` file. +The pattern uses remote base resources from the telco-reference git repository. + +Required components:: +These components are essential for hub cluster functionality: + +* Local Registry: The Telco Hub Reference Design Specifications targets disconnected environments, therefore this component is enabled by default. +* {rh-rhacm-first}: The {rh-rhacm} telco-hub component requires a storage backend to support its observability functionality. You need to configure a storage backend for the hub cluster along with {rh-rhacm}. +* GitOps Operator: This component's configuration is currently provided by default through the Validated Patterns Operator, and its resource URL from telco-reference is not yet supported by the pattern itself. +* {cgu-operator-first}: This component is required and enabled by default. + +Zero Touch Provisioning (ZTP) Workflow Components:: +This component provides ArgoCD applications for synchronizing cluster deployment (ClusterInstance) CRs and configuration (Policy and/or PolicyGenerator) CRs. Enable this resource if you intend to use the GitOps ZTP workflow for automated cluster deployment: + +* ZTP Installation: Uncomment the dedicated resource URL for `ztp-installation`. + +Optional components:: +These components should be enabled based on specific workload and storage requirements: + +* LocalStorage Operator (LSO): Enable if you plan to use LSO as your storage backend. +* Red Hat OpenShift Data Foundation (ODF): Enable if you plan to use ODF as your storage backend. +* Cluster Logging Operator (Logging): Enable if you require the cluster logging operator for log aggregation. + +Environment Customization (Kustomize Patches):: +The `patches:` section allows you to apply modifications to the base configurations sourced from the telco-reference without directly editing those upstream files. This is vital for maintaining upstream compatibility. +Patches are defined using a target specification `group`, `version`, `kind`, or `name` and the specific patch content. + +[id="example-patch"] +=== Examples + +The following examples illustrate how to customize Operator configurations for specific environments, such as disconnected setups or storage class adjustments. + +[source,yaml] +---- +patches: + # Example: Update Red Hat operators catalog to use specific version + - target: + group: operators.coreos.com + version: v1alpha1 + kind: CatalogSource + name: redhat-operators-disconnected + patch: |- + - op: replace + path: /spec/image + value: /openshift-marketplace/redhat-operators-disconnected:v4.20 + + # Example: Add registry CA to the hub cluster + - target: + version: v1 + kind: ConfigMap + name: registry-ca + patch: |- + - op: replace + path: /data + value: + registry.example.com..8443 | + -----BEGIN CERTIFICATE----- + MIIGcjCCBFqgAwIBAgIFICIE... + -----END CERTIFICATE----- + + # Example: AgentServiceConfig storage and OS images configuration + - target: + group: agent-install.openshift.io + version: v1beta1 + kind: AgentServiceConfig + name: agent + patch: |- + - op: replace + path: "/spec/osImages" + value: + - cpuArchitecture: x86_64 + openshiftVersion: "4.18" + rootFSUrl: https://mirror.example.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.18/latest/rhcos-live-rootfs.x86_64.img + url: https://mirror.example.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.18/latest/rhcos-live.x86_64.iso + version: 418.94.202502100215-0 + - cpuArchitecture: x86_64 + openshiftVersion: "4.19" + rootFSUrl: https://mirror.example.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.19/latest/rhcos-live-rootfs.x86_64.img + url: https://mirror.example.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.19/latest/rhcos-live-iso.x86_64.iso + version: 9.6.20250530-0 + - cpuArchitecture: x86_64 + openshiftVersion: "4.20" + rootFSUrl: https://mirror.example.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.20/latest/rhcos-live-rootfs.x86_64.img + url: https://mirror.example.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.20/latest/rhcos-live-iso.x86_64.iso + version: 9.6.20250530-0 + + # Example: LocalVolume disk paths configuration + - target: + group: local.storage.openshift.io + version: v1 + kind: LocalVolume + name: local-disks + namespace: openshift-local-storage + patch: |- + - op: replace + path: /spec/storageClassDevices/0/devicePaths + value: + - /dev/nvme1n1 +---- + +For more examples and detailed configurations, see link:https://github.com/openshift-kni/telco-reference/tree/main/telco-hub/configuration/example-overlays-config[telco-reference example overlays]. diff --git a/content/patterns/telco-hub/getting-started.adoc b/content/patterns/telco-hub/getting-started.adoc new file mode 100644 index 000000000..ace59bca1 --- /dev/null +++ b/content/patterns/telco-hub/getting-started.adoc @@ -0,0 +1,138 @@ +--- +title: Getting Started +weight: 10 +aliases: /telco-hub/getting-started/ +--- + +:toc: +:imagesdir: /images +:_mod-docs-content-type: ASSEMBLY +include::modules/comm-attributes.adoc[] + +[id="deploying-the-telco-hub-pattern"] += Deploying the Telco hub pattern + + +[id="telco-hub-prerequisites"] +== Prerequisites + +* An {ocp} 4.19 or later cluster with: + +** cluster administrator privileges. +** compact 3-node cluster or standard cluster with at least 3 worker nodes. +** more than 500 GB of available storage. +** accessible container registry with all required images. It can be a disconnected registry or accessible by internet. +** accessible web server with base ISO images or accessible via internet access. + +* A Git repository to host your configuration files. +* Access to a terminal with `oc` and `git` command-line tools installed. + +[id="preparing-for-deployment"] +== Preparing for deployment + +.Procedure + +. Clone the `telco-hub-pattern` repository from GitHub and navigate to the directory: ++ +[source,terminal] +---- +$ git clone https://github.com/validatedpatterns/telco-hub-pattern.git +$ cd telco-hub-pattern +---- + +. Configure components by editing the file `kustomize/overlays/telco-hub/kustomization.yaml` to enable optional components and customizations as needed: ++ +[source,yaml] +---- +# ============================================================================= +# Telco Hub pattern - Kustomization Configuration +# ============================================================================= + +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +resources: + # Required: Local Registry + # The Telco Hub Reference Design Specifications targets disconnected environments, hence this component is enabled by default. + - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/required/registry + + # Required: Advanced Cluster Management (ACM) + # The ACM telco-hub component requires a storage backend to support its observability functionality. + # You NEED to configure a storage backend for the hub cluster along with ACM. + - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/required/acm + + # Required: GitOps Operator + # The telco-hub component creates the GitOps/ArgoCD instance used to manage spoke clusters. This instance + # includes resource tuning for scalability and an ACM plugin for simplified creation of policies. The validated + # pattern clustergroup chart does not make these tunings available, so a dedicated instance is created through + # the `gitops` content. This dedicated instance has all the necessary tuning already included so the + # `reference-crs/required/gitops` component does not need to be included. These `gitops` must be included + # prior to the other components. + # - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/required/gitops + - gitops/ + + # Required: Topology Aware Lifecycle Manager (TALM) + - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/required/talm + + # Workflow: GitOps ZTP Installation + # Enable this telco-hub component if you deploy clusters via GitOps ZTP! + # - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/required/gitops/ztp-installation + + # Optional: Local Storage Operator (LSO) + # Enable this telco-hub component if you use LSO as your storage backend! + - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/optional/lso + + # Optional: Open Data Foundation (ODF) + # Enable this telco-hub component if you use ODF as your storage backend! + - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/optional/odf-internal + + # Optional: Logging Operator + # Enable this telco-hub component if you use the logging operator! + # - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/optional/logging + + +# Environment-specific patches (example for disconnected environments) +patches: + - target: + group: operators.coreos.com + version: v1alpha1 + kind: CatalogSource + name: redhat-operators-disconnected + patch: |- + - op: replace + path: /spec/image + value: /openshift-marketplace/redhat-operators-disconnected:v4.20 +---- + +. Commit and push kustomize overlay: ++ +[source,terminal] +---- +$ git commit ./kustomize/overlays/telco-hub/kustomization.yaml +$ git push +---- + +[id="deploying-the-pattern"] +== Deploying the pattern by using the pattern.sh script + +. Deploy the pattern (loads secrets if configured): ++ +[source,terminal] +---- +$ ./pattern.sh make install +---- + +. Update the pattern (does not load secrets): ++ +[source,terminal] +---- +$ ./pattern.sh make operator-upgrade +---- + +.Verification +. Verify the deployment by running the health check: ++ +[source,terminal] +---- +$ ./pattern.sh make argo-healthcheck +---- diff --git a/content/patterns/telco-hub/managing-the-pattern.adoc b/content/patterns/telco-hub/managing-the-pattern.adoc new file mode 100644 index 000000000..bb30af7a1 --- /dev/null +++ b/content/patterns/telco-hub/managing-the-pattern.adoc @@ -0,0 +1,220 @@ +--- +title: Managing the Telco Hub pattern +weight: 30 +aliases: /telco-hub/managing/ +--- + +:toc: +:imagesdir: /images +:_mod-docs-content-type: ASSEMBLY +include::modules/comm-attributes.adoc[] + +[id="managing-the-telco-hub-pattern"] += Managing the Telco Hub pattern + +After the initial deployment, you can use the `pattern.sh` script and standard {ocp} tools to manage, check, and troubleshoot the Telco Hub pattern. + +[id="pattern-management-cli"] +== Pattern management commands + +The pattern includes a `pattern.sh` script that provides commands for managing the pattern lifecycle. + +[source,terminal] +---- +$ ./pattern.sh make help + +For a complete guide to these targets and the available overrides, please visit https://validatedpatterns.io/blog/2025-08-29-new-common-makefile-structure/ + +Usage: + make + +Testing & Development Tasks + argo-healthcheck Checks if all argo applications are synced + validate-telco-reference Validates telco-hub pattern against telco-reference CRs using cluster-compare + super-linter Runs the super-linter locally + validate-kustomize Validates kustomization build and YAML format + help Print this help message + +Pattern Install Tasks + show Shows the template that would be applied by the `make install` target + operator-deploy operator-upgrade Installs/updates the pattern on a cluster (DOES NOT load secrets) + install Installs the pattern onto a cluster (Loads secrets as well if configured) + load-secrets Loads secrets onto the cluster (unless explicitly disabled in values-global.yaml) + +Validation Tasks + validate-prereq verify pre-requisites + validate-origin verify the git origin is available + validate-cluster Do some cluster validations before installing +---- + +[id="day-2-operations"] +== Day 2 operations + +You can change the pattern's configuration after the initial deployment. + +[id="managing-components"] +=== Managing components + +To enable or disable components after deployment: + +. Edit the `kustomize/overlays/telco-hub/kustomization.yaml` file. +. Uncomment the resource URL for a component to enable it, or comment it to disable it. ++ +[source,yaml] +---- +resources: + # Example: Uncomment to enable Logging Operator + # - https://github.com/openshift-kni/telco-reference//telco-hub/configuration/reference-crs/optional/logging +---- ++ +. Apply the changes by running the `operator-upgrade` command: ++ +[source,terminal] +---- +$ ./pattern.sh make operator-upgrade +---- + +[id="customizing-patches"] +=== Customizing environment patches + +To change environment-specific configurations, such as Operator sources for disconnected environments: + +. Edit the `patches:` section in the `kustomize/overlays/telco-hub/kustomization.yaml` file. +. Add or change a patch to target the necessary resource. ++ +[source,yaml] +---- + # ClusterLogForwarder with hub-specific labelsconfiguration + - target: + group: observability.openshift.io + version: v1 + kind: ClusterLogForwarder + name: instance + namespace: openshift-logging + patch: |- + - op: replace + path: "/spec/outputs/0/kafka/url" + value: "tcp://jumphost.inbound.lab:9092/logs" + - op: add + path: /spec/filters/0/openshiftLabels + value: + cluster-role: hub + environment: production + telco-component: hub +---- ++ +. Apply the configuration changes: ++ +[source,terminal] +---- +$ ./pattern.sh make operator-upgrade +---- + +[id="monitoring-the-deployment"] +== Monitoring the deployment + +You can check the health and synchronization status of the pattern components through the {ocp} CLI or the ArgoCD UI. + +[id="monitoring-cli"] +=== Monitoring from the CLI + +. Describe the main `telco-hub` application to view detailed status and synchronization information: ++ +[source,terminal] +---- +$ oc describe applications.argoproj.io telco-config -n telco-hub-pattern-hub +---- ++ +. Describe the `clusters` and `policies` application to view status of deployed managed clusters: ++ +[source,terminal] +---- +$ o$ oc describe applications.argoproj.io clusters policies -n telco-hub-pattern +---- ++ +. View all the ArgoCD applications managed by the pattern: ++ +[source,terminal] +---- +$ ./pattern.sh make argo-healthcheck +---- + +[id="accessing-argocd-ui"] +=== Accessing the ArgoCD UI + +. Retrieve the route for the `telco-hub` application: ++ +[source,terminal] +---- +$ echo "ArgoCD UI: https://$(oc get route hub-gitops-server -n telco-hub-pattern-hub -o jsonpath='{.spec.host}')" +---- + +. Retrieve the default administrator password: ++ +[source,terminal] +---- +$ oc extract secret/hub-gitops-cluster -n telco-hub-pattern-hub --to=- +---- + +. Retrieve the route for the `clusters` and `policies` applications: ++ +[source,terminal] +---- +$ echo "ArgoCD UI: https://$(oc get route telco-hub-gitops-server -n telco-hub-pattern -o jsonpath='{.spec.host}')" +---- ++ +. Retrieve the default administrator password: ++ +[source,terminal] +---- +$ oc extract secret/telco-hub-gitops-cluster -n telco-hub-pattern --to=- +---- ++ +[NOTE] +==== +You can also access the ArgoCD UI from the application launcher (nine-box icon) in the {ocp} console. +==== + +[id="troubleshooting"] +== Troubleshooting + +This section covers common issues and their resolutions. + +Component synchronization failures:: +* **Problem:** An ArgoCD application in the `telco-hub-pattern-hub` namespace displays a `SyncError` or `Degraded` status. +* **Diagnosis:** Check the application's detailed status to identify the failing resource. ++ +[source,terminal] +---- +$ oc describe applications.argoproj.io -n telco-hub-pattern-hub +---- ++ +* **Solution:** Verify that the component configuration in `kustomization.yaml` is correct and that all kustomize patches are valid. Ensure that any prerequisite components are enabled and healthy. + +Git repository access:: +* **Problem**: ArgoCD cannot access the `github.com/openshift-kni/telco-reference` repository. +* **Diagnosis**: Check the ArgoCD application logs for Git-related errors, such as "repository unavailable" or certificate validation failures. +* **Solution**: + +** For standard, connected environments, verify that the hub cluster has network connectivity to `github.com`. +** For disconnected (air-gapped) environments, you must verify the following two common issues: + +... **Wrong repository URL**: Ensure that the `kustomize/overlays/telco-hub/kustomization.yaml` file is updated to point to the correct location, branch, and path of the mirrored repository. +... **Certificate related errors**: If ArgoCD cannot verify the repository's TLS certificates, you might need to add those certificates to the `argocd-tls-certs-cm` patch in `kustomize/overlays/telco-hub/kustomization.yaml`. + +Component dependencies:: +* **Problem**: A component fails to install because a required operator or custom resource definition (CRD) is missing. +* **Diagnosis**: The component's operator logs or the ArgoCD sync status indicates "resource not found" or "missing dependency". +* **Solution**: Ensure that all required components, such as {rh-rhacm-first} or {cgu-operator-first}, are enabled (uncommented) in `kustomization.yaml` before enabling optional components that depend on them. + +[id="additional-resources"] +== Additional resources + +* link:https://github.com/openshift-kni/telco-reference/tree/main/telco-hub/configuration/reference-crs/required/acm[{rh-rhacm} Configuration] +* link:https://github.com/openshift-kni/telco-reference/tree/main/telco-hub/configuration/reference-crs/required/gitops[GitOps Setup] +* link:https://github.com/openshift-kni/telco-reference/tree/main/telco-hub/configuration/reference-crs/required/talm[{cgu-operator} Management] +* link:https://github.com/openshift-kni/telco-reference/tree/main/telco-hub/configuration/reference-crs/optional[Optional Components] +* link:https://github.com/openshift-kni/telco-reference/tree/main/telco-hub/configuration/example-overlays-config[Example Overlays] +* link:https://docs.redhat.com/en/documentation/red_hat_openshift_gitops/latest/html/understanding_openshift_gitops/about-redhat-openshift-gitops[{rh-gitops-short}] +* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/[Advanced Cluster Management] +* link:https://docs.openshift.com/container-platform/latest/scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-clusters-at-scale.html[Zero Touch Provisioning] diff --git a/modules/comm-attributes.adoc b/modules/comm-attributes.adoc index 0660662a2..7ed8d6c0d 100644 --- a/modules/comm-attributes.adoc +++ b/modules/comm-attributes.adoc @@ -188,4 +188,8 @@ // Icons :grid: grid.png // AMD -:amd-instinct: AMD Instinct \ No newline at end of file +:amd-instinct: AMD Instinct +//TALM +:cgu-operator-first: Topology Aware Lifecycle Manager (TALM) +:cgu-operator-full: Topology Aware Lifecycle Manager +:cgu-operator: TALM