mirror of
https://github.com/edgelesssys/constellation.git
synced 2024-10-01 01:36:09 -04: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
This commit is contained in:
parent
e51513985a
commit
69c64d6c69
@ -9,43 +9,17 @@ Subsequently you can initialize your cluster with `constellation apply` as usual
|
||||
|
||||
## Build cdbg
|
||||
|
||||
```shell
|
||||
mkdir -p build
|
||||
cmake ..
|
||||
make cdbg
|
||||
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).
|
||||
|
||||
If you need to build `cdbg` standalone for your current platform, you can run
|
||||
|
||||
```sh
|
||||
bazel build //debugd/cmd/cdbg:cdbg_host
|
||||
```
|
||||
|
||||
## debugd & cdbg usage
|
||||
|
||||
Before continuing, remember to [set up](https://docs.edgeless.systems/constellation/getting-started/install#set-up-cloud-credentials) your cloud credentials for the CLI to work.
|
||||
|
||||
With `cdbg` and `yq` installed in your path:
|
||||
|
||||
1. Run `constellation config generate` to create a new default configuration
|
||||
|
||||
2. Locate the latest debugd images by running `(cd internal/api/versionsapi/cli && go build -o versionsapi . && ./versionsapi latest --ref main --stream debug)`
|
||||
|
||||
3. Modify the `constellation-conf.yaml` to use an image with the debugd already included and add required firewall rules:
|
||||
|
||||
```shell-session
|
||||
# Set full reference of cloud provider image name
|
||||
export IMAGE_URI=
|
||||
```
|
||||
|
||||
```shell-session
|
||||
yq -i \
|
||||
".image = \"${IMAGE_URI}\" | \
|
||||
.debugCluster = true" \
|
||||
constellation-conf.yaml
|
||||
```
|
||||
|
||||
4. Run `constellation create […]`
|
||||
|
||||
5. Run `./cdbg deploy`
|
||||
|
||||
By default, `cdbg` searches for the bootstrapper in the current path (`./bootstrapper`). You can define a custom path by appending the argument `--bootstrapper <path to bootstrapper>` to `cdbg deploy`.
|
||||
|
||||
6. Run `constellation apply […]` as usual
|
||||
Follow the [debug-cluster workflow](../dev-docs/workflows/debug-cluster.md) to deploy a bootstrapper with `cdbg` and `debugd`.
|
||||
|
||||
### Logcollection to Opensearch
|
||||
|
||||
|
@ -5,6 +5,7 @@ The following are instructions for building all components in the constellation
|
||||
Prerequisites:
|
||||
|
||||
* 20GB (minimum), better 40 GB disk space (required if you want to cross compile for all platforms)
|
||||
* 16GB of unutilized RAM for a full Bazel build.
|
||||
* [Latest version of Go](https://go.dev/doc/install).
|
||||
* Unless you use Nix / NixOS: [Bazelisk installed as `bazel` in your path](https://github.com/bazelbuild/bazelisk/releases).
|
||||
* We require Nix to be installed. It is recommended to install nix using the [determinate systems installer](https://github.com/DeterminateSystems/nix-installer) (or to use NixOS as host system).
|
||||
@ -55,7 +56,7 @@ To provision the constellation cluster on the provider infrastructure, please au
|
||||
E.g. AWS:
|
||||
|
||||
```sh
|
||||
aws login
|
||||
aws configure
|
||||
```
|
||||
|
||||
For more details, see [here](https://docs.edgeless.systems/constellation/getting-started/install#set-up-cloud-credentials).
|
||||
|
@ -37,7 +37,7 @@ Additionally, we use the [Redhat YAML formatter](https://marketplace.visualstudi
|
||||
* ShellCheck (timonwong.shellcheck): Shell script linter
|
||||
* vscode-proto3 (zxh404.vscode-proto3): Protobuf language support
|
||||
* Code Spell Checker (streetsidesoftware.code-spell-checker): Highlights potential spelling mistakes
|
||||
* Helm Intellisense: (Tim-Koehler.helm-intellisense): Syntax highlighting and more for Helm charts
|
||||
* Helm Intellisense: (Tim-Koehler.helm-intellisense): Syntax highlighting and more for Helm charts (not available on [Open VSX Registry](https://open-vsx.org/))
|
||||
* YAML (redhat.vscode-yaml): YAML language support. (Does not work with Helm charts)
|
||||
* markdownlint (DavidAnson.vscode-markdownlint): Markdown linter
|
||||
|
||||
|
@ -8,7 +8,7 @@ For pull requests, we employ the following workflow:
|
||||
1. Fork the repository to your own GitHub account
|
||||
2. Create a branch locally with a descriptive name
|
||||
3. Commit changes to the branch
|
||||
4. Write your code according to our development guidelines
|
||||
4. Write your code according to our [development guidelines](../conventions.md)
|
||||
5. Push changes to your fork
|
||||
6. Clean up your commit history
|
||||
7. Open a PR in our repository and summarize the changes in the description
|
||||
|
Loading…
Reference in New Issue
Block a user