ceph/doc/install/containers.rst

   1 .. _containers:
   2
   3 Ceph Container Images
   4 =====================
   5
   6 .. important::
   7
   8    Using the ``:latest`` tag is discouraged. If you use the ``:latest``
   9    tag, there is no guarantee that the same image will be on each of
  10    your hosts.  Under these conditions, upgrades might not work
  11    properly. Remember that ``:latest`` is a relative tag, and a moving
  12    target.
  13
  14    Instead of the ``:latest`` tag, use explicit tags or image IDs. For
  15    example:
  16
  17    ``podman pull ceph/ceph:v15.2.0``
  18
  19 Official Releases
  20 -----------------
  21
  22 Ceph Container images are available from both Quay and Docker Hub::
  23
  24   https://quay.io/repository/ceph/ceph
  25   https://hub.docker.com/r/ceph
  26
  27 ceph/ceph
  28 ^^^^^^^^^
  29
  30 - General purpose Ceph container with all necessary daemons and
  31   dependencies installed.
  32
  33 +----------------------+--------------------------------------------------------------+
  34 | Tag                  | Meaning                                                      |
  35 +----------------------+--------------------------------------------------------------+
  36 | vRELNUM              | Latest release in this series (e.g., *v14* = Nautilus)       |
  37 +----------------------+--------------------------------------------------------------+
  38 | vRELNUM.2            | Latest *stable* release in this stable series (e.g., *v14.2*)|
  39 +----------------------+--------------------------------------------------------------+
  40 | vRELNUM.Y.Z          | A specific release (e.g., *v14.2.4*)                         |
  41 +----------------------+--------------------------------------------------------------+
  42 | vRELNUM.Y.Z-YYYYMMDD | A specific build (e.g., *v14.2.4-20191203*)                  |
  43 +----------------------+--------------------------------------------------------------+
  44
  45 Legacy container images
  46 -----------------------
  47
  48 Legacy container images are available from Docker Hub at::
  49
  50   https://hub.docker.com/r/ceph
  51
  52 ceph/daemon-base
  53 ^^^^^^^^^^^^^^^^
  54
  55 - General purpose Ceph container with all necessary daemons and
  56   dependencies installed.
  57 - Basically the same as *ceph/ceph*, but with different tags.
  58 - Note that all of the *-devel* tags (and the *latest-master* tag) are based on
  59   unreleased and generally untested packages from https://shaman.ceph.com.
  60
  61 :note: This image will soon become an alias to *ceph/ceph*.
  62
  63 +------------------------+---------------------------------------------------------+
  64 | Tag                    | Meaning                                                 |
  65 +------------------------+---------------------------------------------------------+
  66 | latest-master          | Build of master branch a last ceph-container.git update |
  67 +------------------------+---------------------------------------------------------+
  68 | latest-master-devel    | Daily build of the master branch                        |
  69 +------------------------+---------------------------------------------------------+
  70 | latest-RELEASE-devel   | Daily build of the *RELEASE* (e.g., nautilus) branch    |
  71 +------------------------+---------------------------------------------------------+
  72
  73
  74 ceph/daemon
  75 ^^^^^^^^^^^
  76
  77 - *ceph/daemon-base* plus a collection of BASH scripts that are used
  78   by ceph-nano and ceph-ansible to manage a Ceph cluster.
  79
  80 +------------------------+---------------------------------------------------------+
  81 | Tag                    | Meaning                                                 |
  82 +------------------------+---------------------------------------------------------+
  83 | latest-master          | Build of master branch a last ceph-container.git update |
  84 +------------------------+---------------------------------------------------------+
  85 | latest-master-devel    | Daily build of the master branch                        |
  86 +------------------------+---------------------------------------------------------+
  87 | latest-RELEASE-devel   | Daily build of the *RELEASE* (e.g., nautilus) branch    |
  88 +------------------------+---------------------------------------------------------+
  89
  90
  91 Development builds
  92 ------------------
  93
  94 We automatically build container images for development ``wip-*``
  95 branches in the ceph-ci.git repositories and push them to Quay at::
  96
  97   https://quay.ceph.io/organization/ceph-ci
  98
  99 ceph-ci/ceph
 100 ^^^^^^^^^^^^
 101
 102 - This is analogous to the ceph/ceph image above
 103 - TODO: remove the ``wip-*`` limitation and also build ceph.git branches.
 104
 105 +------------------------------------+------------------------------------------------------+
 106 | Tag                                | Meaning                                              |
 107 +------------------------------------+------------------------------------------------------+
 108 | BRANCH                             | Latest build of a given GIT branch (e.g., *wip-foo*) |
 109 +------------------------------------+------------------------------------------------------+
 110 | BRANCH-SHORTSHA1-BASEOS-ARCH-devel | A specific build of a branch                         |
 111 +------------------------------------+------------------------------------------------------+
 112 | SHA1                               | A specific build                                     |
 113 +------------------------------------+------------------------------------------------------+