/--- title: Deploy a local Kubernetes Cluster

Deploy a local Kubernetes Cluster ¶

If you do not have access to a managed Kubernetes cluster you can deploy one on your local machine or or a virtual machine (VM). This document describes deploying a cluster with kind and also for minikube. Refer to the documentation of each product for additional information.

Demo Use Only

The instructions in this document are for testing and learning, and not intended for use in production.

Why not Docker Desktop?

The processes outlined on this page will create either a Kubernetes in Docker (kind) or a minikube cluster. In both cases, the cluster you get is very similar in functionality to the Docker Desktop implementation of Kubernetes. However, a distinct advantage of both offerings is portability (not requiring Docker Desktop). As with the Getting Started example, the files provided will enable and deploy an ingress controller for communicating with the services in the cluster from your local environment.

Kubernetes in Docker Desktop

To use the both examples below, you will need to ensure the Kubernetes feature of Docker Desktop is turned off, as it will conflict.

Docker System Resources

This note applies only if using Docker as a backing for either solution. kind uses Docker by default, and it is also an option for minikube. Docker on Linux is typically installed with root privileges and thus has access to the full resources of the machine. Docker Desktop for Mac and Windows provides a way to set the resources allocated to Docker. For this documentation, a Macbook Pro was configured to use 6 CPUs and 12 GB Memory. You can adjust these values as necessary for your needs.

Kind cluster ¶

This section will cover the kind installation process. See the section further down for minikube instructions.

Prerequisites ¶

docker
kubectl
ports 80 and 443 available on machine

Kubernetes Version

For this guide, the kind implementation of Kubernetes 1.27.3 is used. It is deployed using version 0.20.0 of kind.

Docker Desktop Version

At the time of the writing of this guide, Docker Desktop was version 4.25.2 (129061), which used Docker Engine 24.0.6.

Install and confirm the cluster ¶

Install kind on your platform.
Use the provided sample kind.yaml file to create a kind cluster named ping with ingress support enabled. From the root of your copy of the repository code, run:
```
kind create cluster --config=./20-kubernetes/kind.yaml
```
Output:

Test cluster health by running the following commands:

kubectl cluster-info

# Output - port will vary
Kubernetes control plane is running at https://127.0.0.1:57627
CoreDNS is running at https://127.0.0.1:57627/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy

To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

------------------

kubectl version

< output clipped >
Server Version: v1.27.3

------------------

kubectl get nodes

NAME                 STATUS   ROLES           AGE     VERSION
ping-control-plane   Ready    control-plane   38s     v1.27.3

Enable ingress ¶

Next, install the nginx-ingress-controller for kind (version 1.9.4 at the time of this writing). In the event the Github file is unavailable, a copy has been made to this repository here.

To use the Github file:

kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.9.4/deploy/static/provider/kind/deploy.yaml

To use the local copy:

kubectl apply -f ./20-kubernetes/kind-nginx.yaml

Output:

namespace/ingress-nginx created
serviceaccount/ingress-nginx created
serviceaccount/ingress-nginx-admission created
role.rbac.authorization.k8s.io/ingress-nginx created
role.rbac.authorization.k8s.io/ingress-nginx-admission created
clusterrole.rbac.authorization.k8s.io/ingress-nginx created
clusterrole.rbac.authorization.k8s.io/ingress-nginx-admission created
rolebinding.rbac.authorization.k8s.io/ingress-nginx created
rolebinding.rbac.authorization.k8s.io/ingress-nginx-admission created
clusterrolebinding.rbac.authorization.k8s.io/ingress-nginx created
clusterrolebinding.rbac.authorization.k8s.io/ingress-nginx-admission created
configmap/ingress-nginx-controller created
service/ingress-nginx-controller created
service/ingress-nginx-controller-admission created
deployment.apps/ingress-nginx-controller created
job.batch/ingress-nginx-admission-create created
job.batch/ingress-nginx-admission-patch created
ingressclass.networking.k8s.io/nginx created
networkpolicy.networking.k8s.io/ingress-nginx-admission created
validatingwebhookconfiguration.admissionregistration.k8s.io/ingress-nginx-admission created

To wait for the Nginx ingress to reach a healthy state, run the following command. You can also observe the pod status using k9s or by running kubectl get pods --namespace ingress-nginx. You should see one controller pod running when the ingress controller is ready. This command should exit after no more than 90 seconds or so, depending on the speed of your computer:
```
kubectl wait --namespace ingress-nginx \
  --for=condition=ready pod \
  --selector=app.kubernetes.io/component=controller \
  --timeout=90s
```

Verify nginx-ingress-controller is working:

curl localhost

Output:

<html>
<head><title>404 Not Found</title></head>
<body>
<center><h1>404 Not Found</h1></center>
<hr><center>nginx</center>
</body>
</html>

Our examples will use the Helm release name myping and DNS domain suffix pingdemo.example for accessing applications. You can add all expected hosts to /etc/hosts:

echo '127.0.0.1 myping-pingaccess-admin.pingdemo.example myping-pingaccess-engine.pingdemo.example myping-pingauthorize.pingdemo.example myping-pingauthorizepap.pingdemo.example myping-pingdataconsole.pingdemo.example myping-pingdelegator.pingdemo.example myping-pingdirectory.pingdemo.example myping-pingfederate-admin.pingdemo.example myping-pingfederate-engine.pingdemo.example myping-pingcentral.pingdemo.example' | sudo tee -a /etc/hosts > /dev/null

Setup is complete. This local Kubernetes environment should be ready to deploy our Helm examples

Stop the cluster ¶

When you are finished, you can remove the cluster by running the following command, which removes the cluster completely. You will be required to recreate the cluster and reinstall the ingress controller to use kind again.

kind delete cluster --name ping

Minikube cluster ¶

In this section, a minikube installation with ingress is created. Minikube is simpler than kind overall to configure, but ends up needing one step to configured a tunnel to the cluster that must be managed. For this guide, the Docker driver will be used. As with kind above, Kubernetes in Docker Desktop must be disabled.

Prerequisites ¶

Container or virtual machine manager, such as: Docker, QEMU, Hyperkit, Hyper-V, KVM, Parallels, Podman, VirtualBox, or VMware Fusion/Workstation
kubectl

Minikube and Kubernetes Version

At the time of the writing of this guide, minikube was version 1.32.0, which installs Kubernetes version 1.28.3.

Install and configure minikube ¶

Install minikube for your platform. See the product Get Started! page for details.
Configure the minikube resources and virtualization driver. For example, the following options were used on an Apple Macbook Pro with Docker as the backing platform:
```
minikube config set cpus 6
minikube config set driver docker
minikube config set memory 12g
```
Configuration

See the documentation for more details on configuring minikube.
Start the cluster. Optionally you can include a profile flag (--profile <name>). Naming the cluster enables you to run multiple minikube clusters simultaneously. If you use a profile name, you will need to include it on other minikube commands.
```
minikube start --addons=ingress --kubernetes-version=v1.28.3
```
Output:

Test cluster health by running the following commands:

kubectl cluster-info

# Output - Port will vary
Kubernetes control plane is running at https://127.0.0.1:62531
CoreDNS is running at https://127.0.0.1:62531/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy

To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

------------------

kubectl version

< output clipped >
Server Version: v1.28.3

------------------

kubectl get nodes

NAME       STATUS   ROLES           AGE    VERSION
minikube   Ready    control-plane   4m6s   v1.28.3

Confirm ingress ¶

Confirm ingress is operational:

kubectl get po -n ingress-nginx

NAME                                        READY   STATUS      RESTARTS   AGE
ingress-nginx-admission-create-lr2x2        0/1     Completed   0          174m
ingress-nginx-admission-patch-bjgnn         0/1     Completed   1          174m
ingress-nginx-controller-6cc5ccb977-9n66n   1/1     Running     0          174m

Deploy a test application

Use the following YAML file to create a Pod, Service and Ingress:

apiVersion: v1
kind: Pod
metadata:
  name: example-web-pod
  labels:
    role: webserver
spec:
  containers:
    - name: web
      image: nginx
      ports:
        - name: web
          containerPort: 80
          protocol: TCP
---
apiVersion: v1
kind: Service
metadata:
  name: example-svc
spec:
  selector:
    role: webserver
  ports:
    - protocol: TCP
      port: 80
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: example-ingress
  namespace: default
  annotations:
    spec.ingressClassName: nginx
spec:
  rules:
    - host: example.k8s.local
      http:
        paths:
          - backend:
              service:
                name: example-svc
                port:
                  number: 80
            path: /
            pathType: Prefix

kubectl apply -f test.yaml

pod/example-web-pod created
service/example-svc created
ingress.networking.k8s.io/example-ingress created

Add an alias to the application to /etc/hosts

echo '127.0.0.1 example.k8s.local' | sudo tee -a /etc/hosts > /dev/null

Start a tunnel. This command will tie up the terminal:

minikube tunnel

✅  Tunnel successfully started

📌  NOTE: Please do not close this terminal as this process must stay alive for the tunnel to be accessible ...

❗  The service/ingress example-ingress requires privileged ports to be exposed: [80 443]
🔑  sudo permission will be asked for it.
🏃  Starting tunnel for service example-ingress.

Open a browser to http://example.k8s.local. You should see the Nginx landing page.

Clean up tests
```
kubectl delete -f test.yaml
```

Our examples will use the Helm release name myping and DNS domain suffix pingdemo.example for accessing applications. You can add all expected hosts to /etc/hosts:

echo '127.0.0.1 myping-pingaccess-admin.pingdemo.example myping-pingaccess-engine.pingdemo.example myping-pingauthorize.pingdemo.example myping-pingauthorizepap.pingdemo.example myping-pingdataconsole.pingdemo.example myping-pingdelegator.pingdemo.example myping-pingdirectory.pingdemo.example myping-pingfederate-admin.pingdemo.example myping-pingfederate-engine.pingdemo.example myping-pingcentral.pingdemo.example' | sudo tee -a /etc/hosts > /dev/null

Setup is complete. This local Kubernetes environment should be ready to deploy our Helm examples

Optional features ¶

Dashboard ¶

Minikube provides other add-ons that enhance your experience when working with your cluster. One such add-on is the Dashboard, which can also provide metrics as follows:

minikube addons enable metrics-server
minikube dashboard

Multiple nodes ¶

If you have enough system resources, you can create a multi-node cluster.

For example, to start a 3-node cluster:

minikube start --nodes 3

Resources

Keep in mind that each node will receive the RAM/CPU/Disk configured for minikube. Using the example configuration provided above, a 3-node cluster would need 36GB of RAM and 18 CPUs.

Stop the cluster ¶

When you are finished, you can stop the cluster by running the following command. Stopping retains the configuration and state of the cluster (namespaces, deployments, and so on) that will be restored when starting the cluster again.

minikube stop

You can also pause and unpause the cluster:

minikube pause
minikube unpause

Alternatively, you can delete the minikube environment, which will recreate everything the next time.

minikube delete