Skip to content

Commit b70b8db

Browse files
committed
TELCODOCS#2177: Refactor Edge Computing to improve ToC navigation
1 parent 6013c48 commit b70b8db

File tree

138 files changed

+616
-559
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+616
-559
lines changed

_topic_maps/_topic_map.yml

Lines changed: 102 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -3352,57 +3352,67 @@ Topics:
33523352
File: node-observability-operator
33533353
Distros: openshift-origin,openshift-enterprise
33543354
---
3355-
Name: Edge computing
3356-
Dir: edge_computing
3355+
Name: Day 2 operations for telco core CNF clusters
3356+
Dir: day_2_core_cnf_clusters
33573357
Distros: openshift-origin,openshift-enterprise
33583358
Topics:
3359-
- Name: Challenges of the network far edge
3360-
File: ztp-deploying-far-edge-clusters-at-scale
3361-
- Name: Preparing the hub cluster for ZTP
3362-
File: ztp-preparing-the-hub-cluster
3363-
- Name: Updating GitOps ZTP
3364-
File: ztp-updating-gitops
3365-
- Name: Installing managed clusters with RHACM and SiteConfig resources
3366-
File: ztp-deploying-far-edge-sites
3367-
- Name: Manually installing a single-node OpenShift cluster with GitOps ZTP
3368-
File: ztp-manual-install
3369-
- Name: Recommended single-node OpenShift cluster configuration for vDU application workloads
3370-
File: ztp-reference-cluster-configuration-for-vdu
3371-
- Name: Validating cluster tuning for vDU application workloads
3372-
File: ztp-vdu-validating-cluster-tuning
3373-
- Name: Advanced managed cluster configuration with SiteConfig resources
3374-
File: ztp-advanced-install-ztp
3375-
- Name: Managing cluster policies with PolicyGenerator resources
3376-
Dir: policygenerator_for_ztp
3377-
Distros: openshift-origin,openshift-enterprise
3359+
- Name: Upgrading telco core CNF clusters
3360+
Dir: updating
33783361
Topics:
3379-
- Name: Configuring managed cluster policies by using PolicyGenerator resources
3380-
File: ztp-configuring-managed-clusters-policygenerator
3381-
- Name: Advanced managed cluster configuration with PolicyGenerator resources
3382-
File: ztp-advanced-policygenerator-config
3383-
- Name: Updating managed clusters in a disconnected environment with PolicyGenerator resources and TALM
3384-
File: ztp-talm-updating-managed-policies-pg
3385-
- Name: Managing cluster policies with PolicyGenTemplate resources
3386-
Dir: policygentemplate_for_ztp
3387-
Distros: openshift-origin,openshift-enterprise
3362+
- Name: Upgrading telco core CNF clusters
3363+
File: telco-update-welcome
3364+
- Name: OpenShift Container Platform API compatibility
3365+
File: telco-update-api
3366+
- Name: Preparing for the cluster update
3367+
File: telco-update-ocp-update-prep
3368+
- Name: Managing live CNF pods during the cluster update
3369+
File: telco-update-cnf-update-prep
3370+
- Name: Before you update the cluster
3371+
File: telco-update-before-the-update
3372+
- Name: Completing the Control Plane Only update
3373+
File: telco-update-completing-the-control-plane-only-update
3374+
- Name: Completing the y-stream update
3375+
File: telco-update-completing-the-y-stream-update
3376+
- Name: Completing the z-stream update
3377+
File: telco-update-completing-the-z-stream-update
3378+
- Name: Troubleshooting and maintaining telco core CNF clusters
3379+
Dir: troubleshooting
33883380
Topics:
3389-
- Name: Configuring managed cluster policies by using PolicyGenTemplate resources
3390-
File: ztp-configuring-managed-clusters-policies
3391-
- Name: Advanced managed cluster configuration with PolicyGenTemplate resources
3392-
File: ztp-advanced-policy-config
3393-
- Name: Updating managed clusters in a disconnected environment with PolicyGenTemplate resources and TALM
3394-
File: ztp-talm-updating-managed-policies
3395-
- Name: Using hub templates in PolicyGenerator or PolicyGenTemplate CRs
3396-
File: ztp-using-hub-cluster-templates
3397-
- Name: Updating managed clusters with the Topology Aware Lifecycle Manager
3398-
File: cnf-talm-for-cluster-upgrades
3399-
- Name: Expanding single-node OpenShift clusters with GitOps ZTP
3400-
File: ztp-sno-additional-worker-node
3401-
- Name: Pre-caching images for single-node OpenShift deployments
3402-
File: ztp-precaching-tool
3381+
- Name: Troubleshooting and maintaining telco core CNF clusters
3382+
File: telco-troubleshooting-intro
3383+
- Name: General troubleshooting
3384+
File: telco-troubleshooting-general-troubleshooting
3385+
- Name: Cluster maintenance
3386+
File: telco-troubleshooting-cluster-maintenance
3387+
- Name: Security
3388+
File: telco-troubleshooting-security
3389+
- Name: Certificate maintenance
3390+
File: telco-troubleshooting-cert-maintenance
3391+
- Name: Machine Config Operator
3392+
File: telco-troubleshooting-mco
3393+
- Name: Bare-metal node maintenance
3394+
File: telco-troubleshooting-bmn-maintenance
3395+
- Name: Observability
3396+
Dir: observability
3397+
Topics:
3398+
- Name: Observability in OpenShift Container Platform
3399+
File: telco-observability
3400+
- Name: Security
3401+
Dir: security
3402+
Topics:
3403+
- Name: Security basics
3404+
File: telco-security-basics
3405+
- Name: Host security
3406+
File: telco-security-host-sec
3407+
- Name: Security context constraints
3408+
File: telco-security-sec-context-constraints
3409+
---
3410+
Name: Image-based installation and upgrade for single-node OpenShift clusters
3411+
Dir: image_based_install_and_upgrade
3412+
Distros: openshift-origin,openshift-enterprise
3413+
Topics:
34033414
- Name: Image-based upgrade for single-node OpenShift clusters
34043415
Dir: image_based_upgrade
3405-
Distros: openshift-origin,openshift-enterprise
34063416
Topics:
34073417
- Name: Understanding the image-based upgrade for single-node OpenShift clusters
34083418
File: cnf-understanding-image-based-upgrade
@@ -3428,7 +3438,6 @@ Topics:
34283438
File: ztp-image-based-upgrade
34293439
- Name: Image-based installation for single-node OpenShift
34303440
Dir: image_base_install
3431-
Distros: openshift-origin,openshift-enterprise
34323441
Topics:
34333442
- Name: Understanding image-based installation and deployment for single-node OpenShift
34343443
File: ibi-understanding-image-based-install
@@ -3444,60 +3453,55 @@ Topics:
34443453
File: ibi-edge-image-based-install
34453454
- Name: Deploying single-node OpenShift using the installation program
34463455
File: ibi-edge-image-based-install-standalone
3447-
- Name: Day 2 operations for telco core CNF clusters
3448-
Dir: day_2_core_cnf_clusters
3456+
---
3457+
Name: GitOps ZTP
3458+
Dir: gitops_ztp
3459+
Distros: openshift-origin,openshift-enterprise
3460+
Topics:
3461+
- Name: Challenges of the network far edge
3462+
File: ztp-deploying-far-edge-clusters-at-scale
3463+
- Name: Preparing the hub cluster for ZTP
3464+
File: ztp-preparing-the-hub-cluster
3465+
- Name: Updating GitOps ZTP
3466+
File: ztp-updating-gitops
3467+
- Name: Installing managed clusters with RHACM and SiteConfig resources
3468+
File: ztp-deploying-far-edge-sites
3469+
- Name: Manually installing a single-node OpenShift cluster with GitOps ZTP
3470+
File: ztp-manual-install
3471+
- Name: Recommended single-node OpenShift cluster configuration for vDU application workloads
3472+
File: ztp-reference-cluster-configuration-for-vdu
3473+
- Name: Validating cluster tuning for vDU application workloads
3474+
File: ztp-vdu-validating-cluster-tuning
3475+
- Name: Advanced managed cluster configuration with SiteConfig resources
3476+
File: ztp-advanced-install-ztp
3477+
- Name: Managing cluster policies with PolicyGenerator resources
3478+
Dir: policygenerator_for_ztp
34493479
Distros: openshift-origin,openshift-enterprise
34503480
Topics:
3451-
- Name: Upgrading telco core CNF clusters
3452-
Dir: updating
3453-
Topics:
3454-
- Name: Upgrading telco core CNF clusters
3455-
File: telco-update-welcome
3456-
- Name: OpenShift Container Platform API compatibility
3457-
File: telco-update-api
3458-
- Name: Preparing for the cluster update
3459-
File: telco-update-ocp-update-prep
3460-
- Name: Managing live CNF pods during the cluster update
3461-
File: telco-update-cnf-update-prep
3462-
- Name: Before you update the cluster
3463-
File: telco-update-before-the-update
3464-
- Name: Completing the Control Plane Only update
3465-
File: telco-update-completing-the-control-plane-only-update
3466-
- Name: Completing the y-stream update
3467-
File: telco-update-completing-the-y-stream-update
3468-
- Name: Completing the z-stream update
3469-
File: telco-update-completing-the-z-stream-update
3470-
- Name: Troubleshooting and maintaining telco core CNF clusters
3471-
Dir: troubleshooting
3472-
Topics:
3473-
- Name: Troubleshooting and maintaining telco core CNF clusters
3474-
File: telco-troubleshooting-intro
3475-
- Name: General troubleshooting
3476-
File: telco-troubleshooting-general-troubleshooting
3477-
- Name: Cluster maintenance
3478-
File: telco-troubleshooting-cluster-maintenance
3479-
- Name: Security
3480-
File: telco-troubleshooting-security
3481-
- Name: Certificate maintenance
3482-
File: telco-troubleshooting-cert-maintenance
3483-
- Name: Machine Config Operator
3484-
File: telco-troubleshooting-mco
3485-
- Name: Bare-metal node maintenance
3486-
File: telco-troubleshooting-bmn-maintenance
3487-
- Name: Observability
3488-
Dir: observability
3489-
Topics:
3490-
- Name: Observability in OpenShift Container Platform
3491-
File: telco-observability
3492-
- Name: Security
3493-
Dir: security
3494-
Topics:
3495-
- Name: Security basics
3496-
File: telco-security-basics
3497-
- Name: Host security
3498-
File: telco-security-host-sec
3499-
- Name: Security context constraints
3500-
File: telco-security-sec-context-constraints
3481+
- Name: Configuring managed cluster policies by using PolicyGenerator resources
3482+
File: ztp-configuring-managed-clusters-policygenerator
3483+
- Name: Advanced managed cluster configuration with PolicyGenerator resources
3484+
File: ztp-advanced-policygenerator-config
3485+
- Name: Updating managed clusters in a disconnected environment with PolicyGenerator resources and TALM
3486+
File: ztp-talm-updating-managed-policies-pg
3487+
- Name: Managing cluster policies with PolicyGenTemplate resources
3488+
Dir: policygentemplate_for_ztp
3489+
Distros: openshift-origin,openshift-enterprise
3490+
Topics:
3491+
- Name: Configuring managed cluster policies by using PolicyGenTemplate resources
3492+
File: ztp-configuring-managed-clusters-policies
3493+
- Name: Advanced managed cluster configuration with PolicyGenTemplate resources
3494+
File: ztp-advanced-policy-config
3495+
- Name: Updating managed clusters in a disconnected environment with PolicyGenTemplate resources and TALM
3496+
File: ztp-talm-updating-managed-policies
3497+
- Name: Using hub templates in PolicyGenerator or PolicyGenTemplate CRs
3498+
File: ztp-using-hub-cluster-templates
3499+
- Name: Updating managed clusters with the Topology Aware Lifecycle Manager
3500+
File: cnf-talm-for-cluster-upgrades
3501+
- Name: Expanding single-node OpenShift clusters with GitOps ZTP
3502+
File: ztp-sno-additional-worker-node
3503+
- Name: Pre-caching images for single-node OpenShift deployments
3504+
File: ztp-precaching-tool
35013505
---
35023506
Name: Specialized hardware and driver enablement
35033507
Dir: hardware_enablement

architecture/mce-overview-ocp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ When you enable multicluster engine on {product-title}, you gain the following c
1919
* xref:../hosted_control_planes/index.adoc#hcp-overview[{hcp-capital}], which is a feature that is based on the HyperShift project. With a centralized hosted control plane, you can operate {product-title} clusters in a hyperscale manner.
2020
* Hive, which provisions self-managed {product-title} clusters to the hub and completes the initial configurations for those clusters.
2121
* klusterlet agent, which registers managed clusters to the hub.
22-
* Infrastructure Operator, which manages the deployment of the Assisted Service to orchestrate on-premise bare metal and vSphere installations of {product-title}, such as {sno} on bare metal. The Infrastructure Operator includes xref:../edge_computing/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-challenges-of-far-edge-deployments_ztp-deploying-far-edge-clusters-at-scale[{ztp-first}], which fully automates cluster creation on bare metal and vSphere provisioning with GitOps workflows to manage deployments and configuration changes.
22+
* Infrastructure Operator, which manages the deployment of the Assisted Service to orchestrate on-premise bare metal and vSphere installations of {product-title}, such as {sno} on bare metal. The Infrastructure Operator includes xref:../gitops_ztp/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-challenges-of-far-edge-deployments_ztp-deploying-far-edge-clusters-at-scale[{ztp-first}], which fully automates cluster creation on bare metal and vSphere provisioning with GitOps workflows to manage deployments and configuration changes.
2323
* Open cluster management, which provides resources to manage Kubernetes clusters.
2424

2525
The multicluster engine is included with your {product-title} support subscription and is delivered separately from the core payload. To start to use multicluster engine, you deploy the {product-title} cluster and then install the operator. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#mce-install-intro[Installing and upgrading multicluster engine operator].

day_2_core_cnf_clusters/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes

day_2_core_cnf_clusters/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images

day_2_core_cnf_clusters/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="telco-observability"]
3+
= Observability in {product-title}
4+
include::_attributes/common-attributes.adoc[]
5+
:context: telco-observability
6+
:imagesdir: images
7+
8+
toc::[]
9+
10+
{product-title} generates a large amount of data, such as performance metrics and logs from both the platform and the workloads running on it.
11+
As an administrator, you can use various tools to collect and analyze all the data available.
12+
What follows is an outline of best practices for system engineers, architects, and administrators configuring the observability stack.
13+
14+
Unless explicitly stated, the material in this document refers to both Edge and Core deployments.
15+
16+
include::modules/telco-observability-monitoring-stack.adoc[leveloffset=+1]
17+
18+
[role="_additional-resources"]
19+
.Additional resources
20+
21+
* xref:../../observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc#understanding-the-monitoring-stack_monitoring-stack-architecture[Understanding the monitoring stack]
22+
23+
// * xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack]
24+
// The above assembly is only available in OSD docs. See "_topic_map_osd.yml"
25+
26+
include::modules/telco-observability-key-performance-metrics.adoc[leveloffset=+1]
27+
28+
[role="_additional-resources"]
29+
.Additional resources
30+
31+
// * xref:../../observability/monitoring/managing-metrics.adoc#managing-metrics[Managing metrics]
32+
// // The above assembly is only available in OSD docs. See "_topic_map_osd.yml"
33+
* xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-local.adoc#local-storage-install_persistent-storage-local[Persistent storage using local volumes]
34+
* xref:../../scalability_and_performance/telco-ran-du-rds.adoc#cluster-tuning-crs_telco-ran-du[Cluster tuning reference CRs]
35+
36+
include::modules/telco-observability-monitoring-the-edge.adoc[leveloffset=+1]
37+
38+
include::modules/telco-observability-alerting.adoc[leveloffset=+1]
39+
40+
[role="_additional-resources"]
41+
.Additional resources
42+
43+
* xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc[Managing alerts as an Administrator]
44+
45+
include::modules/telco-observability-workload-monitoring.adoc[leveloffset=+1]
46+
47+
[role="_additional-resources"]
48+
.Additional resources
49+
50+
* xref:../../rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[ServiceMonitor[monitoring.coreos.com/v1]]
51+
52+
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
53+
54+
* xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerting-rules-for-user-defined-projects_managing-alerts-as-an-administrator[Managing alerting rules for user-defined projects]

0 commit comments

Comments
 (0)