Skip to content
Permalink
Browse files

Typographical and link fixes as followup to PR #568. (#582)

  • Loading branch information...
sarahmaddox authored and k8s-ci-robot committed Apr 4, 2019
1 parent d19e5db commit d743387edc3bc950237e27ca0c84dc312282d542
@@ -179,9 +179,9 @@ You can override the default styles and add new ones:
Styling of images:

* To see some examples of styled images, take a look at the
[GKE getting-started page](https://www.kubeflow.org/docs/started/getting-started-gke/#create-oauth-client-credentials)
[OAuth setup page](https://www.kubeflow.org/docs/gke/deploy/oauth-setup/)
in the Kubeflow docs. Search for `.png` in the
[page source](https://raw.githubusercontent.com/kubeflow/website/master/content/docs/started/getting-started-gke.md).
[page source](https://raw.githubusercontent.com/kubeflow/website/master/content/docs/gke/deploy/oauth-setup.md).
* For more help, see the guide to
[Bootstrap image styling](https://getbootstrap.com/docs/4.0/content/images/).
* Also see the Bootstrap utilities, such as
@@ -33,3 +33,6 @@
/docs/pipelines/lightweight-python-components/ /docs/pipelines/sdk/lightweight-python-components/
/docs/pipelines/build-pipeline/ /docs/pipelines/tutorials/build-pipeline/
/docs/pipelines/pipelines-tutorial/ /docs/pipelines/tutorials/pipelines-tutorial/

# Moved the guide to monitoring GKE deployments.
/docs/other-guides/monitoring/ /docs/gke/monitoring/
@@ -127,7 +127,8 @@ If the service type is ClusterIP, you can access through ingress.
It's protected and only one with right credentials can access the endpoint.
Below shows how to programmatically authenticate a service account to access IAP.

1. Save the client id you used to [deploy Kubeflow](https://www.kubeflow.org/docs/started/getting-started-gke/) as `IAP_CLIENT_ID`.
1. Save the client ID that you used to
[deploy Kubeflow](/docs/gke/deploy/) as `IAP_CLIENT_ID`.
2. Create a service account
```
gcloud iam service-accounts create --project=$PROJECT $SERVICE_ACCOUNT
@@ -157,5 +158,5 @@ python iap_request.py https://YOUR_HOST/tfserving/models/mnist IAP_CLIENT_ID --i
Please look at the [Istio guide](/docs/components/istio/).

## Logs and metrics with Stackdriver
See [here](/docs/other-guides/monitoring/) for instructions to get logs and metrics
using Stackdriver.
See the guide to [logging and monitoring](/docs/gke/monitoring/)
for instructions on getting logs and metrics using Stackdriver.
@@ -226,7 +226,7 @@ The TFJob dashboard is available at `<path>/tfjobs/ui/`. Specifically:
![Central UI](/docs/images/central-ui.png)

* If you followed the
[guide for GKE](/docs/started/getting-started-gke), you can
guide to [deploying Kubeflow on GCP](/docs/gke/deploy/), you can
access the TFJob dashboard at the following URL:

```
@@ -621,10 +621,12 @@ further analysis.

### Stackdriver on GKE

See [here](/docs/other-guides/monitoring/) for instructions to get logs using Stackdriver.
See the guide to [logging and monitoring](/docs/gke/monitoring/) for
instructions on getting logs using Stackdriver.

As described [here](https://www.kubeflow.org/docs/other-guides/monitoring/#filter-with-labels) its possible
to fetch the logs for a particular replica based on pod labels.
As described in the guide to
[logging and monitoring](https://www.kubeflow.org/docs/gke/monitoring/#filter-with-labels),
it's possible to fetch the logs for a particular replica based on pod labels.

Using the Stackdriver UI you can use a query like

@@ -23,7 +23,7 @@ repository.

## Setup

Please refer to the [Google Kubernetes Engine Cluster for Kubeflow](https://www.kubeflow.org/docs/started/getting-started-gke/) guide for set up instructions.
Please refer to the guide to [deploying Kubeflow on GCP](/docs/gke/deploy/).

## NVIDIA TensorRT Inference Server Image

@@ -1,5 +1,5 @@
+++
title = "Kubeflow on GCP"
description = "Running Kubeflow on Kubernetes Engine and GCP"
description = "Running Kubeflow on Kubernetes Engine and Google Cloud Platform"
weight = 5
+++
@@ -15,8 +15,7 @@ Cloud Filestore is very useful for creating a shared filesystem that can be moun
## Before you start

This guide assumes you have already set up Kubeflow on GCP. If you haven't done
so, follow the guide to
[getting started with Kubeflow on Kubernetes Engine](/docs/started/getting-started-gke).
so, follow the guide to [deploying Kubeflow on GCP](/docs/gke/deploy/).

## Create a Cloud Filestore instance

@@ -11,7 +11,7 @@ Platform (GCP).

This guide assumes you have already set up Kubeflow on GCP. If you haven't done
so, follow the guide to
[getting started with Kubeflow on Kubernetes Engine](/docs/started/getting-started-gke).
[getting started with Kubeflow on GCP](/docs/gke/deploy/).

## Using your own domain

@@ -5,13 +5,12 @@ weight = 2
+++

This guide describes how to customize your deployment of Kubeflow on Google
Kubernetes Engine (GKE).
Kubernetes Engine (GKE) in Google Cloud Platform (GCP).

## Before you start

This guide assumes you have already set up Kubeflow with GKE. If you haven't done
so, follow the guide to
[getting started with Kubeflow on GKE](/docs/started/getting-started-gke).
so, follow the guide to [deploying Kubeflow on GCP](/docs/gke/deploy/).

## Customizing Kubeflow

@@ -1,5 +1,5 @@
+++
title = "Deploying Kubeflow"
description = "How to deploy Kubeflow on Google Cloud."
description = "How to deploy Kubeflow on Google Cloud Platform"
weight = 1
+++
@@ -5,13 +5,15 @@ weight = 4
+++


If you prefer to have more control over the deployment process and
configuration, you can use the `kfctl` command line tool instead of
the UI to deploy Kubeflow.
This guide describes how to use the `kfctl` command line tool to deploy
Kubeflow. The command line deployment gives you more control over the deployment
process and configuration than the deployment UI. If you're looking for a
simpler deployment procedure, see how to deploy Kubeflow
[using the UI](/docs/gke/deploy/deploy-ui).

Before installing Kubeflow on the command line:

* Ensure you have installed
* Ensure you have installed the following tools:

* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
* [gcloud](https://cloud.google.com/sdk/)
@@ -193,9 +195,10 @@ privilege. The three service accounts are:
[end-to-end MNIST tutorial](/docs/gke/gcp-e2e/) or the
[GitHub issue sumarization
example](https://github.com/kubeflow/examples/tree/master/github_issue_summarization).
* Deleting Kubeflow deployments with the [UI](/docs/gke/deploy/delete-ui)
* See how to [delete](/docs/gke/deploy/delete-ui) your Kubeflow deployment
using the GCP Console.
* See how to [customize](/docs/gke/customizing-gke) your Kubeflow
deployment on GKE.
deployment.
* See how to [upgrade Kubeflow](/docs/other-guides/upgrade/) and how to
[upgrade or reinstall a Kubeflow Pipelines
deployment](/docs/pipelines/upgrade/).
@@ -4,8 +4,10 @@ description = "Instructions for deploying Kubeflow using the UI"
weight = 3
+++

This page provides instructions for deploying Kubeflow using
the Click to Deploy web app for Google Cloud.
This page provides instructions for using the Kubeflow deployment web app to
deploy Kubeflow on Google Cloud Platform (GCP). If you prefer to use the
command line, see the guide to
[deployment using the CLI](/docs/gke/deploy/deploy-cli).

1. Open [https://deploy.kubeflow.cloud/](https://deploy.kubeflow.cloud/#/deploy)
in your web browser.
@@ -34,15 +36,16 @@ It can take 10-15 minutes for the URI to become available. You can watch
for updates in the information box on the deployment UI. If the deployment
takes longer than expected, try accessing the above URI anyway.

## Next Steps
## Next steps

* Run a full ML workflow on Kubeflow, using the
[end-to-end MNIST tutorial](/docs/gke/gcp-e2e/) or the
[GitHub issue sumarization
example](https://github.com/kubeflow/examples/tree/master/github_issue_summarization).
* Deleting Kubeflow deployments with the [UI](/docs/gke/deploy/delete-ui)
* See how to [delete](/docs/gke/deploy/delete-ui) your Kubeflow deployment
using the GCP Console.
* See how to [customize](/docs/gke/customizing-gke) your Kubeflow
deployment on GKE.
deployment.
* See how to [upgrade Kubeflow](/docs/other-guides/upgrade/) and how to
[upgrade or reinstall a Kubeflow Pipelines
deployment](/docs/pipelines/upgrade/).
@@ -1,6 +1,6 @@
+++
title = "Next steps"
description = "Next steps after deploying Kubeflow on GCP"
title = "Next Steps"
description = "Suggestions for further exploration after deploying Kubeflow on GCP"
weight = 6
+++

@@ -1,20 +1,21 @@
+++
title = "OAuth Set Up For IAP"
title = "Set up OAuth for IAP"
description = "Instructions for creating an OAuth client for IAP"
weight = 2
+++

If you want to use [identity aware proxy(IAP)](https://cloud.google.com/iap/docs/),
then you will need to follow these instructions to create an OAuth client to
If you want to use
[Cloud Identity-Aware Proxy (Cloud IAP)](https://cloud.google.com/iap/docs/)
then you must follow these instructions to create an OAuth client to
use with Kubeflow.

You can skip this step if you want to use basic auth (username & password) with
Kubeflow.
You can skip this step if you want to use basic authentication (username and
password) with Kubeflow instead of IAP.

IAP is recommended for production deployments or deployments with access to
sensitive data.

Create an OAuth client ID to be used to identify Cloud IAP when requesting
Create an OAuth client ID that identifies Cloud IAP when requesting
access to a user's email account. Kubeflow uses the email address to verify the
user's identity.

@@ -75,5 +76,7 @@ user's identity.

## Next steps

* Deploy Kubeflow with the [CLI](/docs/gke/deploy/deploy-cli)
* Deploy Kubeflow with the [UI](/docs/gke/deploy/deploy-ui)
Choose one of the following ways to deploy Kubeflow:

* Using the [CLI](/docs/gke/deploy/deploy-cli)
* Using the [UI](/docs/gke/deploy/deploy-ui)
@@ -1,6 +1,6 @@
+++
title = "Set up a GCP Project"
description = "Instructions for creating a GCP project for using Kubeflow"
description = "How to create a GCP project for your Kubeflow deployment"
weight = 1
+++

@@ -39,7 +39,9 @@ cluster for you.

## Next steps

* [Set up an OAuth credential](/docs/gke/deploy/oauth-setup) if you want to use [identity aware proxy(IAP)](https://cloud.google.com/iap/docs/)
* Deploy Kubeflow
* using the [CLI](/docs/gke/deploy/deploy-cli)
* using [UI](/docs/gke/deploy/deploy-ui)
* [Set up an OAuth credential](/docs/gke/deploy/oauth-setup) if you want to use
[identity aware proxy (IAP)](https://cloud.google.com/iap/docs/)
* Choose one of the following ways to deploy Kubeflow:

* Using the [CLI](/docs/gke/deploy/deploy-cli)
* Using the [UI](/docs/gke/deploy/deploy-ui)
@@ -189,8 +189,8 @@ Set up the following environment variables for use throughout the tutorial:
## Deploy Kubeflow

Follow the instructions in the
[GKE getting-started guide](/docs/started/getting-started-gke)
to deploy Kubeflow on GCP, taking note of the following:
guide to [deploying Kubeflow on GCP](/docs/gke/deploy/),
taking note of the following:

* Set up **OAuth client credentials** and **Cloud Identity-Aware Proxy (IAP)**
as prompted during the deployment process. So, **do not choose the deployment
@@ -10,8 +10,7 @@ Kubernetes Engine (GKE).
## Before you start

This guide assumes you have already set up Kubeflow with GKE. If you haven't done
so, follow the guide to
[getting started with Kubeflow on Kubernetes Engine](/docs/started/getting-started-gke).
so, follow the guide to [deploying Kubeflow on GCP](/docs/gke/deploy/).

## Private clusters

@@ -10,7 +10,7 @@ Google Kubernetes Engine (GKE) and Google Cloud Platform (GCP).
## Before you start

This guide covers troubleshooting specifically for
[Kubeflow deployments on GKE](/docs/started/getting-started-gke).
[Kubeflow deployments on GCP](/docs/gke/deploy/).

For more help, try the
[general Kubeflow troubleshooting guide](/docs/other-guides/troubleshooting).
@@ -4,12 +4,12 @@ description = "How to access the Kubeflow web UIs"
weight = 15
+++

Kubeflow includes a number of web UIs. This document provides instructions on
how to connect to them.
Kubeflow includes a number of web user interfaces (UIs). This document provides
instructions on how to connect to them.

## Accessing Kubeflow Web UIs
## Accessing Kubeflow web UIs

Kubeflow comes with a number of web UIs e.g.
Kubeflow comes with a number of web UIs, including:

* Argo UI
* Central UI for navigation
@@ -31,26 +31,27 @@ bar. The landing page looks like this:

## Google Cloud Platform (Kubernetes Engine)

If you followed the [guide for Kubernetes Engine](/docs/started/getting-started-gke), Kubeflow will be deployed with
IAP or Basic Auth and the landing page will be accessible at
If you followed the guide to [deploying Kubeflow on GCP](/docs/gke/deploy/), Kubeflow
is deployed with Cloud Identity-Aware Proxy (Cloud IAP) or basic authentication,
and the Kubeflow landing page is accessible at a URL of the following pattern:

```
https://<name>.endpoints.<project>.cloud.goog/
```

This will bring up the landing page illustrated above.
This URL brings up the landing page illustrated above.

## Using Kubectl and port-forwarding

You can use the following command to setup port forwarding to the
You can use the following command to set up port forwarding to the
[Ambassador](https://www.getambassador.io/) service that provides the reverse proxy.

```
export NAMESPACE=kubeflow
kubectl port-forward svc/ambassador -n ${NAMESPACE} 8080:80
```

You can then access the central navigation dashboard at
You can then access the central navigation dashboard at:

```
http://localhost:8080/
@@ -34,8 +34,8 @@ In
[Kubeflow v0.1.3 and later](https://github.com/kubeflow/pipelines/releases/tag/0.1.3),
Kubeflow Pipelines is one of the Kubeflow core components. It's
automatically deployed during Kubeflow deployment. You can try it currently
with a Kubeflow deployment on GKE. See the
[GKE setup guide](/docs/started/getting-started-gke/).
with a Kubeflow deployment on GKE in Google Cloud Platform (GCP). See the guide
to [deploying Kubeflow on GCP](/docs/gke/deploy/).

{{% pipelines-compatibility %}}

@@ -12,8 +12,8 @@ Kubeflow Pipelines. If you need a more in-depth guide, see the

Follow these steps to deploy Kubeflow and open the pipelines dashboard:

1. Follow the [GKE setup guide](/docs/started/getting-started-gke/) to
deploy Kubeflow using the
1. Follow the guide to [deploying Kubeflow on GCP](/docs/gke/deploy/),
including the step to deploy Kubeflow using the
[Kubeflow deployment UI](https://deploy.kubeflow.cloud/).

{{% pipelines-compatibility %}}
@@ -85,7 +85,7 @@ you need to set up some GCP services for use by the sample.
Follow these steps to set up the necessary GCP services and run the sample:

1. In addition to the standard GCP APIs that you need for Kubeflow (see the
[GKE setup guide](/docs/started/getting-started-gke/)), ensure that the
[GCP setup guide](/docs/gke/deploy/project-setup)), ensure that the
following APIs are enabled:

* [Cloud Storage](https://console.cloud.google.com/apis/library/storage-component.googleapis.com)
@@ -82,8 +82,7 @@ Follow these steps to start a notebook:

1. Deploy Kubeflow and open the pipelines dashboard:

* Follow the
[Kubernetes Engine (GKE) setup guide](/docs/started/getting-started-gke/)
* Follow the [GCP deployment guide](/docs/gke/deploy/), including the step
to deploy Kubeflow using the
[Kubeflow deployment UI](https://deploy.kubeflow.cloud/).

@@ -137,7 +137,7 @@ Set up the following environment variables for use throughout the tutorial:
Deploy Kubeflow on GCP:

1. Follow the instructions in the
[GKE getting-started guide](/docs/started/getting-started-gke),
guide to [deploying Kubeflow on GCP](/docs/gke/deploy/),
taking note of the following:

* Make sure that you enable **Cloud Identity-Aware Proxy (IAP)**
Oops, something went wrong.

0 comments on commit d743387

Please sign in to comment.
You can’t perform that action at this time.