Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1969,7 +1969,7 @@ Topics:
File: olm-webhooks
- Name: Software catalog
Distros: openshift-enterprise,openshift-origin
File: olm-understanding-operatorhub
File: olm-understanding-software-catalog
- Name: Red Hat-provided Operator catalogs
Distros: openshift-enterprise
File: olm-rh-catalogs
Expand Down
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map_osd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ Topics:
- Name: Webhooks
File: olm-webhooks
- Name: Software catalog
File: olm-understanding-operatorhub
File: olm-understanding-software-catalog
- Name: Red Hat-provided Operator catalogs
File: olm-rh-catalogs
- Name: Operators in multitenant clusters
Expand Down
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map_rosa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -896,7 +896,7 @@ Topics:
- Name: Webhooks
File: olm-webhooks
- Name: Software catalog
File: olm-understanding-operatorhub
File: olm-understanding-software-catalog
- Name: Red Hat-provided Operator catalogs
File: olm-rh-catalogs
- Name: Operators in multitenant clusters
Expand Down
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map_rosa_hcp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -758,7 +758,7 @@ Topics:
- Name: Webhooks
File: olm-webhooks
- Name: Software catalog
File: olm-understanding-operatorhub
File: olm-understanding-software-catalog
- Name: Red Hat-provided Operator catalogs
File: olm-rh-catalogs
- Name: Operators in multitenant clusters
Expand Down
2 changes: 1 addition & 1 deletion architecture/control-plane.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ include::modules/arch-olm-operators.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
* xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager (OLM) concepts and resources]
* xref:../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the software catalog].
* xref:../operators/understanding/olm-understanding-software-catalog.adoc#olm-understanding-software-catalog[Understanding the software catalog].

include::modules/etcd-overview.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ include::modules/installing-oadp-aws-sts.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from the software catalog using the web console]
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-software-catalog-using-web-console_olm-installing-operators-in-namespace[Installing from the software catalog using the web console]
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]

[id="oadp-aws-sts-backing-up-and-cleaning"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ endif::openshift-rosa,openshift-rosa-hcp[]
[role="_additional-resources"]
.Additional resources
ifndef::openshift-rosa-hcp[]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators on clusters for administrators]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-software-catalog_olm-adding-operators-to-a-cluster[Installing Operators on clusters for administrators]
endif::openshift-rosa-hcp[]
// This xref is not included in the ROSA classic docs.
ifndef::openshift-rosa,openshift-rosa-hcp[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ include::modules/updating-role-arn-oadp-rosa-sts.adoc[leveloffset=+1]
.Additional resources
// This xref points to a topic that is not published in the ROSA docs.
ifndef::openshift-rosa,openshift-rosa-hcp[]
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from the software catalog using the web console].
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-software-catalog-using-web-console_olm-installing-operators-in-namespace[Installing from the software catalog using the web console].
endif::openshift-rosa,openshift-rosa-hcp[]
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]

Expand Down
2 changes: 1 addition & 1 deletion cicd/pipelines/installing-pipelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This guide walks cluster administrators through the process of installing the {p
ifdef::openshift-origin[]
* Ensure that you have downloaded the {cluster-manager-url-pull} as shown in the xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[Obtaining the installation program] to install this Operator.
+
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in xref:../../post_installation_configuration/preparing-for-users.adoc#olm-installing-operators-from-operatorhub-configure_post-install-preparing-for-users[Configuring {product-title} to use Red Hat Operators].
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in xref:../../post_installation_configuration/preparing-for-users.adoc#olm-installing-operators-from-software-catalog-configure_post-install-preparing-for-users[Configuring {product-title} to use Red Hat Operators].
endif::[]


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ ifeval::["{context}" == "olm-installing-operators-in-namespace"]
endif::[]

:_mod-docs-content-type: PROCEDURE
[id="olm-installing-operator-from-operatorhub-using-cli_{context}"]

[id="olm-installing-operator-from-software-catalog-using-cli_{context}"]
= Installing from the software catalog by using the CLI

Instead of using the {product-title} web console, you can install an Operator from the software catalog by using the CLI. Use the `oc` command to create or update a `Subscription` object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ ifeval::["{context}" == "olm-adding-operators-to-a-cluster"]
endif::[]

:_mod-docs-content-type: PROCEDURE
[id="olm-installing-from-operatorhub-using-web-console_{context}"]

[id="olm-installing-from-software-catalog-using-web-console_{context}"]
= Installing from the software catalog by using the web console

You can install and subscribe to an Operator from software catalog by using the {product-title} web console.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@


:_mod-docs-content-type: CONCEPT
[id="olm-installing-operators-from-operatorhub-configure_{context}"]
[id="olm-installing-operators-from-software-catalog-configure_{context}"]
= About Operator Catalogs in {product-title}

Out of the box {product-title} provides a catalog source for community operators.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ ifeval::["{context}" == "olm-installing-operators-in-namespace"]
endif::[]

:_mod-docs-content-type: CONCEPT
[id="olm-installing-operators-from-operatorhub_{context}"]

[id="olm-installing-operators-from-software-catalog_{context}"]
= About Operator installation from the software catalog

The software catalog is a user interface for discovering Operators; it works in conjunction with Operator Lifecycle Manager (OLM), which installs and manages Operators on a cluster.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
// Module included in the following assemblies:
//
// * operators/understanding/olm-understanding-operatorhub.adoc
// * operators/understanding/olm-understanding-software-catalog.adoc

[id="olm-operatorhub-arch_{context}"]
:_mod-docs-content-type: CONCEPT

[id="olm-software-catalog-arch_{context}"]
= Software catalog architecture

The software catalog UI component is driven by the Marketplace Operator by default on {product-title} in the `openshift-marketplace` namespace.

[id="olm-operatorhub-arch-operatorhub_crd_{context}"]
[id="olm-software-catalog-arch-operatorhub-crd_{context}"]
== OperatorHub custom resource

The Marketplace Operator manages an `OperatorHub` custom resource (CR) named `cluster` that manages the default `CatalogSource` objects provided with the software catalog.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
// Module included in the following assemblies:
//
// * operators/understanding/olm-understanding-operatorhub.adoc
// * operators/understanding/olm-understanding-software-catalog.adoc

:_mod-docs-content-type: CONCEPT
[id="olm-operatorhub-overview_{context}"]

[id="olm-software-catalog-overview_{context}"]
= About the software catalog

The _software catalog_ is the web console interface in {product-title} that cluster administrators use to discover and install Operators. With one click, an Operator can be pulled from its off-cluster source, installed and subscribed on the cluster, and made ready for engineering teams to self-service manage the product across deployment environments using Operator Lifecycle Manager (OLM).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,6 @@ include::modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc[leveloffse
* xref:../../post_installation_configuration/preparing-for-users.adoc#creating-cluster-admin_post-install-preparing-for-users[Creating a cluster admin]
* link:https://operatorhub.io/[OperatorHub.io]
* xref:../../web_console/web-console.adoc#web-console[Accessing the web console]
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from the software catalog using the web console]
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-software-catalog-using-web-console_olm-adding-operators-to-a-cluster[Installing from the software catalog using the web console]
* xref:../../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Creating applications from installed Operators]
* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
2 changes: 1 addition & 1 deletion observability/otel/otel-installing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ include::modules/otel-creating-required-RBAC-resources-automatically.adoc[levelo
* xref:../../post_installation_configuration/preparing-for-users.adoc#creating-cluster-admin_post-install-preparing-for-users[Creating a cluster admin]
* link:https://operatorhub.io/[OperatorHub.io]
* xref:../../web_console/web-console.adoc#web-console[Accessing the web console]
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from the software catalog using the web console]
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-software-catalog-using-web-console_olm-adding-operators-to-a-cluster[Installing from the software catalog using the web console]
* xref:../../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Creating applications from installed Operators]
* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
8 changes: 4 additions & 4 deletions operators/admin/olm-adding-operators-to-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ ifdef::openshift-origin[]
If you have the pull secret, add the `redhat-operators` catalog to the `OperatorHub` custom resource (CR) as shown in _Configuring {product-title} to use Red Hat Operators_.
endif::[]

include::modules/olm-installing-operators-from-operatorhub.adoc[leveloffset=+1]
include::modules/olm-installing-operators-from-software-catalog.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the software catalog]
* xref:../../operators/understanding/olm-understanding-software-catalog.adoc#olm-understanding-software-catalog[Understanding the software catalog]

// Installing from OperatorHub by using the CLI
include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloffset=+1]
include::modules/olm-installing-from-software-catalog-using-web-console.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
Expand All @@ -48,7 +48,7 @@ include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloff
ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

// Installing from OperatorHub by using the CLI
include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
include::modules/olm-installing-from-software-catalog-using-cli.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
Expand Down
2 changes: 1 addition & 1 deletion operators/admin/olm-cs-podsched.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ include::modules/disabling-catalogsource-objects.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-operatorhub-arch-operatorhub_crd_olm-understanding-operatorhub[OperatorHub custom resource]
* xref:../../operators/understanding/olm-understanding-software-catalog.adoc#olm-software-catalog-arch-operatorhub-crd_olm-understanding-software-catalog[OperatorHub custom resource]

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]
Expand Down
2 changes: 1 addition & 1 deletion operators/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ 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 the software catalog].
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 the software catalog].
** xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-software-catalog_olm-adding-operators-to-a-cluster[Install an Operator from the software catalog].
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].
Expand Down
6 changes: 3 additions & 3 deletions operators/operator_sdk/token_auth/osdk-cco-aws-sts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ Your code should check for secrets that never appear and warn users to follow th
.Additional resources

* xref:../../../authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc#cco-short-term-creds-aws-olm_cco-short-term-creds[OLM-managed Operator support for authentication with AWS STS]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-operatorhub-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-software-catalog-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-software-catalog-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI]

include::modules/osdk-cco-aws-sts-enabling.adoc[leveloffset=+1]
include::modules/osdk-cco-aws-sts-role.adoc[leveloffset=+1]
include::modules/osdk-cco-aws-sts-tshooting.adoc[leveloffset=+1]
include::modules/osdk-cco-aws-sts-alt.adoc[leveloffset=+1]
include::modules/osdk-cco-aws-sts-alt.adoc[leveloffset=+1]
6 changes: 3 additions & 3 deletions operators/operator_sdk/token_auth/osdk-cco-azure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The *Install Operator* page in the web console allows cluster administrators to
.Additional resources

* xref:../../../authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc#cco-short-term-creds-azure-olm_cco-short-term-creds[OLM-managed Operator support for authentication with {entra-first}]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-operatorhub-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-software-catalog-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-software-catalog-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI]

include::modules/osdk-cco-azure-enabling.adoc[leveloffset=+1]
include::modules/osdk-cco-azure-enabling.adoc[leveloffset=+1]
6 changes: 3 additions & 3 deletions operators/operator_sdk/token_auth/osdk-cco-gcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The *Install Operator* page in the web console allows cluster administrators to
.Additional resources

* xref:../../../authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc#cco-short-term-creds-gcp-olm_cco-short-term-creds[OLM-managed Operator support for authentication with {gcp-wid-short}]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-operatorhub-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-software-catalog-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-software-catalog-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI]

include::modules/osdk-cco-gcp-enabling.adoc[leveloffset=+1]
include::modules/osdk-cco-gcp-enabling.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
:_mod-docs-content-type: ASSEMBLY
[id="olm-understanding-operatorhub"]
[id="olm-understanding-software-catalog"]
= Understanding the software catalog
include::_attributes/common-attributes.adoc[]
:context: olm-understanding-operatorhub
:context: olm-understanding-software-catalog

toc::[]

include::modules/olm-operatorhub-overview.adoc[leveloffset=+1]
include::modules/olm-operatorhub-architecture.adoc[leveloffset=+1]
include::modules/olm-software-catalog-overview.adoc[leveloffset=+1]
include::modules/olm-software-catalog-architecture.adoc[leveloffset=+1]

[id="olm-understanding-operatorhub-resources"]
[id="olm-understanding-software-catalog-resources"]
[role="_additional-resources"]
== Additional resources

Expand Down
2 changes: 1 addition & 1 deletion operators/understanding/olm/olm-understanding-olm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ include::modules/olm-catalogsource.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources

* xref:../../../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the software catalog]
* xref:../../../operators/understanding/olm-understanding-software-catalog.adoc#olm-understanding-software-catalog[Understanding the software catalog]
* xref:../../../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red Hat-provided Operator catalogs]
* xref:../../../operators/admin/olm-managing-custom-catalogs.adoc#olm-creating-catalog-from-index_olm-managing-custom-catalogs[Adding a catalog source to a cluster]
* xref:../../../operators/understanding/olm/olm-understanding-dependency-resolution.adoc#olm-dependency-catalog-priority_olm-understanding-dependency-resolution[Catalog priority]
Expand Down
Loading