Skip to content

Commit

Permalink
remove OLM related install instructions for Kubeflow Operator (#2149)
Browse files Browse the repository at this point in the history
  • Loading branch information
adrian555 committed Aug 21, 2020
1 parent 0772e13 commit 0f6612d
Show file tree
Hide file tree
Showing 7 changed files with 5 additions and 37 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
6 changes: 0 additions & 6 deletions content/en/docs/operator/install-kubeflow.md
Expand Up @@ -45,12 +45,6 @@ kubectl create -f ${KFDEF} -n ${KUBEFLOW_NAMESPACE}

Note: in the example above, ${KFDEF} points to a local KfDef configuration file, however, it can also points to a remote URL containing a valid KfDef configuration.

Alternately if the Kubeflow Operator is installed through OLM console as outlined in [Installing Kubeflow Operator](/docs/operator/install-kubeflow) guide, you can also start the Kubeflow deployment within the console. Navigate to the namespace `kubeflow` where the Kubeflow will be deployed. From the `Installed Operator` page find the Kubeflow Operator and click on `Create Instance` to open the page where you can provide the KfDef configuration. Then click on the `Create` to start the Kubeflow deployment.

<img src="/docs/images/operator-install-kubeflow.png"
alt="Kubeflow deployment in OLM console"
class="mt-3 mb-3 border border-info rounded">

### Watch the deployment progress

The Kubeflow deployment is carried on by the operator, you can watch the progress with this command
Expand Down
26 changes: 4 additions & 22 deletions content/en/docs/operator/install-operator.md
Expand Up @@ -8,26 +8,9 @@ This guide describes how to install the Kubeflow Operator.

There are different ways to install the Kubeflow Operator, choose one of the following:

## 1. Installing the Kubeflow Operator through the OLM console
## 1. Installing the Kubeflow Operator through the [operatorhub.io](https://operatorhub.io/operator/kubeflow)

If the [Operator Lifecycle Manager](https://github.com/operator-framework/operator-lifecycle-manager) (OLM) and the OLM [console](https://github.com/openshift/console) are installed on your cluster, you can find the Kubeflow Operator from the OperatorHub catalog under the Operators as shown on the console. OLM is officially supported on OpenShift.

<img src="/docs/images/operator-catalog-kubeflow.png"
alt="Kubeflow Operator in OLM console"
class="mt-3 mb-3 border border-info rounded">

Choose the `operators` namespace, select the Kubeflow Operator and follow the instructions there to install the operator. Verify the Kubeflow Operator is running with following command.

```shell
kubectl get pod -n operators

NAME READY STATUS RESTARTS AGE
kubeflow-operator-55876578df-25mq5 1/1 Running 0 17h
```

## 2. Installing the Kubeflow Operator through the [operatorhub.io](https://operatorhub.io/operator/kubeflow)

If your cluster does not have OLM installed, navigate to the [operatorhub.io](https://operatorhub.io/operator/kubeflow), click on the `Install` and follow the instructions there to install the operator.
The stable release of Kubeflow Operator is published to the [operatorhub.io](https://operatorhub.io). Navigate to the [operatorhub.io](https://operatorhub.io/operator/kubeflow), click on the `Install` and follow the instructions there to install the operator.

<img src="/docs/images/operator-operatorhubio-kubeflow.png"
alt="Kubeflow Operator in OperatorHub"
Expand All @@ -42,13 +25,12 @@ NAME READY STATUS RESTARTS AGE
kubeflow-operator-55876578df-25mq5 1/1 Running 0 17h
```

## 3. Installing the Kubeflow Operator with `kustomize` and `kubectl`
## 2. Installing the Kubeflow Operator with `kustomize` and `kubectl`

Previous methods install the stable release of Kubeflow Operator published to the [operatorhub.io](https://operatorhub.io). Both are convenient and simple enough without any knowledges of the Operator SDK. However, if any of the following reasons applies, choose this approach to install the operator.
Previous method is convenient and simple enough without any knowledges of the Operator SDK. However, if any of the following reasons applies, choose this approach to install the operator.

1. You want to install a different release of Kubeflow Operator since the Kubeflow KfDef manifests may not be compatible from release to release.
2. You want to install the latest release of Kubeflow Operator.
3. You want to avoid the OLM but rather install the Kubeflow Operator itself.

### Prerequisites

Expand Down
2 changes: 0 additions & 2 deletions content/en/docs/operator/uninstall-kubeflow.md
Expand Up @@ -13,5 +13,3 @@ kubectl delete kfdef ${KUBEFLOW_DEPLOYMENT_NAME} -n ${KUBEFLOW_NAMESPACE}
```

Note: ${KUBEFLOW_DEPLOYMENT_NAME} and ${KUBEFLOW_NAMESPACE} are defined in the [Installing Kubeflow](/docs/operator/install-kubeflow) guide.

Besides the above approach, if the Kubeflow Operator is installed through the OLM console as outlined in the [Installing Kubeflow Operator](/docs/operator/install-kubeflow) guide, you can also delete the Kubeflow deployment through the console.
8 changes: 1 addition & 7 deletions content/en/docs/operator/uninstall-operator.md
Expand Up @@ -6,13 +6,7 @@ weight = 20

This guide describes how to uninstall the Kubeflow Operator.

If the Kubeflow Operator is installed through the OLM console, it can be uninstalled through the console. Navigate to the `Installed Operators` page and find the Kubeflow Operator. Choose the `Uninstall Operator` option to uninstall the operator.

<img src="/docs/images/operator-uninstall-kubeflow.png"
alt="Uninstall Kubeflow Operator in OLM console"
class="mt-3 mb-3 border border-info rounded">

Alternately you can always uninstall the operator with following commands
You can always uninstall the operator with following commands

```shell
# switch to the cloned kfctl directory
Expand Down

0 comments on commit 0f6612d

Please sign in to comment.