mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Move Operator content to top-level dir
This commit is contained in:
Alex Dellapenta
111
_topic_map.yml
111
_topic_map.yml
@@ -418,6 +418,61 @@ Topics:
|
||||
File: securing-exposing-registry
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
---
|
||||
Name: Operators
|
||||
Dir: operators
|
||||
Topics:
|
||||
- Name: Understanding Operators
|
||||
File: olm-what-operators-are
|
||||
- Name: Understanding the Operator Lifecycle Manager (OLM)
|
||||
File: olm-understanding-olm
|
||||
- Name: Understanding the OperatorHub
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
File: olm-understanding-operatorhub
|
||||
- Name: Adding Operators to a cluster
|
||||
File: olm-adding-operators-to-cluster
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Deleting Operators from a cluster
|
||||
File: olm-deleting-operators-from-cluster
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Creating applications from installed Operators
|
||||
File: olm-creating-apps-from-installed-operators
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Viewing Operator status
|
||||
File: olm-status
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Managing resources from CRDs
|
||||
File: olm-managing-resources-from-crds
|
||||
Distros: openshift-origin,openshift-enterprise,openshift-dedicated
|
||||
- Name: Creating policy for Operator installations and upgrades
|
||||
File: olm-creating-policy
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: Configuring OLM for restricted networks
|
||||
File: olm-restricted-networks
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: Operator SDK
|
||||
Dir: operator_sdk
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
Topics:
|
||||
- Name: Getting started with the Operator SDK
|
||||
File: osdk-getting-started
|
||||
- Name: Creating Ansible-based Operators
|
||||
File: osdk-ansible
|
||||
- Name: Creating Helm-based Operators
|
||||
File: osdk-helm
|
||||
- Name: Generating a ClusterServiceVersion (CSV)
|
||||
File: osdk-generating-csvs
|
||||
- Name: Configuring built-in monitoring with Prometheus
|
||||
File: osdk-monitoring-prometheus
|
||||
- Name: Configuring leader election
|
||||
File: osdk-leader-election
|
||||
- Name: Operator SDK CLI reference
|
||||
File: osdk-cli-reference
|
||||
- Name: Migrating to Operator SDK v0.1.0
|
||||
File: osdk-migrating-to-v0-1-0
|
||||
Distros: openshift-origin
|
||||
- Name: Appendices
|
||||
File: osdk-appendices
|
||||
---
|
||||
Name: Builds
|
||||
Dir: builds
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
@@ -521,37 +576,6 @@ Topics:
|
||||
- Name: Configuring project creation
|
||||
File: configuring-project-creation
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
- Name: Operators
|
||||
Dir: operators
|
||||
Topics:
|
||||
- Name: Understanding Operators
|
||||
File: olm-what-operators-are
|
||||
- Name: Understanding the Operator Lifecycle Manager (OLM)
|
||||
File: olm-understanding-olm
|
||||
- Name: Understanding the OperatorHub
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
File: olm-understanding-operatorhub
|
||||
- Name: Adding Operators to a cluster
|
||||
File: olm-adding-operators-to-cluster
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Deleting Operators from a cluster
|
||||
File: olm-deleting-operators-from-cluster
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Creating applications from installed Operators
|
||||
File: olm-creating-apps-from-installed-operators
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Viewing Operator status
|
||||
File: olm-status
|
||||
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
|
||||
- Name: Managing resources from CRDs
|
||||
File: olm-managing-resources-from-crds
|
||||
Distros: openshift-origin,openshift-enterprise,openshift-dedicated
|
||||
- Name: Creating policy for Operator installations and upgrades
|
||||
File: olm-creating-policy
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: Configuring OLM for restricted networks
|
||||
File: olm-restricted-networks
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: Application life cycle management
|
||||
Dir: application-life-cycle-management
|
||||
Topics:
|
||||
@@ -619,29 +643,6 @@ Topics:
|
||||
- Name: Pruning objects to reclaim resources
|
||||
File: pruning-objects
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: Operator SDK
|
||||
Dir: operator_sdk
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
Topics:
|
||||
- Name: Getting started with the Operator SDK
|
||||
File: osdk-getting-started
|
||||
- Name: Creating Ansible-based Operators
|
||||
File: osdk-ansible
|
||||
- Name: Creating Helm-based Operators
|
||||
File: osdk-helm
|
||||
- Name: Generating a ClusterServiceVersion (CSV)
|
||||
File: osdk-generating-csvs
|
||||
- Name: Configuring built-in monitoring with Prometheus
|
||||
File: osdk-monitoring-prometheus
|
||||
- Name: Configuring leader election
|
||||
File: osdk-leader-election
|
||||
- Name: Operator SDK CLI reference
|
||||
File: osdk-cli-reference
|
||||
- Name: Migrating to Operator SDK v0.1.0
|
||||
File: osdk-migrating-to-v0-1-0
|
||||
Distros: openshift-origin
|
||||
- Name: Appendices
|
||||
File: osdk-appendices
|
||||
---
|
||||
Name: Machine management
|
||||
Dir: machine_management
|
||||
@@ -1130,7 +1131,7 @@ Topics:
|
||||
File: cnv-importing-virtual-machine-images-datavolumes-block
|
||||
- Name: Cloning a virtual machine disk into a new block storage DataVolume
|
||||
File: cnv-cloning-vm-disk-into-new-datavolume-block
|
||||
### Virtual machine live migration
|
||||
### Virtual machine live migration
|
||||
- Name: Virtual machine live migration
|
||||
File: cnv-live-migration
|
||||
- Name: Live migration limits and timeouts
|
||||
|
||||
@@ -48,4 +48,4 @@ namespace, except for the Cluster Logging Operator, which requires the
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../applications/operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]
|
||||
* xref:../operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../images
|
||||
@@ -1 +0,0 @@
|
||||
../modules
|
||||
@@ -16,4 +16,4 @@ include::modules/cnv-monitoring-upgrade-status.adoc[leveloffset=+1]
|
||||
|
||||
.Additional information
|
||||
|
||||
* xref:../../applications/operators/olm-understanding-olm.adoc#olm-csv_olm-understanding-olm[ClusterServiceVersions (CSVs)]
|
||||
* xref:../../operators/olm-understanding-olm.adoc#olm-csv_olm-understanding-olm[ClusterServiceVersions (CSVs)]
|
||||
@@ -18,6 +18,6 @@ include::modules/cluster-logging-deploy-storage-considerations.adoc[leveloffset=
|
||||
|
||||
== Additional resources
|
||||
|
||||
For more information on installing operators,see xref:../applications/operators/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
|
||||
For more information on installing operators,see xref:../operators/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
|
||||
|
||||
// For information on scaling your Elasticsearch cluster, see ../logging/config/cluster-logging-elasticsearch.adoc#cluster-logging-elasticsearch-add-remove_cluster-logging-elasticsearch[Scaling your Elasticsearch cluster].
|
||||
|
||||
@@ -29,4 +29,4 @@ include::modules/cluster-logging-deploy-subscription.adoc[leveloffset=+1]
|
||||
|
||||
== Additional resources
|
||||
|
||||
For more information on installing operators,see xref:../applications/operators/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
|
||||
For more information on installing operators,see xref:../operators/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-getting-started.adoc
|
||||
// * operators/operator_sdk/osdk-getting-started.adoc
|
||||
|
||||
[id="building-memcached-operator-using-osdk_{context}"]
|
||||
= Building a Go-based Memcached Operator using the Operator SDK
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-managing-resources-from-crds.adoc
|
||||
// * operators/olm-managing-resources-from-crds.adoc
|
||||
// * applications/crds/crd-managing-resources-from-crds.adoc
|
||||
// * applications/crds/extending-api-with-crds.adoc
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc
|
||||
// * operators/operator_sdk/osdk-migrating-to-v0-1-0.adoc
|
||||
|
||||
[id="creating-new-operator-sdk-v0-1-0-project_{context}"]
|
||||
= Creating a new Operator SDK v0.1.0 project
|
||||
|
||||
@@ -29,7 +29,7 @@ memory setting though this is not recommended for production deployments.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Install the Elasticsearch Operator via the OperatorHub. See: xref:../applications/operators/olm-adding-operators-to-cluster.adoc[Adding Operators to a cluster].
|
||||
. Install the Elasticsearch Operator via the OperatorHub. See: xref:../operators/olm-adding-operators-to-cluster.adoc[Adding Operators to a cluster].
|
||||
|
||||
. Install the Cluster Logging Operator using the {product-title} web console for best results:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-getting-started.adoc
|
||||
// * operators/operator_sdk/osdk-getting-started.adoc
|
||||
|
||||
[id="managing-memcached-operator-using-olm_{context}"]
|
||||
= Managing a Memcached Operator using the Operator Lifecycle Manager
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc
|
||||
// * operators/operator_sdk/osdk-migrating-to-v0-1-0.adoc
|
||||
|
||||
[id="migrating-custom-types-from-pkg-apis_{context}"]
|
||||
= Migrating custom types from pkg/apis
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc
|
||||
// * operators/operator_sdk/osdk-migrating-to-v0-1-0.adoc
|
||||
|
||||
[id="migrating-reconcile-code_{context}"]
|
||||
= Migrating reconcile code
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-olm.adoc
|
||||
// * operators/olm-understanding-olm.adoc
|
||||
|
||||
[id="olm-architecture_{context}"]
|
||||
= Operator Lifecycle Manager architecture
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-creating-apps-from-installed-operators.adoc
|
||||
// * operators/olm-creating-apps-from-installed-operators.adoc
|
||||
|
||||
[id="olm-creating-etcd-cluster-from-operator_{context}"]
|
||||
= Creating an etcd cluster using an Operator
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-olm.adoc
|
||||
// * operators/olm-understanding-olm.adoc
|
||||
|
||||
[id="olm-csv_{context}"]
|
||||
= ClusterServiceVersions (CSVs)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-adding-operators-to-cluster.adoc
|
||||
// * operators/olm-deleting-operators-to-cluster.adoc
|
||||
|
||||
[id="olm-deleting-operator-from-a-cluster-using-cli_{context}"]
|
||||
= Deleting Operators from a cluster using the CLI
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-adding-operators-to-cluster.adoc
|
||||
// * operators/olm-deleting-operators-to-cluster.adoc
|
||||
|
||||
[id="olm-deleting-operators-from-a-cluster-using-web-console_{context}"]
|
||||
= Deleting Operators from a cluster using the web console
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-olm.adoc
|
||||
// * operators/olm-understanding-olm.adoc
|
||||
|
||||
[id="olm-dependency-resolution_{context}"]
|
||||
= Dependency resolution and upgrades
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-adding-operators-to-cluster.adoc
|
||||
// * operators/olm-adding-operators-to-cluster.adoc
|
||||
|
||||
[id="olm-installing-operator-from-operatorhub-using-cli_{context}"]
|
||||
= Installing from the OperatorHub using the CLI
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-adding-operators-to-cluster.adoc
|
||||
// * operators/olm-adding-operators-to-cluster.adoc
|
||||
|
||||
[id="olm-installing-from-operatorhub-using-web-console_{context}"]
|
||||
= Installing from the OperatorHub using the web console
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-adding-operators-to-cluster.adoc
|
||||
// * operators/olm-adding-operators-to-cluster.adoc
|
||||
|
||||
[id="olm-installing-operators-from-operatorhub_{context}"]
|
||||
= Installing Operators from the OperatorHub
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-olm.adoc
|
||||
// * operators/olm-understanding-olm.adoc
|
||||
|
||||
[id="olm-metrics_{context}"]
|
||||
= Metrics
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-what-operators-are.adoc
|
||||
// * operators/olm-what-operators-are.adoc
|
||||
|
||||
[id="olm-operator-framework_{context}"]
|
||||
= Operator Framework
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-what-operators-are.adoc
|
||||
// * operators/olm-what-operators-are.adoc
|
||||
|
||||
[id="olm-maturity-model_{context}"]
|
||||
= Operator maturity model
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-olm.adoc
|
||||
// * operators/olm-understanding-olm.adoc
|
||||
|
||||
[id="olm-operatorgroups_{context}"]
|
||||
= OperatorGroups
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-operatorhub.adoc
|
||||
// * operators/olm-understanding-operatorhub.adoc
|
||||
|
||||
[id="olm-operatorhub-arch_{context}"]
|
||||
= OperatorHub architecture
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-operatorhub.adoc
|
||||
// * operators/olm-understanding-operatorhub.adoc
|
||||
|
||||
[id="olm-operatorhub-overview_{context}"]
|
||||
= Overview of the OperatorHub
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-olm.adoc
|
||||
// * operators/olm-understanding-olm.adoc
|
||||
|
||||
[id="olm-overview_{context}"]
|
||||
= Overview of the Operator Lifecycle Manager
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-creating-policy.adoc
|
||||
// * operators/olm-creating-policy.adoc
|
||||
|
||||
[id="olm-policy-fine-grained-permissions_{context}"]
|
||||
= Fine-grained permissions
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-creating-policy.adoc
|
||||
// * operators/olm-creating-policy.adoc
|
||||
|
||||
[id="olm-policy-scenarios_{context}"]
|
||||
= Installation scenarios
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-creating-policy.adoc
|
||||
// * operators/olm-creating-policy.adoc
|
||||
|
||||
[id="olm-policy-scoping-operator-install_{context}"]
|
||||
= Scoping Operator installations
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-creating-policy.adoc
|
||||
// * operators/olm-creating-policy.adoc
|
||||
|
||||
[id="olm-policy-troubleshooting_{context}"]
|
||||
= Troubleshooting permission failures
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-creating-policy.adoc
|
||||
// * operators/olm-creating-policy.adoc
|
||||
|
||||
[id="olm-policy-understanding_{context}"]
|
||||
= Understanding Operator installation policy
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-creating-policy.adoc
|
||||
// * operators/olm-creating-policy.adoc
|
||||
|
||||
[id="olm-policy-workflow_{context}"]
|
||||
= Installation workflow
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-restricted-networks.adoc
|
||||
// * operators/olm-restricted-networks.adoc
|
||||
|
||||
[id="olm-restricted-networks-operatorhub_{context}"]
|
||||
= Configuring OperatorHub for restricted networks
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-status.adoc
|
||||
// * operators/olm-status.adoc
|
||||
|
||||
[id="olm-status-conditions_{context}"]
|
||||
= Condition types
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-status.adoc
|
||||
// * operators/olm-status.adoc
|
||||
|
||||
[id="olm-status-viewing-cli_{context}"]
|
||||
= Viewing Operator status using the CLI
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-understanding-olm.adoc
|
||||
// * operators/olm-understanding-olm.adoc
|
||||
|
||||
[id="olm-upgrades_{context}"]
|
||||
= Operator installation and upgrade workflow in OLM
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operators/olm-what-operators-are.adoc
|
||||
// * operators/olm-what-operators-are.adoc
|
||||
|
||||
[id="olm-why-use-operators_{context}"]
|
||||
= Why use Operators?
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-custom-resource-files_{context}"]
|
||||
= Custom Resource files
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-extra-variables_{context}"]
|
||||
= Extra variables sent to Ansible
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-k8s-module-inside-operator_{context}"]
|
||||
= Testing the k8s Ansible module inside an Operator
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-k8s-module-installing_{context}"]
|
||||
= Installing the k8s Ansible module
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-k8s-module-testing-locally_{context}"]
|
||||
= Testing the k8s Ansible module locally
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-managing-cr-status_{context}"]
|
||||
= Managing Custom Resource status using the k8s_status Ansible module
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-runner-directory_{context}"]
|
||||
= Ansible Runner directory
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-support_{context}"]
|
||||
= Ansible support in the Operator SDK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-ansible-watches-file_{context}"]
|
||||
= Watches file
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-generating-csvs.adoc
|
||||
// * operators/operator_sdk/osdk-generating-csvs.adoc
|
||||
|
||||
[id="osdk-apiservices_{context}"]
|
||||
= Understanding your API services
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-getting-started.adoc
|
||||
// * operators/operator_sdk/osdk-getting-started.adoc
|
||||
|
||||
[id="osdk-architecture_{context}"]
|
||||
= Architecture of the Operator SDK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
|
||||
[id="osdk-building-ansible-operator_{context}"]
|
||||
= Building an Ansible-based Operator using the Operator SDK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-helm.adoc
|
||||
// * operators/operator_sdk/osdk-helm.adoc
|
||||
|
||||
[id="osdk-building-helm-operator_{context}"]
|
||||
= Building a Helm-based Operator using the Operator SDK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-generating-csvs.adoc
|
||||
// * operators/operator_sdk/osdk-generating-csvs.adoc
|
||||
|
||||
[id="osdk-crds_{context}"]
|
||||
= Understanding your Custom Resource Definitions (CRDs)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-generating-csvs.adoc
|
||||
// * operators/operator_sdk/osdk-generating-csvs.adoc
|
||||
|
||||
[id="osdk-configuring-csv-composition_{context}"]
|
||||
= CSV composition configuration
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-generating-csvs.adoc
|
||||
// * operators/operator_sdk/osdk-generating-csvs.adoc
|
||||
|
||||
[id="osdk-generating-a-csv_{context}"]
|
||||
= Generating a CSV
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-helm.adoc
|
||||
// * operators/operator_sdk/osdk-helm.adoc
|
||||
|
||||
[id="osdk-helm-chart-support_{context}"]
|
||||
= Helm chart support in the Operator SDK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-generating-csvs.adoc
|
||||
// * operators/operator_sdk/osdk-generating-csvs.adoc
|
||||
|
||||
[id="osdk-how-csv-gen-works_{context}"]
|
||||
= How CSV generation works
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-getting-started.adoc
|
||||
// * applications/operator_sdk/osdk-ansible.adoc
|
||||
// * applications/operator_sdk/osdk-helm.adoc
|
||||
// * operators/operator_sdk/osdk-getting-started.adoc
|
||||
// * operators/operator_sdk/osdk-ansible.adoc
|
||||
// * operators/operator_sdk/osdk-helm.adoc
|
||||
|
||||
[id="osdk-installing-cli_{context}"]
|
||||
= Installing the Operator SDK CLI
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/oosdk-leader-election.adoc
|
||||
// * operators/operator_sdk/oosdk-leader-election.adoc
|
||||
|
||||
[id="osdk-leader-for-life-election_{context}"]
|
||||
= Using Leader-for-life election
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-generating-csvs.adoc
|
||||
// * operators/operator_sdk/osdk-generating-csvs.adoc
|
||||
|
||||
[id="osdk-manually-defined-csv-fields_{context}"]
|
||||
= Manually-defined CSV fields
|
||||
@@ -91,4 +91,4 @@ a future design document.
|
||||
|
||||
.Additional resources
|
||||
|
||||
- xref:../../applications/operators/olm-what-operators-are.adoc#olm-maturity-model_olm-what-operators-are[Operator maturity model]
|
||||
- xref:../../operators/olm-what-operators-are.adoc#olm-maturity-model_olm-what-operators-are[Operator maturity model]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
// * operators/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
|
||||
[id="osdk-monitoring-prometheus-metrics-helper-modifying-port_{context}"]
|
||||
= Modifying the metrics port
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
// * operators/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
|
||||
[id="osdk-monitoring-prometheus-metrics-helper_{context}"]
|
||||
= Metrics helper
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-getting-started.adoc
|
||||
// * applications/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
// * operators/operator_sdk/osdk-getting-started.adoc
|
||||
// * operators/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
|
||||
[id="osdk-monitoring-prometheus-operator-support_{context}"]
|
||||
= Prometheus Operator support
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
// * operators/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
|
||||
[id="osdk-monitoring-prometheus-servicemonitor-creating_{context}"]
|
||||
= Creating ServiceMonitor resources
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
// * operators/operator_sdk/osdk-monitoring-prometheus.adoc
|
||||
|
||||
[id="osdk-monitoring-prometheus-servicemonitor_{context}"]
|
||||
= ServiceMonitor resources
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * applications/operator_sdk/osdk-appendices.adoc
|
||||
// * operators/operator_sdk/osdk-appendices.adoc
|
||||
|
||||
[id="osdk-project-scaffolding-layout_{context}"]
|
||||
= Operator project scaffolding layout
|
||||
|
||||
@@ -11,17 +11,11 @@ full Internet connectivity. Cluster administrators can disable those default
|
||||
sources and create local mirrors so that OLM can install and manage Operators
|
||||
from the local sources instead.
|
||||
|
||||
////
|
||||
.Additional resources
|
||||
|
||||
* Link to section about disconnected cluster installations.
|
||||
////
|
||||
|
||||
include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1]
|
||||
.Additional resources
|
||||
|
||||
* For details on exposing your {product-title} cluster's internal registry to
|
||||
off-cluster access, see
|
||||
xref:../../registry/securing-exposing-registry.adoc#securing-exposing-registry[Exposing the registry].
|
||||
xref:../registry/securing-exposing-registry.adoc#securing-exposing-registry[Exposing the registry].
|
||||
* For details on accessing the internal registry, see
|
||||
xref:../../registry/accessing-the-registry.adoc#accessing-the-registry[Accessing the registry].
|
||||
xref:../registry/accessing-the-registry.adoc#accessing-the-registry[Accessing the registry].
|
||||
@@ -45,7 +45,7 @@ include::modules/osdk-ansible-managing-cr-status.adoc[leveloffset=+1]
|
||||
== Additional resources
|
||||
|
||||
- See
|
||||
xref:../../applications/operator_sdk/osdk-appendices.adoc#osdk-project-scaffolding-layout_operator-appendices[Appendices]
|
||||
xref:../../operators/operator_sdk/osdk-appendices.adoc#osdk-project-scaffolding-layout_operator-appendices[Appendices]
|
||||
to learn about the project directory structures created by the Operator SDK.
|
||||
- link:https://blog.openshift.com/reaching-for-the-stars-with-ansible-operator/[Reaching for the Stars with Ansible Operator] - Red Hat OpenShift Blog
|
||||
|
||||
@@ -30,7 +30,7 @@ include::modules/managing-memcached-operator-using-olm.adoc[leveloffset=+1]
|
||||
== Additional resources
|
||||
|
||||
- See
|
||||
xref:../../applications/operator_sdk/osdk-appendices.adoc#osdk-project-scaffolding-layout_operator-appendices[Appendices]
|
||||
xref:../../operators/operator_sdk/osdk-appendices.adoc#osdk-project-scaffolding-layout_operator-appendices[Appendices]
|
||||
to learn about the project directory structures created by the Operator SDK.
|
||||
|
||||
- link:https://operators.gitbook.io/operator-developer-guide-for-red-hat-partners/[Operator Development Guide for Red Hat Partners]
|
||||
@@ -17,7 +17,7 @@ include::modules/osdk-building-helm-operator.adoc[leveloffset=+1]
|
||||
== Additional resources
|
||||
|
||||
- See
|
||||
xref:../../applications/operator_sdk/osdk-appendices.adoc#osdk-project-scaffolding-layout_operator-appendices[Appendices]
|
||||
xref:../../operators/operator_sdk/osdk-appendices.adoc#osdk-project-scaffolding-layout_operator-appendices[Appendices]
|
||||
to learn about the project directory structures created by the Operator SDK.
|
||||
|
||||
- link:https://operators.gitbook.io/operator-developer-guide-for-red-hat-partners/[Operator Development Guide for Red Hat Partners]
|
||||
@@ -152,7 +152,7 @@ This release adds improvements related to the following components and concepts.
|
||||
[id="ocp-4-1-operators"]
|
||||
=== Operators
|
||||
|
||||
xref:../applications/operators/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
|
||||
xref:../operators/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
|
||||
are pieces of software that ease the operational complexity of running another
|
||||
piece of software. They act like an extension of the software vendor’s
|
||||
engineering team, watching over a Kubernetes environment (such as
|
||||
@@ -174,7 +174,7 @@ access to Operators running on their cluster:
|
||||
* Supports role-based access control (RBAC) for certain teams to use certain Operators
|
||||
|
||||
See
|
||||
xref:../applications/operators/olm-understanding-olm.adoc#olm-understanding-olm[Understanding the Operator Lifecycle Manager (OLM)] for more information.
|
||||
xref:../operators/olm-understanding-olm.adoc#olm-understanding-olm[Understanding the Operator Lifecycle Manager (OLM)] for more information.
|
||||
|
||||
[id="ocp-4-1-installation-and-upgrade"]
|
||||
=== Installation and upgrade
|
||||
@@ -252,7 +252,7 @@ from Red Hat products, Red Hat partners, and the community.
|
||||
|===
|
||||
|
||||
See
|
||||
xref:../applications/operators/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the OperatorHub] for more information.
|
||||
xref:../operators/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the OperatorHub] for more information.
|
||||
|
||||
[id="ocp-4-1-storage"]
|
||||
=== Storage
|
||||
|
||||
@@ -97,7 +97,7 @@ future release.
|
||||
|
||||
See
|
||||
xref:../installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Installing in restricted networks]
|
||||
and xref:../applications/operators/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
|
||||
and xref:../operators/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
|
||||
for details.
|
||||
|
||||
[id="ocp-4-2-cluster-wide-egresss-proxy"]
|
||||
@@ -155,7 +155,7 @@ Operators in this namespace get equal or lower permissions of this
|
||||
ServiceAccount.
|
||||
|
||||
See
|
||||
xref:../applications/operators/olm-creating-policy.adoc#olm-creating-policy[Creating policy for Operator installations and upgrades]
|
||||
xref:../operators/olm-creating-policy.adoc#olm-creating-policy[Creating policy for Operator installations and upgrades]
|
||||
for details.
|
||||
|
||||
[id="ocp-4-2-ingress-operator"]
|
||||
|
||||
@@ -49,14 +49,14 @@ You can install the {ServerlessOperatorName} in the host cluster by following th
|
||||
The {ServerlessOperatorName} only works for {product-title} versions 4.1.13 and later.
|
||||
====
|
||||
|
||||
For details, see the {product-title} documentation on xref:../applications/operators/olm-adding-operators-to-cluster.adoc[adding Operators to a cluster].
|
||||
For details, see the {product-title} documentation on xref:../operators/olm-adding-operators-to-cluster.adoc[adding Operators to a cluster].
|
||||
|
||||
[id="deleting-openshift-serverless-operator_{context}"]
|
||||
== Deleting the {ServerlessOperatorName}
|
||||
|
||||
You can remove the {ServerlessOperatorName} from the host cluster by following the {product-title} instructions on deleting an Operator.
|
||||
|
||||
For details, see the {product-title} documentation on xref:../applications/operators/olm-deleting-operators-from-cluster.adoc[deleting Operators from a cluster].
|
||||
For details, see the {product-title} documentation on xref:../operators/olm-deleting-operators-from-cluster.adoc[deleting Operators from a cluster].
|
||||
|
||||
|
||||
// Installing Knative Serving
|
||||
|
||||
@@ -44,7 +44,7 @@ containerized applications, from simple containers to advanced Kubernetes deploy
|
||||
|
||||
- **xref:../applications/projects/working-with-projects.adoc[Work with projects]**: Create projects from the web console or CLI to organize and share the software you develop.
|
||||
|
||||
- **xref:../applications/operators/olm-what-operators-are.adoc#olm-what-operators-are[Understand Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title} {product-version}. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects.
|
||||
- **xref:../operators/olm-what-operators-are.adoc#olm-what-operators-are[Understand Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title} {product-version}. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects.
|
||||
|
||||
- **xref:../builds/understanding-image-builds.adoc[Understand image builds]**: Choose from different build strategies (Docker, S2I, custom and pipeline) that can include different kinds of source materials (from places like Git repositories, local binary inputs and external artifacts). Then, follow examples of build types from basic builds to advanced builds.
|
||||
|
||||
@@ -56,8 +56,8 @@ Use the Workloads page or `oc` CLI to xref:../applications/deployments/managing-
|
||||
- **xref:../openshift_images/using-templates.adoc[Create templates]**: Use existing templates or create your own templates that describe how an application is built or deployed. A template can combine images with descriptions, parameters, replicas, exposed ports and other content that defines how an application can be run or built.
|
||||
|
||||
ifdef::openshift-enterprise,openshift-origin[]
|
||||
- **xref:../applications/operator_sdk/osdk-getting-started.adoc[Create Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title} {product-version}. Learn the workflow for building, testing, and deploying Operators. Then create your own Operators based on xref:../applications/operator_sdk/osdk-ansible.adoc[Ansible] or
|
||||
xref:../applications/operator_sdk/osdk-helm.adoc[Helm], or configure xref:../applications/operator_sdk/osdk-monitoring-prometheus.adoc[built-in Prometheus monitoring] using the Operator SDK.
|
||||
- **xref:../operators/operator_sdk/osdk-getting-started.adoc[Create Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title} {product-version}. Learn the workflow for building, testing, and deploying Operators. Then create your own Operators based on xref:../operators/operator_sdk/osdk-ansible.adoc[Ansible] or
|
||||
xref:../operators/operator_sdk/osdk-helm.adoc[Helm], or configure xref:../operators/operator_sdk/osdk-monitoring-prometheus.adoc[built-in Prometheus monitoring] using the Operator SDK.
|
||||
|
||||
- **Use xref:../applications/service_brokers/installing-template-service-broker.adoc#sb-about-template-service-broker-sb-installing-tsb[Template Service Broker] or xref:../applications/service_brokers/installing-ansible-service-broker.html#sb-about-ansible-service-broker-sb-installing-asb[OpenShift Ansible Broker] applications**: Service brokers are a mechanism for provisioning applications outside of an {product-title} environment.
|
||||
endif::[]
|
||||
@@ -72,7 +72,7 @@ that watch over the cluster. As a cluster administrator, this
|
||||
documentation will help you:
|
||||
|
||||
- **xref:../architecture/architecture.adoc#architecture-overview-architecture[Understand {product-title} management]**: Learn about components
|
||||
of the {product-title} {product-version} control plane. See how OpenShift masters and workers are managed and updated through the xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machine-api-overview_creating-machineset-aws[Machine API] and xref:../applications/operators/olm-what-operators-are.adoc#machine-api-overview-architecture[Operators].
|
||||
of the {product-title} {product-version} control plane. See how OpenShift masters and workers are managed and updated through the xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machine-api-overview_creating-machineset-aws[Machine API] and xref:../operators/olm-what-operators-are.adoc#machine-api-overview-architecture[Operators].
|
||||
|
||||
=== Manage cluster components
|
||||
|
||||
@@ -122,8 +122,8 @@ As needed, you can
|
||||
xref:../storage/expanding-persistent-volumes.adoc[expand persistent volumes]
|
||||
and configure xref:../storage/dynamic-provisioning.adoc[dynamic provisioning].
|
||||
|
||||
- **xref:../applications/operators/olm-what-operators-are.adoc#olm-what-operators-are[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can
|
||||
be reviewed by cluster administrators and xref:../applications/operators/olm-adding-operators-to-cluster.adoc[installed on their clusters]. Once installed, you can xref:../applications/operators/olm-creating-apps-from-installed-operators.adoc[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do).
|
||||
- **xref:../operators/olm-what-operators-are.adoc#olm-what-operators-are[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can
|
||||
be reviewed by cluster administrators and xref:../operators/olm-adding-operators-to-cluster.adoc[installed on their clusters]. Once installed, you can xref:../operators/olm-creating-apps-from-installed-operators.adoc[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do).
|
||||
|
||||
=== Change cluster components
|
||||
|
||||
@@ -160,8 +160,8 @@ cluster can be performed by {product-title} cluster administrators. As a
|
||||
- **xref:../administering_a_cluster/dedicated-admin-role.adoc#dedicated-administrator-role[Understand the `dedicated-admin` role]**: Learn about the elevated privileges provided to {product-title} cluster administrators.
|
||||
|
||||
////
|
||||
- **xref:../applications/operators/olm-what-operators-are.adoc[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can
|
||||
be reviewed by cluster administrators and xref:../applications/operators/olm-adding-operators-to-cluster.adoc[installed on their clusters]. Once installed, you can xref:../applications/operators/olm-creating-apps-from-installed-operators.adoc[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do).
|
||||
- **xref:../operators/olm-what-operators-are.adoc[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can
|
||||
be reviewed by cluster administrators and xref:../operators/olm-adding-operators-to-cluster.adoc[installed on their clusters]. Once installed, you can xref:../operators/olm-creating-apps-from-installed-operators.adoc[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do).
|
||||
////
|
||||
|
||||
- **xref:../administering_a_cluster/dedicated-admin-role.html#dedicated-managing-administrators_dedicated-administrator[Manage RBAC authorizations]**: Grant permissions to users or groups and manage service accounts.
|
||||
|
||||
Reference in New Issue
Block a user