5 To install Ceph and other enabling software, you need to retrieve packages from
6 the Ceph repository. Follow this guide to get packages; then, proceed to the
7 `Install Ceph Object Storage`_.
13 There are two ways to get packages:
15 - **Add Repositories:** Adding repositories is the easiest way to get packages,
16 because package management tools will retrieve the packages and all enabling
17 software for you in most cases. However, to use this approach, each
18 :term:`Ceph Node` in your cluster must have internet access.
20 - **Download Packages Manually:** Downloading packages manually is a convenient
21 way to install Ceph if your environment does not allow a :term:`Ceph Node` to
28 All Ceph deployments require Ceph packages (except for development). You should
29 also add keys and recommended packages.
31 - **Keys: (Recommended)** Whether you add repositories or download packages
32 manually, you should download keys to verify the packages. If you do not get
33 the keys, you may encounter security warnings. There are two keys: one for
34 releases (common) and one for development (programmers and QA only). Choose
35 the key that suits your needs. See `Add Keys`_ for details.
37 - **Ceph: (Required)** All Ceph deployments require Ceph release packages,
38 except for deployments that use development packages (development, QA, and
39 bleeding edge deployments only). See `Add Ceph`_ for details.
41 - **Ceph Development: (Optional)** If you are developing for Ceph, testing Ceph
42 development builds, or if you want features from the bleeding edge of Ceph
43 development, you may get Ceph development packages. See
44 `Add Ceph Development`_ for details.
46 - **Apache/FastCGI: (Optional)** If you are deploying a
47 :term:`Ceph Object Storage` service, you must install Apache and FastCGI.
48 Ceph provides Apache and FastCGI builds that are identical to those available
49 from Apache, but with 100-continue support. If you want to enable
50 :term:`Ceph Object Gateway` daemons with 100-continue support, you must
51 retrieve Apache/FastCGI packages from the Ceph repository.
52 See `Add Apache/FastCGI`_ for details.
55 If you intend to download packages manually, see Section `Download Packages`_.
61 Add a key to your system's list of trusted keys to avoid a security warning. For
62 major releases (e.g., ``hammer``, ``jewel``) and development releases
63 (``release-name-rc1``, ``release-name-rc2``), use the ``release.asc`` key. For
64 development testing packages, use the ``autobuild.asc`` key (developers and
71 To install the ``release.asc`` key, execute the following::
73 wget -q -O- 'https://download.ceph.com/keys/release.asc' | sudo apt-key add -
76 To install the ``autobuild.asc`` key, execute the following
77 (QA and developers only)::
79 wget -q -O- 'https://download.ceph.com/keys/autobuild.asc' | sudo apt-key add -
85 To install the ``release.asc`` key, execute the following::
87 sudo rpm --import 'https://download.ceph.com/keys/release.asc'
89 To install the ``autobuild.asc`` key, execute the following
90 (QA and developers only)::
92 sudo rpm --import 'https://download.ceph.com/keys/autobuild.asc'
98 Release repositories use the ``release.asc`` key to verify packages.
99 To install Ceph packages with the Advanced Package Tool (APT) or
100 Yellowdog Updater, Modified (YUM), you must add Ceph repositories.
102 You may find releases for Debian/Ubuntu (installed with APT) at::
104 https://download.ceph.com/debian-{release-name}
106 You may find releases for CentOS/RHEL and others (installed with YUM) at::
108 https://download.ceph.com/rpm-{release-name}
110 The major releases of Ceph are summarized at:
112 http://docs.ceph.com/docs/master/releases/
114 Every second major release is considered Long Term Stable (LTS). Critical
115 bugfixes are backported to LTS releases until their retirement. Since retired
116 releases are no longer maintained, we recommend that users upgrade their
117 clusters regularly - preferably to the latest LTS release.
119 The most recent LTS release is Jewel (10.2.x).
121 .. tip:: For international users: There might be a mirror close to you where download Ceph from. For more information see: `Ceph Mirrors`_.
126 Add a Ceph package repository to your system's list of APT sources. For newer
127 versions of Debian/Ubuntu, call ``lsb_release -sc`` on the command line to
128 get the short codename, and replace ``{codename}`` in the following command. ::
130 sudo apt-add-repository 'deb https://download.ceph.com/debian-jewel/ {codename} main'
132 For early Linux distributions, you may execute the following command::
134 echo deb https://download.ceph.com/debian-jewel/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
136 For earlier Ceph releases, replace ``{release-name}`` with the name with the
137 name of the Ceph release. You may call ``lsb_release -sc`` on the command line
138 to get the short codename, and replace ``{codename}`` in the following command.
141 sudo apt-add-repository 'deb https://download.ceph.com/debian-{release-name}/ {codename} main'
143 For older Linux distributions, replace ``{release-name}`` with the name of the
146 echo deb https://download.ceph.com/debian-{release-name}/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
148 Ceph on ARM processors requires Google's memory profiling tools (``google-perftools``).
149 The Ceph repository should have a copy at
150 https://download.ceph.com/packages/google-perftools/debian. ::
152 echo deb https://download.ceph.com/packages/google-perftools/debian $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/google-perftools.list
155 For development release packages, add our package repository to your system's
156 list of APT sources. See `the testing Debian repository`_ for a complete list
157 of Debian and Ubuntu releases supported. ::
159 echo deb https://download.ceph.com/debian-testing/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
161 .. tip:: For international users: There might be a mirror close to you where download Ceph from. For more information see: `Ceph Mirrors`_.
166 For major releases, you may add a Ceph entry to the ``/etc/yum.repos.d``
167 directory. Create a ``ceph.repo`` file. In the example below, replace
168 ``{ceph-release}`` with a major release of Ceph (e.g., ``hammer``, ``jewel``,
169 etc.) and ``{distro}`` with your Linux distribution (e.g., ``el7``, etc.). You
170 may view https://download.ceph.com/rpm-{ceph-release}/ directory to see which
171 distributions Ceph supports. Some Ceph packages (e.g., EPEL) must take priority
172 over standard packages, so you must ensure that you set
176 name=Ceph packages for $basearch
177 baseurl=https://download.ceph.com/rpm-{ceph-release}/{distro}/$basearch
181 gpgkey=https://download.ceph.com/keys/release.asc
184 name=Ceph noarch packages
185 baseurl=https://download.ceph.com/rpm-{ceph-release}/{distro}/noarch
189 gpgkey=https://download.ceph.com/keys/release.asc
192 name=Ceph source packages
193 baseurl=https://download.ceph.com/rpm-{ceph-release}/{distro}/SRPMS
197 gpgkey=https://download.ceph.com/keys/release.asc
200 For development release packages, you may specify the repository
201 for development releases instead. ::
204 name=Ceph packages for $basearch/$releasever
205 baseurl=https://download.ceph.com/rpm-testing/{distro}/$basearch
209 gpgkey=https://download.ceph.com/keys/release.asc
212 name=Ceph noarch packages
213 baseurl=https://download.ceph.com/rpm-testing/{distro}/noarch
217 gpgkey=https://download.ceph.com/keys/release.asc
220 name=Ceph source packages
221 baseurl=https://download.ceph.com/rpm-testing/{distro}/SRPMS
225 gpgkey=https://download.ceph.com/keys/release.asc
228 For specific packages, you may retrieve them by specifically downloading the
229 release package by name. Our development process generates a new release of Ceph
230 every 3-4 weeks. These packages are faster-moving than the major releases.
231 Development packages have new features integrated quickly, while still
232 undergoing several weeks of QA prior to release.
234 The repository package installs the repository details on your local system for
235 use with ``yum``. Replace ``{distro}`` with your Linux distribution, and
236 ``{release}`` with the specific release of Ceph::
238 su -c 'rpm -Uvh https://download.ceph.com/rpms/{distro}/x86_64/ceph-{release}.el7.noarch.rpm'
240 You can download the RPMs directly from::
242 https://download.ceph.com/rpm-testing
244 .. tip:: For international users: There might be a mirror close to you where download Ceph from. For more information see: `Ceph Mirrors`_.
250 Development repositories use the ``autobuild.asc`` key to verify packages.
251 If you are developing Ceph and need to deploy and test specific Ceph branches,
252 ensure that you remove repository entries for major releases first.
258 We automatically build Debian and Ubuntu packages for current
259 development branches in the Ceph source code repository. These
260 packages are intended for developers and QA only.
262 Add our package repository to your system's list of APT sources, but
263 replace ``{BRANCH}`` with the branch you'd like to use (e.g., chef-3,
264 wip-hack, master). See `the gitbuilder page`_ for a complete
265 list of distributions we build. ::
267 echo deb http://gitbuilder.ceph.com/ceph-deb-$(lsb_release -sc)-x86_64-basic/ref/{BRANCH} $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
273 For current development branches, you may add a Ceph entry to the
274 ``/etc/yum.repos.d`` directory. Create a ``ceph.repo`` file. In the example
275 below, replace ``{distro}`` with your Linux distribution (e.g., ``el7``), and
276 ``{branch}`` with the name of the branch you want to install. ::
280 name=Ceph source packages
281 baseurl=http://gitbuilder.ceph.com/ceph-rpm-{distro}-x86_64-basic/ref/{branch}/SRPMS
284 gpgkey=https://download.ceph.com/keys/autobuild.asc
287 You may view http://gitbuilder.ceph.com directory to see which distributions
294 Ceph Object Gateway works with ordinary Apache and FastCGI libraries. However,
295 Ceph builds Apache and FastCGI packages that support 100-continue. To use the
296 Ceph Apache and FastCGI packages, add them to your repository.
302 Add our Apache and FastCGI packages to your system's list of APT sources if you intend to
305 echo deb http://gitbuilder.ceph.com/apache2-deb-$(lsb_release -sc)-x86_64-basic/ref/master $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph-apache.list
306 echo deb http://gitbuilder.ceph.com/libapache-mod-fastcgi-deb-$(lsb_release -sc)-x86_64-basic/ref/master $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph-fastcgi.list
312 You may add a Ceph entry to the ``/etc/yum.repos.d`` directory. Create a
313 ``ceph-apache.repo`` file. In the example below, replace ``{distro}`` with your
314 Linux distribution (e.g., ``el7``). You may view http://gitbuilder.ceph.com
315 directory to see which distributions Ceph supports.
319 [apache2-ceph-noarch]
320 name=Apache noarch packages for Ceph
321 baseurl=http://gitbuilder.ceph.com/apache2-rpm-{distro}-x86_64-basic/ref/master
325 gpgkey=https://download.ceph.com/keys/autobuild.asc
327 [apache2-ceph-source]
328 name=Apache source packages for Ceph
329 baseurl=http://gitbuilder.ceph.com/apache2-rpm-{distro}-x86_64-basic/ref/master
333 gpgkey=https://download.ceph.com/keys/autobuild.asc
336 Repeat the forgoing process by creating a ``ceph-fastcgi.repo`` file. ::
338 [fastcgi-ceph-basearch]
339 name=FastCGI basearch packages for Ceph
340 baseurl=http://gitbuilder.ceph.com/mod_fastcgi-rpm-{distro}-x86_64-basic/ref/master
344 gpgkey=https://download.ceph.com/keys/autobuild.asc
346 [fastcgi-ceph-noarch]
347 name=FastCGI noarch packages for Ceph
348 baseurl=http://gitbuilder.ceph.com/mod_fastcgi-rpm-{distro}-x86_64-basic/ref/master
352 gpgkey=https://download.ceph.com/keys/autobuild.asc
354 [fastcgi-ceph-source]
355 name=FastCGI source packages for Ceph
356 baseurl=http://gitbuilder.ceph.com/mod_fastcgi-rpm-{distro}-x86_64-basic/ref/master
360 gpgkey=https://download.ceph.com/keys/autobuild.asc
366 If you are attempting to install behind a firewall in an environment without internet
367 access, you must retrieve the packages (mirrored with all the necessary dependencies)
368 before attempting an install.
373 Ceph requires additional additional third party libraries.
379 - libgoogle-perftools4
384 The repository package installs the repository details on your local system for
385 use with ``apt``. Replace ``{release}`` with the latest Ceph release. Replace
386 ``{version}`` with the latest Ceph version number. Replace ``{distro}`` with
387 your Linux distribution codename. Replace ``{arch}`` with the CPU architecture.
391 wget -q https://download.ceph.com/debian-{release}/pool/main/c/ceph/ceph_{version}{distro}_{arch}.deb
397 Ceph requires additional additional third party libraries.
398 To add the EPEL repository, execute the following::
400 sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
402 Ceph requires the following packages:
411 Packages are currently built for the RHEL/CentOS7 (``el7``) platforms. The
412 repository package installs the repository details on your local system for use
413 with ``yum``. Replace ``{distro}`` with your distribution. ::
415 su -c 'rpm -Uvh https://download.ceph.com/rpm-jewel/{distro}/noarch/ceph-{version}.{distro}.noarch.rpm'
417 For example, for CentOS 7 (``el7``)::
419 su -c 'rpm -Uvh https://download.ceph.com/rpm-jewel/el7/noarch/ceph-release-1-0.el7.noarch.rpm'
421 You can download the RPMs directly from::
423 https://download.ceph.com/rpm-jewel
426 For earlier Ceph releases, replace ``{release-name}`` with the name
427 with the name of the Ceph release. You may call ``lsb_release -sc`` on the command
428 line to get the short codename. ::
430 su -c 'rpm -Uvh https://download.ceph.com/rpm-{release-name}/{distro}/noarch/ceph-{version}.{distro}.noarch.rpm'
435 .. _Install Ceph Object Storage: ../install-storage-cluster
436 .. _the testing Debian repository: https://download.ceph.com/debian-testing/dists
437 .. _the gitbuilder page: http://gitbuilder.ceph.com
438 .. _Ceph Mirrors: ../mirrors