diff --git a/documentation/operator-guide/setup.rst b/documentation/operator-guide/setup.rst index ea94042ff6fb5dd1d0a31b7fcc93e917c8a78908..b570d9a40146583b1c4ebea1d5ee42c389a79a10 100644 --- a/documentation/operator-guide/setup.rst +++ b/documentation/operator-guide/setup.rst @@ -5,7 +5,8 @@ Setup In this chapter the setup of a new VS stack is detailed. Before this step can be done, the configuration and environment files need to be present. These -files can be added manually or be created in the :ref:`initialization` step. +files can be added manually or be created as described in the +:ref:`initialization` step. Docker @@ -44,7 +45,7 @@ Docker Swarm Now that Docker is installed, the machine can either create a new swarm or join an existing one. -To create a new Swarm, the following command can be used: +To create a new Swarm, the following command is used: .. code-block:: bash @@ -69,12 +70,12 @@ This prints out a command that can be run on a machine to join the swarm: Additional information for swarm management can be obtained in the official -documentation of the project: -https://docs.docker.com/engine/reference/commandline/swarm/ +`documentation of the project +<https://docs.docker.com/engine/reference/commandline/swarm/>`_. -Image retrieval ---------------- +Docker Image Retrieval +---------------------- Before the Docker images can be used, they have to be retrieved first. With images from the default repository, this happens automatically. When private @@ -115,7 +116,7 @@ service identifier: This command actually performs a variety of tasks. First off, it obtains any -missing images, such as the image for the reverse proxy, the database or the +missing images, such as the image for the reverse proxy, the database, or the redis key-value store. When all relevant images are pulled from their respective repository the @@ -123,7 +124,10 @@ services of the stack are initialized. In the default setting, each service is represented by a single container of its respective service type. When starting for the first time, the startup procedure takes some time, as everything needs to be initialized. This includes the creation of the database, user, -required tables and the Django instance. +required tables, and the Django instance. That process can be supervised using the ``docker service ls`` command, which lists all available services and their respective status. + +Continue to the next section :ref:`configuration` to read how a running VS +stack can be configured.