Stash

docs/usage/quickstart.rst

@@ -19,9 +19,9 @@ configuration.
 
 .. _Ansible: https://www.ansible.com
 
-First, create a directory, e.g. ``inventory/quickstart-cluster``, in which the
-inventory will be stored. For our setup, we need to create two files. One
-listing all the hosts, aptly called ``hosts``:
+First, create a directory, e.g. :file:`inventory/quickstart-cluster`, in which
+the inventory will be stored. For our setup, we need to create two files. One
+listing all the hosts, aptly called :file:`hosts`:
 
 .. code-block:: ini
 
@@ -51,10 +51,10 @@ listing all the hosts, aptly called ``hosts``:
 Make sure to change IP-addresses, usernames etc. according to your
 infrastructure.
 
-In a second file, called ``kube-node.yml`` in a ``group_vars`` subdirectory of
-our inventory, we declare how to setup storage (in the default configuration)
-on hosts in the *kube-node* group, i.e. hosts on which Pods will be
-scheduled:
+In a second file, called :file:`kube-node.yml` in a :file:`group_vars`
+subdirectory of our inventory, we declare how to setup storage (in the
+default configuration) on hosts in the *kube-node* group, i.e. hosts on which
+Pods will be scheduled:
 
 .. code-block:: yaml
 
@@ -64,15 +64,16 @@ scheduled:
           drives: ['/dev/vdb']
 
 In the above, we assume every *kube-node* host has a disk available as
-``/dev/vdb`` which can be used to set up Kubernetes *PersistentVolumes*. For
+:file:`/dev/vdb` which can be used to set up Kubernetes *PersistentVolumes*. For
 more information about storage, see :doc:`../architecture/storage`.
 
 Entering the MetalK8s Shell
 ---------------------------
 To easily install a supported version of Ansible and its dependencies, as well
-as some Kubernetes tools (``kubectl`` and ``helm``), we provide a ``make``
-target which installs these in a local environment. To enter this environment,
-run ``make shell`` (this takes a couple of seconds on first run)::
+as some Kubernetes tools (:program:`kubectl` and :program:`helm`), we provide a
+:program:`make` target which installs these in a local environment. To enter this
+environment, run :command:`make shell` (this takes a couple of seconds on first
+run)::
 
     $ make shell
     Creating virtualenv...
@@ -91,9 +92,10 @@ Grab a coffee and wait for deployment to end.
 Inspecting the cluster
 ----------------------
 Once deployment finished, a file containing credentials to access the cluster is
-created: ``inventory/quickstart-cluster/artifacts/admin.conf``. We can export
-this location in the shell such that the ``kubectl`` and ``helm`` tools know how
-to contact the cluster *kube-master* nodes, and authenticate properly::
+created: :file:`inventory/quickstart-cluster/artifacts/admin.conf`. We can
+export this location in the shell such that the :program:`kubectl` and
+:program:`helm` tools know how to contact the cluster *kube-master* nodes, and
+authenticate properly::
 
     (metal-k8s) $ export KUBECONFIG=`pwd`/inventory/quickstart-cluster/artifacts/admin.conf