From: Sage Weil <sage@redhat.com>
Date: Thu, 7 Nov 2019 15:03:49 +0000 (-0600)
Subject: doc/install/containers: add summary of containers and branches
X-Git-Tag: v15.1.0~804^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=cf97ec92276d73688666d7f14d274fc8bcdb0c6e;p=ceph.git

doc/install/containers: add summary of containers and branches

Signed-off-by: Sage Weil <sage@redhat.com>
---

diff --git a/doc/install/containers.rst b/doc/install/containers.rst
new file mode 100644
index 00000000000..c6fa82eaad8
--- /dev/null
+++ b/doc/install/containers.rst
@@ -0,0 +1,88 @@
+Ceph Container Images
+=====================
+
+Official Releases
+-----------------
+
+Ceph Container images are available from Docker Hub at::
+
+  https://hub.docker.com/r/ceph
+
+
+ceph/ceph
+^^^^^^^^^
+
+- General purpose Ceph container with all necessary daemons and
+  dependencies installed.
+- TODO: add vRELNUM.2.DOT so we have a container for every point release.
+
++------------------+--------------------------------------------------------------+
+| Tag              | Meaning                                                      |
++------------------+--------------------------------------------------------------+
+| vRELNUM          | Latest release in this series (e.g., *v14* = Nautilus)       |
++------------------+--------------------------------------------------------------+
+| vRELNUM.2        | Latest *stable* release in this stable series (e.g., *v14.2*)|
++------------------+--------------------------------------------------------------+
+
+ceph/daemon-base
+^^^^^^^^^^^^^^^^
+
+- General purpose Ceph container with all necessary daemons and
+  dependencies installed.
+- Basically the same as *ceph/ceph*, but with different tags.
+- Note that all of the *-devel* tags (and the *latest-master* tag) are based on
+  unreleased and generally untested packages from https://shaman.ceph.com.
+
+:note: This image will soon become an alias to *ceph/ceph*.
+
++------------------------+---------------------------------------------------------+
+| Tag                    | Meaning                                                 |
++------------------------+---------------------------------------------------------+
+| latest-master          | Build of master branch a last ceph-container.git update |
++------------------------+---------------------------------------------------------+
+| latest-master-devel    | Daily build of the master branch                        |
++------------------------+---------------------------------------------------------+
+| latest-RELEASE-devel   | Daily build of the *RELEASE* (e.g., nautilus) branch    |
++------------------------+---------------------------------------------------------+
+
+
+ceph/daemon
+^^^^^^^^^^^
+
+- *ceph/daemon-base* plus a collection of BASH scripts that are used
+  by ceph-nano and ceph-ansible to manage a Ceph cluster.
+
++------------------------+---------------------------------------------------------+
+| Tag                    | Meaning                                                 |
++------------------------+---------------------------------------------------------+
+| latest-master          | Build of master branch a last ceph-container.git update |
++------------------------+---------------------------------------------------------+
+| latest-master-devel    | Daily build of the master branch                        |
++------------------------+---------------------------------------------------------+
+| latest-RELEASE-devel   | Daily build of the *RELEASE* (e.g., nautilus) branch    |
++------------------------+---------------------------------------------------------+
+
+
+Development builds
+------------------
+
+We automatically build container images for development ``wip-*``
+branches in the ceph-ci.git repositories and push them to Quay at::
+
+  https://quay.io/organization/ceph-ci
+
+ceph-ci/ceph
+^^^^^^^^^^^^
+
+- This is analogous to the ceph/ceph image above
+- TODO: remove the ``wip-*`` limitation and also build ceph.git branches.
+
++------------------------------------+------------------------------------------------------+
+| Tag                                | Meaning                                              |
++------------------------------------+------------------------------------------------------+
+| BRANCH                             | Latest build of a given GIT branch (e.g., *wip-foo*) |
++------------------------------------+------------------------------------------------------+
+| BRANCH-SHORTSHA1-BASEOS-ARCH-devel | A specific build of a branch                         |
++------------------------------------+------------------------------------------------------+
+| SHA1                               | A specific build                                     |
++------------------------------------+------------------------------------------------------+
diff --git a/doc/install/index.rst b/doc/install/index.rst
index d9dde72cf45..3f6f5d278fd 100644
--- a/doc/install/index.rst
+++ b/doc/install/index.rst
@@ -22,6 +22,7 @@ repository and build Ceph yourself.
 	Clone Source <clone-source>
 	Build Ceph <build-ceph>
     	Ceph Mirrors <mirrors>
+	Ceph Containers <containers>
 
 
 Install Software