Awesome

What is Kurtosis?

Have you ever tried to build on top of a colleague's work, or contribute to an open source project, just to get stuck on the first steps of spinning up a stack to play with? Kurtosis handles the complexity of spinning up ephemeral dev or test stacks so you can focus on developing, not configuring.

Kurtosis is formed of:

A packaging system for distributing backend stack definitions, which can run on docker or on kubernetes
A runtime with a per-stack file management system for reproducibly initializing the state of your stack
A set of tools to enable devs to interact with their stacks, like they do on docker or k8s

Why use Kurtosis?

Kurtosis is best for:

Reusing the logic in your stack definitions for all of: local dev, scheduled testing in CI, and ad-hoc larger-scale testing on k8s clusters
Giving other devs a way to spin up your application, and commonly used variations of it, with one-liners, via Kurtosis' packaging and parameterization systems
Handling complex setup logic in your backend stack, like passing arbitrary data between services as they start up, and enforcing arbitrary wait conditions

How is Kurtosis different than Docker Compose or Helm?

Kurtosis operates at a level higher than Docker Compose or Helm, and produces stacks running on either of the underlying engines (the Docker engine, or Kubernetes). Because of this additional layer of abstraction, we are able to introduce several features to improve the experience of spinning up ephemeral stacks:

A per-stack file management system that enables portable state initialization for dev or test stacks
Stack-level parameterizability; users have a powerful and flexible way (beyond messing with env vars) to affect modifications in their stacks
First-class plug-and-play composability; it's expected for users to import stack definitions into larger stacks, and this experience is optimized
The ability to get all of the above, but running over either the docker engine or k8s, at your election

How do I get going?

To see Kurtosis in action, first install it using the instructions here.

Then, run the Redis voting app Kurtosis package:

kurtosis run github.com/kurtosis-tech/awesome-kurtosis/redis-voting-app

Finally, open the http link printed in the last line in your browser.

If you have an issue or feature request, we'd love to hear about it through one of the following:

Post your question on our Github Discussions Forum
Asking for help on our Discord server
Filing an issue on our Github (which can also be done via kurtosis feedback --bug or kurtosis feedback --feature)
Messaging us on Twitter

Going further

To try more Kurtosis packages just like this one, check out the awesome-kurtosis repo!

To learn about how to write Kurtosis packages, check out our quickstart.

To read about how Kurtosis works, see our documentation.

To see where we're going with the product, check out the roadmap here.

Got more questions? Drop them in our Github Discussions where we, or other community members, can help answer.

Contributing to Kurtosis

<details> <summary>Expand to see contribution info</summary>

See our CONTRIBUTING file.

Repository Structure

This repository is structured as a monorepo, containing the following projects:

container-engine-lib: Library used to abstract away container engine being used by the enclave.
core: Container launched inside an enclave to coordinate its state
engine: Container launched to coordinate enclaves
api: Defines the API of the Kurtosis platform (engine and core)
cli: Produces CLI binary, allowing interaction with the Kurtosis system
docs: Documentation that is published to docs.kurtosis.com
internal_testsuites: End to end tests

Dev Dependencies (Nix)

Install the Nix package manager.

sh <(curl -L https://nixos.org/nix/install)

And enable some Nix flags (alternatively you can add --extra-experimental-features 'nix-command flakes' every time calling the nix command):

mkdir -p ~/.config/nix
echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf

And to bring the environment up, just open a new shell terminal, go to the root folder of the repo and run:

nix  develop

This will download all dev deps and setup the environment accordingly.

You can also use the direnv to automatically load the environment when entering the main folder or using a plugin in your preferred IDE:

vscode: mkhl.direnv
jet brains: Direnv integration

Direnv can also be easily installed with Nix (or HomeBrew if you prefer):

nix-env -f '<nixpkgs>' -iA direnv

Now you just to add the direnv hook to your shell:

echo 'eval "$(direnv hook bash)"' >> ~/.bashrc
# or for ZSH
echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc

Now next time you open a new shell terminal and go to repo's folder you environment will update and load automatically.

Dev Dependencies (Manual install)

The commands below assume that the env variable BREW_PREFIX contains the brew prefix.

BREW_PREFIX="$(brew --prefix)"

Bash (5 or above)

On MacOS:

# Install modern version of bash, the one that ships on MacOS is too old
brew install bash
# Allow bash as shell
echo "${BREW_PREFIX}/bin/bash" | sudo tee -a /etc/shells
# Optional: make bash your default shell
chsh -s "${BREW_PREFIX}/bin/bash"

Git

On MacOS:

# Install modern version of git, the one that ships on MacOS can be too old
brew install git

Docker

On MacOS:

brew install docker

Go (1.20 or above)

On MacOS:

brew install go@1.20
# Add the Go binary dir to your PATH
PATH="${BREW_PREFIX}/opt/go@1.20/bin:$PATH"
# Add the GOPATH bin dir to your PATH
PATH="${HOME}/go/bin:$PATH"

On Ubuntu:

wget https://go.dev/dl/go1.20.8.linux-amd64.tar.gz
tar -C /usr/local -zxf go1.20.8.linux-amd64.tar.gz
# Add the following to your bashrc or equivalent.
export PATH=$PATH:/usr/local/go/bin

Goreleaser

On MacOS:

brew install goreleaser/tap/goreleaser

On Ubuntu:

echo 'deb [trusted=yes] https://repo.goreleaser.com/apt/ /' | sudo tee /etc/apt/sources.list.d/goreleaser.list
sudo apt update
sudo apt install goreleaser

Node (20.* or above) and Yarn

On MacOS, using NVM:

brew install nvm
mkdir ~/.nvm
nvm install 20.11.0
npm install -g yarn

On Ubuntu, using NVM:

curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
source ~/.bashrc
nvm install 20.11.0
npm install -g yarn

Rust

On MacOS, Ubuntu:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Go and Typescript protobuf compiler binaries

On MacOS:

brew install protoc-gen-go
brew install protoc-gen-go-grpc
go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest
yarn global add ts-protoc-gen
yarn global add grpc-tools

On Ubuntu:

go install google.golang.org/grpc/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest
yarn global add ts-protoc-gen
yarn global add grpc-tools

OpenAPI generators for Go and Typescript

On MacOS:

go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.16.2
yarn global add openapi-typescript@7.0.0-next.5

On Ubuntu:

go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.16.2
yarn global add openapi-typescript@7.0.0-next.5

Build Instructions

To build the entire project, run:

./scripts/build.sh

To only build a specific project, run the script on ./PROJECT/PATH/script/build.sh, for example:

./container-engine-lib/scripts/build.sh
./core/scripts/build.sh
./api/scripts/build.sh
./engine/scripts/build.sh
./cli/scripts/build.sh

If there are any changes to the Protobuf files in the api subdirectory, the Protobuf bindings must be regenerated:

./api/scripts/regenerate-protobuf-bindings.sh

Build scripts also run unit tests as part of the build process.

Unit Test Instructions

For all Go modules, run go test ./... on the module folder. For example:

cd cli/cli/
go test ./...

E2E Test Instructions

Each project's build script also runs the unit tests inside the project. Running ./script/build.sh will guarantee that all unit tests in the monorepo pass.

To run the end-to-end tests:

Make sure Docker is running

$ docker --version
Docker version X.Y.Z

Make sure Kurtosis Engine is running

$ kurtosis engine status
A Kurtosis engine is running with the following info:
Version:   0.X.Y

Run test.sh script

$ ./internal_testsuites/scripts/test.sh

If you are developing the Typescript test, make sure that you have first built api/typescript. Any changes made to the Typescript package within api/typescript aren't hot loaded as of 2022-09-29.

Dev Run Instructions

Once the project has built, run ./cli/cli/scripts/launch-cli.sh as if it was the kurtosis command:

./cli/cli/scripts/launch-cli.sh enclave add

If you want tab completion on the recently built CLI, you can alias it to kurtosis:

alias kurtosis="$(pwd)/cli/cli/scripts/launch-cli.sh"
kurtosis enclave add

Run Debug Instructions (for Golang code so far)

For running CLI with Golang remote debug:

Build the CLI dev binary and run the command you want to debug (kurtosis version in this example), this will start the debug server and will wait for a client connection

cli/cli/scripts/build.sh
source ./scripts/set_kt_alias.sh
ktdebug version

Open the command's file you want to debug
Add the breakpoint in the line where you want to stop the cursor <img src="./readme-static-files/goland-breakpoint.png" />
Then choose the "CLI-remote-debug" run configuration in the "run panel"
Press the "debug" button <img src="./readme-static-files/goland-debug-button.png" />
Use the debug panel to inspect the variables value and continue with the debug flow <img src="./readme-static-files/goland-debug-panel.png" />

For running CLI with Delve debug client:

Build the CLI dev binary and run the command you want to debug (kurtosis version in this example), but first pass "dlv-terminal" as the first argument (this will start the Delve client in the terminal)

cli/cli/scripts/build.sh
source ./scripts/set_kt_alias.sh
ktdebug dlv-terminal version

You can add a new breakpoint using the terminal client and the break command

(dlv) break version.run:1

You can move the cursor to the breakpoint created in the previous step with the continue command

(dlv) continue

<img src="./readme-static-files/dlv-terminal.png" /> 4. You can see [more Delve commands here][delve-docs]

For running Kurtosis engine with Golang remote debug:

Run the main build script with the first argument debug_mode as true. This will generate a new Kurtosis engine container image which will contain the debug suffix in the name.

scripts/build.sh true

Add the breakpoint in the line where you want to stop the cursor <img src="./readme-static-files/goland-engine-breakpoint.png" />
Run the engine in debug mode with the ktdev engine start --debug-mode or the ktdev engine restart --debug-mode commands

source ./scripts/set_kt_alias.sh
ktdev engine start --debug-mode

Then choose the "Engine-remote-debug" run configuration in the "run panel"
Press the "debug" button <img src="./readme-static-files/goland-engine-debug-button.png" />
Make a call to the engine's server (you can use the Kurtosis CLI or Postman) in order to reach out the breakpoint in the code
Use the debug panel to inspect the variables value and continue with the debug flow <img src="./readme-static-files/goland-debug-panel.png" />
You can debug the CLI and the Kurtosis engine's server at the same time by running it with ktdebug instead of ktdev mentioned in a previous step, remember to run both remote debug configurations in the Goland IDE.

source ./scripts/set_kt_alias.sh
ktdebug engine start

Additional steps if you are debugging Kurtosis engine in K8s:

Upload the engine's image for debug to the K8s cluster

# for example:
k3d image load kurtosistech/engine:5ec6eb-dirty-debug

Run the port-forward script before pressing the debug button in Golang (in another terminal instance) to bind the host's port to the container's debug server port

scripts/port-forward-engine-debug.sh

Do not forget to run the Kurtosis gateway after calling the engine's server (in another terminal instance also)

ktdev gateway

For running Kurtosis APIC with Golang remote debug:

Run the main build script with the first argument debug_mode as true. This will generate a new Kurtosis APIC container image which will contain the debug suffix in the name.

scripts/build.sh true

Add the breakpoint in the line where you want to stop the cursor. <img src="./readme-static-files/goland-apic-breakpoint.png" />
Run the Kurtosis engine in debug more or not depending on if you want to also debug the engine.

source ./scripts/set_kt_alias.sh
ktdev engine start --debug-mode

OR

ktdev engine start # you will have to build the engine in the regular way `engine/scripts/build.sh` if you choose this version

Add a new enclave in debug mode with the enclave add command and passing the debug-mode flag. This will create a new APIC container with the debug server port bounded and waiting for a connection. IMPORTANT: You can only run one enclave in debug mode so far, if you want to run another one it will fail due the debug port is already in use,

ktdev enclave add --debug-mode

Then choose the "APIC-remote-debug" run configuration in the "run panel"
Press the "debug" button <img src="./readme-static-files/goland-apic-debug-button.png" />
Find the APIC's GRPC server port in the host machine (you can check it in Docker Desktop or using the Docker CLI, it's the one bounded with the container's 7443 port)
Make a call to the APIC's server (you can use the Kurtosis CLI or Postman) in order to reach out the breakpoint in the code
Use the debug panel to inspect the variables value and continue with the debug flow <img src="./readme-static-files/goland-debug-panel.png" />
You can debug the CLI, the Kurtosis engine's server and the Kurtosis APIC's server at the same time by running it with ktdebug instead of ktdev mentioned in a previous step, remember to run the three remote debug configurations in the Goland IDE.

source ./scripts/set_kt_alias.sh
ktdev engine start --debug-mode
ktdebug enclave add

Additional steps if you are debugging Kurtosis engine in K8s:

Upload the APIC's image for debug to the K8s cluster

# for example:
k3d image load kurtosistech/core:5ec6eb-dirty-debug

Run the port-forward script before pressing the debug button in Golang (in another terminal instance) to bind the host's port to the container's debug server port

scripts/port-forward-apic-debug.sh enclave-name

Do not forget to run the Kurtosis gateway after calling the APIC's server (in another terminal instance also)

ktdev gateway

</details>