diff options
author | Jan Dittberner <jan@dittberner.info> | 2016-04-24 15:01:30 +0200 |
---|---|---|
committer | Jan Dittberner <jan@dittberner.info> | 2016-04-24 15:01:30 +0200 |
commit | 9fc48cee69e324e253452afe11c7c073fbba9471 (patch) | |
tree | 2ebfb28297db70af157feb93c16de986280fc347 /docs | |
parent | e1586608bafaf52a96daf07673196c635d69883a (diff) | |
download | cacert-infradocs-9fc48cee69e324e253452afe11c7c073fbba9471.tar.gz cacert-infradocs-9fc48cee69e324e253452afe11c7c073fbba9471.tar.xz cacert-infradocs-9fc48cee69e324e253452afe11c7c073fbba9471.zip |
Add glossary and indexing
This commit adds a glossary and some :term: marks. The system files for
emailout and monitor got titles and index terms.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/glossary.rst | 12 | ||||
-rw-r--r-- | docs/index.rst | 1 | ||||
-rw-r--r-- | docs/systems/arbitration.rst | 8 | ||||
-rw-r--r-- | docs/systems/emailout.rst | 5 | ||||
-rw-r--r-- | docs/systems/infra02.rst | 17 | ||||
-rw-r--r-- | docs/systems/monitor.rst | 5 | ||||
-rw-r--r-- | docs/systems/template.rst | 7 |
7 files changed, 39 insertions, 16 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 0000000..19e6811 --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,12 @@ +Glossary +======== + +.. glossary:: + + LXC + `Linux Containers <https://linuxcontainers.org/>`_ + + Container + A container is an isolated system with a separate root file system and + operating system userland. The containers share a common operating system + kernel. diff --git a/docs/index.rst b/docs/index.rst index a7c191b..17a4e83 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Contents: iplist sshkeys certlist + glossary Indices and tables diff --git a/docs/systems/arbitration.rst b/docs/systems/arbitration.rst index 9a931ff..36bffc2 100644 --- a/docs/systems/arbitration.rst +++ b/docs/systems/arbitration.rst @@ -40,7 +40,8 @@ Contact Additional People ----------------- -`Jan Dittberner`_ and `Mario Lipinski`_ have sudo access on that machine too. +`Jan Dittberner`_ and `Mario Lipinski`_ have :program:`sudo` access on that +machine too. .. _Jan Dittberner: jandd@cacert.org .. _Mario Lipinski: mario@cacert.org @@ -51,9 +52,8 @@ Basics Physical Location ----------------- -This system is located in an LXC_ container on physical machine :doc:`infra02`. - -.. _LXC: https://linuxcontainers.org/ +This system is located in an :term:`LXC` container on physical machine +:doc:`infra02`. Logical Location ---------------- diff --git a/docs/systems/emailout.rst b/docs/systems/emailout.rst index e69de29..a6fb000 100644 --- a/docs/systems/emailout.rst +++ b/docs/systems/emailout.rst @@ -0,0 +1,5 @@ +.. index:: + single: Systems; Emailout + +Emailout +======== diff --git a/docs/systems/infra02.rst b/docs/systems/infra02.rst index bc0c213..35b054a 100644 --- a/docs/systems/infra02.rst +++ b/docs/systems/infra02.rst @@ -12,14 +12,13 @@ The infrastructure host system Infra02 is a dedicated physical machine for the CAcert infrastructure. .. index:: - single: LXC single: Ferm -Infra02 is the host system for all infrastructure containers. The containers -are setup using the Linux kernel's LXC_ system. The firewall for infrastructure -is maintained on this machine using Ferm_. +Infra02 is the host system for all infrastructure :term:`containers +<container>`. The containers are setup using the Linux kernel's :term:`LXC` +system. The firewall for infrastructure is maintained on this machine using +Ferm_. -.. _LXC: https://linuxcontainers.org/ .. _Ferm: http://ferm.foo-projects.org/ Administration @@ -42,8 +41,8 @@ Contact Additional People ----------------- -`Wytze van der Raay`_ and `Mendel Mobach`_ have sudo access on that machine -too. +`Wytze van der Raay`_ and `Mendel Mobach`_ have :program:`sudo` access on that +machine too. .. _Wytze van der Raay: wytze@cacert.org .. _Mendel Mobach: mendel@cacert.org @@ -59,7 +58,7 @@ The machine is located in a server rack at BIT B.V. in the Netherlands. Physical Configuration ---------------------- -The machine has been sponsored by Thomas Krenn and has the following hardware +The machine has been sponsored by `Thomas Krenn`_ and has the following hardware parameters: :Mainboard: Supermicro X9SCL/X9SCM Version 1.11A @@ -77,6 +76,8 @@ There is a 2 TB USB backup disk attached to the system. See https://wiki.cacert.org/SystemAdministration/EquipmentList +.. _Thomas Krenn: https://www.thomas-krenn.com/ + Logical Location ---------------- diff --git a/docs/systems/monitor.rst b/docs/systems/monitor.rst index e69de29..6260153 100644 --- a/docs/systems/monitor.rst +++ b/docs/systems/monitor.rst @@ -0,0 +1,5 @@ +.. index:: + single: Systems; Monitor + +Monitor +======= diff --git a/docs/systems/template.rst b/docs/systems/template.rst index de33829..7b8555d 100644 --- a/docs/systems/template.rst +++ b/docs/systems/template.rst @@ -35,7 +35,7 @@ Contact Additional People ----------------- -`Person A`_ and `Person B`_ have sudo access on that machine too. +`Person A`_ and `Person B`_ have :program:`sudo` access on that machine too. .. _Person A: persona@cacert.org .. _Person B: personb@cacert.org @@ -50,9 +50,8 @@ Physical Location .. ## Use the following for containers on Infra02: -This system is located in an LXC_ container on physical machine :doc:`infra02`. - -.. _LXC: https://linuxcontainers.org/ +This system is located in an :term:`LXC` container on physical machine +:doc:`infra02`. Physical Configuration ---------------------- |