diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index 23495ff40e..88668564aa 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -516,6 +516,175 @@ Topics: - Name: Accessing the registry File: accessing-the-registry --- +Name: Operators +Dir: operators +Distros: openshift-rosa-hcp +Topics: +- Name: Operators overview + File: index +- Name: Understanding Operators + Dir: understanding + Topics: + - Name: What are Operators? + File: olm-what-operators-are + - Name: Packaging format + File: olm-packaging-format + - Name: Common terms + File: olm-common-terms + - Name: Operator Lifecycle Manager (OLM) + Dir: olm + Topics: + - Name: Concepts and resources + File: olm-understanding-olm + - Name: Architecture + File: olm-arch + - Name: Workflow + File: olm-workflow + - Name: Dependency resolution + File: olm-understanding-dependency-resolution + - Name: Operator groups + File: olm-understanding-operatorgroups + - Name: Multitenancy and Operator colocation + File: olm-colocation + - Name: Operator conditions + File: olm-operatorconditions + - Name: Metrics + File: olm-understanding-metrics + - Name: Webhooks + File: olm-webhooks + - Name: OperatorHub + File: olm-understanding-operatorhub + - Name: Red Hat-provided Operator catalogs + File: olm-rh-catalogs + - Name: Operators in multitenant clusters + File: olm-multitenancy + - Name: CRDs + Dir: crds + Topics: + - Name: Managing resources from CRDs + File: crd-managing-resources-from-crds +- Name: User tasks + Dir: user + Topics: + - Name: Creating applications from installed Operators + File: olm-creating-apps-from-installed-operators +- Name: Administrator tasks + Dir: admin + Topics: + - Name: Adding Operators to a cluster + File: olm-adding-operators-to-cluster + - Name: Updating installed Operators + File: olm-upgrading-operators + - Name: Deleting Operators from a cluster + File: olm-deleting-operators-from-cluster + - Name: Configuring proxy support + File: olm-configuring-proxy-support + - Name: Viewing Operator status + File: olm-status + - Name: Managing Operator conditions + File: olm-managing-operatorconditions + - Name: Managing custom catalogs + File: olm-managing-custom-catalogs + - Name: Catalog source pod scheduling + File: olm-cs-podsched + - Name: Troubleshooting Operator issues + File: olm-troubleshooting-operator-issues +- Name: Developing Operators + Dir: operator_sdk + Topics: + - Name: About the Operator SDK + File: osdk-about + - Name: Installing the Operator SDK CLI + File: osdk-installing-cli + - Name: Go-based Operators + Dir: golang + Topics: +# Quick start excluded, because it requires cluster-admin permissions. +# - Name: Getting started +# File: osdk-golang-quickstart + - Name: Tutorial + File: osdk-golang-tutorial + - Name: Project layout + File: osdk-golang-project-layout + - Name: Updating Go-based projects + File: osdk-golang-updating-projects + - Name: Ansible-based Operators + Dir: ansible + Topics: +# Quick start excluded, because it requires cluster-admin permissions. +# - Name: Getting started +# File: osdk-ansible-quickstart + - Name: Tutorial + File: osdk-ansible-tutorial + - Name: Project layout + File: osdk-ansible-project-layout + - Name: Updating Ansible-based projects + File: osdk-ansible-updating-projects + - Name: Ansible support + File: osdk-ansible-support + - Name: Kubernetes Collection for Ansible + File: osdk-ansible-k8s-collection + - Name: Using Ansible inside an Operator + File: osdk-ansible-inside-operator + - Name: Custom resource status management + File: osdk-ansible-cr-status + - Name: Helm-based Operators + Dir: helm + Topics: +# Quick start excluded, because it requires cluster-admin permissions. +# - Name: Getting started +# File: osdk-helm-quickstart + - Name: Tutorial + File: osdk-helm-tutorial + - Name: Project layout + File: osdk-helm-project-layout + - Name: Updating Helm-based projects + File: osdk-helm-updating-projects + - Name: Helm support + File: osdk-helm-support +# - Name: Hybrid Helm Operator <= Tech Preview +# File: osdk-hybrid-helm +# - Name: Updating Hybrid Helm-based projects (Technology Preview) +# File: osdk-hybrid-helm-updating-projects +# - Name: Java-based Operators <= Tech Preview +# Dir: java +# Topics: +# - Name: Getting started +# File: osdk-java-quickstart +# - Name: Tutorial +# File: osdk-java-tutorial +# - Name: Project layout +# File: osdk-java-project-layout +# - Name: Updating Java-based projects +# File: osdk-java-updating-projects + - Name: Defining cluster service versions (CSVs) + File: osdk-generating-csvs + - Name: Working with bundle images + File: osdk-working-bundle-images + - Name: Complying with pod security admission + File: osdk-complying-with-psa + - Name: Validating Operators using the scorecard + File: osdk-scorecard + - Name: Validating Operator bundles + File: osdk-bundle-validate + - Name: High-availability or single-node cluster detection and support + File: osdk-ha-sno + - Name: Configuring built-in monitoring with Prometheus + File: osdk-monitoring-prometheus + - Name: Configuring leader election + File: osdk-leader-election + - Name: Object pruning utility + File: osdk-pruning-utility + - Name: Migrating package manifest projects to bundle format + File: osdk-pkgman-to-bundle + - Name: Operator SDK CLI reference + File: osdk-cli-ref + - Name: Migrating to Operator SDK v0.1.0 + File: osdk-migrating-to-v0-1-0 +# ROSA customers can't configure/edit the cluster Operators +# - Name: Cluster Operators reference +# File: operator-reference +--- Name: Backup and restore Dir: backup_and_restore Distros: openshift-rosa-hcp diff --git a/modules/gathering-operator-logs.adoc b/modules/gathering-operator-logs.adoc index 9ef14db7ec..5a8799280c 100644 --- a/modules/gathering-operator-logs.adoc +++ b/modules/gathering-operator-logs.adoc @@ -10,12 +10,12 @@ If you experience Operator issues, you can gather detailed diagnostic informatio .Prerequisites -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` role. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Your API service is still functional. * You have installed the OpenShift CLI (`oc`). * 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 ---- $ oc logs pod/ -c -n ---- - +ifndef::openshift-rosa-hcp[] . If the API is not functional, review Operator pod and container logs on each control plane node by using SSH instead. Replace `..` with appropriate values. .. List pods on each control plane node: + @@ -83,3 +83,4 @@ $ ssh core@.. sudo crictl logs -f ..`. ==== +endif::openshift-rosa-hcp[] \ No newline at end of file diff --git a/operators/admin/olm-adding-operators-to-cluster.adoc b/operators/admin/olm-adding-operators-to-cluster.adoc index 65bc5d6a1b..9d472b67d2 100644 --- a/operators/admin/olm-adding-operators-to-cluster.adoc +++ b/operators/admin/olm-adding-operators-to-cluster.adoc @@ -10,12 +10,12 @@ include::_attributes/common-attributes.adoc[] toc::[] Using Operator Lifecycle Manager (OLM), -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] cluster administrators -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] administrators with the `dedicated-admin` role -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] can install OLM-based Operators to an {product-title} cluster. [NOTE] @@ -45,7 +45,7 @@ include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloff * xref:../../operators/admin/olm-upgrading-operators.adoc#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator update] -ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa[] +ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1] [role="_additional-resources"] @@ -89,13 +89,13 @@ include::modules/olm-pod-placement.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors-project_nodes-scheduler-node-selectors[Creating project-wide node selectors] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] endif::[] include::modules/olm-overriding-operator-pod-affinity.adoc[leveloffset=+1] @@ -106,6 +106,6 @@ include::modules/olm-overriding-operator-pod-affinity.adoc[leveloffset=+1] * xref:../../nodes/scheduling/nodes-scheduler-pod-affinity.adoc#nodes-scheduler-pod-affinity-about_nodes-scheduler-pod-affinity[Understanding pod affinity] * xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-about_nodes-scheduler-node-affinity[Understanding node affinity] // This xref points to a topic not currently included in the OSD and ROSA docs. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/admin/olm-configuring-proxy-support.adoc b/operators/admin/olm-configuring-proxy-support.adoc index 85e18486e0..49dc2ff2a7 100644 --- a/operators/admin/olm-configuring-proxy-support.adoc +++ b/operators/admin/olm-configuring-proxy-support.adoc @@ -12,17 +12,17 @@ If a global proxy is configured on the {product-title} cluster, Operator Lifecyc .Additional resources // Configuring the cluster-wide proxy is a different topic in OSD/ROSA. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[Configuring the cluster-wide proxy] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated,openshift-rosa[] * xref:../../networking/configuring-cluster-wide-proxy.adoc[Configuring a cluster-wide proxy] endif::openshift-dedicated,openshift-rosa[] // This xref points to a topic that is not currently included in the OSD and ROSA docs. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../networking/configuring-a-custom-pki.adoc#configuring-a-custom-pki[Configuring a custom PKI] (custom CA certificate) -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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] diff --git a/operators/admin/olm-cs-podsched.adoc b/operators/admin/olm-cs-podsched.adoc index faef82038a..0c192fa822 100644 --- a/operators/admin/olm-cs-podsched.adoc +++ b/operators/admin/olm-cs-podsched.adoc @@ -33,9 +33,9 @@ include::modules/disabling-catalogsource-objects.adoc[leveloffset=+1] * xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-operatorhub-arch-operatorhub_crd_olm-understanding-operatorhub[OperatorHub custom resource] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../disconnected/using-olm.adoc#olm-restricted-networks-operatorhub_olm-restricted-networks[Disabling the default OperatorHub catalog sources] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-node-selector.adoc[leveloffset=+1] @@ -55,9 +55,9 @@ include::modules/olm-tolerations.adoc[leveloffset=+1] // The following xref points to a topic that is not included in the OSD or // ROSA docs. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/admin/olm-deleting-operators-from-cluster.adoc b/operators/admin/olm-deleting-operators-from-cluster.adoc index cfb8c4a792..18b72926ee 100644 --- a/operators/admin/olm-deleting-operators-from-cluster.adoc +++ b/operators/admin/olm-deleting-operators-from-cluster.adoc @@ -12,9 +12,9 @@ The following describes how to delete, or uninstall, Operators that were previou ==== 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. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] For more information, see xref:../../operators/admin/olm-troubleshooting-operator-issues.adoc#olm-reinstall_olm-troubleshooting-operator-issues[Reinstalling Operators after failed uninstallation]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ==== include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1] diff --git a/operators/admin/olm-managing-custom-catalogs.adoc b/operators/admin/olm-managing-custom-catalogs.adoc index 9e6da3946d..290cde3bb8 100644 --- a/operators/admin/olm-managing-custom-catalogs.adoc +++ b/operators/admin/olm-managing-custom-catalogs.adoc @@ -6,12 +6,12 @@ include::_attributes/common-attributes.adoc[] toc::[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Cluster administrators -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Administrators with the `dedicated-admin` role -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] and Operator catalog maintainers can create and manage custom catalogs packaged using the xref:../../operators/understanding/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[bundle format] on Operator Lifecycle Manager (OLM) in {product-title}. [IMPORTANT] @@ -29,7 +29,10 @@ If your cluster is using custom catalogs, see xref:../../operators/operator_sdk/ [id="olm-managing-custom-catalogs-bundle-format-prereqs"] == Prerequisites +// TODO-HCP remove conditions for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] * You have installed the xref:../../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[`opm` CLI]. +endif::openshift-rosa-hcp[] [id="olm-managing-custom-catalogs-fb"] == File-based catalogs @@ -43,29 +46,32 @@ As of {product-title} 4.11, the default Red Hat-provided Operator catalog releas The `opm` subcommands, flags, and functionality related to the SQLite database format are also deprecated and will be removed in a future release. The features are still supported and must be used for catalogs that use the deprecated SQLite database format. Many of the `opm` subcommands and flags for working with the SQLite database format, such as `opm index prune`, do not work with the file-based catalog format. -ifndef::openshift-dedicated,openshift-rosa[] -For more information about working with file-based catalogs, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format] and xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#about-installing-oc-mirror-v2[Mirroring images for a disconnected installation by using the oc-mirror plugin v2]. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +For more information about working with file-based catalogs, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format] and xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] For more information about working with file-based catalogs, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ==== include::modules/olm-creating-fb-catalog-image.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources +// TODO-HCP remove conditions for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../cli_reference/opm/cli-opm-ref.adoc#cli-opm-ref[`opm` CLI reference] +endif::openshift-rosa-hcp[] include::modules/olm-filtering-fbc.adoc[leveloffset=+2] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../../operators/understanding/olm-packaging-format.adoc#olm-deprecations-schema_olm-packaging-format[Packaging format -> Schemas -> olm.deprecations schema] * xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#updating-mirror-registry-content[Mirroring images for a disconnected installation using the oc-mirror plugin -> Keeping your mirror registry content updated] * xref:../../disconnected/using-olm.adoc#olm-creating-catalog-from-index_olm-restricted-networks[Adding a catalog source to a cluster] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="olm-managing-custom-catalogs-sqlite"] == SQLite-based catalogs @@ -82,7 +88,10 @@ include::modules/olm-catalog-source-and-psa.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources +// TODO-HCP remove conditions for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission] +endif::openshift-rosa-hcp[] include::modules/olm-migrating-sqlite-catalog-to-fbc.adoc[leveloffset=+2] @@ -100,14 +109,14 @@ include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+1] .Additional resources * xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[Operator Lifecycle Manager concepts and resources -> Catalog source] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-accessing-images-private-registries_olm-managing-custom-catalogs[Accessing images for Operators from private registries] // This xref may be relevant to OSD/ROSA, but the topic is not currently included in the OSD and ROSA docs. * xref:../../openshift_images/managing_images/image-pull-policy.adoc#image-pull-policy[Image pull policy] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Exclude from OSD/ROSA - dedicated-admins can't create the necessary secrets to do this procedure. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-accessing-images-private-registries.adoc[leveloffset=+1] [role="_additional-resources"] @@ -116,17 +125,17 @@ include::modules/olm-accessing-images-private-registries.adoc[leveloffset=+1] * See xref:../../cicd/builds/creating-build-inputs.adoc#builds-secrets-overview_creating-build-inputs[What is a secret?] for more information on the types of secrets, including those used for registry credentials. * See xref:../../openshift_images/managing_images/using-image-pull-secrets.adoc#images-update-global-pull-secret_using-image-pull-secrets[Updating the global cluster pull secret] for more details on the impact of changing this secret. * See xref:../../openshift_images/managing_images/using-image-pull-secrets.adoc#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets[Allowing pods to reference images from other secured registries] for more details on linking pull secrets to service accounts per namespace. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Exclude from OSD/ROSA - dedicated-admins can't do this procedure. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Removing custom catalogs can be done as a dedicated-admin, but the steps are different. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-removing-catalogs.adoc[leveloffset=+1] -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/sd-olm-removing-catalogs.adoc[leveloffset=+1] -endif::openshift-dedicated,openshift-rosa[] \ No newline at end of file +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] \ No newline at end of file diff --git a/operators/admin/olm-managing-operatorconditions.adoc b/operators/admin/olm-managing-operatorconditions.adoc index 1079c2d2f6..b7052be0a8 100644 --- a/operators/admin/olm-managing-operatorconditions.adoc +++ b/operators/admin/olm-managing-operatorconditions.adoc @@ -6,12 +6,12 @@ include::_attributes/common-attributes.adoc[] toc::[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As a cluster administrator, you can manage Operator conditions by using Operator Lifecycle Manager (OLM). -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As an administrator with the `dedicated-admin` role, you can manage Operator conditions by using Operator Lifecycle Manager (OLM). -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-overriding-operatorconditions.adoc[leveloffset=+1] include::modules/olm-updating-use-operatorconditions.adoc[leveloffset=+1] diff --git a/operators/admin/olm-status.adoc b/operators/admin/olm-status.adoc index ee437f105c..4849030b05 100644 --- a/operators/admin/olm-status.adoc +++ b/operators/admin/olm-status.adoc @@ -23,6 +23,6 @@ include::modules/olm-cs-status-cli.adoc[leveloffset=+1] * xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[Operator Lifecycle Manager concepts and resources -> Catalog source] * gRPC documentation: link:https://grpc.github.io/grpc/core/md_doc_connectivity-semantics-and-api.html[States of Connectivity] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-accessing-images-private-registries_olm-managing-custom-catalogs[Accessing images for Operators from private registries] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/admin/olm-troubleshooting-operator-issues.adoc b/operators/admin/olm-troubleshooting-operator-issues.adoc index 3ae7b624e7..e46c13c53e 100644 --- a/operators/admin/olm-troubleshooting-operator-issues.adoc +++ b/operators/admin/olm-troubleshooting-operator-issues.adoc @@ -26,13 +26,13 @@ include::modules/olm-cs-status-cli.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[Operator Lifecycle Manager concepts and resources -> Catalog source] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * gRPC documentation: link:https://grpc.github.io/grpc/core/md_doc_connectivity-semantics-and-api.html[States of Connectivity] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-accessing-images-private-registries_olm-managing-custom-catalogs[Accessing images for Operators from private registries] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Querying Operator Pod status include::modules/querying-operator-pod-status.adoc[leveloffset=+1] @@ -41,29 +41,29 @@ include::modules/querying-operator-pod-status.adoc[leveloffset=+1] include::modules/gathering-operator-logs.adoc[leveloffset=+1] // cannot patch resource "machineconfigpools" -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Disabling Machine Config Operator from autorebooting include::modules/troubleshooting-disabling-autoreboot-mco.adoc[leveloffset=+1] include::modules/troubleshooting-disabling-autoreboot-mco-console.adoc[leveloffset=+2] include::modules/troubleshooting-disabling-autoreboot-mco-cli.adoc[leveloffset=+2] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Refreshing failing subscriptions // OSD/ROSA cannot delete resource "clusterserviceversions", "jobs" in API group "operators.coreos.com" in the namespace "openshift-apiserver" -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-refresh-subs.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Reinstalling Operators after failed uninstallation // OSD/ROSA gitcannot delete resource "customresourcedefinitions" -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-reinstall.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster] * xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/admin/olm-upgrading-operators.adoc b/operators/admin/olm-upgrading-operators.adoc index 802ee925c1..7110e45fb7 100644 --- a/operators/admin/olm-upgrading-operators.adoc +++ b/operators/admin/olm-upgrading-operators.adoc @@ -7,10 +7,10 @@ include::_attributes/common-attributes.adoc[] toc::[] As -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] a cluster administrator, endif::[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] an administrator with the `dedicated-admin` role, endif::[] you can update Operators that have been previously installed using Operator Lifecycle Manager (OLM) on your {product-title} cluster. @@ -24,10 +24,10 @@ include::modules/olm-preparing-upgrade.adoc[leveloffset=+1] include::modules/olm-changing-update-channel.adoc[leveloffset=+1] include::modules/olm-approving-pending-upgrade.adoc[leveloffset=+1] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] [id="additional-resources_olm-upgrading-operators"] == Additional resources * xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments] -endif::openshift-dedicated,openshift-rosa[] \ No newline at end of file +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] \ No newline at end of file diff --git a/operators/index.adoc b/operators/index.adoc index 082e98c777..152a841fde 100644 --- a/operators/index.adoc +++ b/operators/index.adoc @@ -15,59 +15,59 @@ As an Operator author, you can perform the following development tasks for OLM-b ** xref:../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Install Operator SDK CLI]. // The Operator quickstarts aren't published for OSD/ROSA, so for OSD/ROSA, these xrefs point to the tutorials instead. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** Create xref:../operators/operator_sdk/golang/osdk-golang-quickstart.adoc#osdk-golang-quickstart[Go-based Operators], xref:../operators/operator_sdk/ansible/osdk-ansible-quickstart.adoc#osdk-ansible-quickstart[Ansible-based Operators], xref:../operators/operator_sdk/java/osdk-java-quickstart.adoc#osdk-java-quickstart[Java-based Operators], and xref:../operators/operator_sdk/helm/osdk-helm-quickstart.adoc#osdk-helm-quickstart[Helm-based Operators]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // TODO: When the Java-based Operators is GA, it can be added to the list below for OSD/ROSA. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** Create xref:../operators/operator_sdk/golang/osdk-golang-tutorial.adoc#osdk-golang-tutorial[Go-based Operators], xref:../operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc#osdk-ansible-tutorial[Ansible-based Operators], and xref:../operators/operator_sdk/helm/osdk-helm-tutorial.adoc#osdk-helm-tutorial[Helm-based Operators]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/operator_sdk/osdk-about.adoc#osdk-about[Use Operator SDK to build, test, and deploy an Operator]. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Install and subscribe an Operator to your namespace]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Create an application from an installed Operator through the web console]. // This xref could be relevant for OSD/ROSA, but the target doesn't currently exist in the OSD/ROSA docs. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion-uses_deleting-machine[Machine deletion lifecycle hook examples for Operator developers] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="operators-overview-administrator-tasks_{context}"] == For administrators -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As a cluster administrator, you can perform the following administrative tasks for OLM-based Operators: -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As an administrator with the `dedicated-admin` role, you can perform the following Operator tasks: -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Manage custom catalogs]. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/admin/olm-creating-policy.adoc#olm-creating-policy[Allow non-cluster administrators to install Operators]. -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Install an Operator from OperatorHub]. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Install an Operator from OperatorHub]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../operators/admin/olm-status.adoc#olm-status[View Operator status]. ** xref:../operators/admin/olm-managing-operatorconditions.adoc#olm-managing-operatorconditions[Manage Operator conditions]. ** xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Upgrade installed Operators]. ** xref:../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Delete installed Operators]. ** xref:../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[Configure proxy support]. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** xref:../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments]. // Not sure if the xref above should be changed in #82841 since this is the index page of the Operators section For information about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="operators-overview-next-steps"] == Next steps diff --git a/operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc b/operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc index e30868ead3..700bdb3698 100644 --- a/operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc +++ b/operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc @@ -20,27 +20,30 @@ Operator SDK:: The `operator-sdk` CLI tool and `controller-runtime` library API Operator Lifecycle Manager (OLM):: Installation, upgrade, and role-based access control (RBAC) of Operators on a cluster -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than xref:../../../operators/operator_sdk/ansible/osdk-ansible-quickstart.adoc#osdk-ansible-quickstart[Getting started with Operator SDK for Ansible-based Operators]. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // The "Getting started" quickstarts require cluster-admin and are therefore only available in OCP. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-ansible-quickstart[Getting started with Operator SDK for Ansible-based Operators] in the OpenShift Container Platform documentation. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-common-prereqs.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI] +// TODO-HCP remove line 44 and 46 ifndef conditions for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI] +endif::openshift-rosa-hcp[] include::modules/osdk-create-project.adoc[leveloffset=+1] include::modules/osdk-project-file.adoc[leveloffset=+2] @@ -52,18 +55,18 @@ include::modules/osdk-run-proxy.adoc[leveloffset=+1] include::modules/osdk-run-operator.adoc[leveloffset=+1] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-locally_osdk-ansible-tutorial[Running locally outside the cluster] (OpenShift Container Platform documentation) * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-deployment_osdk-ansible-tutorial[Running as a deployment on the cluster] (OpenShift Container Platform documentation) -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // In OSD/ROSA, the only applicable option for running the Operator is to bundle and deploy with OLM. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-run-locally.adoc[leveloffset=+2] include::modules/osdk-run-deployment.adoc[leveloffset=+2] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="osdk-bundle-deploy-olm_{context}"] === Bundling an Operator and deploying with Operator Lifecycle Manager @@ -78,9 +81,13 @@ include::modules/osdk-create-cr.adoc[leveloffset=+1] == Additional resources * See xref:../../../operators/operator_sdk/ansible/osdk-ansible-project-layout.adoc#osdk-ansible-project-layout[Project layout for Ansible-based Operators] to learn about the directory structures created by the Operator SDK. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] -* If a xref:../../../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[cluster-wide egress proxy is configured], administrators with the `dedicated-admin` role can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +// TODO-HCP remove line 88 and 91 ifndef conditions for HCP after networking book is migrated +ifndef::openshift-rosa-hcp[] +* If a xref:../../../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[cluster-wide egress proxy is configured] +endif::openshift-rosa-hcp[] +, administrators with the `dedicated-admin` role can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/operator_sdk/golang/osdk-golang-tutorial.adoc b/operators/operator_sdk/golang/osdk-golang-tutorial.adoc index c292800836..51cb7b75d6 100644 --- a/operators/operator_sdk/golang/osdk-golang-tutorial.adoc +++ b/operators/operator_sdk/golang/osdk-golang-tutorial.adoc @@ -16,27 +16,30 @@ Operator SDK:: The `operator-sdk` CLI tool and `controller-runtime` library API Operator Lifecycle Manager (OLM):: Installation, upgrade, and role-based access control (RBAC) of Operators on a cluster -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than xref:../../../operators/operator_sdk/golang/osdk-golang-quickstart.adoc#osdk-golang-quickstart[Getting started with Operator SDK for Go-based Operators]. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // The "Getting started" quickstarts require cluster-admin and are therefore only available in OCP. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-golang-quickstart[Getting started with Operator SDK for Go-based Operators] in the OpenShift Container Platform documentation. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-common-prereqs.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI] +// TODO-HCP remove conditions ifndef line 40 & 42 for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI] +endif::openshift-rosa-hcp[] include::modules/osdk-create-project.adoc[leveloffset=+1] include::modules/osdk-project-file.adoc[leveloffset=+2] @@ -60,18 +63,18 @@ include::modules/osdk-golang-controller-rbac-markers.adoc[leveloffset=+2] include::modules/osdk-run-proxy.adoc[leveloffset=+1] include::modules/osdk-run-operator.adoc[leveloffset=+1] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-locally_osdk-golang-tutorial[Running locally outside the cluster] (OpenShift Container Platform documentation) * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-deployment_osdk-golang-tutorial[Running as a deployment on the cluster] (OpenShift Container Platform documentation) -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // In OSD/ROSA, the only applicable option for running the Operator is to bundle and deploy with OLM. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-run-locally.adoc[leveloffset=+2] include::modules/osdk-run-deployment.adoc[leveloffset=+2] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="osdk-bundle-deploy-olm_{context}"] === Bundling an Operator and deploying with Operator Lifecycle Manager @@ -86,9 +89,15 @@ include::modules/osdk-create-cr.adoc[leveloffset=+1] == Additional resources * See xref:../../../operators/operator_sdk/golang/osdk-golang-project-layout.adoc#osdk-golang-project-layout[Project layout for Go-based Operators] to learn about the directory structures created by the Operator SDK. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated,openshift-rosa[] -* If a xref:../../../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[cluster-wide egress proxy is configured], administrators with the `dedicated-admin` role can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). +// TODO-HCP remove line 97 and 99 conditions and add the HCP condition to line 92 and 98 for HCP after networking book is migrated +ifndef::openshift-rosa-hcp[] +* If a xref:../../../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[cluster-wide egress proxy is configured], +endif::openshift-rosa-hcp[] +administrators with the `dedicated-admin` role can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). endif::openshift-dedicated,openshift-rosa[] + + diff --git a/operators/operator_sdk/helm/osdk-helm-tutorial.adoc b/operators/operator_sdk/helm/osdk-helm-tutorial.adoc index 71c14c1187..ec6d25f9b4 100644 --- a/operators/operator_sdk/helm/osdk-helm-tutorial.adoc +++ b/operators/operator_sdk/helm/osdk-helm-tutorial.adoc @@ -20,27 +20,30 @@ Operator SDK:: The `operator-sdk` CLI tool and `controller-runtime` library API Operator Lifecycle Manager (OLM):: Installation, upgrade, and role-based access control (RBAC) of Operators on a cluster -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than xref:../../../operators/operator_sdk/helm/osdk-helm-quickstart.adoc#osdk-helm-quickstart[Getting started with Operator SDK for Helm-based Operators]. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // The "Getting started" quickstarts require cluster-admin and are therefore only available in OCP. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-helm-quickstart[Getting started with Operator SDK for Helm-based Operators] in the OpenShift Container Platform documentation. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-common-prereqs.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI] +// TODO-HCP remove line 44 and 46 ifndef conditions for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI] +endif::openshift-rosa-hcp[] include::modules/osdk-create-project.adoc[leveloffset=+1] include::modules/osdk-helm-existing-chart.adoc[leveloffset=+2] @@ -55,18 +58,18 @@ include::modules/osdk-run-proxy.adoc[leveloffset=+1] include::modules/osdk-run-operator.adoc[leveloffset=+1] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-locally_osdk-helm-tutorial[Running locally outside the cluster] (OpenShift Container Platform documentation) * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-deployment_osdk-helm-tutorial[Running as a deployment on the cluster] (OpenShift Container Platform documentation) -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // In OSD/ROSA, the only applicable option for running the Operator is to bundle and deploy with OLM. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-run-locally.adoc[leveloffset=+2] include::modules/osdk-run-deployment.adoc[leveloffset=+2] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="osdk-bundle-deploy-olm_{context}"] === Bundling an Operator and deploying with Operator Lifecycle Manager @@ -81,9 +84,13 @@ include::modules/osdk-create-cr.adoc[leveloffset=+1] == Additional resources * See xref:../../../operators/operator_sdk/helm/osdk-helm-project-layout.adoc#osdk-helm-project-layout[Project layout for Helm-based Operators] to learn about the directory structures created by the Operator SDK. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated,openshift-rosa[] +// TODO-HCP remove line 92 and 94 ifndef conditions for HCP after networking book is migrated ad put the hcp condition back on line 90 and 95 +ifndef::openshift-rosa-hcp[] * If a xref:../../../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[cluster-wide egress proxy is configured], administrators with the `dedicated-admin` role can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM). +endif::openshift-rosa-hcp[] endif::openshift-dedicated,openshift-rosa[] + diff --git a/operators/operator_sdk/java/osdk-java-tutorial.adoc b/operators/operator_sdk/java/osdk-java-tutorial.adoc index 12eecea2a4..a0d5d5d4a2 100644 --- a/operators/operator_sdk/java/osdk-java-tutorial.adoc +++ b/operators/operator_sdk/java/osdk-java-tutorial.adoc @@ -20,20 +20,20 @@ Operator SDK:: The `operator-sdk` CLI tool and `java-operator-sdk` library API Operator Lifecycle Manager (OLM):: Installation, upgrade, and role-based access control (RBAC) of Operators on a cluster -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than xref:../../../operators/operator_sdk/java/osdk-java-quickstart.adoc#osdk-java-quickstart[Getting started with Operator SDK for Java-based Operators]. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // The "Getting started" quickstarts require cluster-admin and are therefore only available in OCP. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== This tutorial goes into greater detail than link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-java-quickstart[Getting started with Operator SDK for Java-based Operators] in the OpenShift Container Platform documentation. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-common-prereqs.adoc[leveloffset=+1] @@ -60,18 +60,18 @@ include::modules/osdk-java-controller-memcached-deployment.adoc[leveloffset=+2] include::modules/osdk-run-operator.adoc[leveloffset=+1] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-locally_osdk-java-tutorial[Running locally outside the cluster] (OpenShift Container Platform documentation) * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-deployment_osdk-java-tutorial[Running as a deployment on the cluster] (OpenShift Container Platform documentation) -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // In OSD/ROSA, the only applicable option for running the Operator is to bundle and deploy with OLM. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-run-locally.adoc[leveloffset=+2] include::modules/osdk-run-deployment.adoc[leveloffset=+2] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="osdk-bundle-deploy-olm_{context}"] === Bundling an Operator and deploying with Operator Lifecycle Manager diff --git a/operators/operator_sdk/osdk-about.adoc b/operators/operator_sdk/osdk-about.adoc index 239054f93a..65e45c5849 100644 --- a/operators/operator_sdk/osdk-about.adoc +++ b/operators/operator_sdk/osdk-about.adoc @@ -26,12 +26,12 @@ The Operator SDK is a framework that uses the link:https://github.com/kubernetes - Extensions to cover common Operator use cases - Metrics set up automatically in any generated Go-based Operator for use on clusters where the Prometheus Operator is deployed -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Operator authors with cluster administrator access to a Kubernetes-based cluster (such as {product-title}) -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Operator authors with dedicated-admin access to {product-title} -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] can use the Operator SDK CLI to develop their own Operators based on Go, Ansible, Java, or Helm. link:https://kubebuilder.io/[Kubebuilder] is embedded into the Operator SDK as the scaffolding solution for Go-based Operators, which means existing Kubebuilder projects can be used as is with the Operator SDK and continue to work. [NOTE] diff --git a/operators/operator_sdk/osdk-bundle-validate.adoc b/operators/operator_sdk/osdk-bundle-validate.adoc index 7d4a67bd11..16773a53b3 100644 --- a/operators/operator_sdk/osdk-bundle-validate.adoc +++ b/operators/operator_sdk/osdk-bundle-validate.adoc @@ -20,7 +20,7 @@ include::modules/osdk-bundle-validate-tests.adoc[leveloffset=+1] include::modules/osdk-bundle-validate-run.adoc[leveloffset=+1] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-multi-arch-validate.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/operators/operator_sdk/osdk-cli-ref.adoc b/operators/operator_sdk/osdk-cli-ref.adoc index b6c1ecac08..33db59edca 100644 --- a/operators/operator_sdk/osdk-cli-ref.adoc +++ b/operators/operator_sdk/osdk-cli-ref.adoc @@ -41,7 +41,10 @@ include::modules/osdk-cli-ref-run-bundle.adoc[leveloffset=+2] * See xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-membership_olm-understanding-operatorgroups[Operator group membership] for details on possible install modes. * xref:../../operators/operator_sdk/osdk-complying-with-psa.adoc#osdk-complying-with-psa[Complying with pod security admission] +// TODO-HCP remove line 45 and 47 ifndef conditions for HCP after Authentication book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission] +endif::openshift-rosa-hcp[] include::modules/osdk-cli-ref-run-bundle-upgrade.adoc[leveloffset=+2] @@ -49,7 +52,10 @@ include::modules/osdk-cli-ref-run-bundle-upgrade.adoc[leveloffset=+2] .Additional resources * xref:../../operators/operator_sdk/osdk-complying-with-psa.adoc#osdk-complying-with-psa[Complying with pod security admission] +// TODO-HCP remove line 55 and 57 ifndef conditions for HCP after Authentication book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission] +endif::openshift-rosa-hcp[] include::modules/osdk-cli-ref-scorecard.adoc[leveloffset=+1] @@ -58,4 +64,7 @@ include::modules/osdk-cli-ref-scorecard.adoc[leveloffset=+1] * See xref:../../operators/operator_sdk/osdk-scorecard.adoc#osdk-scorecard[Validating Operators using the scorecard tool] for details about running the scorecard tool. * xref:../../operators/operator_sdk/osdk-complying-with-psa.adoc#osdk-complying-with-psa[Complying with pod security admission] +// TODO-HCP remove line 67 and 69 ifndef conditions for HCP after Authentication book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission] +endif::openshift-rosa-hcp[] \ No newline at end of file diff --git a/operators/operator_sdk/osdk-complying-with-psa.adoc b/operators/operator_sdk/osdk-complying-with-psa.adoc index 9e80f34132..cc448d4ab5 100644 --- a/operators/operator_sdk/osdk-complying-with-psa.adoc +++ b/operators/operator_sdk/osdk-complying-with-psa.adoc @@ -13,8 +13,10 @@ If your Operator project does not require escalated permissions to run, you can * The allowed pod security admission level for the Operator's namespace * The allowed security context constraints (SCC) for the workload's service account - +// TODO-HCP remove line 17 and 19 ifndef conditions for HCP after authentication book is migrated +ifndef::openshift-rosa-hcp[] For more information, see xref:../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission]. +endif::openshift-rosa-hcp[] include::snippets/osdk-deprecation.adoc[] @@ -30,13 +32,17 @@ include::modules/osdk-ensuring-operator-workloads-run-restricted-psa.adoc[levelo [role="_additional-resources"] .Additional resources - +// TODO-HCP remove line 36 and 38 ifndef conditions for HCP after authentication book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../authentication/managing-security-context-constraints.adoc#managing-security-context-constraints[Managing security context constraints] +endif::openshift-rosa-hcp[] include::modules/osdk-managing-psa-for-operators-with-escalated-permissions.adoc[leveloffset=+1] [id="osdk-complying-with-psa-additional-resources"] [role="_additional-resources"] == Additional resources - +// TODO-HCP remove line 46 and 48 ifndef conditions for HCP after authentication book is migrated +ifndef::openshift-rosa-hcp[] * xref:../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission] +endif::openshift-rosa-hcp[] \ No newline at end of file diff --git a/operators/operator_sdk/osdk-generating-csvs.adoc b/operators/operator_sdk/osdk-generating-csvs.adoc index a46a0e7f39..a4020e9de8 100644 --- a/operators/operator_sdk/osdk-generating-csvs.adoc +++ b/operators/operator_sdk/osdk-generating-csvs.adoc @@ -37,9 +37,9 @@ include::modules/osdk-csv-annotations-infra.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources * xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-enabling-operator-for-restricted-network_osdk-generating-csvs[Enabling your Operator for restricted network environments] (disconnected mode) -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../installing/overview/installing-fips.adoc#installing-fips[Support for FIPS cryptography] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/osdk-csv-annotations-dep.adoc[leveloffset=+2] include::modules/osdk-csv-annotations-other.adoc[leveloffset=+2] @@ -76,9 +76,9 @@ include::modules/olm-defining-csv-webhooks.adoc[leveloffset=+1] .Additional resources // This xref points to a topic that is not currently included in the OSD and ROSA docs. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plugins] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Kubernetes documentation: ** link:https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook[Validating admission webhooks] ** link:https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook[Mutating admission webhooks] diff --git a/operators/operator_sdk/osdk-ha-sno.adoc b/operators/operator_sdk/osdk-ha-sno.adoc index 68ac8ed761..325cae8cab 100644 --- a/operators/operator_sdk/osdk-ha-sno.adoc +++ b/operators/operator_sdk/osdk-ha-sno.adoc @@ -7,9 +7,9 @@ include::_attributes/common-attributes.adoc[] toc::[] // OSD/ROSA don't support single-node clusters, but these Operator authors still need to know how to handle this configuration for their Operators to work correctly in OCP. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] To ensure that your Operator runs well on both high-availability (HA) and non-HA modes in OpenShift Container Platform clusters, you can use the Operator SDK to detect the cluster's infrastructure topology and set the resource requirements to fit the cluster's topology. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Not using {product-title} here, because HA mode and non-HA mode are specific to OCP and should be spelled out this way in other distros. An OpenShift Container Platform cluster can be configured in high-availability (HA) mode, which uses multiple nodes, or in non-HA mode, which uses a single node. A single-node cluster, also known as {sno}, is likely to have more conservative resource constraints. Therefore, it is important that Operators installed on a single-node cluster can adjust accordingly and still run well. diff --git a/operators/operator_sdk/osdk-installing-cli.adoc b/operators/operator_sdk/osdk-installing-cli.adoc index d0bfb4742c..857d24cdc4 100644 --- a/operators/operator_sdk/osdk-installing-cli.adoc +++ b/operators/operator_sdk/osdk-installing-cli.adoc @@ -10,12 +10,12 @@ The Operator SDK provides a command-line interface (CLI) tool that Operator deve include::snippets/osdk-deprecation.adoc[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Operator authors with cluster administrator access to a Kubernetes-based cluster, such as {product-title}, -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Operator authors with dedicated-admin access to {product-title} -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] can use the Operator SDK CLI to develop their own Operators based on Go, Ansible, Java, or Helm. link:https://kubebuilder.io/[Kubebuilder] is embedded into the Operator SDK as the scaffolding solution for Go-based Operators, which means existing Kubebuilder projects can be used as is with the Operator SDK and continue to work. [NOTE] diff --git a/operators/operator_sdk/osdk-leader-election.adoc b/operators/operator_sdk/osdk-leader-election.adoc index e34681b25a..9cd2d5c0e4 100644 --- a/operators/operator_sdk/osdk-leader-election.adoc +++ b/operators/operator_sdk/osdk-leader-election.adoc @@ -8,7 +8,7 @@ toc::[] During the lifecycle of an Operator, it is possible that there may be more than one instance running at any given time, for example when rolling out an upgrade for the Operator. In such a scenario, it is necessary to avoid contention between multiple Operator instances using leader election. This ensures only one leader instance handles the reconciliation while the other instances are inactive but ready to take over when the leader steps down. -There are two different leader election implementations to choose from, each with its own trade-off: +There are two different leader election implementations to choose from, each with its own tradeoff: Leader-for-life:: The leader pod only gives up leadership, using garbage collection, when it is deleted. This implementation precludes the possibility of two instances mistakenly running as leaders, a state also known as split brain. However, this method can be subject to a delay in electing a new leader. For example, when the leader pod is on an unresponsive or partitioned node, you can specify `node.kubernetes.io/unreachable` and `node.kubernetes.io/not-ready` tolerations on the leader pod and use the `tolerationSeconds` value to dictate how long it takes for the leader pod to be deleted from the node and step down. These tolerations are added to the pod by default on admission with a `tolerationSeconds` value of 5 minutes. See the link:https://godoc.org/github.com/operator-framework/operator-sdk/pkg/leader[Leader-for-life] Go documentation for more. diff --git a/operators/operator_sdk/osdk-monitoring-prometheus.adoc b/operators/operator_sdk/osdk-monitoring-prometheus.adoc index 83f6efb33c..b1b292ca61 100644 --- a/operators/operator_sdk/osdk-monitoring-prometheus.adoc +++ b/operators/operator_sdk/osdk-monitoring-prometheus.adoc @@ -8,7 +8,7 @@ toc::[] // Dedicated-admins in OSD and ROSA don't have the permissions to complete the procedures in this assembly. Also, the procedures use the default Prometheus Operator in the openshift-monitoring project, which OSD/ROSA customers should not use. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] This guide describes the built-in monitoring support provided by the Operator SDK using the Prometheus Operator and details usage for authors of Go-based and Ansible-based Operators. include::snippets/osdk-deprecation.adoc[] @@ -16,7 +16,7 @@ include::snippets/osdk-deprecation.adoc[] include::modules/osdk-monitoring-prometheus-operator-support.adoc[leveloffset=+1] include::modules/osdk-monitoring-custom-metrics.adoc[leveloffset=+1] include::modules/osdk-ansible-metrics.adoc[leveloffset=+1] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated,openshift-rosa[] // Since OSD/ROSA dedicated-admins can't do the procedures in this assembly, point to the OCP docs. @@ -35,5 +35,9 @@ Do not use the Prometheus Operator in the `openshift-monitoring` project. Red Ha .Additional resources * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-monitoring-custom-metrics_osdk-monitoring-prometheus[Exposing custom metrics for Go-based Operators] (OpenShift Container Platform documentation) * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-ansible-metrics_osdk-monitoring-prometheus[Exposing custom metrics for Ansible-based Operators] (OpenShift Container Platform documentation) +// TODO-HCP remove line 39 and 41 ifndef conditions for HCP after Observability book is migrated and add back HCP condition to line 41 and 21 +ifndef::openshift-rosa-hcp[] * xref:../../observability/monitoring/monitoring-overview.adoc#understanding-the-monitoring-stack_monitoring-overview[Understanding the monitoring stack] in {product-title} +endif::openshift-rosa-hcp[] endif::openshift-dedicated,openshift-rosa[] + diff --git a/operators/understanding/olm-multitenancy.adoc b/operators/understanding/olm-multitenancy.adoc index b81b915a30..0d9ed89db1 100644 --- a/operators/understanding/olm-multitenancy.adoc +++ b/operators/understanding/olm-multitenancy.adoc @@ -26,10 +26,10 @@ include::modules/olm-multitenancy-solution.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-preparing-operators-multitenant_olm-adding-operators-to-a-cluster[Preparing for multiple instances of an Operator for multitenant clusters] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../operators/admin/olm-creating-policy.adoc#olm-creating-policy[Allowing non-cluster administrators to install Operators] * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-restricted-networks-operatorhub_olm-managing-custom-catalogs[Disabling the default OperatorHub catalog sources] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="olm-colocation_{context}"] == Operator colocation and Operator groups diff --git a/operators/understanding/olm-packaging-format.adoc b/operators/understanding/olm-packaging-format.adoc index f5dabaab71..7e6543cd0a 100644 --- a/operators/understanding/olm-packaging-format.adoc +++ b/operators/understanding/olm-packaging-format.adoc @@ -17,8 +17,10 @@ include::modules/olm-dependencies.adoc[leveloffset=+2] * xref:../../operators/understanding/olm/olm-understanding-dependency-resolution.adoc#olm-understanding-dependency-resolution[Operator Lifecycle Manager dependency resolution] include::modules/olm-about-opm.adoc[leveloffset=+2] - +// TODO-HCP remove conditions for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] * See xref:../../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[CLI tools] for steps on installing the `opm` CLI. +endif::openshift-rosa-hcp[] ifdef::openshift-origin[] [id="olm-packaging-format-addtl-resources"] @@ -40,12 +42,12 @@ As of {product-title} 4.11, the default Red Hat-provided Operator catalog releas The `opm` subcommands, flags, and functionality related to the SQLite database format are also deprecated and will be removed in a future release. The features are still supported and must be used for catalogs that use the deprecated SQLite database format. Many of the `opm` subcommands and flags for working with the SQLite database format, such as `opm index prune`, do not work with the file-based catalog format. -ifndef::openshift-dedicated,openshift-rosa[] -For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs] and xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#about-installing-oc-mirror-v2[Mirroring images for a disconnected installation by using the oc-mirror plugin v2]. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs] and xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ==== include::modules/olm-fb-catalogs-structure.adoc[leveloffset=+2] @@ -68,7 +70,9 @@ include::modules/olm-fb-catalogs-guidelines.adoc[leveloffset=+2] === CLI usage For instructions about creating file-based catalogs by using the `opm` CLI, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-creating-fb-catalog-image_olm-managing-custom-catalogs[Managing custom catalogs]. - +// TODO-HCP remove conditions for HCP after cli_tools book is migrated +ifndef::openshift-rosa-hcp[] For reference documentation about the `opm` CLI commands related to managing file-based catalogs, see xref:../../cli_reference/opm/cli-opm-ref.adoc#cli-opm-ref[CLI tools]. +endif::openshift-rosa-hcp[] include::modules/olm-fb-catalogs-automation.adoc[leveloffset=+2] diff --git a/operators/understanding/olm-rh-catalogs.adoc b/operators/understanding/olm-rh-catalogs.adoc index dedfd12cdc..443ee9bcbb 100644 --- a/operators/understanding/olm-rh-catalogs.adoc +++ b/operators/understanding/olm-rh-catalogs.adoc @@ -15,14 +15,14 @@ As of {product-title} 4.11, the default Red Hat-provided Operator catalog releas The `opm` subcommands, flags, and functionality related to the SQLite database format are also deprecated and will be removed in a future release. The features are still supported and must be used for catalogs that use the deprecated SQLite database format. Many of the `opm` subcommands and flags for working with the SQLite database format, such as `opm index prune`, do not work with the file-based catalog format. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Managing custom catalogs], -xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format], and xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#about-installing-oc-mirror-v2[Mirroring images for a disconnected installation by using the oc-mirror plugin v2]. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format], and xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Managing custom catalogs], and xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format]. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ==== include::modules/olm-about-catalogs.adoc[leveloffset=+1] @@ -32,8 +32,8 @@ include::modules/olm-about-catalogs.adoc[leveloffset=+1] * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Managing custom catalogs] * xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Packaging format] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-rh-catalogs.adoc[leveloffset=+1] diff --git a/operators/understanding/olm/olm-operatorconditions.adoc b/operators/understanding/olm/olm-operatorconditions.adoc index 0d592ce737..5a148915c4 100644 --- a/operators/understanding/olm/olm-operatorconditions.adoc +++ b/operators/understanding/olm/olm-operatorconditions.adoc @@ -18,7 +18,7 @@ include::modules/olm-supported-operatorconditions.adoc[leveloffset=+1] * xref:../../../operators/admin/olm-managing-operatorconditions.adoc#olm-operatorconditions[Managing Operator conditions] * xref:../../../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-operatorconditions_osdk-generating-csvs[Enabling Operator conditions] // The following xrefs point to topics that are not currently included in the OSD/ROSA docs. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../nodes/pods/nodes-pods-configuring.adoc#nodes-pods-configuring-pod-distruption-about_nodes-pods-configuring[Using pod disruption budgets to specify the number of pods that must be up] * xref:../../../applications/deployments/route-based-deployment-strategies.adoc#deployments-graceful-termination_route-based-deployment-strategies[Graceful termination] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/understanding/olm/olm-understanding-olm.adoc b/operators/understanding/olm/olm-understanding-olm.adoc index 11390a63c4..5f53847256 100644 --- a/operators/understanding/olm/olm-understanding-olm.adoc +++ b/operators/understanding/olm/olm-understanding-olm.adoc @@ -21,40 +21,40 @@ include::modules/olm-catalogsource.adoc[leveloffset=+2] * xref:../../../operators/understanding/olm/olm-understanding-dependency-resolution.adoc#olm-dependency-catalog-priority_olm-understanding-dependency-resolution[Catalog priority] * xref:../../../operators/admin/olm-status.adoc#olm-cs-status-cli_olm-status[Viewing Operator catalog source status by using the CLI] // This xref points to a topic that is not currently included in the OSD/ROSA docs. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../operators/admin/olm-cs-podsched.adoc#olm-cs-podsched[Catalog source pod scheduling] include::modules/olm-catalogsource-image-template.adoc[leveloffset=+3] include::modules/olm-cs-health.adoc[leveloffset=+3] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../../../operators/admin/olm-managing-custom-catalogs.adoc#olm-removing-catalogs_olm-managing-custom-catalogs[Removing custom catalogs] * xref:../../../operators/admin/olm-managing-custom-catalogs.adoc#olm-restricted-networks-operatorhub_olm-managing-custom-catalogs[Disabling the default OperatorHub catalog sources] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-subscription.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Multitenancy and Operator colocation] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../operators/admin/olm-status.adoc#olm-status-viewing-cli_olm-status[Viewing Operator subscription status by using the CLI] include::modules/olm-installplan.adoc[leveloffset=+2] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Multitenancy and Operator colocation] * xref:../../../operators/admin/olm-creating-policy.adoc#olm-creating-policy[Allowing non-cluster administrators to install Operators] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-operatorgroups-about.adoc[leveloffset=+2] .Additional resources diff --git a/operators/understanding/olm/olm-understanding-operatorgroups.adoc b/operators/understanding/olm/olm-understanding-operatorgroups.adoc index be19ef7c7b..e7fdc406ee 100644 --- a/operators/understanding/olm/olm-understanding-operatorgroups.adoc +++ b/operators/understanding/olm/olm-understanding-operatorgroups.adoc @@ -20,12 +20,12 @@ include::modules/olm-operatorgroups-intersections.adoc[leveloffset=+1] include::modules/olm-operatorgroups-limitations.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Operator Lifecycle Manager (OLM) -> Multitenancy and Operator colocation] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../operators/understanding/olm-multitenancy.adoc#olm-multitenancy[Operators in multitenant clusters] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../operators/admin/olm-creating-policy.adoc#olm-creating-policy[Allowing non-cluster administrators to install Operators] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-operatorgroups-troubleshooting.adoc[leveloffset=+1] diff --git a/operators/understanding/olm/olm-webhooks.adoc b/operators/understanding/olm/olm-webhooks.adoc index cdaf8779a4..4c0490b8dc 100644 --- a/operators/understanding/olm/olm-webhooks.adoc +++ b/operators/understanding/olm/olm-webhooks.adoc @@ -14,9 +14,9 @@ See xref:../../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-defining- [role="_additional-resources"] == Additional resources -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plugins] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Kubernetes documentation: ** link:https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook[Validating admission webhooks] ** link:https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook[Mutating admission webhooks]