Dev Container

This page contains the configuration for a development container that provides a consistent environment for working with Terrakube.

The devcontainer includes all the necessary tools and dependencies to develop both the Java backend, TypeScript frontend components and includes terraform CLI.

Make sure The below was tested using Ubuntu-based distribution, not sure if this will work with macos, windows or codespaces

Features

• Java 17 (Liberica)

• Maven 3.9.9

• Node.js 20.x with Yarn

• VS Code extensions for Java, JavaScript/TypeScript

Getting Started

Prerequisites

• Visual Studio Code

• VS Code Remote - Containers extension

Local Development Domains

To use the devcontainer we need to setup the following domains in our local computer:

terrakube.platform.local
terrakube-api.platform.local
terrakube-registry.platform.local
terrakube-dex.platform.local

HTTPS Local Certificates

Install mkcert to generate the local certificates.

To generate local CA certificate execute the following:

mkcert -install
Created a new local CA 💥
The local CA is now installed in the system trust store! ⚡️
The local CA is now installed in the Firefox trust store (requires browser restart)! 🦊

Create Docker Network for the devcontainer

docker network create terrakube-network -d bridge --subnet 10.25.25.0/24 --gateway 10.25.25.254

We will be using 10.25.25.253 for our the traefik gateway

Local DNS entries

Update the /etc/hosts file adding the following entries:

10.25.25.253 terrakube.platform.local
10.25.25.253 terrakube-api.platform.local
10.25.25.253 terrakube-registry.platform.local
10.25.25.253 terrakube-dex.platform.local

Opening the Project in a Dev Container

• Clone the Terrakube repository and run the project:

  git clone https://github.com/AzBuilder/terrakube.git
  cd terrakube/.devcontainer
  mkcert -key-file key.pem -cert-file cert.pem platform.local *.platform.local
  CAROOT=$(mkcert -CAROOT)/rootCA.pem
  cp $CAROOT rootCA.pem
  cd ..
  code .

1. When prompted to "Reopen in Container", click "Reopen in Container". Alternatively, you can:

   • Press F1 or Ctrl+Shift+P

   • Type "Remote-Containers: Reopen in Container" and press Enter

2. Wait for the container to build and start. This may take a few minutes the first time.

3. Start all Terrakube components

   

4. Terrakube should be availabe with the following url https://terrakube.platform.local using [email protected] with password admin

   

Ports

The devcontainer forwards the following ports:

• 8080: Terrakube API

• 8075: Terrakube Registry

• 8090: Terrakube Executor

• 3000: Terrakube UI

• 80/443: Traefik Gateway

Customization

You can customize the devcontainer by modifying:

• .devcontainer/devcontainer.json: VS Code settings and extensions

• .devcontainer/Dockerfile: Container image configuration