1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

Applied changes based on OperatorHub UI updates

Conflicts:
	modules/dedicated-efk-install-deploy.adoc
	modules/efk-logging-deploy-subscription.adoc
This commit is contained in:
Ashley Hardin
2019-09-04 15:01:06 -04:00
parent c306f1e226
commit e44ecfd4c6
21 changed files with 116 additions and 118 deletions

View File

@@ -17,7 +17,7 @@ during deployment.
. From the {product-title} web console, select `openshift-cnv` from
the *Projects* list.
. Navigate to the *Catalog* -> *Installed Operators* page.
. Navigate to the *Operators* -> *Installed Operators* page.
. Click *KubeVirt HyperConverged Cluster Operator*.

View File

@@ -14,18 +14,15 @@ Cluster Operator catalog subscription.
.Procedure
. From the {product-title} web console, select `openshift-cnv` from
the *Projects* list.
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the KubeVirt HyperConverged Cluster Operator. Then,
click on it.
. Navigate to the *Catalog* -> *Operator Management* page.
. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
. Click the *Operator Subscriptions* tab.
. Click the Options menu {kebab} in the row that contains the *hco-subscription*
subscription. In the expanded menu, click *Remove Subscription*.
. Ensure that the *Also completely remove the Operator from the selected namespace*
check box is selected. If it is not selected, Operator Pods will remain in
*Workloads* -> *Pods* when the subscription is removed.
. Confirm that you want to remove the subscription by clicking *Remove* again.
. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.

View File

@@ -16,11 +16,11 @@ in the `openshift-cnv` namespace
.Procedure
. Navigate to the *Catalog* -> *Installed Operators* page.
. Navigate to the *Operators* -> *Installed Operators* page.
. Click *KubeVirt HyperConverged Cluster Operator*.
. Click the *KubeVirt HyperConverged Cluster Operator Deployment* tab and click
. Click the *KubeVirt HyperConverged Cluster Operator Deployment* tab and click
*Create HyperConverged*.
. Click *Create* to launch {CNVProductName}.

View File

@@ -19,11 +19,21 @@ both created in the `openshift-cnv` namespace
. Open a browser window and navigate to the {product-title} web console.
. Select the `openshift-cnv` project from the *Projects* list.
. Navigate in the web console to the *Operators → OperatorHub* page.
. Navigate to the *Catalog* -> *Operator Management* page.
. Scroll or type a keyword into the *Filter by keyword* box to find the KubeVirt
HyperConverged Cluster Operator, then click on it.
. In the *Operator Catalogs* tab, locate *KubeVirt HyperConverged Cluster Operator* and
click *Create Subscription*.
. Read the information about the Operator and click *Install*.
. Click *Create* to launch the {CNVProductName} Operators.
. On the *Create Operator Subscription* page:
.. Select one of the following:
*** *All namespaces on the cluster (default)* installs the Operator in the default
`openshift-operators` namespace to watch and be made available to all namespaces
in the cluster. This option is not always available.
*** *A specific namespace on the cluster* allows you to choose a specific, single
namespace in which to install the Operator. The Operator will only watch and be
made available for use in this single namespace.
. Click *Subscribe* to make the Operator available to the selected namespaces on
this {product-title} cluster.

View File

@@ -223,7 +223,7 @@ The Elasticsearch operator is installed to the `openshift-operators-redhat` name
. Install the Cluster Logging Operator using the {product-title} web console for best results:
.. In the {product-title} web console, click *Catalog* -> *OperatorHub*.
.. In the {product-title} web console, click *Operators* -> *OperatorHub*.
.. Choose *Cluster Logging* from the list of available Operators, and click *Install*.
@@ -232,7 +232,7 @@ Then, click *Subscribe*.
. Verify the operator installations:
.. Switch to the *Catalog* → *Installed Operators* page.
.. Switch to the *Operators* → *Installed Operators* page.
.. Ensure that *Cluster Logging* and *Elasticsearch Operator* are listed on
the *InstallSucceeded* tab with a *Status* of *InstallSucceeded*. Change the project to *all projects* if necessary.
@@ -245,11 +245,8 @@ you can safely ignore the *Failed* message.
+
If either operator does not appear as installed, to troubleshoot further:
+
* On the *Copied* tab of the *Installed Operators* page, if an operator show a *Status* of
*Copied*, this indicates the installation is in process and is expected behavior.
* Switch to the *Catalog* → *Operator Management* page and inspect
the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors
under *Status*.
* Switch to the *Operators* → *Installed Operators* page and inspect
the *Status* column for any errors or failures.
* Switch to the *Workloads* → *Pods* page and check the logs in any Pods in the
`openshift-logging` and `openshift-operators-redhat` projects that are reporting issues.

View File

@@ -13,6 +13,6 @@ Before application developers can monitor their applications, the human operator
.Procedure
. In the {product-title} web console, navigate to *Catalog* -> *OperatorHub* and install the Prometheus Operator in the namespace where your application is.
. In the {product-title} web console, navigate to *Operators* -> *OperatorHub* and install the Prometheus Operator in the namespace where your application is.
. Navigate to *Catalog* -> *Developer Catalog* and install Prometheus, Alertmanager, Prometheus Rule, and Service Monitor in the same namespace.

View File

@@ -18,7 +18,7 @@ Operator, managed by the Operator Lifecycle Manager (OLM).
. Create a new project in the {product-title} web console for this procedure. This
example uses a project called *my-etcd*.
. Navigate to the *Catalogs -> Installed Operators* page. The Operators that have
. Navigate to the *Operators -> Installed Operators* page. The Operators that have
been installed to the cluster by the cluster administrator and are available for
use are shown here as a list of ClusterServiceVersions (CSVs). CSVs are used to
launch and manage the software provided by the Operator.

View File

@@ -10,34 +10,14 @@ console, follow these steps:
.Procedure
. Select the Operator to delete. There are two paths to do this:
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the Operator you want. Then, click on it.
** From the *Catalog* → *OperatorHub* page:
+
--
. Scroll or type a keyword into the *Filter by keyword box* (in this case,
`jaeger`) to find the Operator you want and click on it.
. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
. Click *Uninstall*.
--
** From the *Catalog* → *Operator Management* page:
+
--
. Select the namespace where the Operator is installed from the *Project* list.
For cluster-wide Operators, the default is `openshift-operators`.
. From the *Operator Subscriptions* tab, find the Operator you want to delete (in
this example, `jaeger`) and click the Options menu {kebab} at the end of its
entry.
+
image::olm-operator-delete.png[]
. Click *Remove Subscription*.
--
. When prompted by the *Remove Subscription* window, optionally select the
*Also completely remove the jaeger Operator from the selected namespace*
. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.

View File

@@ -20,7 +20,7 @@ endif::[]
.Procedure
. Navigate in the web console to the *Catalog → OperatorHub* page.
. Navigate in the web console to the *Operators → OperatorHub* page.
. Scroll or type a keyword into the *Filter by keyword* box (in this case,
`Couchbase`) to find the Operator you want.
@@ -52,9 +52,6 @@ endif::[]
. Click *Subscribe* to make the Operator available to the selected namespaces on
this {product-title} cluster.
. From the *Catalog → Operator Management* page, you can monitor an Operator
Subscription's installation and upgrade progress.
.. If you selected a Manual approval strategy, the Subscription's upgrade status
will remain *Upgrading* until you review and approve its Install Plan.
+
@@ -70,7 +67,7 @@ resolve to *Up to date* without intervention.
.Subscription upgrade status *Up to date*
image::olm-uptodate.png[]
. After the Subscription's upgrade status is *Up to date*, select *Catalog → Installed Operators*
. After the Subscription's upgrade status is *Up to date*, select *Operators → Installed Operators*
to verify that the *Couchbase* ClusterServiceVersion (CSV) eventually shows up
and its *Status* ultimately resolves to *InstallSucceeded* in the relevant namespace.
+
@@ -83,10 +80,6 @@ For the *All namespaces...* Installation Mode, the status resolves to
+
If it does not:
.. Switch to the *Catalog → Operator Management* page and inspect
the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors
under *Status*.
.. Check the logs in any Pods in the `openshift-operators` project (or other
relevant namespace if *A specific namespace...* Installation Mode was selected)
on the *Workloads → Pods* page that are reporting issues to troubleshoot

View File

@@ -39,7 +39,7 @@ Follow this procedure to add the Bookinfo project to the {ProductShortName} memb
. Enter a *Project Name* (for example, *bookinfo*), a *Display Name*, and a *Description*, then click *Create*.
. Click *Catalog* -> *Installed Operators*.
. Click *Operators* -> *Installed Operators*.
. Click the *Project* menu and choose `istio-system` from the list.
@@ -91,4 +91,3 @@ This example joins the Bookinfo project to the {ProductShortName} from the CLI.
# a list of projects joined into the service mesh
- bookinfo
----

View File

@@ -26,7 +26,7 @@ Do not install Community versions of the Operators. Community Operators are not
. Log in to the {product-title} web console.
. Navigate to *Catalog* -> *OperatorHub*.
. Navigate to *Operators* -> *OperatorHub*.
. Type *Elasticsearch* into the filter box to locate the Elasticsearch Operator.
@@ -68,7 +68,7 @@ Do not install Community versions of the Operators. Community Operators are not
. Log in to the {product-title} web console.
. Navigate to *Catalog* -> *OperatorHub*.
. Navigate to *Operators* -> *OperatorHub*.
. Type *Jaeger* into the filter box to locate the Jaeger Operator.
@@ -111,7 +111,7 @@ Do not install Community versions of the Operators. Community Operators are not
. Log in to the {product-title} web console.
. Navigate to *Catalog* -> *OperatorHub*.
. Navigate to *Operators* -> *OperatorHub*.
. Type *Kiali* into the filter box to find the Kiali Operator.
@@ -149,7 +149,7 @@ The Manual approval strategy requires a user with appropriate credentials to app
. Log in to the {product-title} web console.
. Navigate to *Catalog* -> *OperatorHub*.
. Navigate to *Operators* -> *OperatorHub*.
. Type *{ProductName}* into the filter box to find the {ProductName} Operator.

View File

@@ -5,7 +5,9 @@
[id="ossm-operatorhub-remove_{context}"]
= Removing the installed Operators
You must remove the Operators to successfully remove {ProductName}. Once you remove the {ProductName} Operator, you must remove the Jaeger Operator, Kiali Operator, and the Elasticsearch Operator.
You must remove the Operators to successfully remove {ProductName}. Once you
remove the {ProductName} Operator, you must remove the Jaeger Operator, Kiali
Operator, and the Elasticsearch Operator.
[id="ossm-remove-operator-servicemesh_{context}"]
== Removing the {ProductName} Operator
@@ -21,13 +23,17 @@ Follow this procedure to remove the {ProductName} Operator.
. Log in to the {product-title} web console.
. Navigate to *Catalogs* -> *Operator Management*.
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the {ProductName} Operator. Then, click on it.
. Click the *Project* menu, and then click *openshift-operators*.
. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
. Click the *servicemeshoperator* Options menu {kebab}, and then click *Remove Subscription*.
. Select *Also completely remove the Operator from the selected namespace*, and then click *Remove*.
. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.
[id="ossm-remove-operator-jaeger_{context}"]
@@ -44,13 +50,17 @@ Follow this procedure to remove the Jaeger Operator.
. Log in to the {product-title} web console.
. Navigate to *Catalogs* -> *Operator Management*.
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the Jaeger Operator. Then, click on it.
. Click the *Project* menu, and then click *openshift-operators*.
. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
. Click the *jaegeroperator* Options menu {kebab}, and then click *Remove Subscription*.
. Select *Also completely remove the Operator from the selected namespace*, and then click *Remove*.
. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.
[id="ossm-remove-operator-kiali_{context}"]
== Removing the Kiali Operator
@@ -66,13 +76,17 @@ Follow this procedure to remove the Kiali Operator.
. Log in to the {product-title} web console.
. Navigate to *Catalogs* -> *Operator Management*.
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the Kiali Operator. Then, click on it.
. Click the *Project* menu, and then click *openshift-operators*.
. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
. Click the *kiali-ossm* Options menu {kebab}, and then click *Remove Subscription*.
. Select *Also completely remove the Operator from the selected namespace*, and then click *Remove*.
. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.
[id="ossm-remove-operator-elasticsearch_{context}"]
== Removing the Elasticsearch Operator
@@ -88,14 +102,17 @@ Follow this procedure to remove the Elasticsearch Operator.
. Log in to the {product-title} web console.
. Navigate to *Catalogs* -> *Operator Management*.
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the Elasticsearch Operator. Then, click on it.
. Click the *Project* menu, and then click *openshift-operators*.
. Click the *elasticsearch-operator* Options menu {kebab}, and then click *Remove Subscription*.
. Select *Also completely remove the Operator from the selected namespace*, and then click *Remove*.
. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.
[id="ossm-remove-cleanup_{context}"]
== Clean up Operator resources
@@ -125,4 +142,3 @@ $ oc delete clusterrole/istio-admin
$ oc get crds -o name | grep '.*\.istio\.io' | xargs -r -n 1 oc delete
$ oc get crds -o name | grep '.*\.maistra\.io' | xargs -r -n 1 oc delete
----

View File

@@ -35,7 +35,7 @@ This tutorial walks you through creating a Bookinfo project, deploying the Booki
$ oc new-project bookinfo
----
. Click *Catalog* -> *Installed Operators*.
. Click *Operators* -> *Installed Operators*.
. Click the *Project* menu and choose `openshift-operators` from the list.

View File

@@ -40,7 +40,7 @@ $ oc delete project bookinfo
. Log in to the {product-title} web console.
. Click *Catalog* -> *Installed Operators*.
. Click *Operators* -> *Installed Operators*.
. Click the *Project* menu and choose `openshift-operators` from the list.
@@ -57,4 +57,3 @@ $ oc -n <control plane project> patch --type='json' smmr default -p '[{"op": "re
----
. Click *Save* to update Service Mesh Member Roll.

View File

@@ -15,7 +15,7 @@ The following procedure customizes the settings for your {asb-name}.
This procedure assumes that you used `ansible-service-broker` both as the {asb-name} name and the project that it was installed into.
. Navigate in the web console to *Catalog* -> *Installed Operators* and select the `ansible-service-broker` project.
. Navigate in the web console to *Operators* -> *Installed Operators* and select the `ansible-service-broker` project.
. Select the *OpenShift Ansible Service Broker Operator*.
. On the *Automation Broker* tab, select `ansible-service-broker`.
. On the *YAML* tab, add or update any {asb-name} configuration options under the `spec` field.

View File

@@ -34,7 +34,7 @@ NOTE: The namespace must start with `openshift-`.
.. Add a *Key* of `username` and a *Value* of your Red Hat Container Catalog user name.
.. Click *Add Key/Value* and add a *Key* of `password` and a *Value* of your Red Hat Container Catalog password.
.. Click *Create*.
. Navigate to the *Catalog* -> *OperatorHub* page. Verify that the `openshift-ansible-service-broker` project is selected.
. Navigate to the *Operators* -> *OperatorHub* page. Verify that the `openshift-ansible-service-broker` project is selected.
. Select *OpenShift Ansible Service Broker Operator*.
. Read the information about the Operator and click *Install*.
. Review the default selections and click *Subscribe*.

View File

@@ -19,7 +19,7 @@ web console.
.. Enter `openshift-template-service-broker` in the *Name* field and click *Create*.
+
NOTE: The namespace must start with `openshift-`.
. Navigate to the *Catalog* -> *OperatorHub* page. Verify that the `openshift-template-service-broker` project is selected.
. Navigate to the *Operators* -> *OperatorHub* page. Verify that the `openshift-template-service-broker` project is selected.
. Select *Template Service Broker Operator*.
. Read the information about the Operator and click *Install*.
. Review the default selections and click *Subscribe*.

View File

@@ -15,7 +15,7 @@ using the following procedure.
.Procedure
. Navigate in the web console to *Catalog* -> *Installed Operators* and select the `openshift-ansible-service-broker` project.
. Navigate in the web console to *Operators* -> *Installed Operators* and select the `openshift-ansible-service-broker` project.
. Select the *OpenShift Ansible Service Broker Operator*.
. Under *Provided APIs*, click *Create New* for *Automation Broker*.
. Add the following to the `spec` field in the default YAML provided:

View File

@@ -15,7 +15,7 @@ After you have installed the {tsb-name} Operator, you can start the
.Procedure
. Navigate in the web console to *Catalog* -> *Installed Operators* and select the `openshift-template-service-broker` project.
. Navigate in the web console to *Operators* -> *Installed Operators* and select the `openshift-template-service-broker` project.
. Select the *Template Service Broker Operator*.
. Under *Provided APIs*, click *Create New* for *Template Service Broker*.
. Review the default YAML and click *Create*.

View File

@@ -20,7 +20,7 @@ This procedure assumes that you installed the {asb-name} into the
`openshift-ansible-service-broker` project.
. Uninstall the {asb-name}.
.. Navigate to *Catalog* -> *Installed Operators* and select the
.. Navigate to *Operators* -> *Installed Operators* and select the
*openshift-ansible-service-broker* project from the drop-down menu.
.. Click *OpenShift Ansible Service Broker Operator*.
.. Select the *Automation Broker* tab.
@@ -32,13 +32,17 @@ The {asb-name} is now uninstalled, and service bundles will soon be removed
from the Developer Catalog.
. Uninstall the OpenShift Ansible Service Broker Operator.
.. Navigate to *Catalog* -> *Operator Management* and select the
*openshift-ansible-service-broker* project from the drop-down menu.
.. Click *View subscription* for the *OpenShift Ansible Service Broker Operator*.
.. Select *automationbroker*.
.. From the *Actions* drop-down menu, select *Remove Subscription*.
.. Verify that the checkbox is checked next to *Also completely remove the automationbroker Operator from the selected namespace* and click *Remove*.
+
.. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the OpenShift Ansible Service Broker Operator, then click on it.
.. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
.. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.
.. Select *Remove*. This Operator will stop running and no longer receive updates.
The OpenShift Ansible Service Broker Operator is no longer installed in your cluster.
After the {asb-name} is uninstalled, users will no longer have access to the

View File

@@ -20,7 +20,7 @@ This procedure assumes that you installed the {tsb-name} into the
`openshift-template-service-broker` project.
. Uninstall the {tsb-name}.
.. Navigate to *Catalog* -> *Installed Operators* and select the
.. Navigate to *Operators* -> *Installed Operators* and select the
*openshift-template-service-broker* project from the drop-down menu.
.. Click *Template Service Broker Operator*.
.. Select the *Template Service Broker* tab.
@@ -32,13 +32,16 @@ The {tsb-name} is now uninstalled, and template applications will soon be
removed from the Developer Catalog.
. Uninstall the {tsb-name} Operator.
.. Navigate to *Catalog* -> *Operator Management* and select the
*openshift-template-service-broker* project from the drop-down menu.
.. Click *View subscription* for the *Template Service Broker Operator*.
.. Select *templateservicebroker*.
.. From the *Actions* drop-down menu, select *Remove Subscription*.
.. Verify that the checkbox is checked next to *Also completely remove the templateservicebroker Operator from the selected namespace* and click *Remove*.
+
.. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
the *Filter by name* to find the {tsb-name} Operator, then click on it.
.. On the right-hand side of the *Operator Details* page, select *Uninstall
Operator* from the *Actions* drop-down menu.
.. When prompted by the *Remove Operator Subscription* window, optionally select the
*Also completely remove the Operator from the selected namespace*
check box if you want all components related to the installation to be removed.
This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs
associated with the Operator.
.. Select *Remove*. This Operator will stop running and no longer receive updates.
The {tsb-name} Operator is no longer installed in your cluster.
After the {tsb-name} is uninstalled, users will no longer have access to the