Skip to content

Commit 09e44c2

Browse files
sarahmaddoxk8s-ci-robot
authored andcommitted
Clarified port forwarding and auth for GCP (#1083)
* Clarifies port forwarding and auth for GCP. * Fixed formatting. * Addressed review comments.
1 parent a8d9887 commit 09e44c2

File tree

5 files changed

+35
-44
lines changed

5 files changed

+35
-44
lines changed

content/docs/gke/deploy/deploy-cli.md

-2
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,6 @@ Follow these steps to deploy Kubeflow:
148148
[Cloud DNS](https://cloud.google.com/dns/docs/)
149149
then you can configure this process to be much faster.
150150
See [kubeflow/kubeflow#731](https://github.com/kubeflow/kubeflow/issues/731).
151-
* While you wait you can access Kubeflow services by using `kubectl proxy`
152-
and `kubectl port-forward` to connect to services in the cluster.
153151
154152
1. We recommend that you check in the contents of your **${KFAPP}** directory
155153
into source control.

content/docs/gke/deploy/deploy-ui.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,7 @@ Follow these steps to open the deployment UI and deploy Kubeflow on GCP:
3232

3333
* **Project:** Enter your GCP project ID.
3434
* **Deployment name:** Enter a short name that you can use to recognize this
35-
deployment of Kubeflow. If you plan to use [Cloud Identity-Aware Proxy
36-
(Cloud IAP)](https://cloud.google.com/iap/docs/) for access control (see
37-
the next option below), make sure you use the same deployment name
38-
on the deployment UI and when [creating the OAuth
39-
client ID](/docs/gke/deploy/oauth-setup/).
35+
deployment of Kubeflow.
4036
The maximum length for the deployment name is 25 characters.
4137
* **Choose how to connect to Kubeflow:** You can choose one of the
4238
following options:
@@ -49,9 +45,9 @@ Follow these steps to open the deployment UI and deploy Kubeflow on GCP:
4945
* **Login with Username Password:** Choose this option if you want to
5046
allow users to access Kubeflow with a username and password, that is,
5147
with basic authentication. See more details [below](#basic-auth).
52-
* **Setup Endpoint later:** Choose this option if you want to skip
53-
the authentication process and set up the URI for the Kubeflow UI later.
54-
See more details [below](#later-auth).
48+
* **Setup Endpoint later:** *(Not recommended.)* Choose this option if you
49+
want to skip the authentication process and set up the URI for the
50+
Kubeflow UI later. See more details [below](#later-auth).
5551

5652
* **GKE zone:** Enter the
5753
[GCP zone](https://cloud.google.com/compute/docs/regions-zones/) in which
@@ -120,16 +116,12 @@ password) to control access to Kubeflow.
120116
1. Click **Kubeflow Service Endpoint** to access your Kubeflow URI.
121117

122118
<a id="later-auth"></a>
123-
## Setting up your endpoint later
119+
## Setting up your endpoint later (not recommended)
124120

125121
You can choose to deploy Kubeflow without creating an endpoint for the Kubeflow
126122
service.
127123

128124
1. Choose the **Setup Endpoint later** option on the Kubeflow deployment UI.
129-
1. Click **Port Forward** to set up port forwarding and access your Kubeflow
130-
cluster at `http://localhost:8080/`. For more information about port
131-
forwarding, see the guide to
132-
[accessing the Kubeflow UIs](/docs/other-guides/accessing-uis/).
133125
1. Finish the setup later by inserting your OAuth client into the
134126
Kubeflow cluster. Read more about
135127
[customizing Kubeflow](/docs/gke/customizing-gke/) and

content/docs/gke/pipelines-tutorial.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,7 @@ Set up the following environment variables for use throughout the tutorial:
121121

122122
1. If you want a custom name for your Kubeflow deployment, set the
123123
`DEPLOYMENT_NAME` environment variable. The deployment name must be
124-
**4-20 characters** in length. Note that the name must be the same
125-
as the one you use in later steps of this tutorial when configuring the
126-
**redirect URI** for the OAuth client credentials. If you don't set this
124+
**4-20 characters** in length. If you don't set this
127125
environment variable, your deployment gets the default name of `kubeflow`:
128126

129127
```
@@ -212,11 +210,10 @@ Notes:
212210
213211
* It can take 10-15 minutes for the URI to become available. Kubeflow needs
214212
to provision a signed SSL certificate and register a DNS name.
215-
* If you own/manage the domain or a subdomain with [Cloud DNS][dns]
216-
then you can configure this process to be much faster. See
217-
[kubeflow/kubeflow#731](https://github.com/kubeflow/kubeflow/issues/731).
218-
* While you wait you can access Kubeflow services by using `kubectl proxy`
219-
and `kubectl port-forward` to connect to services in the cluster.
213+
214+
If you own/manage the domain or a subdomain with [Cloud DNS][dns]
215+
then you can configure this process to be much faster. See
216+
[kubeflow/kubeflow#731](https://github.com/kubeflow/kubeflow/issues/731).
220217
221218
### Create a Cloud Storage bucket
222219

content/docs/gke/troubleshooting-gke.md

-3
Original file line numberDiff line numberDiff line change
@@ -283,9 +283,6 @@ Events:
283283
284284
### Fixing the problem
285285
286-
Note: You can ignore the error you have not enabled Cloud IAP for the cluster,
287-
that is, if you are connecting via a port-forward.
288-
289286
If you have any redundant Kubeflow deployments, you can delete them using
290287
the [Deployment Manager](https://cloud.google.com/deployment-manager/docs/).
291288

content/docs/other-guides/accessing-uis.md

+25-18
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,9 @@ weight = 1
77
Kubeflow includes a number of web user interfaces (UIs). This document provides
88
instructions on how to connect to them.
99

10-
To access the Kubeflow UI's you need to connect to the
11-
[ISTIO gateway](https://istio.io/docs/concepts/traffic-management/#gateways) that
12-
provides access to the Kubeflow
13-
[service mesh](https://istio.io/docs/concepts/what-is-istio/#what-is-a-service-mesh).
14-
15-
How you access the ISTIO gateway will vary depending on how you've configured it.
10+
## Overview of Kubeflow UIs
1611

17-
18-
## Accessing Kubeflow web UIs
19-
20-
The Kubeflow web UIs include the following:
12+
The Kubeflow UIs include the following:
2113

2214
* A central **Kubeflow** UI for navigation between the Kubeflow applications.
2315
* **Pipelines** for a Kubeflow Pipelines dashboard
@@ -36,6 +28,15 @@ The central UI dashboard looks like this:
3628
alt="Kubeflow central UI"
3729
class="mt-3 mb-3 border border-info rounded">
3830

31+
## Overview of accessing the Kubeflow UIs
32+
33+
To access the Kubeflow UIs, you need to connect to the
34+
[Istio gateway](https://istio.io/docs/concepts/traffic-management/#gateways) that
35+
provides access to the Kubeflow
36+
[service mesh](https://istio.io/docs/concepts/what-is-istio/#what-is-a-service-mesh).
37+
38+
How you access the Istio gateway varies depending on how you've configured it.
39+
3940
## URL pattern with Google Cloud Platform (GCP)
4041

4142
If you followed the guide to [deploying Kubeflow on GCP](/docs/gke/deploy/),
@@ -56,14 +57,22 @@ guide to
5657
## Using kubectl and port-forwarding
5758

5859
If you didn't configure Kubeflow to integrate with an identity provider and perform
59-
any authorization then you can port-forward directly to the ISTIO gateway.
60+
any authorization then you can port-forward directly to the Istio gateway.
61+
62+
Port-forwarding typically does not work if any of the following are true:
6063

61-
Port-forwarding typically won't work if any of the following are true
64+
* You've deployed Kubeflow on GCP using the
65+
[GCP deployment UI](/docs/gke/deploy/deploy-ui/) or the default settings
66+
with the [CLI deployment](/docs/gke/deploy/deploy-cli/). (If you want to
67+
use port forwarding, you must deploy Kubeflow on an existing Kubernetes
68+
cluster using the [`kfctl_k8s_istio`
69+
configuration](/docs/started/k8s/kfctl-k8s-istio/).)
6270

63-
* you've configured the ISTIO ingress to only accept
64-
HTTPS traffic on a specific domain or IP address
71+
* You've configured the Istio ingress to only accept
72+
HTTPS traffic on a specific domain or IP address.
6573

66-
* you've configured the ISTIO ingress to perform an authorization check (e.g. using IAP or Dex)
74+
* You've configured the Istio ingress to perform an authorization check
75+
(for example, using Cloud IAP or [Dex](https://github.com/dexidp/dex)).
6776

6877

6978
You can access Kubeflow via `kubectl` and port-forwarding as follows:
@@ -76,7 +85,7 @@ You can access Kubeflow via `kubectl` and port-forwarding as follows:
7685
installation guide](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
7786

7887
1. Use the following command to set up port forwarding to the
79-
[ISTIO gateway](https://istio.io/docs/tasks/traffic-management/ingress/ingress-control/).
88+
[Istio gateway](https://istio.io/docs/tasks/traffic-management/ingress/ingress-control/).
8089

8190
{{% code-webui-port-forward %}}
8291

@@ -86,8 +95,6 @@ You can access Kubeflow via `kubectl` and port-forwarding as follows:
8695
http://localhost:8080/
8796
```
8897
89-
* Port-forwarding will not work if you're using basic authentication with GCP.
90-
9198
* Depending on how you've configured Kubeflow, not all UIs work behind
9299
port-forwarding to the reverse proxy.
93100

0 commit comments

Comments
 (0)