Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-05-02 14:26:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

dev-docs: refactor and add information for newbies (#1912)

Browse source 
* 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>
This commit is contained in:
Adrian Stobbe 2023-06-19 17:39:43 +02:00 • committed by GitHub
parent be4a636361
commit 7dcd8c3dab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 501 additions and 350 deletions
Download patch file Download diff file Expand all files Collapse all files

46
dev-docs/workflows/create-debug-cluster.md Normal file
View file

@ -0,0 +1,46 @@
# 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
```