| commit | aad79488d417eefafd4102bda9bd10d6473cf6c7 | [log] [tgz] |
|---|---|---|
| author | Serge Bazanski <serge@nexantic.com> | Fri Jul 02 17:40:36 2021 +0200 |
| committer | Sergiusz Bazanski <serge@nexantic.com> | Mon Jul 05 18:19:29 2021 +0000 |
| tree | a638f94700704699b4ae4a5ad6b5214d6adcb479 | |
| parent | cbf1fa97307024b1f0c60c88e8ebf968a42bf980 [diff] |
metropolis/handbook: init This is the beginning of the Metropolis Handbook, the main end-user documentation of Metropolis. It is built using mdbook, and currently contains only the default content from `mdbook init`. Future work: start writing the handbook, build in CI, publish in CI. Change-Id: I81753350215b2f7aabc17925eadfd20706e1fdb5 Reviewed-on: https://review.monogon.dev/c/monogon/+/202 Reviewed-by: Leopold Schabel <leo@nexantic.com>
This is the main repository containing the source code for the Monogon Project.
⚠️ This is pre-release software that happens to be publicly available. Nothing to see here, please move along.
Our build environment requires a working Podman binary (your distribution should have one).
Spinning up: scripts/create_container.sh
Spinning down: scripts/destroy_container.sh
Running commands: scripts/run_in_container.sh <...>
Using bazel using a wrapper script: scripts/bin/bazel <...> (add to your local $PATH for convenience)
This repository is compatible with the IntelliJ Bazel plugin, which enables full autocompletion for external dependencies and generated code. All commands run inside the container, and necessary paths are mapped into the container.
The following steps are necessary:
Install Google's Bazel plugin in IntelliJ. On IntelliJ 2020.3 or later, you need to install a beta release of the plugin.
Add the absolute path to your ~/.cache/bazel-monogon folder to your idea64.vmoptions (Help → Edit Custom VM Options) and restart IntelliJ:
-Dbazel.bep.path=/home/leopold/.cache/bazel-monogon
Set "Bazel Binary Location" in Other Settings → Bazel Settings to the absolute path of scripts/bin/bazel. This is a wrapper that will execute Bazel inside the container.
Use File → Import Bazel project... to create a new project from .bazelproject.
After running the first sync, everything should now resolve in the IDE, including generated code.
Launch the node:
scripts/bin/bazel run //:launch
Run a kubectl command:
scripts/bin/bazel run //metropolis/cli/dbg -- kubectl describe
Run tests:
scripts/bin/bazel test //...