60bf770e62
* refactor `debugd` file structure * create `hack`-tool to deploy logcollection to non-debug clusters * integrate changes into CI * update fields * update workflow input names * use `working-directory` * add opensearch creds to upgrade workflow * make template func generic * make templating func generic * linebreaks * remove magic defaults * move `os.Exit` to main package * make logging index configurable * make templating generic * remove excess brace * update fields * copy fields * fix flag name * fix linter warnings Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> * remove unused workflow inputs * remove makefiles * fix command * bazel: fix output paths of container This fixes the output paths of builds within the container by mounting directories to paths that exist on the host. We also explicitly set the output path in a .bazelrc to the user specific path. The rc file is mounted into the container and overrides the host rc. Also adding automatic stop in case start is called and a containers is already running. Sym links like bazel-out and paths bazel outputs should generally work with this change. Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> * tabs -> spaces --------- Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| cmd | ||
| filebeat | ||
| internal | ||
| logstash | ||
| service | ||
| README.md | ||
debug daemon (debugd)
Debugd is a tool we built to allow for shorter iteration cycles during development.
The debugd gets embedded into OS images at the place where the bootstrapper normally sits.
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.
Subsequently you can initialize your cluster with constellation init as usual.
Build cdbg
mkdir -p build
cmake ..
make cdbg
debugd & cdbg usage
Before continuing, remember to set up your cloud credentials for the CLI to work.
With cdbg and yq installed in your path:
-
Run
constellation config generateto create a new default configuration -
Locate the latest debugd images by running
(cd internal/api/versionsapi/cli && go build -o versionsapi . && ./versionsapi latest --ref main --stream debug) -
Modify the
constellation-conf.yamlto use an image with the debugd already included and add required firewall rules:# Set full reference of cloud provider image name export IMAGE_URI=yq -i \ ".image = \"${IMAGE_URI}\" | \ .debugCluster = true" \ constellation-conf.yaml -
Run
constellation create […] -
Run
./cdbg deployBy default,
cdbgsearches for the bootstrapper in the current path (./bootstrapper). You can define a custom path by appending the argument--bootstrapper <path to bootstrapper>tocdbg deploy. -
Run
constellation init […]as usual
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.
On AWS, attach the SecretManagerE2E policy to your control-plane and worker node role.
When deploying with cdbg, enable by setting the logcollect=true and your name logcollect.admin=yourname.
./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
For QEMU, the credentials for Opensearch must be parsed via the info flag as well:
./cdbg deploy \
--info logcollect=true \
--info logcollect.admin=yourname \
--info qemu.opensearch-pw='xxxxxxx'
Remember to use single quotes for the password.
You will also need to increase the memory size of QEMU to 4GB.