Skip to content

Commit 401e9d1

Browse files
committed
uncommenting Operators section in HCP topic map and adding conditions for HCP
resolving error in HCP topic map indentation removed the < and replaced with brackets for tech preview in HCP topic map removed the < and replaced with brackets for Operators tech preview in HCP topic map removed the file with tech preview for Operators in HCP topic map applied conditions to 20 xrefs because the networking, cli, authentication and observability books are not in HCP repo yet added blank line after and endif and an include module
1 parent 6649910 commit 401e9d1

32 files changed

+409
-184
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

+169
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,175 @@ Topics:
516516
- Name: Accessing the registry
517517
File: accessing-the-registry
518518
---
519+
Name: Operators
520+
Dir: operators
521+
Distros: openshift-rosa-hcp
522+
Topics:
523+
- Name: Operators overview
524+
File: index
525+
- Name: Understanding Operators
526+
Dir: understanding
527+
Topics:
528+
- Name: What are Operators?
529+
File: olm-what-operators-are
530+
- Name: Packaging format
531+
File: olm-packaging-format
532+
- Name: Common terms
533+
File: olm-common-terms
534+
- Name: Operator Lifecycle Manager (OLM)
535+
Dir: olm
536+
Topics:
537+
- Name: Concepts and resources
538+
File: olm-understanding-olm
539+
- Name: Architecture
540+
File: olm-arch
541+
- Name: Workflow
542+
File: olm-workflow
543+
- Name: Dependency resolution
544+
File: olm-understanding-dependency-resolution
545+
- Name: Operator groups
546+
File: olm-understanding-operatorgroups
547+
- Name: Multitenancy and Operator colocation
548+
File: olm-colocation
549+
- Name: Operator conditions
550+
File: olm-operatorconditions
551+
- Name: Metrics
552+
File: olm-understanding-metrics
553+
- Name: Webhooks
554+
File: olm-webhooks
555+
- Name: OperatorHub
556+
File: olm-understanding-operatorhub
557+
- Name: Red Hat-provided Operator catalogs
558+
File: olm-rh-catalogs
559+
- Name: Operators in multitenant clusters
560+
File: olm-multitenancy
561+
- Name: CRDs
562+
Dir: crds
563+
Topics:
564+
- Name: Managing resources from CRDs
565+
File: crd-managing-resources-from-crds
566+
- Name: User tasks
567+
Dir: user
568+
Topics:
569+
- Name: Creating applications from installed Operators
570+
File: olm-creating-apps-from-installed-operators
571+
- Name: Administrator tasks
572+
Dir: admin
573+
Topics:
574+
- Name: Adding Operators to a cluster
575+
File: olm-adding-operators-to-cluster
576+
- Name: Updating installed Operators
577+
File: olm-upgrading-operators
578+
- Name: Deleting Operators from a cluster
579+
File: olm-deleting-operators-from-cluster
580+
- Name: Configuring proxy support
581+
File: olm-configuring-proxy-support
582+
- Name: Viewing Operator status
583+
File: olm-status
584+
- Name: Managing Operator conditions
585+
File: olm-managing-operatorconditions
586+
- Name: Managing custom catalogs
587+
File: olm-managing-custom-catalogs
588+
- Name: Catalog source pod scheduling
589+
File: olm-cs-podsched
590+
- Name: Troubleshooting Operator issues
591+
File: olm-troubleshooting-operator-issues
592+
- Name: Developing Operators
593+
Dir: operator_sdk
594+
Topics:
595+
- Name: About the Operator SDK
596+
File: osdk-about
597+
- Name: Installing the Operator SDK CLI
598+
File: osdk-installing-cli
599+
- Name: Go-based Operators
600+
Dir: golang
601+
Topics:
602+
# Quick start excluded, because it requires cluster-admin permissions.
603+
# - Name: Getting started
604+
# File: osdk-golang-quickstart
605+
- Name: Tutorial
606+
File: osdk-golang-tutorial
607+
- Name: Project layout
608+
File: osdk-golang-project-layout
609+
- Name: Updating Go-based projects
610+
File: osdk-golang-updating-projects
611+
- Name: Ansible-based Operators
612+
Dir: ansible
613+
Topics:
614+
# Quick start excluded, because it requires cluster-admin permissions.
615+
# - Name: Getting started
616+
# File: osdk-ansible-quickstart
617+
- Name: Tutorial
618+
File: osdk-ansible-tutorial
619+
- Name: Project layout
620+
File: osdk-ansible-project-layout
621+
- Name: Updating Ansible-based projects
622+
File: osdk-ansible-updating-projects
623+
- Name: Ansible support
624+
File: osdk-ansible-support
625+
- Name: Kubernetes Collection for Ansible
626+
File: osdk-ansible-k8s-collection
627+
- Name: Using Ansible inside an Operator
628+
File: osdk-ansible-inside-operator
629+
- Name: Custom resource status management
630+
File: osdk-ansible-cr-status
631+
- Name: Helm-based Operators
632+
Dir: helm
633+
Topics:
634+
# Quick start excluded, because it requires cluster-admin permissions.
635+
# - Name: Getting started
636+
# File: osdk-helm-quickstart
637+
- Name: Tutorial
638+
File: osdk-helm-tutorial
639+
- Name: Project layout
640+
File: osdk-helm-project-layout
641+
- Name: Updating Helm-based projects
642+
File: osdk-helm-updating-projects
643+
- Name: Helm support
644+
File: osdk-helm-support
645+
# - Name: Hybrid Helm Operator <= Tech Preview
646+
# File: osdk-hybrid-helm
647+
# - Name: Updating Hybrid Helm-based projects (Technology Preview)
648+
# File: osdk-hybrid-helm-updating-projects
649+
# - Name: Java-based Operators <= Tech Preview
650+
# Dir: java
651+
# Topics:
652+
# - Name: Getting started
653+
# File: osdk-java-quickstart
654+
# - Name: Tutorial
655+
# File: osdk-java-tutorial
656+
# - Name: Project layout
657+
# File: osdk-java-project-layout
658+
# - Name: Updating Java-based projects
659+
# File: osdk-java-updating-projects
660+
- Name: Defining cluster service versions (CSVs)
661+
File: osdk-generating-csvs
662+
- Name: Working with bundle images
663+
File: osdk-working-bundle-images
664+
- Name: Complying with pod security admission
665+
File: osdk-complying-with-psa
666+
- Name: Validating Operators using the scorecard
667+
File: osdk-scorecard
668+
- Name: Validating Operator bundles
669+
File: osdk-bundle-validate
670+
- Name: High-availability or single-node cluster detection and support
671+
File: osdk-ha-sno
672+
- Name: Configuring built-in monitoring with Prometheus
673+
File: osdk-monitoring-prometheus
674+
- Name: Configuring leader election
675+
File: osdk-leader-election
676+
- Name: Object pruning utility
677+
File: osdk-pruning-utility
678+
- Name: Migrating package manifest projects to bundle format
679+
File: osdk-pkgman-to-bundle
680+
- Name: Operator SDK CLI reference
681+
File: osdk-cli-ref
682+
- Name: Migrating to Operator SDK v0.1.0
683+
File: osdk-migrating-to-v0-1-0
684+
# ROSA customers can't configure/edit the cluster Operators
685+
# - Name: Cluster Operators reference
686+
# File: operator-reference
687+
---
519688
Name: Backup and restore
520689
Dir: backup_and_restore
521690
Distros: openshift-rosa-hcp

modules/gathering-operator-logs.adoc

+6-5
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ If you experience Operator issues, you can gather detailed diagnostic informatio
1010

1111
.Prerequisites
1212

13-
ifndef::openshift-rosa,openshift-dedicated[]
13+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1414
* You have access to the cluster as a user with the `cluster-admin` role.
15-
endif::openshift-rosa,openshift-dedicated[]
16-
ifdef::openshift-rosa,openshift-dedicated[]
15+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
16+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1717
* You have access to the cluster as a user with the `dedicated-admin` role.
18-
endif::openshift-rosa,openshift-dedicated[]
18+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1919
* Your API service is still functional.
2020
* You have installed the OpenShift CLI (`oc`).
2121
* You have the fully qualified domain names of the control plane or control plane machines.
@@ -42,7 +42,7 @@ If an Operator pod has multiple containers, the preceding command will produce a
4242
----
4343
$ oc logs pod/<operator_pod_name> -c <container_name> -n <operator_namespace>
4444
----
45-
45+
ifndef::openshift-rosa-hcp[]
4646
. If the API is not functional, review Operator pod and container logs on each control plane node by using SSH instead. Replace `<master-node>.<cluster_name>.<base_domain>` with appropriate values.
4747
.. List pods on each control plane node:
4848
+
@@ -83,3 +83,4 @@ $ ssh core@<master-node>.<cluster_name>.<base_domain> sudo crictl logs -f <conta
8383
====
8484
{product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Accessing cluster nodes by using SSH is not recommended. Before attempting to collect diagnostic data over SSH, review whether the data collected by running `oc adm must gather` and other `oc` commands is sufficient instead. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to access nodes using `ssh core@<node>.<cluster_name>.<base_domain>`.
8585
====
86+
endif::openshift-rosa-hcp[]

operators/admin/olm-adding-operators-to-cluster.adoc

+11-11
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ include::_attributes/common-attributes.adoc[]
1010
toc::[]
1111

1212
Using Operator Lifecycle Manager (OLM),
13-
ifndef::openshift-dedicated,openshift-rosa[]
13+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1414
cluster administrators
15-
endif::openshift-dedicated,openshift-rosa[]
16-
ifdef::openshift-dedicated,openshift-rosa[]
15+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
16+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1717
administrators with the `dedicated-admin` role
18-
endif::openshift-dedicated,openshift-rosa[]
18+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1919
can install OLM-based Operators to an {product-title} cluster.
2020

2121
[NOTE]
@@ -45,7 +45,7 @@ include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloff
4545
4646
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator update]
4747
48-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa[]
48+
ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4949
include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
5050
5151
[role="_additional-resources"]
@@ -89,13 +89,13 @@ include::modules/olm-pod-placement.adoc[leveloffset=+1]
8989
9090
[role="_additional-resources"]
9191
.Additional resources
92-
ifndef::openshift-dedicated,openshift-rosa[]
92+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
9393
* Adding taints and tolerations xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-adding_nodes-scheduler-taints-tolerations[manually to nodes] or xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-adding-machineset_nodes-scheduler-taints-tolerations[with compute machine sets]
94-
endif::openshift-dedicated,openshift-rosa[]
94+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
9595
* xref:../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors-project_nodes-scheduler-node-selectors[Creating project-wide node selectors]
96-
ifndef::openshift-dedicated,openshift-rosa[]
96+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
9797
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-projects_nodes-scheduler-taints-tolerations[Creating a project with a node selector and toleration]
98-
endif::openshift-dedicated,openshift-rosa[]
98+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
9999
endif::[]
100100
101101
include::modules/olm-overriding-operator-pod-affinity.adoc[leveloffset=+1]
@@ -106,6 +106,6 @@ include::modules/olm-overriding-operator-pod-affinity.adoc[leveloffset=+1]
106106
* xref:../../nodes/scheduling/nodes-scheduler-pod-affinity.adoc#nodes-scheduler-pod-affinity-about_nodes-scheduler-pod-affinity[Understanding pod affinity]
107107
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-about_nodes-scheduler-node-affinity[Understanding node affinity]
108108
// This xref points to a topic not currently included in the OSD and ROSA docs.
109-
ifndef::openshift-dedicated,openshift-rosa[]
109+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
110110
* xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes]
111-
endif::openshift-dedicated,openshift-rosa[]
111+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

operators/admin/olm-configuring-proxy-support.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ If a global proxy is configured on the {product-title} cluster, Operator Lifecyc
1212
.Additional resources
1313

1414
// Configuring the cluster-wide proxy is a different topic in OSD/ROSA.
15-
ifndef::openshift-dedicated,openshift-rosa[]
15+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1616
* xref:../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[Configuring the cluster-wide proxy]
17-
endif::openshift-dedicated,openshift-rosa[]
17+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1818
ifdef::openshift-dedicated,openshift-rosa[]
1919
* xref:../../networking/configuring-cluster-wide-proxy.adoc[Configuring a cluster-wide proxy]
2020
endif::openshift-dedicated,openshift-rosa[]
2121

2222
// This xref points to a topic that is not currently included in the OSD and ROSA docs.
23-
ifndef::openshift-dedicated,openshift-rosa[]
23+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2424
* xref:../../networking/configuring-a-custom-pki.adoc#configuring-a-custom-pki[Configuring a custom PKI] (custom CA certificate)
25-
endif::openshift-dedicated,openshift-rosa[]
25+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2626

2727
* Developing Operators that support proxy settings for xref:../../operators/operator_sdk/golang/osdk-golang-tutorial.adoc#osdk-run-proxy_osdk-golang-tutorial[Go], xref:../../operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc#osdk-run-proxy_osdk-ansible-tutorial[Ansible], and xref:../../operators/operator_sdk/helm/osdk-helm-tutorial.adoc#osdk-run-proxy_osdk-helm-tutorial[Helm]
2828

operators/admin/olm-cs-podsched.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ include::modules/disabling-catalogsource-objects.adoc[leveloffset=+1]
3333

3434
* xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-operatorhub-arch-operatorhub_crd_olm-understanding-operatorhub[OperatorHub custom resource]
3535
36-
ifndef::openshift-dedicated,openshift-rosa[]
36+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3737
* xref:../../disconnected/using-olm.adoc#olm-restricted-networks-operatorhub_olm-restricted-networks[Disabling the default OperatorHub catalog sources]
38-
endif::openshift-dedicated,openshift-rosa[]
38+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3939

4040
include::modules/olm-node-selector.adoc[leveloffset=+1]
4141

@@ -55,9 +55,9 @@ include::modules/olm-tolerations.adoc[leveloffset=+1]
5555

5656
// The following xref points to a topic that is not included in the OSD or
5757
// ROSA docs.
58-
ifndef::openshift-dedicated,openshift-rosa[]
58+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5959
[role="_additional-resources"]
6060
.Additional resources
6161
6262
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
63-
endif::openshift-dedicated,openshift-rosa[]
63+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

operators/admin/olm-deleting-operators-from-cluster.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ The following describes how to delete, or uninstall, Operators that were previou
1212
====
1313
You must successfully and completely uninstall an Operator prior to attempting to reinstall the same Operator. Failure to fully uninstall the Operator properly can leave resources, such as a project or namespace, stuck in a "Terminating" state and cause "error resolving resource" messages to be observed when trying to reinstall the Operator.
1414
15-
ifndef::openshift-dedicated,openshift-rosa[]
15+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1616
For more information, see xref:../../operators/admin/olm-troubleshooting-operator-issues.adoc#olm-reinstall_olm-troubleshooting-operator-issues[Reinstalling Operators after failed uninstallation].
17-
endif::openshift-dedicated,openshift-rosa[]
17+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1818
====
1919

2020
include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)