Fix some typos/grammar/variable shadows

Change-Id: I43e78ec7931399c4f60f431d659953f084db7172
Reviewed-on: https://review.monogon.dev/c/monogon/+/1074
Tested-by: Leopold Schabel <leo@monogon.tech>
Reviewed-by: Leopold Schabel <leo@monogon.tech>
2 files changed
tree: 47b90debe3873ee1d8075ffac1995f3769bdae31
  1. .github/
  2. build/
  3. cloud/
  4. intellij/
  5. metropolis/
  6. scripts/
  7. third_party/
  8. tools/
  9. .bazelignore
  10. .bazelproject
  11. .bazelrc
  12. .git-ignore-revs
  13. .gitignore
  14. BUILD
  15. CODING_STANDARDS.md
  16. go.mod
  17. go.sum
  18. LICENSE
  19. README.md
  20. 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 //...