package mirage
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ade8c410b2de3997c4a513f53f6c990dac6af508161e20df01b64fa7975ca5be
sha512=42fddf09be84c4251417145b88d4f63b41db1b29c9622b2b4e4508e31146f227a16875e670da96251208745f79a42f0b7d2bd8b44b883a705381b4c97a4255b8
doc/mirage.devices/Devices/Runtime_arg/index.html
Module Devices.Runtime_argSource
Command-line arguments for Mirage applications.
include module type of Functoria.Runtime_arg
The type command-line arguments where the type of the value is abstract.
Set implements sets over t elements.
Code Serialization
serialize ctx ppf k outputs the Cmdliner runes to parse command-line arguments represented by k at runtime.
The type for command-line arguments that reads a value of type 'a.
val create :
pos:(string * int * int * int) ->
?packages:Functoria.DSL.package list ->
string ->
'a argv k is the k with its type hidden.
OCaml Arguments
The OCaml runtime is usually configurable via the OCAMLRUNPARAM environment variable. We provide boot parameters covering these options.
--backtrace: Output a backtrace if an uncaught exception terminated the unikernel.
--randomize-hashtables: Randomize all hash tables.
GC control
The OCaml garbage collector can be configured, as described in detail in GC control.
The following arguments allow boot time configuration.
Network Arguments
A network interface.
An option for dual stack to only use IPv4.
An option for dual stack to only use IPv6.
val resolver :
?group:string ->
?docs:string ->
?default:string list ->
unit ->
string list option Functoria.DSL.runtime_argThe address of the DNS resolver to use. See $REFERENCE for format.
val syslog :
?group:string ->
?docs:string ->
Ipaddr.t option ->
Ipaddr.t option Functoria.DSL.runtime_argThe address to send syslog frames to.
val monitor :
?group:string ->
?docs:string ->
Ipaddr.t option ->
Ipaddr.t option Functoria.DSL.runtime_argThe address to send monitor statistics to.
val syslog_port :
?group:string ->
?docs:string ->
int option ->
int option Functoria.DSL.runtime_argThe port to send syslog frames to.
val syslog_hostname :
?group:string ->
?docs:string ->
string ->
string Functoria.DSL.runtime_argThe hostname to use in syslog frames.
Logs
The type for log threshold. A log level of None disables logging.
Startup delay
The initial delay, specified in seconds, before a unikernel starting up. Defaults to 0. Useful for tenders and environments that take some time to bring devices up.