mirror of
https://github.com/edgelesssys/constellation.git
synced 2024-12-27 16:39:38 -05:00
7dcd8c3dab
* 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>
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# 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](./build-develop-deploy.md#build)), you can find all CLIs and binaries in the `build` directory.
|
|
|
|
The cluster creation mostly follows the [official docs instructions](https://docs.edgeless.systems/constellation/getting-started/first-steps), 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
|
|
|
|
```sh
|
|
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:
|
|
|
|
```sh
|
|
yq eval -i '.debugCluster=true' constellation-conf.yaml
|
|
```
|
|
|
|
Fetch measurements for the debug image:
|
|
|
|
```sh
|
|
./constellation config fetch-measurements --insecure
|
|
```
|
|
|
|
Create the cluster and deploy the debug images:
|
|
|
|
```sh
|
|
./constellation create ...
|
|
```
|
|
|
|
```sh
|
|
./cdbg deploy
|
|
```
|
|
|
|
Finally run:
|
|
|
|
```sh
|
|
./constellation init
|
|
```
|