Vega Development Kit (VDK)

Develop Kubernetes applications locally with ease using KinD (Kubernetes in Docker).

VDK is a Command Line Interface (CLI) tool designed to help developers quickly and securely set up local Kubernetes clusters using KinD. It simplifies the process of creating clusters with varying configurations (versions, node counts) to assist in building and testing applications for platforms like Vega.

Overview

Building and testing applications designed for Kubernetes often requires a realistic cluster environment. VDK streamlines the setup of local clusters via KinD, providing commands to:

• Create single or multi-node Kubernetes clusters.
• Specify desired Kubernetes versions.
• Manage the lifecycle of these local clusters (list, delete).
• Easily integrate with kubectl.

This tool is particularly useful for developers working on the Vega platform, enabling consistent and reproducible development environments.

Installation

For detailed installation instructions for your operating system, please refer to the Getting Started Guide.

Prerequisites:

• Docker
• kubectl (Recommended for interacting with clusters)

For development prerequisites (Devbox/Nix), see the Getting Started Guide.

Quick Start

1. Create a default cluster:

   vdk create cluster

   (This may take a few minutes)

2. Verify cluster access:

   kubectl cluster-info --context kind-kind

3. Delete the cluster:

   vdk delete cluster

Usage

For comprehensive usage details, examples, and command references, please see the Usage Documentation:

• Creating Clusters
• Managing Clusters
• Command Reference

Contributing

We welcome contributions! Please read our Contribution Guidelines and Development Setup guides to get started.

Debugging & Troubleshooting

If you encounter issues while using VDK, consult the Troubleshooting Guide.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details. (Ensure a LICENSE file exists)

Getting Started

• Install DevBox

    curl -fsSL https://get.jetify.com/devbox | bash

• Clone the repository git clone https://github.com/ArchetypicalSoftware/VDK.git
• Start DevBox session in the cloned repository

    devbox shell

• Run vega --help to see the available commands

Configuration options

If you already have a process listening on your host on port 443, you will have issues with the vega reverse proxy. You can either stop the existing process or change the port by defining the environment variable REVERSE_PROXY_HOST_PORT. The default port is 443.