Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-12-25 15:29:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update glossary

Browse Source 
- Add entry for "admin qube"
- Add entry for "named disposable" (QubesOS/qubes-issues#6709)
- Clarify disposable-related definitions (QubesOS/qubes-issues#6709)
- Add "previously known as" terms
- Clarify wording in various entries
This commit is contained in:
Andrew David Wong 2021-06-18 20:34:02 -07:00
parent ba232b6b58
commit 0a53418de1
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
2 changed files with 61 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
user/advanced-topics/disposable-customization.md
View File

@ -81,9 +81,9 @@ This can be done by customizing the disposable template on which it is based:
4. Shutdown the qube (either by `poweroff` from qube's terminal, or `qvm-shutdown` from dom0 terminal). 4. Shutdown the qube (either by `poweroff` from qube's terminal, or `qvm-shutdown` from dom0 terminal).
## Using static disposables for sys-* ## Using named disposables for sys-*
You can use a static disposable for `sys-*` as long as it is stateless. You can use a [named disposable](/doc/glossary/#named-disposable) for `sys-*` as long as it is stateless.
For example, a `sys-net` using DHCP or `sys-usb` will work. For example, a `sys-net` using DHCP or `sys-usb` will work.
In most cases `sys-firewall` will also work, even if you have configured app qube firewall rules. In most cases `sys-firewall` will also work, even if you have configured app qube firewall rules.
The only exception is if you require something like VM to VM communication and have manually edited `iptables` or other items directly inside the firewall app qube. The only exception is if you require something like VM to VM communication and have manually edited `iptables` or other items directly inside the firewall app qube.

81
user/reference/glossary.md
View File

@ -10,29 +10,39 @@ ref: 140
title: Glossary title: Glossary
--- ---
## admin qube
A type of [qube](#qube) used for administering Qubes OS.
* Currently, the only admin qube is [dom0](#dom0).
## app qube ## app qube
Any [qube](#qube) that does not have a root filesystem of its own. Every app Any [qube](#qube) that does not have a root filesystem of its own. Every app
qube is based on a [template](#template) from which it borrows the root qube is based on a [template](#template) from which it borrows the root
filesystem. filesystem.
* Technical note: This is the preferred user-facing term replacing the * Previously known as: `AppVM`, `TemplateBasedVM`.
deprecated terms "AppVM" and "TemplateBasedVM."
* Historical note: This term originally meant "a qube intended for running user * Historical note: This term originally meant "a qube intended for running user
software applications" (hence the name "app"). software applications" (hence the name "app").
## disposable ## disposable
A type of temporary [app qube](#app-qube) that can quickly be created, used, A type of temporary [app qube](#app-qube) that self-destructs when its
and destroyed. Each disposable is based on a [disposable originating window closes. Each disposable is based on a [disposable
template](#disposable-template). template](#disposable-template).
See [How to Use Dispoables](/doc/how-to-use-disposables/). See [How to Use Dispoables](/doc/how-to-use-disposables/).
* Previously known as: `DisposableVM`, `DispVM`.
## disposable template ## disposable template
A type of [app qube](#app-qube) on which [disposables](#disposable) are based. Any [app qube](#app-qube) on which [disposables](#disposable) are based. A
disposable template shares its user directories (and, indirectly, the root
filesystem of the regular [template](#template) on which it is based) with all
[disposables](#disposable) based on it.
* Not to be confused with the concept of a regular [template](#template) that * Not to be confused with the concept of a regular [template](#template) that
is itself disposable, which does not exist in Qubes OS. is itself disposable, which does not exist in Qubes OS.
@ -40,18 +50,23 @@ A type of [app qube](#app-qube) on which [disposables](#disposable) are based.
* Disposable templates must be app qubes. They cannot be regular * Disposable templates must be app qubes. They cannot be regular
[templates](#template). [templates](#template).
* Each [disposable](#disposable) is based on a disposable template, which is in * Every [disposable](#disposable) is based on a disposable template, which is
turn based on a regular [template](#template). in turn based on a regular [template](#template).
* Unlike [disposables](#disposable), disposable templates have the persistence
properties of normal [app qubes](#app-qube).
* Previously known as: `DisposableVM Template`, `DVM Template`, `DVM`.
## dom0 ## dom0
[Domain](#domain) zero. Also known as the **host** domain, dom0 is the initial [Domain](#domain) zero. A type of [admin qube](#admin-qube). Also known as the
qube started by the Xen hypervisor on boot. Dom0 runs the Xen management **host** domain, dom0 is the initial qube started by the Xen hypervisor on
toolstack and has special privileges relative to other domains, such as direct boot. Dom0 runs the Xen management toolstack and has special privileges
access to most hardware. relative to other domains, such as direct access to most hardware.
* The term "dom0" is not a proper noun. It should follow the capitalization * The term "dom0" is a common noun and should follow the capitalization rules
rules of common nouns. of common nouns.
## domain ## domain
@ -67,8 +82,11 @@ Unprivileged [domain](#domain). Also known as **guest** domains, domUs are the
counterparts to dom0. In Xen, all VMs except dom0 are domUs. By default, most counterparts to dom0. In Xen, all VMs except dom0 are domUs. By default, most
domUs lack direct hardware access. domUs lack direct hardware access.
* The term "domU" is not a proper noun. It should follow the capitalization * The term "domU" is a common noun and should follow the capitalization rules
rules of common nouns. of common nouns.
* Sometimes the term [VM](#vm) is used as a synonym for domU. This is
technically inaccurate, as [dom0](#dom0) is also a VM in Xen.
## HVM ## HVM
@ -79,6 +97,23 @@ emulation, HVMs allow the user to create domains based on any operating system.
See [Standalones and HVM](/doc/standalones-and-HVM/). See [Standalones and HVM](/doc/standalones-and-HVM/).
## named disposable
A type of [disposable](#disposable) given a permanent name that continues to
exist even after it is shut down and can be restarted again. Like a regular
[disposable](#disposable), a named disposable has no persistent state: Any
changes made are lost when it is shut down.
* Only one instance of a named disposable can run at a time.
* Like a regular [disposable](#disposable), a named disposable always has the
same state when it starts, namely that of the [disposable
template](#disposable-template) on which it is based.
* Technical note: Named disposables are useful for certain [service
qubes](#service-qube), where the combination of persistent device assignment
and ephemeral qube state is desirable.
## qube ## qube
A secure compartment in Qubes OS. Currently, qubes are implemented as Xen A secure compartment in Qubes OS. Currently, qubes are implemented as Xen
@ -86,7 +121,7 @@ A secure compartment in Qubes OS. Currently, qubes are implemented as Xen
technology. VMs could be replaced with a different technology, and qubes would technology. VMs could be replaced with a different technology, and qubes would
still be called "qubes." still be called "qubes."
* **Important:** The term "qube" is not a proper noun. It should follow the * **Important:** The term "qube" is a common noun and should follow the
capitalization rules of common nouns. For example, "I have three qubes" is capitalization rules of common nouns. For example, "I have three qubes" is
correct," while "I have three Qubes" is incorrect. correct," while "I have three Qubes" is incorrect.
@ -122,19 +157,19 @@ See [Qubes Windows Tools](/doc/windows-tools/) and [Windows](/doc/windows/).
## service qube ## service qube
A type of [qube](#qube) the primary purpose of which is to provide a service or Any [app qube](#app-qube) the primary purpose of which is to provide services
services to other qubes. `sys-net` and `sys-firewall` are examples of service to other qubes. `sys-net` and `sys-firewall` are examples of service qubes.
qubes.
## standalone ## standalone
Any [qube](#qube) that has its own root filesystem and does not share it with Any [qube](#qube) that has its own root filesystem and does not share it with
another qube. Standalones are distinct from both templates and app qubes. A another qube. Distinct from both [templates](#template) and [app
standalone is created by cloning a template while selecting the option to make qubes](#app-qube).
the clone standalone.
See [Standalones and HVMs](/doc/standalones-and-hvm/). See [Standalones and HVMs](/doc/standalones-and-hvm/).
* Previously known as: `StandaloneVM`.
## template ## template
Any [qube](#qube) that shares its root filesystem with another qube. A qube Any [qube](#qube) that shares its root filesystem with another qube. A qube
@ -152,6 +187,8 @@ See [Templates](/doc/templates/).
* Regular templates cannot function as [disposable * Regular templates cannot function as [disposable
templates](#disposable-template). (Disposable templates must be app qubes.) templates](#disposable-template). (Disposable templates must be app qubes.)
* Previously known as: `TemplateVM`.
## VM ## VM
An abbreviation for "virtual machine." A software implementation of a machine An abbreviation for "virtual machine." A software implementation of a machine