docs(cookbook): config.toml [tools]/[jails], cookbook, and doc highlighting#32
Draft
markovejnovic wants to merge 18 commits into
Draft
docs(cookbook): config.toml [tools]/[jails], cookbook, and doc highlighting#32markovejnovic wants to merge 18 commits into
markovejnovic wants to merge 18 commits into
Conversation
Stage the documentation and configuration work split out of the larger get-a-vm-running branch into its own PR off main: - docs/cookbook: rewritten intro/install + new config.md, documenting the /etc/hyper/config.toml [tools] and [jails] tables, the [tools] node-tool paths, and the User Configuration / cgroup setup. - mix.exs/mix.lock: makeup_syntect + a docs alias step that aliases bash/sh fences to the shell grammar, so cookbook code blocks highlight. - config/runtime.exs: optional /etc/hyper/config.exs operator override. - lib/hyper/config.ex + umoci.ex: the [tools]/[jails] config reading these docs describe. Note: this branch is a content snapshot off main; it intentionally diverges from main's behavior (the supporting Rust/test changes live on the other branch), so it is not expected to build/test green on its own.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Creates Hyper.Cfg.Dirs with work_dir/0 (config.toml-only, default /srv/hyper) and all 8 derived directory accessors. Migrates every call-site away from Hyper.Config.*; removes now-unused aliases in img.ex, oci_loader.ex, umoci.ex. Resolves the last undefined-accessor warning: firecracker_install_dir/0.
Delete the now-redundant Hyper.Config module (all accessors have been re-homed under Hyper.Cfg.*). Migrate the two test files that still referenced it, and remove the three dead flat keys (cgroup_parent, uid_gid_range, layer_dir) from config/config.exs that were never read via Application.get_env.
Rename and relocate Hyper.Node.Config.Budget to Hyper.Cfg.Budget, update the runtime.exs app-env key, and fix all aliases/call-sites.
Delete the hardcoded @period_ms/@tau_s module attributes from the four /proc monitors and replace period/0 + tau/0 with delegations to the new Hyper.Cfg.Mon module. Operators can now override sampling cadence per metric via config :hyper, Hyper.Cfg.Mon, cpu: [period_ms: .., tau_s: ..].
- alphabetize aliases in node_state.ex/gc.ex/tools_test.exs (credo --strict) - mix format the longer Hyper.Cfg.* call-sites (oci_loader.ex, img/server.ex) - restore anti-thrash rationale comment in layer/server.ex moduledoc - add Jails.range_from/1 non-integer-list refusal test - drop unused Hyper.Cfg.Toml.path/0 (YAGNI)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Splits the documentation + configuration work out of the larger
chore/get-a-vm-runningbranch into its own PR offmain.What's here
intro.md/install.mdand a newconfig.md,documenting the
/etc/hyper/config.toml[tools]and[jails]tables, the[tools]node-tool paths (skopeo/mke2fs/umoci/suidhelper), theUser Configuration (dedicated unprivileged user) and cgroup setup.
mix.exs/mix.lock: addmakeup_syntectplus adocsalias step that aliasesbash/shfences to the shell grammar, socookbook code blocks (toml/bash/sh/python/rust/elixir/markdown) highlight.
/etc/hyper/config.exsoperator override,merged last (skipped under
:test).[tools]/[jails]config readingthese docs describe.
Caveat
This is a content snapshot off
main. It intentionally diverges frommain'sbehavior — the supporting Rust (
config.rs) and test-stub changes live on thechore/get-a-vm-runningbranch — so it is not expected to build or test greenon its own. Draft until rebased onto / merged with that branch.