From 547471c1ef1fc151351b59e00fad6824716be3b6 Mon Sep 17 00:00:00 2001 From: Michael Ryan Peter Date: Thu, 17 Apr 2025 15:59:01 -0400 Subject: [PATCH 1/2] Update topic map --- _topic_maps/_topic_map.yml | 76 +----------------------- _topic_maps/_topic_map_osd.yml | 76 +----------------------- _topic_maps/_topic_map_rosa.yml | 74 ----------------------- _topic_maps/_topic_map_rosa_hcp.yml | 91 ----------------------------- 4 files changed, 3 insertions(+), 314 deletions(-) diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index de5f181d6cc0..defa362388d2 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1001,14 +1001,6 @@ Topics: File: cli-opm-install - Name: opm CLI reference File: cli-opm-ref -- Name: Operator SDK - Dir: osdk - Distros: openshift-enterprise,openshift-origin - Topics: - - Name: Installing the Operator SDK CLI - File: cli-osdk-install - - Name: Operator SDK CLI reference - File: cli-osdk-ref --- Name: Security and compliance Dir: security @@ -1971,57 +1963,8 @@ Topics: Dir: operator_sdk Distros: openshift-origin,openshift-enterprise 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: - - 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: - - 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: - - 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: 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: Token authentication @@ -2035,27 +1978,12 @@ Topics: File: osdk-cco-azure - Name: CCO-based workflow for OLM-managed Operators with GCP Workload Identity File: osdk-cco-gcp - - 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: Configuring support for multiple platforms File: osdk-multi-arch-support - - 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 - Distros: openshift-origin + - Name: Configuring leader election + File: osdk-leader-election - Name: Cluster Operators reference File: operator-reference - Name: OLM v1 diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index e4174f68a165..cba955d1d7f2 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -341,14 +341,6 @@ Topics: File: cli-opm-install - Name: opm CLI reference File: cli-opm-ref -- Name: Operator SDK - Dir: osdk - Distros: openshift-dedicated - Topics: - - Name: Installing the Operator SDK CLI - File: cli-osdk-install - - Name: Operator SDK CLI reference - File: cli-osdk-ref --- Name: Cluster administration Dir: osd_cluster_admin @@ -729,81 +721,15 @@ Topics: - 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: 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 + # ROSA customers can't configure/edit the cluster Operators # - Name: Cluster Operators reference # File: operator-reference --- diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 2496b3fcb454..245ab537e28a 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -540,14 +540,6 @@ Topics: File: cli-opm-install - Name: opm CLI reference File: cli-opm-ref -- Name: Operator SDK - Dir: osdk - Distros: openshift-rosa - Topics: - - Name: Installing the Operator SDK CLI - File: cli-osdk-install - - Name: Operator SDK CLI reference - File: cli-osdk-ref - Name: ROSA CLI Dir: rosa_cli Distros: openshift-rosa @@ -975,80 +967,14 @@ Topics: - 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: 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 diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index ea71a7a5f248..71be185930e7 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -300,14 +300,6 @@ Topics: File: cli-opm-install - Name: opm CLI reference File: cli-opm-ref -- Name: Operator SDK - Dir: osdk - Distros: openshift-rosa-hcp - Topics: - - Name: Installing the Operator SDK CLI - File: cli-osdk-install - - Name: Operator SDK CLI reference - File: cli-osdk-ref - Name: ROSA CLI Dir: rosa_cli Distros: openshift-rosa-hcp @@ -747,95 +739,12 @@ Topics: - 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 From e7dc80d0479fdeaf794e6b5a685038581fde7252 Mon Sep 17 00:00:00 2001 From: Michael Ryan Peter Date: Fri, 18 Apr 2025 10:16:08 -0400 Subject: [PATCH 2/2] Remove xrefs --- architecture/control-plane.adoc | 6 +++--- cli_reference/index.adoc | 5 +---- cli_reference/opm/cli-opm-install.adoc | 5 ++--- extensions/catalogs/managing-catalogs.adoc | 2 -- modules/olm-about-catalogs.adoc | 2 -- operators/admin/olm-configuring-proxy-support.adoc | 3 --- operators/admin/olm-managing-custom-catalogs.adoc | 4 +--- operators/index.adoc | 11 +---------- operators/operator-reference.adoc | 1 - operators/operator_sdk/osdk-generating-csvs.adoc | 11 ----------- operators/operator_sdk/osdk-multi-arch-support.adoc | 5 ----- .../understanding/olm-understanding-operatorhub.adoc | 1 - 12 files changed, 8 insertions(+), 48 deletions(-) diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc index fb2fa4b8e096..4d68160fc8e8 100644 --- a/architecture/control-plane.adoc +++ b/architecture/control-plane.adoc @@ -54,8 +54,8 @@ include::modules/arch-olm-operators.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* For more details on running add-on Operators in {product-title}, see the _Operators_ guide sections on xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager (OLM)] and xref:../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[OperatorHub]. -* For more details on the Operator SDK, see xref:../operators/operator_sdk/osdk-about.adoc#osdk-about[Developing Operators]. +* 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 OperatorHub]. include::modules/etcd-overview.adoc[leveloffset=+1] @@ -71,4 +71,4 @@ ifndef::openshift-dedicated,openshift-rosa[] .Additional resources * xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices] * xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd[Backing up etcd] -endif::openshift-dedicated,openshift-rosa[] \ No newline at end of file +endif::openshift-dedicated,openshift-rosa[] diff --git a/cli_reference/index.adoc b/cli_reference/index.adoc index 4c3eeb91909d..787c69ea6ff6 100644 --- a/cli_reference/index.adoc +++ b/cli_reference/index.adoc @@ -15,7 +15,6 @@ such as the following: * Managing clusters * Building, deploying, and managing applications * Managing deployment processes -* Developing Operators * Creating and maintaining Operator catalogs ifndef::openshift-rosa[] @@ -60,8 +59,6 @@ using the terminal. Unlike the web console, it allows the user to work directly * xref:../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[opm CLI]: The `opm` CLI tool helps the Operator developers and cluster administrators to create and maintain the catalogs of Operators from the terminal. -* xref:../cli_reference/osdk/cli-osdk-install.adoc#cli-osdk-install[Operator SDK]: The Operator SDK, a component of the Operator Framework, provides a CLI tool that Operator developers can use to build, test, and deploy an Operator from the terminal. It simplifies the process of building Kubernetes-native applications, which can require deep, application-specific operational knowledge. - ifdef::openshift-rosa,openshift-rosa-hcp[] * xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI (`rosa`)]: Use the `rosa` CLI to create, update, manage, and delete ROSA clusters and resources. -endif::openshift-rosa,openshift-rosa-hcp[] \ No newline at end of file +endif::openshift-rosa,openshift-rosa-hcp[] diff --git a/cli_reference/opm/cli-opm-install.adoc b/cli_reference/opm/cli-opm-install.adoc index 8709cefc1a9a..fe80190213a8 100644 --- a/cli_reference/opm/cli-opm-install.adoc +++ b/cli_reference/opm/cli-opm-install.adoc @@ -13,8 +13,7 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] .Additional resources * See xref:../../operators/understanding/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[Operator Framework packaging format] for more information about the bundle format. -* To create a bundle image using the Operator SDK, see -xref:../../operators/operator_sdk/osdk-working-bundle-images.adoc#osdk-working-bundle-images[Working with bundle images]. + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/olm-installing-opm.adoc[leveloffset=+1] @@ -24,4 +23,4 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] == Additional resources * See xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Managing custom catalogs] for `opm` procedures including creating, updating, and pruning catalogs. -endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] \ No newline at end of file +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/extensions/catalogs/managing-catalogs.adoc b/extensions/catalogs/managing-catalogs.adoc index 530a8a5703c5..297924b695a6 100644 --- a/extensions/catalogs/managing-catalogs.adoc +++ b/extensions/catalogs/managing-catalogs.adoc @@ -15,8 +15,6 @@ _File-based catalogs_ are the latest iteration of the catalog format in Operator [IMPORTANT] ==== Kubernetes periodically deprecates certain APIs that are removed in subsequent releases. As a result, Operators are unable to use removed APIs starting with the version of {product-title} that uses the Kubernetes version that removed the API. - -If your cluster is using custom catalogs, see xref:../../operators/operator_sdk/osdk-working-bundle-images.adoc#osdk-control-compat_osdk-working-bundle-images[Controlling Operator compatibility with {product-title} versions] for more details about how Operator authors can update their projects to help avoid workload issues and prevent incompatible upgrades. ==== include::modules/olmv1-about-catalogs.adoc[leveloffset=+1] diff --git a/modules/olm-about-catalogs.adoc b/modules/olm-about-catalogs.adoc index 4dc03f669663..e7f48791f1f0 100644 --- a/modules/olm-about-catalogs.adoc +++ b/modules/olm-about-catalogs.adoc @@ -17,8 +17,6 @@ As a cluster administrator, you can create your own custom index image, either b [IMPORTANT] ==== Kubernetes periodically deprecates certain APIs that are removed in subsequent releases. As a result, Operators are unable to use removed APIs starting with the version of {product-title} that uses the Kubernetes version that removed the API. - -If your cluster is using custom catalogs, see xref:../../operators/operator_sdk/osdk-working-bundle-images#osdk-control-compat_osdk-working-bundle-images[Controlling Operator compatibility with {product-title} versions] for more details about how Operator authors can update their projects to help avoid workload issues and prevent incompatible upgrades. ==== [NOTE] diff --git a/operators/admin/olm-configuring-proxy-support.adoc b/operators/admin/olm-configuring-proxy-support.adoc index 6a597c3c9b6b..5d020a222a39 100644 --- a/operators/admin/olm-configuring-proxy-support.adoc +++ b/operators/admin/olm-configuring-proxy-support.adoc @@ -24,9 +24,6 @@ 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,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] - - include::modules/olm-overriding-proxy-settings.adoc[leveloffset=+1] include::modules/olm-injecting-custom-ca.adoc[leveloffset=+1] diff --git a/operators/admin/olm-managing-custom-catalogs.adoc b/operators/admin/olm-managing-custom-catalogs.adoc index 290cde3bb89e..a52c03ab15f0 100644 --- a/operators/admin/olm-managing-custom-catalogs.adoc +++ b/operators/admin/olm-managing-custom-catalogs.adoc @@ -17,8 +17,6 @@ and Operator catalog maintainers can create and manage custom catalogs packaged [IMPORTANT] ==== Kubernetes periodically deprecates certain APIs that are removed in subsequent releases. As a result, Operators are unable to use removed APIs starting with the version of {product-title} that uses the Kubernetes version that removed the API. - -If your cluster is using custom catalogs, see xref:../../operators/operator_sdk/osdk-working-bundle-images#osdk-control-compat_osdk-working-bundle-images[Controlling Operator compatibility with {product-title} versions] for more details about how Operator authors can update their projects to help avoid workload issues and prevent incompatible upgrades. ==== [role="_additional-resources"] @@ -138,4 +136,4 @@ include::modules/olm-removing-catalogs.adoc[leveloffset=+1] 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,openshift-rosa-hcp[] \ No newline at end of file +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/index.adoc b/operators/index.adoc index af8ff4565885..58003a7fa6ad 100644 --- a/operators/index.adoc +++ b/operators/index.adoc @@ -13,15 +13,6 @@ include::modules/operators-overview.adoc[leveloffset=+1] As an Operator author, you can perform the following development tasks for OLM-based Operators: -** 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,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], and xref:../operators/operator_sdk/helm/osdk-helm-quickstart.adoc#osdk-helm-quickstart[Helm-based Operators]. -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -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,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,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,openshift-rosa-hcp[] @@ -71,4 +62,4 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="operators-overview-next-steps"] == Next steps -To understand more about Operators, see xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[What are Operators?] +* xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[What are Operators?] diff --git a/operators/operator-reference.adoc b/operators/operator-reference.adoc index 004a94293fe9..a202f2f5223b 100644 --- a/operators/operator-reference.adoc +++ b/operators/operator-reference.adoc @@ -167,7 +167,6 @@ In {product-title}, OLM functionality is provided across a set of cluster Operat [id="cluster-operators-ref-olm-addtl-resources"] === Additional resources * xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Understanding Operator Lifecycle Manager (OLM)] -* xref:../operators/operator_sdk/osdk-working-bundle-images.adoc#osdk-control-compat_osdk-working-bundle-images[Controlling Operator compatibility with {product-title} versions] include::modules/olmv1-clusteroperator.adoc[leveloffset=+1] diff --git a/operators/operator_sdk/osdk-generating-csvs.adoc b/operators/operator_sdk/osdk-generating-csvs.adoc index a4020e9de8ab..bbf20b6b8b4e 100644 --- a/operators/operator_sdk/osdk-generating-csvs.adoc +++ b/operators/operator_sdk/osdk-generating-csvs.adoc @@ -8,19 +8,8 @@ toc::[] A _cluster service version_ (CSV), defined by a `ClusterServiceVersion` object, is a YAML manifest created from Operator metadata that assists Operator Lifecycle Manager (OLM) in running the Operator in a cluster. It is the metadata that accompanies an Operator container image, used to populate user interfaces with information such as its logo, description, and version. It is also a source of technical information that is required to run the Operator, like the RBAC rules it requires and which custom resources (CRs) it manages or depends on. -The Operator SDK includes the CSV generator to generate a CSV for the current Operator project, customized using information contained in YAML manifests and Operator source files. - -include::snippets/osdk-deprecation.adoc[] - -A CSV-generating command removes the responsibility of Operator authors having in-depth OLM knowledge in order for their Operator to interact with OLM or publish metadata to the Catalog Registry. Further, because the CSV spec will likely change over time as new Kubernetes and OLM features are implemented, the Operator SDK is equipped to easily extend its update system to handle new CSV features going forward. - include::modules/osdk-how-csv-gen-works.adoc[leveloffset=+1] -[role="_additional-resources"] -.Additional resources - -* See xref:../../operators/operator_sdk/osdk-working-bundle-images.adoc#osdk-bundle-operator_osdk-working-bundle-images[Bundling an Operator] for a full procedure that includes generating a bundle and CSV. - include::modules/osdk-csv-bundle-files.adoc[leveloffset=+2] include::modules/osdk-csv-ver.adoc[leveloffset=+2] diff --git a/operators/operator_sdk/osdk-multi-arch-support.adoc b/operators/operator_sdk/osdk-multi-arch-support.adoc index 74d1baad7e56..270192d0f26a 100644 --- a/operators/operator_sdk/osdk-multi-arch-support.adoc +++ b/operators/operator_sdk/osdk-multi-arch-support.adoc @@ -41,8 +41,3 @@ include::modules/osdk-multi-arch-node-preference.adoc[leveloffset=+2] == Next steps * xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-enabling-operator-for-multi-arch_osdk-generating-csvs[Label the platforms your Operator supports for Operator Lifecycle Manager (OLM)] -* Bundle your Operator and Deploy with OLM -** xref:../../operators/operator_sdk/golang/osdk-golang-tutorial.adoc#osdk-bundle-deploy-olm_osdk-golang-tutorial[Go-based Operator projects] -** xref:../../operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc#osdk-bundle-deploy-olm_osdk-ansible-tutorial[Ansible-based Operator projects] -** xref:../../operators/operator_sdk/helm/osdk-helm-tutorial.html#osdk-bundle-deploy-olm_osdk-helm-tutorial[Helm-based Operator projects] -* xref:../../operators/operator_sdk/osdk-bundle-validate.html#osdk-multi-arch-validate_osdk-bundle-validate[Validate your Operator's multi-platform readiness] diff --git a/operators/understanding/olm-understanding-operatorhub.adoc b/operators/understanding/olm-understanding-operatorhub.adoc index 76b6a36aa1bb..d9b026c9b90b 100644 --- a/operators/understanding/olm-understanding-operatorhub.adoc +++ b/operators/understanding/olm-understanding-operatorhub.adoc @@ -14,7 +14,6 @@ include::modules/olm-operatorhub-architecture.adoc[leveloffset=+1] == Additional resources * xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[Catalog source] -* xref:../../operators/operator_sdk/osdk-about.adoc#osdk-about[About the Operator SDK] * xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-generating-csvs[Defining cluster service versions (CSVs)] * xref:../../operators/understanding/olm/olm-workflow.adoc#olm-upgrades_olm-workflow[Operator installation and upgrade workflow in OLM] * link:https://connect.redhat.com[Red Hat Partner Connect]