Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-09-19 15:56:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
5e1c09bdd6
constellation/debugd/README.md

57 lines
2.0 KiB
Markdown
Raw Normal View History

readme: move debugd and local image testing to other files and add a component overview
2022-05-18 17:08:31 +00:00
# debug daemon (debugd)
AB#2369: Use contributing.md as ToC for dev docs. * Structure content into typical sections and split into separate files. * Also document how to locally create measurements Signed-off-by: Otto Bittner <cobittner@posteo.net>
2022-09-06 12:49:13 +00:00
Debugd is a tool we built to allow for shorter iteration cycles during development.
Remove all traces of CoreOS from the codebase
2022-10-21 08:16:44 +00:00
The debugd gets embedded into OS images at the place where the bootstrapper normally sits.
AB#2369: Use contributing.md as ToC for dev docs. * Structure content into typical sections and split into separate files. * Also document how to locally create measurements Signed-off-by: Otto Bittner <cobittner@posteo.net>
2022-09-06 12:49:13 +00:00
Therefore, when a debug image is started, the debugd starts executing instead of the bootstrapper.
The debugd will then wait for a request from the `cdbg` tool to upload a bootstrapper binary.
Once the upload is finished debugd will start the bootstrapper.
docs: refer to apply command instead of `init` or `upgrade apply` (#2487) Signed-off-by: Daniel Weiße <dw@edgeless.systems>
2023-10-27 06:30:59 +00:00
Subsequently you can initialize your cluster with `constellation apply` as usual.
AB#2369: Use contributing.md as ToC for dev docs. * Structure content into typical sections and split into separate files. * Also document how to locally create measurements Signed-off-by: Otto Bittner <cobittner@posteo.net>
2022-09-06 12:49:13 +00:00
Use cmake to compile debugd / cdbg Signed-off-by: Malte Poll <mp@edgeless.systems>
2022-05-23 10:13:23 +00:00
## Build cdbg
readme: move debugd and local image testing to other files and add a component overview
2022-05-18 17:08:31 +00:00
docs: improve developer documentation for folks new to the codebase * Correct example invocation of aws cli * Add warning to Helm Intellisense recommendation * Link code conventions in PR guidelines * Tighten debugd README * cmake is not used for building debugd anymore, remove references to it * make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places * Document that Bazel eats a lot of RAM
2023-11-17 18:16:52 +00:00
The `cdbg` tool is part of the `//:devbuild` target, if you follow the generic build instructions at [build-develop-deploy](../dev-docs/workflows/build-develop-deploy.md).
Fix gcp debug image command Signed-off-by: Daniel Weiße <dw@edgeless.systems>
2022-06-10 13:05:09 +00:00
docs: improve developer documentation for folks new to the codebase * Correct example invocation of aws cli * Add warning to Helm Intellisense recommendation * Link code conventions in PR guidelines * Tighten debugd README * cmake is not used for building debugd anymore, remove references to it * make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places * Document that Bazel eats a lot of RAM
2023-11-17 18:16:52 +00:00
If you need to build `cdbg` standalone for your current platform, you can run
Fix gcp debug image command Signed-off-by: Daniel Weiße <dw@edgeless.systems>
2022-06-10 13:05:09 +00:00
docs: improve developer documentation for folks new to the codebase * Correct example invocation of aws cli * Add warning to Helm Intellisense recommendation * Link code conventions in PR guidelines * Tighten debugd README * cmake is not used for building debugd anymore, remove references to it * make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places * Document that Bazel eats a lot of RAM
2023-11-17 18:16:52 +00:00
```sh
bazel build //debugd/cmd/cdbg:cdbg_host
```
readme: move debugd and local image testing to other files and add a component overview
2022-05-18 17:08:31 +00:00
docs: improve developer documentation for folks new to the codebase * Correct example invocation of aws cli * Add warning to Helm Intellisense recommendation * Link code conventions in PR guidelines * Tighten debugd README * cmake is not used for building debugd anymore, remove references to it * make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places * Document that Bazel eats a lot of RAM
2023-11-17 18:16:52 +00:00
## debugd & cdbg usage
Remove cdbg-config.yaml (#26) This removes systemd service upload support in cdbg, but keeps it in the protobuf protocol.
2022-08-31 10:25:27 +00:00
docs: improve developer documentation for folks new to the codebase * Correct example invocation of aws cli * Add warning to Helm Intellisense recommendation * Link code conventions in PR guidelines * Tighten debugd README * cmake is not used for building debugd anymore, remove references to it * make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places * Document that Bazel eats a lot of RAM
2023-11-17 18:16:52 +00:00
Follow the [debug-cluster workflow](../dev-docs/workflows/debug-cluster.md) to deploy a bootstrapper with `cdbg` and `debugd`.
readme: move debugd and local image testing to other files and add a component overview
2022-05-18 17:08:31 +00:00
debugd: document basic logcollection Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2022-11-30 09:43:09 +00:00
### Logcollection to Opensearch
You can enable the logcollection of debugd to send logs to Opensearch.
On Azure, ensure your user assigned identity has the `Key Vault Secrets User` role assigned on the key vault `opensearch-creds`.
debugd: document AWS IAM needed for log collection Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2022-12-13 10:03:41 +00:00
On AWS, attach the `SecretManagerE2E` policy to your control-plane and worker node role.
debugd: document basic logcollection Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2022-11-30 09:43:09 +00:00
When deploying with cdbg, enable by setting the `logcollect=true` and your name `logcollect.admin=yourname`.
```shell-session
./cdbg deploy --info logcollect=true,logcollect.admin=yourname
# OR
./cdbg deploy --info logcollect=true --info logcollect.admin=yourname
```
Other available fields can be found in [the filed list](/debugd/internal/debugd/logcollector/fields.go)
For QEMU, the credentials for Opensearch must be parsed via the info flag as well:
```shell-session
./cdbg deploy \
--info logcollect=true \
--info logcollect.admin=yourname \
--info qemu.opensearch-pw='xxxxxxx'
```
Remember to use single quotes for the password.
Remove cdbg-config.yaml (#26) This removes systemd service upload support in cdbg, but keeps it in the protobuf protocol.
2022-08-31 10:25:27 +00:00
debugd: add qemu logcollection memory requirement Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2022-12-01 06:59:28 +00:00
You will also need to increase the memory size of QEMU to 4GB.
Reference in New Issue Copy Permalink