Update the docs for private GKE. #2190

jlewi · 2020-09-14T14:19:36Z

Replace the instructions for private GKE with the instructions from the
repo: https://github.com/kubeflow/gcp-blueprints/blob/master/kubeflow/deploy_private.md
fix: [GCP] Update docs for private clusters and VPC service controls for 1.0 #1705

kubeflow-bot · 2020-09-14T14:19:42Z

This change is

jlewi · 2020-09-14T14:37:53Z

Preview
https://deploy-preview-2190--competent-brattain-de2d6d.netlify.app/docs/gke/private-clusters/

* Replace the instructions for private GKE with the instructions from the repo: https://github.com/kubeflow/gcp-blueprints/blob/master/kubeflow/deploy_private.md * fix: kubeflow#1705

jlewi · 2020-09-14T14:39:38Z

/assign @Bobgy
This should be ready for review.

Bobgy

/lgtm
Thanks!

/assign @joeliedtke
for tech writer review

Bobgy · 2020-09-16T02:59:35Z

content/en/docs/gke/private-clusters.md

+   * If this times out waiting for the cluster to be ready check if the reason the update failed is
+     because of [kubeflow/gcp-blueprints#34](https://github.com/kubeflow/gcp-blueprints/issues/35)


The issue has been fixed and closed, shall we remove this?

Bobgy · 2020-09-16T03:06:59Z

content/en/docs/gke/private-clusters.md


-          1. Remove the images from the `images` section
-          1. Remove it from the `steps` section
+    * DNS configurations - Check that the `DNSRecordSet` and `DNSManagedZone` CNRM resources are in a ready state


Sounds like it'll be better if we wait for all CNRM resources before continuing to apply other manifests.
Just a side note

8bitmp3

Hey @jlewi Thanks again!

I did a quick scan, here are some of my suggestions @Bobgy @joeliedtke :

Lines 12-13:
- "work around" -> "workaround" or "work-around"?
- For links: "text"
- Add a short description of the GitHub issue and provide a definition for CRD (CustomResourceDefinition(s) - one word, according to k8s docs):
  - "As a workaround for Issue (...Getting started guide for Microsoft Azure #32)[...32] (in CNRM 1.9.1, the CustomResourceDefinition (CRD) for container cluster is missing ipAllocationPolicy fields needed to create a private GKE cluster)..."
    - Should we be using "CustomResourceDefinitions" as one word as per k8s docs or three words on GCP docs?
- One word "containercluster" -> two words "container cluster"? (I couldn't find containercluster (one word) on Google Cloud docs unless it was a field/var name in some CLI output.)

1. As a workaround for Issue
   [kubeflow/gcp-blueprints#32](https://github.com/kubeflow/gcp-blueprints/issues/32)
   (in CNRM 1.9.1, the [CustomResourceDefinition
   (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)
   for container cluster is missing `ipAllocationPolicy` fields needed to create
   a private GKE cluster), modify the container cluster CRD schema in your
   management cluster to include the missing fields.

Add: "where {PKGDIR} is the directory..." (for Kubeflow that you created earlier)?
"1. Change to the Kubeflow directory" (<- "kubeflow")
Add back ticks: patchesStrategicMerge and resources
Add "Note:"

   *Note:* Do not use `kustomize edit` to perform the above actions until Issue [kubernetes-sigs/kustomize#2310](https://github.com/kubernetes-sigs/kustomize/issues/2310) is fixed.

Add full stops at the end of sentences.
"Sanity check" -> "double check" (less slang).
Line 194: Let's add a definition to "GCR", since it could be Google Cloud resources/Run/registry (depending on who's reading this).
Line 240: since there is already one troubleshooting section for KF on private GKE:

- * [Troubleshoot](/docs/gke/troubleshooting-gke) any issues you may
  find.
+ * [Troubleshoot](/docs/gke/troubleshooting-gke) any GKE issues you may
  find.

LMKWYT

content/en/docs/gke/private-clusters.md

8bitmp3 · 2020-09-16T12:18:45Z

content/en/docs/gke/private-clusters.md

-export PROJECT_NUMBER=$(gcloud projects describe ${PROJECT} --format='value(projectNumber)')
-```
+   1. Open `instance/gcp_config`
+   1. In patchesStrategicMerge add 


Suggested change

1. In patchesStrategicMerge add

1. In `patchesStrategicMerge`, add

content/en/docs/gke/private-clusters.md

8bitmp3 · 2020-09-16T12:30:50Z

content/en/docs/gke/private-clusters.md

+you will need to add an explict ingress firewall rule to allow that port to be accessed.
+
+These errors usually manifest as failures to create custom resources that depend on webhooks. An example
+error is


Suggested change

error is

error is:

content/en/docs/gke/private-clusters.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

jlewi · 2020-09-16T18:58:06Z

@8bitmp3 Thanks for all the great suggestions! I think I addressed all of them (may have missed one or two full stops).

@8bitmp3 I think the only use of containercluster is in a command

kubectl --context=$(MGMTCTXT) wait --for=condition=Ready --timeout=600s  containercluster $(NAME)

In this case there is no space; its one word.

Similarly I think for custom resource defintiion 3 words or 1 are both valid depending on whether you are using the actual resource name as it appears in APIs or more descriptively.

jlewi · 2020-09-17T13:59:24Z

/test all

jlewi · 2020-09-18T13:45:24Z

@8bitmp3 and @Bobgy Could one of you PTAL?

8bitmp3

@jlewi Thanks a million!

A few suggestions:

Line 10: The steps below 1. Follow the blueprint instructions to setup a management cluster - should be be indented to the right?
Line 20: Refactor to:

   * Check Issue [kubeflow/gcp-blueprints#32](https://github.com/kubeflow/gcp-blueprints/issues/32)
     to find out if it has been resolved in later versions of CNRM. If the issue hasn't been resolved, there should be directions for a workaround.

(or something along these lines)

Added back ticks around ${PKGDIR} and Makefile.
Added full stops (.) and colons (:) in sequential and non-sequential instructions for consistency.
Added commas and carried out some minor refactoring.
There was a space missing in * Google Container Registry (GCR) images can't be pulled.
Changed "Ensure" to "Make sure" (this is more formal, but to me it looks good either way).
To avoid repeating "issue" twice, refactored: * This likely indicates an issue with access to private GCR. This could be because of:
Added "and" -> * If image pull errors show IP addresses and not the restricted.googleapis.com VIP, then you have an issue with networking.

Obviously, these are just suggestions. LMKWYT!

cc @Bobgy

Cheers

content/en/docs/gke/private-clusters.md

8bitmp3 · 2020-09-18T19:02:29Z

content/en/docs/gke/private-clusters.md


-    Kubeflow uses IAP to make Kubeflow web apps accessible
-    from your browser.
+1. Follow the blueprint instructions to setup a management cluster


Line 10: The steps below 1. Follow the blueprint instructions to setup a management cluster - should be be indented to the right?

content/en/docs/gke/private-clusters.md

Bobgy · 2020-09-21T08:41:51Z

/lgtm
from my side

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

jlewi · 2020-09-21T14:53:49Z

Line 10: The steps below 1. Follow the blueprint instructions to setup a management cluster - should be be indented to the right?

This shouldn't be indented; the instructions below aren't setting up the management cluster. I added a link to the management cluster setup instructions.

jlewi · 2020-09-21T14:54:19Z

@8bitmp3 Thanks again! I incorporated all your suggestions. PTAL.

8bitmp3 · 2020-09-21T18:05:30Z

/lgtm

Thank you @jlewi !

Let's have an updated KF on private GKE doc on the site asap, since the current one is out of date. Any incremental improvements can be added later on.

@Bobgy WDYT?

8bitmp3

Hey @jlewi, I ran "private GKE" in the search bar:

I think maybe we could improve the UX by amending the title a little bit.

- title = "Securing Your Clusters"
+ title = "Securing Your Clusters with Private GKE"
description = "How to secure Kubeflow clusters using private GKE"

or

- title = "Securing Your Clusters"
+ title = "Securing Your Clusters on Private GKE"
description = "How to secure Kubeflow clusters using private GKE"

It would be similar to:

title = "Kubeflow On-premises on Anthos GKE"

LMKWYT

8bitmp3 · 2020-09-21T18:14:13Z

content/en/docs/gke/private-clusters.md

@@ -1,307 +1,247 @@
 +++
 title = "Securing Your Clusters"


Hey @jlewi, I ran "private GKE" in the search bar:

I think maybe we could improve the UX by amending the title a little bit.

- title = "Securing Your Clusters" + title = "Securing Your Clusters with Private GKE" description = "How to secure Kubeflow clusters using private GKE"

or

- title = "Securing Your Clusters" + title = "Securing Your Clusters on Private GKE" description = "How to secure Kubeflow clusters using private GKE"

It would be similar to:

title = "Kubeflow On-premises on Anthos GKE"

LMKWYT

Sounds good to me. I'll merge this PR first because the original one is out of date

Bobgy · 2020-09-22T06:48:22Z

/lgtm
/approve
Thank you both @jlewi @8bitmp3!

k8s-ci-robot · 2020-09-22T06:48:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bobgy

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/docs/gke/OWNERS~~ [Bobgy]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added the size/L label Sep 14, 2020

k8s-ci-robot requested review from 8bitmp3 and joeliedtke September 14, 2020 14:19

8bitmp3 mentioned this pull request Sep 14, 2020

[GCP] Update docs for private clusters and VPC service controls for 1.0 #1705

Closed

jlewi changed the title ~~Update the docs for private GKE.~~ WIP Update the docs for private GKE. Sep 14, 2020

k8s-ci-robot added the do-not-merge/work-in-progress label Sep 14, 2020

Update the docs for private GKE.

ae7bbdd

* Replace the instructions for private GKE with the instructions from the repo: https://github.com/kubeflow/gcp-blueprints/blob/master/kubeflow/deploy_private.md * fix: kubeflow#1705

jlewi force-pushed the private_gke_coming branch from 85d61f7 to ae7bbdd Compare September 14, 2020 14:38

jlewi changed the title ~~WIP Update the docs for private GKE.~~ Update the docs for private GKE. Sep 14, 2020

k8s-ci-robot removed the do-not-merge/work-in-progress label Sep 14, 2020

k8s-ci-robot assigned Bobgy Sep 14, 2020

Bobgy reviewed Sep 16, 2020

View reviewed changes

k8s-ci-robot assigned joeliedtke Sep 16, 2020

k8s-ci-robot added the lgtm label Sep 16, 2020

8bitmp3 suggested changes Sep 16, 2020

View reviewed changes

Update content/en/docs/gke/private-clusters.md

4cf5c1c

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

k8s-ci-robot removed the lgtm label Sep 16, 2020

jlewi and others added 2 commits September 16, 2020 06:24

Update content/en/docs/gke/private-clusters.md

90b26e2

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Update content/en/docs/gke/private-clusters.md

5eef99c

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

jlewi mentioned this pull request Sep 16, 2020

CNRM containercluster missing ipAllocationPolicy fields needed to create private GKE clusters GoogleCloudPlatform/kubeflow-distribution#32

Open

Address comments.

402a0a2

Jeremy Lewi added 2 commits September 17, 2020 07:02

Update the Anthos docs to point to the relevant GitHub issue.

be3cb31

Add some fullstops.

b2c0fdc

8bitmp3 suggested changes Sep 18, 2020

View reviewed changes

k8s-ci-robot added the lgtm label Sep 21, 2020

Update content/en/docs/gke/private-clusters.md

5964bb5

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

k8s-ci-robot removed the lgtm label Sep 21, 2020

jlewi and others added 8 commits September 21, 2020 07:42

Update content/en/docs/gke/private-clusters.md

244a89c

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Update content/en/docs/gke/private-clusters.md

54bb293

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Update content/en/docs/gke/private-clusters.md

a145799

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Update content/en/docs/gke/private-clusters.md

67eb31d

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Update content/en/docs/gke/private-clusters.md

78985ec

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Update content/en/docs/gke/private-clusters.md

c920e2b

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Update content/en/docs/gke/private-clusters.md

7fc5d88

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

More fixes.

0968cdb

k8s-ci-robot assigned 8bitmp3 Sep 21, 2020

k8s-ci-robot added the lgtm label Sep 21, 2020

8bitmp3 reviewed Sep 21, 2020

View reviewed changes

k8s-ci-robot added the approved label Sep 22, 2020

k8s-ci-robot merged commit c59e3ae into kubeflow:master Sep 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the docs for private GKE. #2190

Update the docs for private GKE. #2190

jlewi commented Sep 14, 2020

kubeflow-bot commented Sep 14, 2020

jlewi commented Sep 14, 2020

jlewi commented Sep 14, 2020

Bobgy left a comment

Bobgy Sep 16, 2020

jlewi Sep 16, 2020

Bobgy Sep 16, 2020

jlewi Sep 16, 2020

8bitmp3 left a comment •

edited

Loading

8bitmp3 Sep 16, 2020 •

edited

Loading

8bitmp3 Sep 16, 2020

jlewi Sep 16, 2020

jlewi commented Sep 16, 2020

jlewi commented Sep 17, 2020

jlewi commented Sep 18, 2020

8bitmp3 left a comment

8bitmp3 Sep 18, 2020

Bobgy commented Sep 21, 2020

jlewi commented Sep 21, 2020

jlewi commented Sep 21, 2020

8bitmp3 commented Sep 21, 2020

8bitmp3 left a comment

8bitmp3 Sep 21, 2020

Bobgy Sep 22, 2020

Bobgy commented Sep 22, 2020

k8s-ci-robot commented Sep 22, 2020

		* If this times out waiting for the cluster to be ready check if the reason the update failed is
		because of [kubeflow/gcp-blueprints#34](https://github.com/kubeflow/gcp-blueprints/issues/35)

	1. In patchesStrategicMerge add
	1. In `patchesStrategicMerge`, add

Update the docs for private GKE. #2190

Update the docs for private GKE. #2190

Conversation

jlewi commented Sep 14, 2020

kubeflow-bot commented Sep 14, 2020

jlewi commented Sep 14, 2020

jlewi commented Sep 14, 2020

Bobgy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

8bitmp3 left a comment • edited Loading

Choose a reason for hiding this comment

8bitmp3 Sep 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jlewi commented Sep 16, 2020

jlewi commented Sep 17, 2020

jlewi commented Sep 18, 2020

8bitmp3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bobgy commented Sep 21, 2020

jlewi commented Sep 21, 2020

jlewi commented Sep 21, 2020

8bitmp3 commented Sep 21, 2020

8bitmp3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bobgy commented Sep 22, 2020

k8s-ci-robot commented Sep 22, 2020

8bitmp3 left a comment •

edited

Loading

8bitmp3 Sep 16, 2020 •

edited

Loading