mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
131 lines
5.1 KiB
Plaintext
131 lines
5.1 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * scalability_and_performance/cluster-compare/using-the-cluster-compare-plugin.adoc
|
|
// * scalability_and_performance/telco_ran_du_ref_design_specs/telco-ran-du-rds.adoc
|
|
// * scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-crs.adoc
|
|
// *scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-crs.adoc
|
|
// *scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc
|
|
// *scalability_and_performance/cluster-compare/using-the-cluster-compare-plugin.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
|
|
[id="using-cluster-compare-telco-ran_{context}"]
|
|
= Comparing a cluster with the {rds} reference configuration
|
|
|
|
After you deploy a {rds} cluster, you can use the `cluster-compare` plugin to assess the cluster's compliance with the {rds} reference design specifications (RDS). The `cluster-compare` plugin is an OpenShift CLI (`oc`) plugin. The plugin uses a {rds} reference configuration to validate the cluster with the {rds} custom resources (CRs).
|
|
|
|
The plugin-specific reference configuration for {rds} is packaged in a container image with the {rds} CRs.
|
|
|
|
For further information about the `cluster-compare` plugin, see "Understanding the cluster-compare plugin".
|
|
|
|
.Prerequisites
|
|
|
|
* You have access to the cluster as a user with the `cluster-admin` role.
|
|
|
|
* You have credentials to access the `registry.redhat.io` container image registry.
|
|
|
|
* You installed the `cluster-compare` plugin.
|
|
|
|
.Procedure
|
|
|
|
. Log on to the container image registry with your credentials by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ podman login registry.redhat.io
|
|
----
|
|
|
|
. Extract the content from the `ztp-site-generate-rhel8` container image by running the following commands::
|
|
+
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
$ podman pull registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version}
|
|
----
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ mkdir -p ./out
|
|
----
|
|
+
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
$ podman run --log-driver=none --rm registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version} extract /home/ztp --tar | tar x -C ./out
|
|
----
|
|
|
|
. Compare the configuration for your cluster to the reference configuration by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc cluster-compare -r out/reference/metadata.yaml
|
|
----
|
|
+
|
|
.Example output
|
|
[source,terminal]
|
|
----
|
|
...
|
|
|
|
**********************************
|
|
|
|
Cluster CR: config.openshift.io/v1_OperatorHub_cluster <1>
|
|
Reference File: required/other/operator-hub.yaml <2>
|
|
Diff Output: diff -u -N /tmp/MERGED-2801470219/config-openshift-io-v1_operatorhub_cluster /tmp/LIVE-2569768241/config-openshift-io-v1_operatorhub_cluster
|
|
--- /tmp/MERGED-2801470219/config-openshift-io-v1_operatorhub_cluster 2024-12-12 14:13:22.898756462 +0000
|
|
+++ /tmp/LIVE-2569768241/config-openshift-io-v1_operatorhub_cluster 2024-12-12 14:13:22.898756462 +0000
|
|
@@ -1,6 +1,6 @@
|
|
apiVersion: config.openshift.io/v1
|
|
kind: OperatorHub
|
|
metadata:
|
|
+ annotations: <3>
|
|
+ include.release.openshift.io/hypershift: "true"
|
|
name: cluster
|
|
-spec:
|
|
- disableAllDefaultSources: true
|
|
|
|
**********************************
|
|
|
|
Summary <4>
|
|
CRs with diffs: 11/12 <5>
|
|
CRs in reference missing from the cluster: 40 <6>
|
|
optional-image-registry:
|
|
image-registry:
|
|
Missing CRs: <7>
|
|
- optional/image-registry/ImageRegistryPV.yaml
|
|
optional-ptp-config:
|
|
ptp-config:
|
|
One of the following is required:
|
|
- optional/ptp-config/PtpConfigBoundary.yaml
|
|
- optional/ptp-config/PtpConfigGmWpc.yaml
|
|
- optional/ptp-config/PtpConfigDualCardGmWpc.yaml
|
|
- optional/ptp-config/PtpConfigForHA.yaml
|
|
- optional/ptp-config/PtpConfigMaster.yaml
|
|
- optional/ptp-config/PtpConfigSlave.yaml
|
|
- optional/ptp-config/PtpConfigSlaveForEvent.yaml
|
|
- optional/ptp-config/PtpConfigForHAForEvent.yaml
|
|
- optional/ptp-config/PtpConfigMasterForEvent.yaml
|
|
- optional/ptp-config/PtpConfigBoundaryForEvent.yaml
|
|
ptp-operator-config:
|
|
One of the following is required:
|
|
- optional/ptp-config/PtpOperatorConfig.yaml
|
|
- optional/ptp-config/PtpOperatorConfigForEvent.yaml
|
|
optional-storage:
|
|
storage:
|
|
Missing CRs:
|
|
- optional/local-storage-operator/StorageLV.yaml
|
|
|
|
...
|
|
|
|
No CRs are unmatched to reference CRs <8>
|
|
Metadata Hash: 09650c31212be9a44b99315ec14d2e7715ee194a5d68fb6d24f65fd5ddbe3c3c <9>
|
|
No patched CRs <10>
|
|
----
|
|
<1> The CR under comparison. The plugin displays each CR with a difference from the corresponding template.
|
|
<2> The template matching with the CR for comparison.
|
|
<3> The output in Linux diff format shows the difference between the template and the cluster CR.
|
|
<4> After the plugin reports the line diffs for each CR, the summary of differences are reported.
|
|
<5> The number of CRs in the comparison with differences from the corresponding templates.
|
|
<6> The number of CRs represented in the reference configuration, but missing from the live cluster.
|
|
<7> The list of CRs represented in the reference configuration, but missing from the live cluster.
|
|
<8> The CRs that did not match to a corresponding template in the reference configuration.
|
|
<9> The metadata hash identifies the reference configuration.
|
|
<10> The list of patched CRs.
|