Skip to content
Permalink
Browse files

[debops.docker_server] Refresh role documentation

  • Loading branch information...
drybjed committed Aug 13, 2019
1 parent f12e80b commit 3bbcb505b39ad41362bd4d194877f2538ac3d7c4
@@ -1,6 +1,6 @@
debops.docker_server - Manage Docker server using Ansible

Copyright (C) 2015-2016 Maciej Delmanowski <drybjed@gmail.com>
Copyright (C) 2015-2019 Maciej Delmanowski <drybjed@gmail.com>
Copyright (C) 2019 Imre Jonk <mail@imrejonk.nl>
Copyright (C) 2015-2019 DebOps https://debops.org/

This file was deleted.

@@ -41,11 +41,12 @@ This role does not support switching from Docker CE to Docker EE on an already
installed machine. It does support switching from distribution repository to
upstream. However, it is recommended to start with a clean machine if possible.

``debops.docker_server`` relies on configuration managed by :ref:`debops.core`,
:ref:`debops.ferm`, and :ref:`debops.pki` Ansible roles.
The :ref:`debops.docker_server` role relies on configuration managed by
:ref:`debops.core`, :ref:`debops.ferm`, and :ref:`debops.pki` Ansible roles.

.. _Docker variants: https://docs.docker.com/install/overview/


Useful variables
----------------

@@ -62,6 +63,7 @@ Ansible inventory to customize Docker:
:envvar:`docker_server__admins`
List of UNIX accounts that have access to Docker daemon socket.


Example inventory
-----------------

@@ -73,6 +75,7 @@ To configure Docker on a given remote host, it needs to be added to the
[debops_service_docker_server]
hostname


Example playbook
----------------

@@ -81,6 +84,7 @@ Here's an example playbook that can be used to manage Docker:
.. literalinclude:: ../../../../ansible/playbooks/service/docker_server.yml
:language: yaml


Ansible tags
------------

@@ -100,3 +104,34 @@ Available role tags:

``role::docker_server:admins``
Manage access to Docker daemon by UNIX accounts.


Other resources
---------------

List of other useful resources related to the ``debops.docker_server`` Ansible
role:

- Manual pages: :man:`docker(1)`, :man:`docker-run(1)`, :man:`Dockerfile(5)`,
:man:`docker-compose(1)`

- `Docker`__ page on Debian Wiki

.. __: https://wiki.debian.org/Docker
- `Docker`__ page on Arch Linux Wiki

.. __: https://wiki.archlinux.org/index.php/Docker
- `Docker documentation page`__

.. __: https://docs.docker.com/
- `Docker guide for Ansible`__

.. __: https://docs.ansible.com/ansible/latest/scenario_guides/guide_docker.html
- Official DebOps image in the Docker Hub: `debops/debops`__ (see also
:ref:`quick_start__docker`)

.. __: https://hub.docker.com/r/debops/debops
@@ -3,16 +3,28 @@
debops.docker_server
====================

`Docker`_ is a lightweight virtualization platform based on Linux kernel
features that allow creation and management of isolated application
environments.

.. _Docker: https://docker.com/

The ``debops.docker_server`` role can be used to install and configure Docker
service on Debian/Ubuntu hosts. To role supports installation of Docker from OS
distribution repositories, as well as from the upstream repository.

.. toctree::
:maxdepth: 2

introduction
getting-started
defaults/main
defaults-detailed
docker-virtualenv
copyright
upgrade

Copyright
---------

.. literalinclude:: ../../../../ansible/roles/debops.docker_server/COPYRIGHT

..
Local Variables:

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 3bbcb50

Please sign in to comment.
You can’t perform that action at this time.