Skip to content

Commit 733ced3

Browse files
committed
Update README.md
1 parent d42c1b0 commit 733ced3

File tree

1 file changed

+31
-32
lines changed

1 file changed

+31
-32
lines changed

README.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,13 @@ A picture serves to illustrate the communication:
3030
`sed -i.bak 's|'{GOPATH}'|'${GOPATH}'|g' cluster/config.yaml`
3131
```
3232

33-
<!-- To be checked! -->
33+
You can also open [config.yaml](cluster/config.yaml#L21) and replace `{GOPATH}` with the absolute path manually. If you already installed kind (Kubernetes in Docker) on your local system, you can create the cluster with this command:
3434

35+
```sh
36+
kind create cluster --config cluster/config.yaml --name=local-debug-k8s
37+
```
3538

36-
37-
You can also open [config.yaml](cluster/config.yaml#L21) and replace `{GOPATH}` with the absolute path manually:
38-
39-
extraMounts:
40-
- hostPath: {GOPATH}/src
41-
42-
Assuming you already have installed kind (Kubernetes in Docker) on your local machine, the cluster is created by the following command:
43-
44-
`kind create cluster --config cluster/config.yaml --name=local-debug-k8s`
45-
46-
The cluster has the name `local-debug-k8s` and is created with the custom configuration (parameter `--config cluster/config.yaml`). Let us take a look at `cluster/config.yaml` and explain it:
39+
Ensure that port 8090 and 30123 are not used on your local system. The newly created cluster has the name `local-debug-k8s` and has been created with custom configuration ( `--config cluster/config.yaml`). The following is a brief explanation:
4740

4841
```yml
4942
kind: Cluster
@@ -70,41 +63,47 @@ nodes:
7063
containerPath: /go/src # path to the project folder inside the worker node
7164
```
7265
73-
_Hint: make sure that ports 8090 and 30123 are free on your computer before you create the cluster_
66+
Desired result:
7467
75-
Output:
68+
```sh
69+
Creating cluster "local-debug-k8s" ...
70+
✓ Ensuring node image (kindest/node:v1.17.0) 🖼
71+
✓ Preparing nodes 📦 📦
72+
✓ Writing configuration 📜
73+
✓ Starting control-plane 🕹️
74+
✓ Installing CNI 🔌
75+
✓ Installing StorageClass 💾
76+
✓ Joining worker nodes 🚜
7677

77-
Creating cluster "local-debug-k8s" ...
78-
✓ Ensuring node image (kindest/node:v1.17.0) 🖼
79-
✓ Preparing nodes 📦 📦
80-
✓ Writing configuration 📜
81-
✓ Starting control-plane 🕹️
82-
✓ Installing CNI 🔌
83-
✓ Installing StorageClass 💾
84-
✓ Joining worker nodes 🚜
85-
Set kubectl context to "kind-local-debug-k8s"
86-
You can now use your cluster with:
78+
Set kubectl context to "kind-local-debug-k8s"
79+
You can now use your cluster with:
8780

88-
kubectl cluster-info --context kind-local-debug-k8s
81+
kubectl cluster-info --context kind-local-debug-k8s
8982

90-
Have a nice day! 👋
83+
Have a nice day! 👋
84+
```
9185

92-
Activate the kube-context, so that _kubectl_ can communicate with the newly created cluster:
86+
Activate the kube-context for `kubectl` to communicate with the new cluster:
9387

88+
```sh
9489
`kubectl cluster-info --context kind-local-debug-k8s`
90+
```
9591

9692
#### Install nginx-ingress
9793

98-
Source: <https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx>
94+
For both ports (8090 and 30123) to work it´s necessary to deploy a nginx controller:
9995

100-
In order to make both port mounts working (8090 and 30123), it is necessary to deploy the nginx controller as well.
101-
Run the following command for it:
96+
```sh
97+
kubectl create -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml
98+
```
10299

103-
`kubectl create -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml`
100+
Source: <https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx>
104101

105102
...and wait until nginx-controller runs:
106103

107-
`kubectl wait --namespace ingress-nginx --for=condition=ready pod --selector=app.kubernetes.io/component=controller --timeout=120s`
104+
```sh
105+
kubectl wait --namespace ingress-nginx --for=condition=ready pod --selector=app.kubernetes.io/component=controller --timeout=120s
106+
```
108107

109108
#### Labelling the worker node
110109

0 commit comments

Comments
 (0)