Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarified versions available in deployment UI and CLI #981

Merged
merged 3 commits into from
Jul 29, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions content/docs/gke/deploy/deploy-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ weight = 3
+++

This page provides instructions for using the Kubeflow deployment web app to
deploy Kubeflow on GCP. If you prefer to use the
command line, see the guide to
deploy Kubeflow on GCP. The deployment web app currently supports
**Kubeflow {{% kf-deployment-ui-version %}}**.

For more control over your deployment, see the guide to
[deployment using the CLI](/docs/gke/deploy/deploy-cli).
sarahmaddox marked this conversation as resolved.
Show resolved Hide resolved
The CLI supports Kubeflow {{% kf-latest-version %}} and later versions.

## Overview of the deployment user interface (UI)

Expand Down
16 changes: 12 additions & 4 deletions content/docs/pipelines/tutorials/pipelines-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,22 +128,30 @@ Deploy Kubeflow on GCP:
guide to [deploying Kubeflow on GCP](/docs/gke/deploy/),
taking note of the following:

* For the simplest deployment experience, use the Kubeflow deployment web app
sarahmaddox marked this conversation as resolved.
Show resolved Hide resolved
as described in the guide to
[deployment using the UI](/docs/gke/deploy/deploy-ui/).
sarahmaddox marked this conversation as resolved.
Show resolved Hide resolved
The deployment web app currently supports
**Kubeflow {{% kf-deployment-ui-version %}}**.
* For more control
over the deployment, use the guide to
[deployment using the CLI](/docs/gke/deploy/deploy-cli/).
sarahmaddox marked this conversation as resolved.
Show resolved Hide resolved
The CLI supports **Kubeflow {{% kf-latest-version %}}** and later versions.
* Make sure that you enable **Cloud Identity-Aware Proxy (IAP)**
as prompted during the deployment process.
* When setting up the **authorized redirect URI** for the **OAuth client
credentials**, use the same value for the `<deployment_name>` as you used
when setting up the `DEPLOYMENT_NAME` environment variable earlier in this
tutorial.
* Choose **Kubeflow {{% kf-stable-tag %}}** or later.

The following screenshot shows the Kubeflow deployment UI with hints about
* The following screenshot shows the Kubeflow deployment UI with hints about
the value for each input field:

<img src="/docs/images/gcp-e2e-deploy-kubeflow.png"
alt="Prediction UI"
class="mt-3 mb-3 p-3 border border-info rounded">

1. (Optional) If you want to examine your cluster while waiting for the UI to
1. (Optional) If you want to examine your cluster while waiting for the
Kubeflow dashboard to
be available, you can use `kubectl` to connect to your cluster:

* Connect your Cloud Shell session to the cluster:
Expand Down
8 changes: 4 additions & 4 deletions content/docs/started/getting-started-minikube.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,12 @@ curl -Lo docker-machine-driver-kvm2 https://storage.googleapis.com/minikube/rele
The following describes a script driven installation that you can use to deploy all
the necessary components including `kubectl`, `minikube`, `kfctl` along with Kubeflow itself. The script requires input from you on some configuration information and then it drives the rest of the installation. Run the following to start the installation:
```
export KUBEFLOW_TAG={{% kf-stable-tag %}}
export KUBEFLOW_TAG={{% kf-latest-version %}}
curl -O https://raw.githubusercontent.com/kubeflow/kubeflow/${KUBEFLOW_TAG}/scripts/setup-minikube.sh
chmod +x setup-minikube.sh
./setup-minikube.sh
```
**KUBEFLOW_TAG** is a tag corresponding to the version to checkout such as {{% kf-stable-tag %}} or `master`.
**KUBEFLOW_TAG** is a tag corresponding to the version to checkout such as {{% kf-latest-version %}} or `master`.

The script asks for some config input as shown below:
![ConfigInputs](../ConfigInputs.png)
Expand Down Expand Up @@ -214,11 +214,11 @@ The following steps will deploy Kubeflow components and start them on the Miniku
```
mkdir ${KUBEFLOW_SRC}
cd ${KUBEFLOW_SRC}
export KUBEFLOW_TAG={{% kf-stable-tag %}}
export KUBEFLOW_TAG={{% kf-latest-version %}}
curl https://raw.githubusercontent.com/kubeflow/kubeflow/${KUBEFLOW_TAG}/scripts/download.sh | bash
```
- **KUBEFLOW_SRC** directory where you want kubeflow source to be downloaded
- **KUBEFLOW_TAG** is a tag corresponding to the version to checkout such as {{% kf-stable-tag %}}
- **KUBEFLOW_TAG** is a tag corresponding to the version to checkout such as {{% kf-latest-version %}}

1. Run the following to setup and deploy Kubeflow:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/use-cases/gitops-for-kubeflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ You can read about other options to connect to your Argo CD instance [here](http
```shell
mkdir ${KUBEFLOW_SRC}
cd ${KUBEFLOW_SRC}
export KUBEFLOW_TAG={{% kf-stable-tag %}}
export KUBEFLOW_TAG=v0.5.0
curl https://raw.githubusercontent.com/kubeflow/kubeflow/${KUBEFLOW_TAG}/scripts/download.sh | bash
```
* **KUBEFLOW_SRC** directory where you want kubeflow source to be downloaded
Expand Down
1 change: 1 addition & 0 deletions layouts/shortcodes/kf-deployment-ui-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v0.5.0
2 changes: 1 addition & 1 deletion layouts/shortcodes/kf-latest-version.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.6.1
v0.6.1
1 change: 0 additions & 1 deletion layouts/shortcodes/kf-stable-tag.html

This file was deleted.