m/handbook: add a chapter on Cluster API

For what it's worth, here's my attempt at writing down pieces of
information that could be of interest to potential users, based on
the current implementation.

Change-Id: I92062f103888340e9823551ed8af87741f3e4165
Reviewed-on: https://review.monogon.dev/c/monogon/+/807
Tested-by: Jenkins CI
Reviewed-by: Lorenz Brun <lorenz@monogon.tech>
1 file changed
tree: 6595649cd3c3f4290bd6ff7d05cd291de69c6818
  1. .github/
  2. build/
  3. intellij/
  4. metropolis/
  5. scripts/
  6. third_party/
  7. .bazelignore
  8. .bazelproject
  9. .bazelrc
  10. .git-ignore-revs
  11. .gitignore
  12. BUILD
  13. CODING_STANDARDS.md
  14. go.mod
  15. go.sum
  16. LICENSE
  17. README.md
  18. WORKSPACE
README.md

Monogon Monorepo

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!

Environment

Our build environment requires a working Podman binary (your distribution should have one).

Usage

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)

IntelliJ

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.

Metropolis

Run a single node cluster

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 //...