Kubernetes Hello World Kustomization

A Kuberbetes Kustomization KRM config example to run the kubernetes-hello-world-api project.

Table of contents

• Table of contents
• Prerequisites
• Getting started
  • 1. Start the local registry
  • 2. Create the Kubernetes cluster
  • 3. Apply the Kubernetes Resource Model (KRM) using Kustomize
  • 4. Gain (easy) access

Prerequisites

• Docker
• Kind
• kubectl
• Kustomize

Getting started

Before we begin, make sure that you have the adjacent kubernetes-hello-world-api project and build the corresponding Docker image using the commands in the project's README.md.

It is also worth viewing the Makefile in this project. This houses most of the initial commands to manage the cluster.

1. Start the local registry

In order to serve local Docker images to your Kubernetes cluster, we firstly need to call a script that will pull and run another Docker a registry container.

make local-registry

At this point, you should run the make docker-build-and-push-local command in the kubernetes-hello-world-api project to make the API Docker image available locally.

2. Create the Kubernetes cluster

This will create the cluster and configure it to use the local Docker registry. It will also ensure that the local registry is running prior to the cluster's creation.

make create-cluster

3. Apply the Kubernetes Resource Model (KRM) using Kustomize

Now the cluster is running, you can now apply the KRM object configuration,

make apply-kustomize-base

You can monitor the deployment rollout(s) by running the following command,

kubectl get pods -w

NAME                                         READY   STATUS    RESTARTS   AGE
hello-world-api-deployment-c8457c4df-nss7g   1/1     Running   0          11m
hello-world-api-deployment-c8457c4df-wjm5v   1/1     Running   0          11m

4. Gain (easy) access

You can gain access to the hosted API using port forwarding to create a local relationship to the containerized API service.

kubectl port-forward service/hello-world-api-service 8080:80
Forwarding from 127.0.0.1:8080 -> 3000
Forwarding from [::1]:8080 -> 3000

curl http://127.0.0.1:8080/v1/hello/
{"message":"Hello world"}