constellation/dev-docs/workflows/create-debug-cluster.md
Adrian Stobbe 7dcd8c3dab
dev-docs: refactor and add information for newbies (#1912)
* refactor dev-docs structure and add information

* improve doc

* Update dev-docs/workflows/create-debug-cluster.md

Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com>

* Update dev-docs/workflows/create-debug-cluster.md

Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com>

* pr feedback daniel

* Update dev-docs/README.md

Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com>

* move to howto again

* split up dev-setup and pull-request into sep files

* fix backticks

* add writing style convention + testing repo

* remove OSS cluster + reduce plugins vs code

* update bazel pre-pr doc

* ghcr img private hint

* add fetch measurement + provider sub-directory hint

* add label doc + pr title check in template

* add OSS build comment

* Update CONTRIBUTING.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* Update CONTRIBUTING.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* Update dev-docs/README.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* Update dev-docs/workflows/dev-setup.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* thomas feedback

* add go proverb mention

---------

Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com>
Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
2023-06-19 17:39:43 +02:00

1.2 KiB

Creating a Debug cluster

A debug cluster allows quicker iteration cycles during development by being able to upload new bootstrapper binaries through the cdbg tool.

After building (see here), you can find all CLIs and binaries in the build directory.

The cluster creation mostly follows the official docs instructions, but varies slightly in the following steps:

./constellation config generate <CSP> by default uses the referenced nightly image. To replace them with the latest debug image, run

bazel run //internal/api/versionsapi/cli -- latest --ref main --stream debug

to fetch the latest version and insert in the image field of the config file.

Before cluster creation you need to configure the cluster as debug. Set debugCluster: true in the config:

yq eval -i '.debugCluster=true' constellation-conf.yaml

Fetch measurements for the debug image:

./constellation config fetch-measurements --insecure

Create the cluster and deploy the debug images:

./constellation create ...
./cdbg deploy

Finally run:

./constellation init