| commit | 867107d6f8ab9e237f476c290c21381829e18e22 | [log] [tgz] |
|---|---|---|
| author | Serge Bazanski <serge@nexantic.com> | Tue Jul 06 12:55:26 2021 +0200 |
| committer | Sergiusz Bazanski <serge@monogon.tech> | Fri Jul 01 10:31:50 2022 +0000 |
| tree | 960baa15e8239c96d742c257be91d06821a0bc00 | |
| parent | fcc5115636da2fcc27d4707c908b8aa2bb0162d0 [diff] |
handbook: structure, introduction, chapter 3 root This is a first pass at the Metropolis Handbook. We write out the expected outline of the documentation, and start filling in some chapters. The introduction pages and Chapter 1 are a high-level overview of what Metropolis is and how it's expected to be used. Chapter 3 will delve deep into the technical details of how Metropolis is implemented. For now, the introduction/overview section of that chapter is written. Change-Id: Ic16aa91ed9a127f4f3791eeaf8d7f5e1a24b1018 Reviewed-on: https://review.monogon.dev/c/monogon/+/453 Tested-by: Jenkins CI Reviewed-by: Sergiusz Bazanski <serge@monogon.tech>
This is the main repository containing the source code for the Monogon Project.
This is pre-release software - feel free to look around, and check back later for our first release!
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 -c dbg
Run a kubectl command:
scripts/bin/bazel run //metropolis/cli/dbg -c dbg -- kubectl describe
Run tests:
scripts/bin/bazel test -c dbg //...