https://github.com/datawire/kubernaut

Instant ephemeral Kubernetes clusters for development and testing
https://github.com/datawire/kubernaut

developer-tools kubernetes kubernetes-deployment kubernetes-setup microservices testing-tools

Last synced: 5 months ago
JSON representation

Instant ephemeral Kubernetes clusters for development and testing

• Host: GitHub
• URL: https://github.com/datawire/kubernaut
• Owner: datawire
• License: apache-2.0
• Created: 2017-07-24T14:06:21.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T01:17:24.000Z (over 3 years ago)
• Last Synced: 2025-12-07T18:11:55.598Z (6 months ago)
• Topics: developer-tools, kubernetes, kubernetes-deployment, kubernetes-setup, microservices, testing-tools
• Language: Python
• Homepage:
• Size: 166 KB
• Stars: 116
• Watchers: 7
• Forks: 8
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Kubernaut

[![Build Status](https://travis-ci.org/datawire/kubernaut.svg?branch=master)](https://travis-ci.org/datawire/kubernaut)

Ephemeral Kubernetes clusters for frustration and friction free development. This is the `kubernaut` CLI.

# Installation

An executable binary is provided for both Linux and MacOS. There is no Windows support at this time. 

## Native Installation

Latest release: `curl http://releases.datawire.io/kubernaut/latest.txt`

### Linux

`curl -OL http://releases.datawire.io/kubernaut/$(curl http://releases.datawire.io/kubernaut/latest.txt)/linux/amd64/kubernaut`

### macOS

`curl -OL http://releases.datawire.io/kubernaut/$(curl http://releases.datawire.io/kubernaut/latest.txt)/darwin/amd64/kubernaut`

# Quick Start

## Get Token

**NOTE**: This is temporary until we have a better account mgmt and login UX.

1. Goto https://kubernaut.io/token and login.

2. Copy the token to your clipboard.

3. Run the below command:

`kubernaut config backend create --url="https://next.kubernaut.io" --name="v2" --activate $TOKEN`

## Create a cluster claim

`kubernaut claims create --name mycluster`

## View active Claims

`kubernaut claims list`

## Delete a cluster claim

`kubernaut claims delete mycluster`

# Developer Information

## Versioning

The `kubernaut` command line application uses [Calendar Versioning ("CalVer")](https://calver.org/) for releases.

- The version scheme is `${YYYY}.${MM}.${DD}[-${GIT_COMMIT}]`.

- Latest releases always have the `${GIT_COMMIT}` appended after a dash.

- Latest releases are any build from `master` branch that passes CI tests. 

- **FUTURE** - Stable release cadence has not been determined but *WILL HAVE* the form `${YYYY}.${MM}.${DD}` without the `${GIT_COMMIT}` appended.