From e83aa5ffcaed07ee176135b957f7934f40837a11 Mon Sep 17 00:00:00 2001 From: Justin Kulikauskas <44813129+JustinKuli@users.noreply.github.com> Date: Thu, 21 May 2020 13:30:45 -0400 Subject: [PATCH] Improve formatting of Docker Desktop instructions --- DEVELOPMENT.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 96194da4a3e..218121c5752 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -88,25 +88,41 @@ configuring Kubernetes resources. ## Kubernetes cluster -Docker for Desktop using an edge version has been proven to work for both -developing and running Pipelines. The recommended configuration is: +The recommended configuration is: - Kubernetes version 1.15 or later - 4 vCPU nodes (`n1-standard-4`) - Node autoscaling, up to 3 nodes - API scopes for cloud-platform -To setup a cluster with Docker on Desktop: +### To setup a cluster with Docker Desktop: -To use minikube: `bash minikube start eval $(minikube docker-env)` +Docker Desktop using an edge version has been proven to work for both developing +and running Pipelines. -To use the Kubernetes that comes with Docker for Desktop: 1. First go into the -Docker For Desktop preferences. Under the resource tabs ensure that you have at -least 4 CPUs, 8.0 GiB Memory, and 1.0 GiB Swap. 1. Under the Kubernetes tab, -enable Kubernetes. 1. Click the Apply and Restart button to save the -preferences. 1. Switch the proper `kubectl` config context: `bash kubectl config -get-contexts # You should see docker-for-desktop in the previous command output -kubectl config use-context docker-for-desktop` To setup a cluster with GKE: +To use minikube: + +```bash +minikube start eval $(minikube docker-env)` +``` + +To use the Kubernetes that comes with Docker Desktop: + +1. First go into the Docker Desktop preferences. Under the resource tabs ensure + that you have at least 4 CPUs, 8.0 GiB Memory, and 1.0 GiB Swap. + +1. Under the Kubernetes tab, enable Kubernetes. + +1. Click the Apply and Restart button to save the preferences. + +1. Switch the proper `kubectl` config context: + + ```bash + kubectl config get-contexts # You should see docker-for-desktop in the previous command output + kubectl config use-context docker-for-desktop + ``` + +### To setup a cluster with GKE: 1. [Install required tools and setup GCP project](https://knative.dev/v0.12-docs/install/knative-with-gke/) (You may find it useful to save the ID of the project in an environment