@@ -24,15 +24,15 @@ Note the keys are abbreviated for better layout:
2424 - All keys under ` config.exs ` are written in short-hand form. The parent
2525 group is given as the section title. For example, ` .mke2fs ` in the tool
2626 configuration section expands to
27- ` :hyper, Hyper.Config .Tools, mke2fs: "/path/to/mke2fs" ` .
27+ ` :hyper, Hyper.Cfg .Tools, mke2fs: "/path/to/mke2fs" ` .
2828
2929### Root Keys (` Hyper.Config ` , ` - ` )
3030
3131| Config Key | ` config.exs ` | ` config.toml ` | Default | Notes |
3232| ---------------| -------------------------| --------------------------| -----------------------------------| -------------------------------------------------------------------------|
3333| ` work_dir ` | - | ` work_dir ` | - | [ Absolute Path] ( #absolute-path ) where ` Hyper ` creates its working tree. |
3434
35- ### Tool Configuration (` Hyper.Config .Tools ` , ` [tools] ` )
35+ ### Tool Configuration (` Hyper.Cfg .Tools ` , ` [tools] ` )
3636
3737Hyper relies on a large number of external tools, of which the paths are
3838configurable:
@@ -56,7 +56,7 @@ configurable:
5656| ` cgroup ` | - | ` .cgroup ` | ` "hyper" ` | Parent cgroup under which each VM's cgroup is nested. Each VM receives its own ephemeral cgroup which lives under the umbrella of this cgroup. |
5757| ` uid_gid_range ` | - | ` .uid_gid_range ` | - | [ Range] ( #range ) limiting the UID/GID values given to VMs. Each VM receives its own UID/GID pair, within these bounds. Must not be an existing user/group. |
5858
59- ### gRPC Configuration (` Hyper.Config .Grpc ` , ` [grpc] ` )
59+ ### gRPC Configuration (` Hyper.Cfg .Grpc ` , ` [grpc] ` )
6060
6161Hyper supports a [ gRPC] ( https://grpc.io/ ) interface enabling you to interface
6262with ` Hyper ` from any language.
@@ -77,7 +77,7 @@ with `Hyper` from any language.
7777> you can also conditionally enable the ` gRPC ` server based on logic in your
7878> ` config.exs ` , for example, to only spawn it on your "main" server.
7979
80- ### Telemetry Configuration (` Hyper.Config .Otel ` , ` [otel] ` )
80+ ### Telemetry Configuration (` Hyper.Cfg .Otel ` , ` [otel] ` )
8181
8282You can configure telemetry with Hyper by adding this section to your
8383configuration and Hyper will emit tracing spans as configured.
@@ -88,7 +88,7 @@ configuration and Hyper will emit tracing spans as configured.
8888| ` endpoint ` | ` .endpoint ` | ` .endpoint ` | - | |
8989| ` headers ` | ` .headers ` | ` .headers ` | - | |
9090
91- ### Budget Configuration (` Hyper.Config .Budget ` , ` [budget] ` )
91+ ### Budget Configuration (` Hyper.Cfg .Budget ` , ` [budget] ` )
9292
9393Hyper allows you to control the absolute maximal budgets that are available to
9494all VMs on a particular node.
@@ -104,7 +104,7 @@ all VMs on a particular node.
104104| ` net_bw_cap ` | ` .net_bw_cap ` | ` .net_bw_cap ` | - | [ $\beta$ budget] ( ./architecture.md#budgets ) [ unit] ( #unit ) of net bandwidth. |
105105| ` net_bw_max_load ` | ` .net_bw_max_load ` | ` .net_bw_max_load ` | - | [ $\alpha$ budget] ( ./architecture.md#budgets ) [ unit] ( #unit ) of net bandwidth. |
106106
107- ### VmLinux Paths (` Hyper.Config .VmLinux ` , ` [vmlinux] ` )
107+ ### VmLinux Paths (` Hyper.Cfg .VmLinux ` , ` [vmlinux] ` )
108108
109109Hyper requires Linux images for the architectures it runs on:
110110
@@ -113,7 +113,7 @@ Hyper requires Linux images for the architectures it runs on:
113113| ` amd64 ` | ` .amd64 ` | ` .amd64 ` | Automatically downloaded from [ hyper-vmlinux] ( https://github.com/harmont-dev/hyper-vmlinux ) . | [ Absolute Path] ( #absolute-path ) . |
114114| ` aarch64 ` | ` .aarch64 ` | ` .aarch64 ` | Automatically downloaded from [ hyper-vmlinux] ( https://github.com/harmont-dev/hyper-vmlinux ) . | [ Absolute Path] ( #absolute-path ) . |
115115
116- ### Image Configuration (` Hyper.Config .Img ` , ` [img] ` )
116+ ### Image Configuration (` Hyper.Cfg .Img ` , ` [img] ` )
117117
118118Hyper's image provisioning layer has a large set of configuration flags
119119enabling you to tweak how you want Hyper to manage images.
@@ -124,7 +124,7 @@ enabling you to tweak how you want Hyper to manage images.
124124
125125Additionally, sub-sections are available.
126126
127- #### Database Configuration (` Hyper.Config .Img.Db ` , ` [img.db] ` )
127+ #### Database Configuration (` Hyper.Cfg .Img.Db ` , ` [img.db] ` )
128128
129129| Config Key | ` config.exs ` | ` config.toml ` | Default | Notes |
130130| ----------------| -------------------------| --------------------------| -----------------------------------| -----------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -133,7 +133,7 @@ Additionally, sub-sections are available.
133133| ` password ` | ` .password ` | - | - | |
134134| ` hostname ` | ` .hostname ` | - | - | |
135135
136- #### Garbage Collector Configuration (` Hyper.Config .Img.Gc ` , ` [img.gc] ` )
136+ #### Garbage Collector Configuration (` Hyper.Cfg .Img.Gc ` , ` [img.gc] ` )
137137
138138Hyper supports a mechanism to prune unreferenced image layers. Unreferenced
139139image layers occur when an ungraceful crash happens, resulting in entries in
0 commit comments