7 To install Ceph and other enabling software, you need to retrieve packages from
10 There are three ways to get packages:
12 - **Cephadm:** Cephadm can configure your Ceph repositories for you
13 based on a release name or a specific Ceph version. Each
14 :term:`Ceph Node` in your cluster must have internet access.
16 - **Configure Repositories Manually:** You can manually configure your
17 package management tool to retrieve Ceph packages and all enabling
18 software. Each :term:`Ceph Node` in your cluster must have internet
21 - **Download Packages Manually:** Downloading packages manually is a convenient
22 way to install Ceph if your environment does not allow a :term:`Ceph Node` to
25 Install packages with cephadm
26 =============================
28 #. Download the cephadm script
33 curl --silent --remote-name --location https://github.com/ceph/ceph/raw/|stable-release|/src/cephadm/cephadm
36 #. Configure the Ceph repository based on the release name::
38 ./cephadm add-repo --release nautilus
40 For Octopus (15.2.0) and later releases, you can also specify a specific
43 ./cephadm add-repo --version 15.2.1
45 For development packages, you can specify a specific branch name::
47 ./cephadm add-repo --dev my-branch
49 #. Install the appropriate packages. You can install them using your
50 package management tool (e.g., APT, Yum) directly, or you can also
51 use the cephadm wrapper. For example::
53 ./cephadm install ceph-common
56 Configure Repositories Manually
57 ===============================
59 All Ceph deployments require Ceph packages (except for development). You should
60 also add keys and recommended packages.
62 - **Keys: (Recommended)** Whether you add repositories or download packages
63 manually, you should download keys to verify the packages. If you do not get
64 the keys, you may encounter security warnings.
66 - **Ceph: (Required)** All Ceph deployments require Ceph release packages,
67 except for deployments that use development packages (development, QA, and
68 bleeding edge deployments only).
70 - **Ceph Development: (Optional)** If you are developing for Ceph, testing Ceph
71 development builds, or if you want features from the bleeding edge of Ceph
72 development, you may get Ceph development packages.
79 Add a key to your system's list of trusted keys to avoid a security warning. For
80 major releases (e.g., ``luminous``, ``mimic``, ``nautilus``) and development releases
81 (``release-name-rc1``, ``release-name-rc2``), use the ``release.asc`` key.
87 To install the ``release.asc`` key, execute the following::
89 wget -q -O- 'https://download.ceph.com/keys/release.asc' | sudo apt-key add -
95 To install the ``release.asc`` key, execute the following::
97 sudo rpm --import 'https://download.ceph.com/keys/release.asc'
100 ---------------------
102 Release repositories use the ``release.asc`` key to verify packages.
103 To install Ceph packages with the Advanced Package Tool (APT) or
104 Yellowdog Updater, Modified (YUM), you must add Ceph repositories.
106 You may find releases for Debian/Ubuntu (installed with APT) at::
108 https://download.ceph.com/debian-{release-name}
110 You may find releases for CentOS/RHEL and others (installed with YUM) at::
112 https://download.ceph.com/rpm-{release-name}
114 For Octopus and later releases, you can also configure a repository for a
115 specific version ``x.y.z``. For Debian/Ubuntu packages::
117 https://download.ceph.com/debian-{version}
121 https://download.ceph.com/rpm-{version}
123 The major releases of Ceph are summarized at: :ref:`ceph-releases-general`
125 .. tip:: For non-US users: There might be a mirror close to you where
126 to download Ceph from. For more information see: `Ceph Mirrors`_.
131 Add a Ceph package repository to your system's list of APT sources. For newer
132 versions of Debian/Ubuntu, call ``lsb_release -sc`` on the command line to
133 get the short codename, and replace ``{codename}`` in the following command.
138 sudo apt-add-repository 'deb https://download.ceph.com/debian-|stable-release|/ {codename} main'
140 For early Linux distributions, you may execute the following command
145 echo deb https://download.ceph.com/debian-|stable-release|/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
147 For earlier Ceph releases, replace ``{release-name}`` with the name with the
148 name of the Ceph release. You may call ``lsb_release -sc`` on the command line
149 to get the short codename, and replace ``{codename}`` in the following command.
153 sudo apt-add-repository 'deb https://download.ceph.com/debian-{release-name}/ {codename} main'
155 For older Linux distributions, replace ``{release-name}`` with the name of the
160 echo deb https://download.ceph.com/debian-{release-name}/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
162 For development release packages, add our package repository to your system's
163 list of APT sources. See `the testing Debian repository`_ for a complete list
164 of Debian and Ubuntu releases supported.
168 echo deb https://download.ceph.com/debian-testing/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
170 .. tip:: For non-US users: There might be a mirror close to you where
171 to download Ceph from. For more information see: `Ceph Mirrors`_.
180 For major releases, you may add a Ceph entry to the ``/etc/yum.repos.d``
181 directory. Create a ``ceph.repo`` file. In the example below, replace
182 ``{ceph-release}`` with a major release of Ceph (e.g., ``|stable-release|``)
183 and ``{distro}`` with your Linux distribution (e.g., ``el8``, etc.). You
184 may view https://download.ceph.com/rpm-{ceph-release}/ directory to see which
185 distributions Ceph supports. Some Ceph packages (e.g., EPEL) must take priority
186 over standard packages, so you must ensure that you set
192 name=Ceph packages for $basearch
193 baseurl=https://download.ceph.com/rpm-{ceph-release}/{distro}/$basearch
197 gpgkey=https://download.ceph.com/keys/release.asc
200 name=Ceph noarch packages
201 baseurl=https://download.ceph.com/rpm-{ceph-release}/{distro}/noarch
205 gpgkey=https://download.ceph.com/keys/release.asc
208 name=Ceph source packages
209 baseurl=https://download.ceph.com/rpm-{ceph-release}/{distro}/SRPMS
213 gpgkey=https://download.ceph.com/keys/release.asc
216 For specific packages, you may retrieve them by downloading the release package
217 by name. Our development process generates a new release of Ceph every 3-4
218 weeks. These packages are faster-moving than the major releases. Development
219 packages have new features integrated quickly, while still undergoing several
220 weeks of QA prior to release.
222 The repository package installs the repository details on your local system for
223 use with ``yum``. Replace ``{distro}`` with your Linux distribution, and
224 ``{release}`` with the specific release of Ceph
228 su -c 'rpm -Uvh https://download.ceph.com/rpms/{distro}/x86_64/ceph-{release}.el7.noarch.rpm'
230 You can download the RPMs directly from
234 https://download.ceph.com/rpm-testing
236 .. tip:: For non-US users: There might be a mirror close to you where
237 to download Ceph from. For more information see: `Ceph Mirrors`_.
242 You need to add the Ceph package repository to your list of zypper sources. This can be done with the following command
246 zypper ar https://download.opensuse.org/repositories/filesystems:/ceph/openSUSE_Leap_15.1/filesystems:ceph.repo
251 The newest major release of Ceph is already available through the normal Tumbleweed repositories.
252 There's no need to add another package repository manually.
255 Ceph Development Packages
256 -------------------------
258 If you are developing Ceph and need to deploy and test specific Ceph branches,
259 ensure that you remove repository entries for major releases first.
265 We automatically build Ubuntu packages for current development branches in the
266 Ceph source code repository. These packages are intended for developers and QA
269 Add the package repository to your system's list of APT sources, but
270 replace ``{BRANCH}`` with the branch you'd like to use (e.g.,
271 wip-hack, master). See `the shaman page`_ for a complete
272 list of distributions we build.
276 curl -L https://shaman.ceph.com/api/repos/ceph/{BRANCH}/latest/ubuntu/$(lsb_release -sc)/repo/ | sudo tee /etc/apt/sources.list.d/shaman.list
278 .. note:: If the repository is not ready an HTTP 504 will be returned
280 The use of ``latest`` in the url, means it will figure out which is the last
281 commit that has been built. Alternatively, a specific sha1 can be specified.
282 For Ubuntu Xenial and the master branch of Ceph, it would look like
286 curl -L https://shaman.ceph.com/api/repos/ceph/master/53e772a45fdf2d211c0c383106a66e1feedec8fd/ubuntu/xenial/repo/ | sudo tee /etc/apt/sources.list.d/shaman.list
289 .. warning:: Development repositories are no longer available after two weeks.
294 For current development branches, you may add a Ceph entry to the
295 ``/etc/yum.repos.d`` directory. The `the shaman page`_ can be used to retrieve the full details
296 of a repo file. It can be retrieved via an HTTP request, for example
300 curl -L https://shaman.ceph.com/api/repos/ceph/{BRANCH}/latest/centos/7/repo/ | sudo tee /etc/yum.repos.d/shaman.repo
302 The use of ``latest`` in the url, means it will figure out which is the last
303 commit that has been built. Alternatively, a specific sha1 can be specified.
304 For CentOS 7 and the master branch of Ceph, it would look like
308 curl -L https://shaman.ceph.com/api/repos/ceph/master/53e772a45fdf2d211c0c383106a66e1feedec8fd/centos/7/repo/ | sudo tee /etc/apt/sources.list.d/shaman.list
311 .. warning:: Development repositories are no longer available after two weeks.
313 .. note:: If the repository is not ready an HTTP 504 will be returned
315 Download Packages Manually
316 --------------------------
318 If you are attempting to install behind a firewall in an environment without internet
319 access, you must retrieve the packages (mirrored with all the necessary dependencies)
320 before attempting an install.
325 Ceph requires additional third party libraries.
331 - libgoogle-perftools4
336 The repository package installs the repository details on your local system for
337 use with ``apt``. Replace ``{release}`` with the latest Ceph release. Replace
338 ``{version}`` with the latest Ceph version number. Replace ``{distro}`` with
339 your Linux distribution codename. Replace ``{arch}`` with the CPU architecture.
343 wget -q https://download.ceph.com/debian-{release}/pool/main/c/ceph/ceph_{version}{distro}_{arch}.deb
349 Ceph requires additional third party libraries.
350 To add the EPEL repository, execute the following
354 sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
356 Ceph requires the following packages:
365 Packages are currently built for the RHEL/CentOS7 (``el7``) platforms. The
366 repository package installs the repository details on your local system for use
367 with ``yum``. Replace ``{distro}`` with your distribution.
372 su -c 'rpm -Uvh https://download.ceph.com/rpm-|stable-release|/{distro}/noarch/ceph-{version}.{distro}.noarch.rpm'
374 For example, for CentOS 8 (``el8``)
379 su -c 'rpm -Uvh https://download.ceph.com/rpm-|stable-release|/el8/noarch/ceph-release-1-0.el8.noarch.rpm'
381 You can download the RPMs directly from
386 https://download.ceph.com/rpm-|stable-release|
389 For earlier Ceph releases, replace ``{release-name}`` with the name
390 with the name of the Ceph release. You may call ``lsb_release -sc`` on the command
391 line to get the short codename.
395 su -c 'rpm -Uvh https://download.ceph.com/rpm-{release-name}/{distro}/noarch/ceph-{version}.{distro}.noarch.rpm'
399 .. _the testing Debian repository: https://download.ceph.com/debian-testing/dists
400 .. _the shaman page: https://shaman.ceph.com
401 .. _Ceph Mirrors: ../mirrors