diff --git a/docs/source/installation/containerized.rst b/docs/source/installation/containerized.rst new file mode 100644 index 000000000..1aeb61474 --- /dev/null +++ b/docs/source/installation/containerized.rst @@ -0,0 +1,4 @@ +Containerized deployment +======================== + +Ceph-ansible supports docker and podman only in order to deploy Ceph in a containerized context. \ No newline at end of file diff --git a/docs/source/installation/methods.rst b/docs/source/installation/methods.rst index 682b6d0a0..d146dce4b 100644 --- a/docs/source/installation/methods.rst +++ b/docs/source/installation/methods.rst @@ -1,69 +1,10 @@ Installation methods ==================== -The following are all of the available options for the installing Ceph through different channels. +ceph-ansible can deploy Ceph either in a non-containerized context (via packages) or in a containerized context using ceph-container images. -We support 3 main installation methods, all managed by the ``ceph_origin`` variable: +.. toctree:: + :maxdepth: 1 -- ``repository``: means that you will get Ceph installed through a new repository. Later below choose between ``community``, ``rhcs`` or ``dev``. These options will be exposed through the ``ceph_repository`` variable. -- ``distro``: means that no separate repo file will be added and you will get whatever version of Ceph is included in your Linux distro. -- ``local``: means that the Ceph binaries will be copied over from the local machine (not well tested, use at your own risk) - -Origin: Repository ------------------- - -If ``ceph_origin`` is set to ``repository``, you now have the choice between a couple of repositories controlled by the ``ceph_repository`` option: - -- ``community``: fetches packages from http://download.ceph.com, the official community Ceph repositories -- ``rhcs``: means you are a Red Hat customer, additionally you will have to select a repository type through ``ceph_repository_type`` (``cdn`` or ``iso``) -- ``dev``: fetches packages from shaman, a gitbuilder based package system -- ``uca``: fetches packages from Ubuntu Cloud Archive -- ``custom``: fetches packages from a specific repository - -Community repository -~~~~~~~~~~~~~~~~~~~~ - -If ``ceph_repository`` is set to ``community``, packages you will be by default installed from http://download.ceph.com, this can be changed by tweaking ``ceph_mirror``. -Final step is to select which Ceph release you want to install, for this you have to set ``ceph_stable_release`` accordingly. -For example, ``ceph_stable_release: luminous``. - -RHCS repository -~~~~~~~~~~~~~~~ - -RHCS is the Red Hat Ceph Storage product from Red Hat, the enterprise version of Ceph. -If ``ceph_repository`` is set to ``rhcs``, packages you will be installed from Red Hat sources. - -Additionally you will have to select a repository type through ``ceph_repository_type``, it can be ``cdn`` or ``iso``. -To choose a specific version of RHCS you can set the ``ceph_rhcs_version`` variable accordingly, e.g: ``ceph_rhcs_version: 2``. - -UCA repository -~~~~~~~~~~~~~~ - -If ``ceph_repository`` is set to ``uca``, packages you will be by default installed from http://ubuntu-cloud.archive.canonical.com/ubuntu, this can be changed by tweaking ``ceph_stable_repo_uca``. -You can also decide which OpenStack version the Ceph packages should come from by tweaking ``ceph_stable_openstack_release_uca``. -For example, ``ceph_stable_openstack_release_uca: queens``. - -Dev repository -~~~~~~~~~~~~~~ - -If ``ceph_repository`` is set to ``dev``, packages you will be by default installed from https://shaman.ceph.com/, this can not be tweaked. -You can obviously decide which branch to install with the help of ``ceph_dev_branch`` (defaults to 'master'). -Additionally, you can specify a SHA1 with ``ceph_dev_sha1``, defaults to 'latest' (as in latest built). - -Custom repository -~~~~~~~~~~~~~~~~~ - -If ``ceph_repository`` is set to ``custom``, packages you will be by default installed from a desired repository. -This repository is specifie with ``ceph_custom_repo``, e.g: ``ceph_custom_repo: https://server.domain.com/ceph-custom-repo``. - - -Origin: Distro --------------- - -If ``ceph_origin`` is set to ``distro``, no separate repo file will be added and you will get whatever version of Ceph is included in your Linux distro. - - -Origin: Local -------------- - -If ``ceph_origin`` is set to ``local``, the ceph binaries will be copied over from the local machine (not well tested, use at your own risk) + non-containerized + containerized diff --git a/docs/source/installation/non-containerized.rst b/docs/source/installation/non-containerized.rst new file mode 100644 index 000000000..a00d66648 --- /dev/null +++ b/docs/source/installation/non-containerized.rst @@ -0,0 +1,69 @@ +Non containerized deployement +============================= + +The following are all of the available options for the installing Ceph through different channels. + +We support 3 main installation methods, all managed by the ``ceph_origin`` variable: + +- ``repository``: means that you will get Ceph installed through a new repository. Later below choose between ``community``, ``rhcs`` or ``dev``. These options will be exposed through the ``ceph_repository`` variable. +- ``distro``: means that no separate repo file will be added and you will get whatever version of Ceph is included in your Linux distro. +- ``local``: means that the Ceph binaries will be copied over from the local machine (not well tested, use at your own risk) + +Origin: Repository +------------------ + +If ``ceph_origin`` is set to ``repository``, you now have the choice between a couple of repositories controlled by the ``ceph_repository`` option: + +- ``community``: fetches packages from http://download.ceph.com, the official community Ceph repositories +- ``rhcs``: means you are a Red Hat customer, additionally you will have to select a repository type through ``ceph_repository_type`` (``cdn`` or ``iso``) +- ``dev``: fetches packages from shaman, a gitbuilder based package system +- ``uca``: fetches packages from Ubuntu Cloud Archive +- ``custom``: fetches packages from a specific repository + +Community repository +~~~~~~~~~~~~~~~~~~~~ + +If ``ceph_repository`` is set to ``community``, packages you will be by default installed from http://download.ceph.com, this can be changed by tweaking ``ceph_mirror``. +Final step is to select which Ceph release you want to install, for this you have to set ``ceph_stable_release`` accordingly. +For example, ``ceph_stable_release: luminous``. + +RHCS repository +~~~~~~~~~~~~~~~ + +RHCS is the Red Hat Ceph Storage product from Red Hat, the enterprise version of Ceph. +If ``ceph_repository`` is set to ``rhcs``, packages you will be installed from Red Hat sources. + +Additionally you will have to select a repository type through ``ceph_repository_type``, it can be ``cdn`` or ``iso``. +To choose a specific version of RHCS you can set the ``ceph_rhcs_version`` variable accordingly, e.g: ``ceph_rhcs_version: 2``. + +UCA repository +~~~~~~~~~~~~~~ + +If ``ceph_repository`` is set to ``uca``, packages you will be by default installed from http://ubuntu-cloud.archive.canonical.com/ubuntu, this can be changed by tweaking ``ceph_stable_repo_uca``. +You can also decide which OpenStack version the Ceph packages should come from by tweaking ``ceph_stable_openstack_release_uca``. +For example, ``ceph_stable_openstack_release_uca: queens``. + +Dev repository +~~~~~~~~~~~~~~ + +If ``ceph_repository`` is set to ``dev``, packages you will be by default installed from https://shaman.ceph.com/, this can not be tweaked. +You can obviously decide which branch to install with the help of ``ceph_dev_branch`` (defaults to 'master'). +Additionally, you can specify a SHA1 with ``ceph_dev_sha1``, defaults to 'latest' (as in latest built). + +Custom repository +~~~~~~~~~~~~~~~~~ + +If ``ceph_repository`` is set to ``custom``, packages you will be by default installed from a desired repository. +This repository is specifie with ``ceph_custom_repo``, e.g: ``ceph_custom_repo: https://server.domain.com/ceph-custom-repo``. + + +Origin: Distro +-------------- + +If ``ceph_origin`` is set to ``distro``, no separate repo file will be added and you will get whatever version of Ceph is included in your Linux distro. + + +Origin: Local +------------- + +If ``ceph_origin`` is set to ``local``, the ceph binaries will be copied over from the local machine (not well tested, use at your own risk)