Skip to content

Latest commit

 

History

History
144 lines (94 loc) · 4.61 KB

DEV-GUIDE.md

File metadata and controls

144 lines (94 loc) · 4.61 KB
Raw

Development Guide

This document explains how to build and run Unguard locally inside Kubernetes using skaffold.

Warning: Most of the services rely on the Kubernetes DNS. If you must deploy some parts of the application without a Kubernetes cluster, read the READMEs of the individual services instead.

🗒️ Prerequisites

⛵ Local Cluster

🅰 First-Time Cluster Setup

  1. Launch a local Kubernetes cluster

    • Launch a kind cluster with extraPortMappings for the local ingress

      kind create cluster --name unguard --config ./k8s-manifests/localdev/kind/cluster-config.yaml
      • Optionally add an nginx ingress controller if you want to expose Unguard locally without port-forwarding 
        kubectl apply -k ./k8s-manifests/localdev/kind/

    • Or, launch a minikube cluster with the ingress addon

      minikube start --addons=ingress --profile unguard

  2. Run kubectl get nodes to verify the connection to the respective control plane

🅱 Application Deployment

  1. Use skaffold to build and deploy the application. The first full build will take up to 20 minutes. If the images should be rebuilt automatically, run skaffold dev.

    skaffold run

  2. Add an entry in your /etc/hosts file to access the ingress exposing the frontend on unguard.kube

    • For kind clusters, append this to /etc/hosts:
    127.0.0.1 unguard.kube
    • For minikube clusters, execute this in your shell or manually add the output of minikube -p unguard ip to your /etc/hosts file
    sudo -- sh -c "echo $(minikube -p unguard ip) unguard.kube >> /etc/hosts"

🔥 Cleanup

Run skaffold delete with the chosen profile used to start unguard to clean up the deployed resources.

skaffold delete [-p <profile>]

🙋‍♀️ FAQ

What are skaffold profiles?

Have a look at the profiles that are supported in skaffold.yaml. If you want to enable tracing use the tracing profile. See these instructions

skaffold run -p tracing

How can I have fast, incremental Java builds during development?

To benefit from incremental Java builds in the container, install OpenJDK 11 and Jib.

You may then append the jib profile which adapts the build section so that it uses your locally installed Jib.

skaffold run -p jib

How can I switch between multiple clusters?

Clusters are configured in ~/.kube/config.

To switch between different clusters (e.g., between aws and kind) set the current-context: to a cluster saved in the contexts: section.

A great tool that makes this process faster is kubectx.

Is there more?

Maybe you find something in the other FAQ document.

Troubleshooting

  1. Skaffold did not detect the running minikube:

    Skaffold normally detects reliably a running minikube and should adapt automatically, if not forwarding minikubes's docker daemon might help:

    For more information see :https://skaffold.dev/docs/environment/local-cluster/#auto-detection

    # on 🐧 Linux
eval $(minikube -p unguard docker-env)

# on 🍎 macOS
source <(minikube docker-env -p unguard)

# on 💻 Windows with PowerShell
& minikube -p unguard docker-env | Invoke-Expression

License

Copyright 2023 Dynatrace LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.