Skip to content

Commit 3a7a693

Browse files
mrutkowstekton-robot
authored andcommitted
Update Docker Desktop setup and separate out MiniKube setup
This PR seeks to separate out the MiniKube setup which somehow appears to have been placed under the Docker Desktop setup instructions. While doing this I thought to update the instructions to be more accurate relative to the Docker Desktop preferences and menuing system.
1 parent cb85f1d commit 3a7a693

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

DEVELOPMENT.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -95,32 +95,38 @@ The recommended configuration is:
9595
- Node autoscaling, up to 3 nodes
9696
- API scopes for cloud-platform
9797

98-
### To setup a cluster with Docker Desktop:
9998

100-
Docker Desktop using an edge version has been proven to work for both developing
101-
and running Pipelines.
99+
### To setup a cluster using MiniKube:
102100

103-
To use minikube:
101+
- Follow instructions for your platform to [Install Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) and start a session as follows:
104102

105103
```bash
106104
minikube start eval $(minikube docker-env)
107105
```
108106

109-
To use the Kubernetes that comes with Docker Desktop:
107+
### To setup a cluster with Docker Desktop:
108+
109+
Docker Desktop versions come integrated with an edge version of Kubernetes that has been proven to work for both developing and running Pipelines. To find out what Kubernetes a specific version of Docker Desktop includes, please refer to the release notes for your platform here: https://docs.docker.com/.
110+
111+
To enable the Kubernetes that comes with Docker Desktop:
112+
113+
1. From the Docker Desktop dropdown menu, open the `preferences...` interface.
114+
115+
1. Under the `Resources` tab ensure that in the `ADVANCED` menuitem you have at allocated at least 4 CPUs, 8.0 GiB Memory, and 1.0 GiB Swap.
110116

111-
1. First go into the Docker Desktop preferences. Under the resource tabs ensure
112-
that you have at least 4 CPUs, 8.0 GiB Memory, and 1.0 GiB Swap.
117+
1. Under the `Kubernetes` tab, check the `Enable Kubernetes` box.
113118

114-
1. Under the Kubernetes tab, enable Kubernetes.
119+
* *Note: the Kubernetes version Docker Desktop will use is displayed at the top of the window.*
115120

116-
1. Click the Apply and Restart button to save the preferences.
121+
1. Click the `Apply and Restart` button to save the preferences.
117122

118123
1. Switch the proper `kubectl` config context:
119124

120125
```bash
121126
kubectl config get-contexts # You should see docker-for-desktop in the previous command output
122127
kubectl config use-context docker-for-desktop
123128
```
129+
* *Note: Docker Desktop menu provides a `Kubernetes` menuitem that allows you to select between contexts which is equivalent to the `kubectl` command.*
124130

125131
### To setup a cluster with GKE:
126132

docs/tutorial.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -602,9 +602,9 @@ You must reconfigure any `image` resource definitions in your `PipelineResources
602602
Complete these prerequisites to run this tutorial locally using Minikube:
603603

604604
- Install the [required tools](https://github.com/tektoncd/pipeline/blob/master/DEVELOPMENT.md#requirements).
605-
- Install [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) and start a sesion as follows:
605+
- Install [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) and start a session as follows:
606606
```bash
607-
minikube start --memory 6144 --cpus 2
607+
minikube start --memory 6144 --cpus 2
608608
```
609609
- Point your shell to minikube's docker-daemon by running `eval $(minikube -p minikube docker-env)`
610610
- Set up a [registry on minikube](https://github.com/kubernetes/minikube/tree/master/deploy/addons/registry-aliases) by running `minikube addons enable registry` and `minikube addons enable registry-aliases`
@@ -614,15 +614,15 @@ minikube start --memory 6144 --cpus 2
614614
The `registry-aliases` addon will create several aliases for the minikube registry. You'll need to reconfigure your `image` resource definitions to use one of these aliases in your `PipelineResources` (for this tutorial, we use `example.com`; for a full list of aliases, you can run `minikube ssh -- cat /etc/hosts`. You can also configure your own alias by editing minikube's `/etc/hosts` file and the `coredns` configmap in the `kube-system` namespace).
615615

616616
- Set the URL to `example.com/<image_name>`
617-
- When using `ko`, be sure to [use the `-L` flag](https://github.com/google/ko/blob/master/README.md#with-minikube) (i.e. `ko apply -L -f config/`)
617+
- When using `ko`, be sure to [use the `-L` flag](https://github.com/google/ko/blob/master/README.md#with-minikube) (i.e. `ko apply -L -f config/`)
618618
- Set your applications (such as deployment definitions) to push to
619619
`example.com/<image name>`.
620620

621621
If you wish to use a different image URL, you can add the appropriate line to minikube's `/etc/hosts`.
622622

623623
### Reconfigure logging
624624

625-
See the information in the "Docker for Desktop" section
625+
See the information in the "Docker for Desktop" section
626626

627627
## Further reading
628628

0 commit comments

Comments
 (0)