k8s ingress explained

Expose kubernetes services with nginx / traefik ingress for spring-boot services in k8s with skaffold

                 +---------------------------------------------+
                 |                        +-------+            |
                 |      K8S               | hello |<---+       |
  O       +---------+                     +-------+    |       |
 /|\ <--> | Ingress | <---+                            |       |
 / \      +---------+     |    +----------+      +----------+  |
                 |        +--> | frontend | ---> | greeting |  |
                 |             +----------+      +----------+  |
                 +---------------------------------------------+

table of content

1. version: 0.0.1
   • local workflow
     • hello
     • greeting
     • frontend
   • maven-release-plugin
2. version: 0.0.2
   • gib-maven-plugin
     • fat jar configuration
     • thin jar configuration
     • debug jib images
   • fabric8 docker-maven-plugin
     • configuration
     • build, run and test
   • dkanejs docker-compose-maven-plugin
     • configuration
     • build, run and test
3. 0.0.3: kubernetes skaffold workflow
   • k8s resources
   • skaffold docker for mac / windows
4. version: 0.0.4
   • k8s nginx ingress for Docker for Mac / Windows
     • nginx ingress default backend
     • nginx ingress rewrite-target
   • k8s traefik ingress for k3d k3s
     • traefik ingress default backend
     • traefik ingress PathPrefixStrip
5. resources

features

• k8s, k3s, k3d
• skaffold in multi-project
• fabric8 docker-compose wait
• docker-compose with fabric8 docker-maven-plugin
• jib thin jar
• jib fat jar
• spring.factories auto-configurations
• spring-boot maven multi-module project

local

local hello-variants-service

./mvnw -f hello-variants-service clean spring-boot:run &
http :8001/api/hello/find-all-hello
http post :8001/actuator/shutdown

local greeting-service

./mvnw -f greeting-service clean spring-boot:run &
http :8003/api/greeting/find-all-greetings
http :8003/api/greeting/find-all-greetings/max
http post :8003/actuator/shutdown

local frontend

./mvnw -f frontend clean spring-boot:run &
http :8004/api/greeting/find-all-hello
http :8004/api/greeting/find-all-greetings
http :8004/api/greeting/find-all-greetings/max
http post :8004/actuator/shutdown

GIB

requires: Docker

• Add Google jib maven plugin in pom.xml file for spring-boot all applications / services

fat jar configuration

<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>jib-maven-plugin</artifactId>
    <version>${jib-maven-plugin.version}</version>
    <configuration>
        <containerizingMode>packaged</containerizingMode>
        <container>
            <appRoot>/tmp</appRoot>
            <useCurrentTimestamp>true</useCurrentTimestamp>
            <entrypoint>
                <shell>bash</shell>
                <option>-c</option>
                <arg>java -cp /tmp/classpath:/tmp/*.jar</arg>
            </entrypoint>
            <args>
                <arg>/bin/bash</arg>
            </args>
        </container>
        <from>
            <image>openjdk:11.0.5-jre-stretch</image>
        </from>
        <to>
            <image>daggerok/${project.parent.artifactId}-${project.artifactId}</image>
            <tags>
                <tag>${project.version}</tag>
                <tag>latest</tag>
            </tags>
        </to>
    </configuration>
</plugin>

thin jar configuration

<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>jib-maven-plugin</artifactId>
    <version>${jib-maven-plugin.version}</version>
    <configuration>
        <allowInsecureRegistries>true</allowInsecureRegistries>
        <container>
            <creationTime>USE_CURRENT_TIMESTAMP</creationTime>
        </container>
        <to>
            <image>daggerok/${project.parent.artifactId}-${project.artifactId}</image>
            <tags>
                <tag>${project.version}</tag>
                <tag>latest</tag>
            </tags>
        </to>
    </configuration>
</plugin>

debug jib

make sure you are using:

<from>
    <!--<image>gcr.io/distroless/java:11</image>-->
    <image>gcr.io/distroless/java:11-debug</image>
</from>

then build jib image and run command:

docker run -it \
    --entrypoint /busybox/sh \
    --network docker_k8s-ingress-explained \
    daggerok/k8s-ingress-explained-frontend:latest

fabric8

fabric8 configuration

<plugin>
    <groupId>io.fabric8</groupId>
    <artifactId>docker-maven-plugin</artifactId>
    <version>${docker-maven-plugin.version}</version>
    <configuration>
        <follow>false</follow>
        <verbose>true</verbose>
        <useColor>true</useColor>
        <logDate>default</logDate>
        <autoPull>always</autoPull>
        <keepRunning>false</keepRunning>
        <watchInterval>500</watchInterval>
        <allContainers>true</allContainers>
        <removeVolumes>true</removeVolumes>
        <imagePullPolicy>IfNotPresent</imagePullPolicy>
        <autoCreateCustomNetworks>true</autoCreateCustomNetworks>
        <images>
            <image>
                <alias>frontend</alias>
                <external>
                    <type>compose</type>
                    <basedir>src/main/docker</basedir>
                    <composeFile>docker-compose.yml</composeFile>
                </external>
                <run>
                    <wait>
                        <http>
                            <url>http://127.0.0.1:8004/find-all-greetings/ready</url>
                            <method>GET</method>
                            <status>200</status>
                        </http>
                        <time>100000</time>
                    </wait>
                </run>
            </image>
        </images>
    </configuration>
</plugin>

run with fabric8

build jib docker images and run everything using fabric8 maven docker-compose

./mvnw clean package jib:dockerBuild
./mvnw -f docker-compose -Pstart
http :8004/find-all-hello
http :8004/find-all-greetings
./mvnw -f docker-compose -Pstop

dkanejs docker-compose-maven-plugin

dkanejs configuration

<plugin>
    <groupId>com.dkanejs.maven.plugins</groupId>
    <artifactId>docker-compose-maven-plugin</artifactId>
    <version>${docker-compose-maven-plugin.version}</version>
    <configuration>
        <detail>true</detail>
        <verbose>false</verbose>
        <detachedMode>true</detachedMode>
        <ignorePullFailures>true</ignorePullFailures>
        <removeImagesType>local</removeImagesType>
        <removeImages>true</removeImages>
        <removeOrphans>true</removeOrphans>
        <removeVolumes>true</removeVolumes>
        <composeFile>${project.basedir}/src/main/docker/docker-compose.yaml</composeFile>
    </configuration>
</plugin>

run using dkanejs docker-compose-maven-plugin

build jib docker images and run everything using dkanejs docker-compose-maven-plugin

./mvnw clean package jib:dockerBuild
./mvnw -f docker-compose -Pup
http :8004/find-all-hello
http :8004/find-all-greetings
./mvnw -f docker-compose -Pdown

k8s + skaffold

k8s

prepared kubernetes resources can be found in k8s folder

skaffold

with k8s based on docker for mac / windows

brew reinstall skaffold
skaffold init --skip-build
vi ./skaffold.yaml
# ...
skaffold dev --cache-artifacts=false
http :30001/info
http :30003/info
http :30004/info
http :30004/find-all-hello
http :30004/find-all-greetings
# ...
skaffold delete

k8s nginx ingress for Docker for Mac

nginx ingress default backend

Default backend for fronted application or main micro-services gateway, see k8s/ingress/ingress-docker-for-mac-nginx-default-backend.yaml k8s resources file for details

# enable Kubernetes cluster in DOcker for Mac / Windows...
# watch pods...
kubectl get pods --all-namespaces -o wide -w &
# deploy cloud native micro-services apps and ingress
kubectl apply -f k8s/
kubectl apply -f k8s/ingress/ingress-docker-for-mac-nginx-default-backend.yaml
# wait more...
sleep 120s
# test if everything is working
http :/actuator/health
http :/actuator/info
http :/
http :/info
http :/find-all-hello
http :/find-all-greetings
http :/find-all-greetings/ololo-trololo
# cleanup
kubectl delete -f k8s/
kubectl delete -f k8s/ingress/

nginx ingress rewrite-target

Default backend with some rewrite targets, see k8s/ingress/ingress-docker-for-mac-nginx-rewrite-target.yaml k8s resources file for details

# enable Kubernetes cluster in DOcker for Mac / Windows...
# watch pods...
kubectl get pods --all-namespaces -o wide -w &
# deploy cloud native micro-services apps and ingress
kubectl apply -f k8s/
kubectl apply -f k8s/ingress/ingress-docker-for-mac-nginx-rewrite-target.yaml
# wait more...
sleep 120s
# test if everything is working
http :/actuator/health
http :/actuator/info
http :/
http :/info
http :/find-all-hello
http :/find-all-greetings
http :/find-all-greetings/ololo-trololo
# cleanup
kubectl delete -f k8s/
kubectl delete -f k8s/ingress/

k8s traefik ingress for k3d k3s

traefik ingress default backend

Default backend for fronted application or main micro-services gateway, see k8s/ingress/ingress-traefik-default-backend.yaml k8s resources file for details

# create k3s k8s cluster by using k3d tool (k3s in docker) with published port: 80
k3d create --name k3s --api-port 6551 --publish 80:80 --workers 1
# wait few moments
sleep 5s
# point kubectl to created k3s
export KUBECONFIG="$(k3d get-kubeconfig --name='k3s')"
# watch pods
kubectl get pods --all-namespaces -o wide -w &
# deploy cloud native micro-services apps and ingress
kubectl apply -f k8s/
kubectl apply -f k8s/ingress/ingress-traefik-default-backend.yaml
# wait more...
sleep 120s
# test if everything is working
http :/actuator/health
http :/actuator/info
http :/
http :/info
http :/find-all-hello
http :/find-all-greetings
http :/find-all-greetings/ololo-trololo
# cleanup
kubectl delete -f k8s/
kubectl delete -f k8s/ingress/
k3d stop --name=k3s -a
docker rm -f -v `docker ps -a -q`
rm -rf ~/.config/k3d/k3s

traefik ingress PathPrefixStrip

Default backend with some rewrite targets, see k8s/ingress/ingress-traefik-path-prefix-strip.yaml k8s resources file for details

# create k3s k8s cluster by using k3d tool (k3s in docker) with published port: 80
k3d create --name k3s --api-port 6551 --publish 80:80 --workers 1
# wait few moments
sleep 5s
# point kubectl to created k3s
export KUBECONFIG="$(k3d get-kubeconfig --name='k3s')"
# watch pods
kubectl get pods --all-namespaces -o wide -w &
# deploy cloud native micro-services apps and ingress
kubectl apply -f k8s/
kubectl apply -f k8s/ingress/ingress-traefik-path-prefix-strip.yaml
# wait more...
sleep 120s
# test if everything is working
http :/info
http :/greeting/info
http :/hello/info
# cleanup
kubectl delete -f k8s/
kubectl delete -f k8s/ingress/
k3d stop --name=k3s -a
docker rm -f -v `docker ps -a -q`
rm -rf ~/.config/k3d/k3s

Check k8s folder and .travis.yml file for details...

release and publish docker hub

./mvnw release:clean release:prepare release:perform --batch-mode ; ./mvnw package jib:build
# ./mvnw release:rollback

resources

• traefik-ingress rewrite
• GitHub: rancher/k3d
• GitHub: rancher/k3s
• k3s reference
• nginx-ingress rewrite
• ingress
• nginx-ingress: common
• nginx-ingress: docker for mac / windows
• nginx-ingress: bare-metal
• k8s ingress controllers
• k8s ingress minikube
• k8s service type: LoadBalancer
• k8s service type: NodePort
• Quarkus skaffold
• multi skaffold
• Spring WebFlux WebFilter
• spring-boot k8s
• spring k8s
• fabric8 docker-compose wait
• Shell in jib
• Using jib
• Using skaffold
• Using maven-release-plugin
• R2DBC H2
• R2DBC example
• R2DBC Homepage
• Spring Data R2DBC [Experimental]
• Spring Configuration Processor
• Spring Boot Maven Plugin Reference Guide
• Official Apache Maven documentation