Directories
¶
| Path | Synopsis |
|---|---|
|
Package archive packs one file or directory as a tar stream and unpacks it with cp's placement rules:
|
Package archive packs one file or directory as a tar stream and unpacks it with cp's placement rules: |
|
Package atomicfile writes files so that a crash cannot leave a partial one in place of a good one.
|
Package atomicfile writes files so that a crash cannot leave a partial one in place of a good one. |
|
Package cli implements the dicer command-line client.
|
Package cli implements the dicer command-line client. |
|
printer
Package printer renders a Printable as a table, JSON, YAML or a Go template.
|
Package printer renders a Printable as a table, JSON, YAML or a Go template. |
|
remote
Package remote is the daemons the CLI knows, kept with the current one in ~/.config/dicer/remotes.yaml, and how each is reached.
|
Package remote is the daemons the CLI knows, kept with the current one in ~/.config/dicer/remotes.yaml, and how each is reached. |
|
Package compose reads compose files: a project's instances, networks and volumes, described together in YAML as Docker Compose describes containers, and turned into the definitions the client creates them from.
|
Package compose reads compose files: a project's instances, networks and volumes, described together in YAML as Docker Compose describes containers, and turned into the definitions the client creates them from. |
|
Package daemon assembles and runs dicerd: it loads the configuration, wires the services together and manages the process lifecycle.
|
Package daemon assembles and runs dicerd: it loads the configuration, wires the services together and manages the process lifecycle. |
|
Package defaults is where Dicer lives on a host unless configured otherwise: the locations more than one of its packages or programs must agree on, such as the socket the daemon serves on and a client looks at.
|
Package defaults is where Dicer lives on a host unless configured otherwise: the locations more than one of its packages or programs must agree on, such as the socket the daemon serves on and a client looks at. |
|
Package diskfile makes, grows, copies and measures disk files: the sparse files that hold a guest's disks on the host.
|
Package diskfile makes, grows, copies and measures disk files: the sparse files that hold a guest's disks on the host. |
|
Package dns answers the DNS queries of a network's guests, so that an instance can reach another by name.
|
Package dns answers the DNS queries of a network's guests, so that an instance can reach another by name. |
|
Package doctor checks that a host can run Dicer's instances and that they can be reached.
|
Package doctor checks that a host can run Dicer's instances and that they can be reached. |
|
Package errdefs defines the classes of error the daemon's code returns, matched with errors.Is.
|
Package errdefs defines the classes of error the daemon's code returns, matched with errors.Is. |
|
Package event defines the events recorded about what happens on this host, keeps their log, and delivers new ones to subscribers.
|
Package event defines the events recorded about what happens on this host, keeps their log, and delivers new ones to subscribers. |
|
Package filestore stores the instance, snapshot, network, volume, kernel and token definitions as YAML files, cached in memory and written through:
|
Package filestore stores the instance, snapshot, network, volume, kernel and token definitions as YAML files, cached in memory and written through: |
|
Package grpcserver implements the DaemonService gRPC service and the interceptors in front of it: those that authenticate a call's token, authorize it by the token's scopes, and audit it.
|
Package grpcserver implements the DaemonService gRPC service and the interceptors in front of it: those that authenticate a call's token, authorize it by the token's scopes, and audit it. |
|
Package guest defines the contract between the host and a guest: the Config written to the config disk, the Status read from the status disk, the agent's port, how a guest's workload and probes are reported, and who a process in the guest runs as.
|
Package guest defines the contract between the host and a guest: the Config written to the config disk, the Status read from the status disk, the agent's port, how a guest's workload and probes are reported, and who a process in the guest runs as. |
|
agent
Package agent runs inside the guest and serves the host's exec, copy, probe, process listing, shutdown, clock, identity and info requests over vsock.
|
Package agent runs inside the guest and serves the host's exec, copy, probe, process listing, shutdown, clock, identity and info requests over vsock. |
|
agentclient
Package agentclient is the host's end of the guest agent: it reaches dicer-agent through the vsock socket of the guest's VMM and makes its requests.
|
Package agentclient is the host's end of the guest agent: it reaches dicer-agent through the vsock socket of the guest's VMM and makes its requests. |
|
boot
Package boot is the guest's PID 1.
|
Package boot is the guest's PID 1. |
|
Package health checks an instance's health.
|
Package health checks an instance's health. |
|
Package hostfs finds the host's files from the daemon, whose view of the filesystem may not be the host's: systemd's PrivateTmp gives it a /tmp of its own, in a mount namespace of its own.
|
Package hostfs finds the host's files from the daemon, whose view of the filesystem may not be the host's: systemd's PrivateTmp gives it a /tmp of its own, in a mount namespace of its own. |
|
Package hostinfo reports the physical resources of the machine the daemon runs on, read from /proc.
|
Package hostinfo reports the physical resources of the machine the daemon runs on, read from /proc. |
|
Package hostnet configures the host networking a VM needs: bridges, TAP devices, iptables rules for NAT, isolation and published ports, the bridges' places in firewalld, and bandwidth limits.
|
Package hostnet configures the host networking a VM needs: bridges, TAP devices, iptables rules for NAT, isolation and published ports, the bridges' places in firewalld, and bandwidth limits. |
|
Package humanize writes sizes, numbers, durations and counts for people, so that every one Dicer prints reads the same: in a table, a message or an event.
|
Package humanize writes sizes, numbers, durations and counts for people, so that every one Dicer prints reads the same: in a table, a message or an event. |
|
Package hypervisor defines the VM specification and the operations a virtual machine monitor must support.
|
Package hypervisor defines the VM specification and the operations a virtual machine monitor must support. |
|
cloudhypervisor
Package cloudhypervisor provides primitives to interact with the openapi HTTP API.
|
Package cloudhypervisor provides primitives to interact with the openapi HTTP API. |
|
firecracker
Package firecracker implements the hypervisor interfaces with Firecracker.
|
Package firecracker implements the hypervisor interfaces with Firecracker. |
|
Package image pulls container images and converts them into read-only EROFS disks a guest boots from.
|
Package image pulls container images and converts them into read-only EROFS disks a guest boots from. |
|
reference
Package reference parses OCI image references and resolves tags to digests.
|
Package reference parses OCI image references and resolves tags to digests. |
|
Package initrd builds the initramfs a guest boots from, carrying dicer-init and dicer-agent.
|
Package initrd builds the initramfs a guest boots from, carrying dicer-init and dicer-agent. |
|
Package instance runs instances as virtual machines and manages their lifecycle: it starts, stops, pauses and deletes them, puts them on standby, and snapshots and forks them.
|
Package instance runs instances as virtual machines and manages their lifecycle: it starts, stops, pauses and deletes them, puts them on standby, and snapshots and forks them. |
|
Package kernel manages guest kernels: their definitions, and their binaries on the host.
|
Package kernel manages guest kernels: their definitions, and their binaries on the host. |
|
Package metric serves the daemon's Prometheus metrics, and is how the rest of the daemon defines its own.
|
Package metric serves the daemon's Prometheus metrics, and is how the rest of the daemon defines its own. |
|
metrictest
Package metrictest tests the collectors packages serve their metrics with.
|
Package metrictest tests the collectors packages serve their metrics with. |
|
Package naming is the rule every name Dicer gives a resource follows: an instance's, a network's, a snapshot's, a remote's; and a guest's hostname, which follows the same rule.
|
Package naming is the rule every name Dicer gives a resource follows: an instance's, a network's, a snapshot's, a remote's; and a guest's hostname, which follows the same rule. |
|
Package network defines host-local networks and attaches instances to them, assigning their addresses and naming their interfaces.
|
Package network defines host-local networks and attaches instances to them, assigning their addresses and naming their interfaces. |
|
Package process provides handles on long-lived processes such as VMMs, started or adopted, that report when the process exits.
|
Package process provides handles on long-lived processes such as VMMs, started or adopted, that report when the process exits. |
|
Package registry talks to OCI registries: resolving references, pulling manifests and layers, and exporting an unpacked root filesystem.
|
Package registry talks to OCI registries: resolving references, pulling manifests and layers, and exporting an unpacked root filesystem. |
|
Package token makes and reads the tokens a client presents to a daemon's TCP listener, and manages the daemon's record of them.
|
Package token makes and reads the tokens a client presents to a daemon's TCP listener, and manages the daemon's record of them. |
|
Package version holds the build's identity, set at link time with -X.
|
Package version holds the build's identity, set at link time with -X. |
|
Package virtiofs shares host directories with guests: it runs virtiofsd, the virtio-fs daemon, for each, on a socket the VMM connects to.
|
Package virtiofs shares host directories with guests: it runs virtiofsd, the virtio-fs daemon, for each, on a socket the VMM connects to. |
|
Package volume manages the persistent disks instances mount: their definitions, and the sparse files with a filesystem that back them, independent of any instance.
|
Package volume manages the persistent disks instances mount: their definitions, and the sparse files with a filesystem that back them, independent of any instance. |
Click to show internal directories.
Click to hide internal directories.