Gitiles
Code Review Sign In
gerrit-dev.monogon.dev / monogon / a4edfa9e12ce6db3216da01be7bf35825893c749 / . / README.md
blob: 24f2cfb96a1f9f8239c871708e7d12c5efca6e01 [file] [log] [blame] [view]
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]1# Nexantic monorepo
Leopold Schabel67f9d092019-10-22 15:41:42 +0200[diff] [blame]2
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]3This is the monorepo storing all of nexantic's internal projects and libraries.
Leopold Schabel67f9d092019-10-22 15:41:42 +0200[diff] [blame]4
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]5## Environment
Leopold Schabel5c80aca2019-10-22 15:48:58 +0200[diff] [blame]6
Leopold Schabeldb6283e2020-01-06 17:05:54 +0100[diff] [blame]7We assume a Fedora host system provisioned using rW, and IntelliJ as the IDE.
Leopold Schabel67f9d092019-10-22 15:41:42 +0200[diff] [blame]8
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]9For better reproducibility, all builds are executed in containers.
Leopold Schabel67f9d092019-10-22 15:41:42 +0200[diff] [blame]10
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]11#### Usage
Leopold Schabel5c80aca2019-10-22 15:48:58 +0200[diff] [blame]12
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]13Spinning up: `scripts/create_container.sh`
Leopold Schabel5c80aca2019-10-22 15:48:58 +0200[diff] [blame]14
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]15Spinning down: `scripts/destroy_container.sh`
16
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]17Running commands: `scripts/run_in_container.sh <...>`
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]18
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]19Using bazel using a wrapper script: `scripts/bin/bazel <...>` (add to your local $PATH for convenience)
Leopold Schabelac9947f2020-07-09 18:58:26 +0200[diff] [blame]20
21#### Run a single node cluster
22
23Launch the node:
24
25 bazel run //:launch
26
27Run a kubectl command:
28
29 bazel run //core/cmd/dbg -- kubectl describe
Hendrik Hofstadt0d7c91e2019-10-23 21:44:47 +0200[diff] [blame]30
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]31#### IntelliJ
32
33This repository is compatible with the IntelliJ Bazel plugin. All commands run inside the container, and
34necessary paths are mapped into the container.
35
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]36The following steps are necessary:
37
Leopold Schabela4edfa92020-12-13 18:55:21 +0100[diff] [blame^]38- Install Google's [Bazel plugin](https://plugins.jetbrains.com/plugin/8609-bazel) in IntelliJ.
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]39
Leopold Schabela4edfa92020-12-13 18:55:21 +0100[diff] [blame^]40- Add the absolute path to your `~/.cache/bazel-nxt` folder to your `idea64.vmoptions` (Help → Edit Custom VM Options)
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]41 and restart IntelliJ:
42
43 `-Dbazel.bep.path=/home/leopold/.cache/bazel-nxt`
44
Leopold Schabela4edfa92020-12-13 18:55:21 +0100[diff] [blame^]45- Set "*Bazel Binary Location*" in Other Settings → Bazel Settings to the absolute path of `scripts/bin/bazel`.
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]46 This is a wrapper that will execute Bazel inside the container.
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]47
Leopold Schabela4edfa92020-12-13 18:55:21 +0100[diff] [blame^]48- Use _File → Import Bazel project_... to create a new project from `.bazelproject`.
Leopold Schabel8b9c0552019-11-15 14:07:45 +0100[diff] [blame]49
Leopold Schabela4edfa92020-12-13 18:55:21 +0100[diff] [blame^]50After running the first sync, everything should now resolve in the IDE, including generated code.