Name: mirage-handbook
Owner: MirageOS
Description: WIP Handbook for MirageOS
Created: 2018-03-15 18:59:13.0
Updated: 2018-03-23 14:52:54.0
Pushed: 2018-03-15 19:01:11.0
Homepage: null
Size: 3
Language: null
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
no need to oversell, be precise what we can do at the moment and what we can't!
tutorial (interactive!?)
introduction: how can i contribute (interactive also, e.g. comment on tutorial/documentation directly? - with link to markdown source or issue or whatever to improve documentation)
hello world
lwt tutorial
now the protocols: device-usage/network
static_website_tls
http_fetch: why is it good to run as unikernel? parse some json (isolated in unikernel), type-safe json parser
how do i run my own irmin-git-mirage unikernel?
how do my unikernels communicate with each other? service-orchestration
how do I run my slideshow as a qubesos/sdl-framebuffer unikernel?
how to run qubes-mirage-firewall? (binary distribution soon)
DNS (resolver, authoritative nameserver)
operators guide
what is mirageos?
introduction, including available backends and their status
what is the setup? how can i test it is correct?
what is supported in terms of network protocols, file systems, orchestration solutions
building unikernels (including command-line arguments)
where and how can i deploy mirageos? (ec2, gce, self-hosted (albatross), qubes, local development)
troubleshooting / FAQ
developing unikernels
community section: where to get help
concept: underlying API (xen/solo5/hypercall/…), openlibm, ocaml runtime
mirageos interfaces (console, block, random, …) (and the shape of mirageos - module type definitions & implementations)
coding guidelines and best current practises see https://github.com/mirage/mirage-www/pull/562
mirageos libraries best practises: logs, fmt, astring, randomconv, duration
tests (alcotest, qcheck, crowbar) and setup thereof
debugging sections: how to use gdb (platform-dependent)
tuning MirageOS (OCaml GC settings)
glossary for our concepts and tools: solo5, tender, lwt