]> git.proxmox.com Git - ceph.git/blobdiff - ceph/doc/cephadm/install.rst
import quincy beta 17.1.0
[ceph.git] / ceph / doc / cephadm / install.rst
index 269bdfbcad53240734bcd33039c99156276d06e9..e9272a55f518adfc0237344734e530f02575234d 100644 (file)
@@ -213,22 +213,20 @@ available options.
   designate with this option must have passwordless sudo access.
 
 * If you are using a container on an authenticated registry that requires
-  login, you may add the three arguments:
-  #. ``--registry-url <url of registry>``
-
-  #. ``--registry-username <username of account on registry>``
+  login, you may add the argument:
 
-  #. ``--registry-password <password of account on registry>`` 
+  * ``--registry-json <path to json file>`` 
 
-  OR
+  example contents of JSON file with login info::
 
-  * ``--registry-json <json file with login info>`` 
+      {"url":"REGISTRY_URL", "username":"REGISTRY_USERNAME", "password":"REGISTRY_PASSWORD"}
   
   Cephadm will attempt to log in to this registry so it can pull your container
   and then store the login info in its config database. Other hosts added to
   the cluster will then also be able to make use of the authenticated registry.
 
+* See :ref:`cephadm-deployment-scenarios` for additional examples for using ``cephadm bootstrap``.
+
 .. _cephadm-enable-cli:
 
 Enable Ceph CLI
@@ -316,7 +314,31 @@ available and unused device:
 
     ceph orch apply osd --all-available-devices
 
-Or See :ref:`cephadm-deploy-osds` for more detailed instructions.
+See :ref:`cephadm-deploy-osds` for more detailed instructions.
+
+Enabling OSD memory autotuning
+------------------------------
+
+.. warning:: By default, cephadm enables ``osd_memory_target_autotune`` on bootstrap, with ``mgr/cephadm/autotune_memory_target_ratio`` set to ``.7`` of total host memory.
+
+See :ref:`osd_autotune`.
+
+To deploy hyperconverged Ceph with TripleO, please refer to the TripleO documentation: `Scenario: Deploy Hyperconverged Ceph <https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/features/cephadm.html#scenario-deploy-hyperconverged-ceph>`_
+
+In other cases where the cluster hardware is not exclusively used by Ceph (hyperconverged),
+reduce the memory consumption of Ceph like so:
+
+  .. prompt:: bash #
+
+    # hyperconverged only:
+    ceph config set mgr mgr/cephadm/autotune_memory_target_ratio 0.2
+
+Then enable memory autotuning:
+
+  .. prompt:: bash #
+
+    ceph config set osd osd_memory_target_autotune true
+
 
 Using Ceph
 ==========
@@ -329,5 +351,46 @@ To use *NFS*, follow :ref:`deploy-cephadm-nfs-ganesha`
 
 To use *iSCSI*, follow :ref:`cephadm-iscsi`
 
+.. _cephadm-deployment-scenarios:
+
+Different deployment scenarios
+==============================
+
+Single host
+-----------
+
+To configure a Ceph cluster to run on a single host, use the ``--single-host-defaults`` flag when bootstrapping. For use cases of this, see :ref:`one-node-cluster`.
+
+The ``--single-host-defaults`` flag sets the following configuration options::
+
+  global/osd_crush_choose_leaf_type = 0
+  global/osd_pool_default_size = 2
+  mgr/mgr_standby_modules = False
+   
+For more information on these options, see :ref:`one-node-cluster` and ``mgr_standby_modules`` in :ref:`mgr-administrator-guide`.
+
+Deployment in an isolated environment
+-------------------------------------
+
+You can install Cephadm in an isolated environment by using a custom container registry. You can either configure Podman or Docker to use an insecure registry, or make the registry secure. Ensure your container image is inside the registry and that you have access to all hosts you wish to add to the cluster.
+
+Run a local container registry:
+
+.. prompt:: bash #
+
+   podman run --privileged -d --name registry -p 5000:5000 -v /var/lib/registry:/var/lib/registry --restart=always registry:2
+
+If you are using an insecure registry, configure Podman or Docker with the hostname and port where the registry is running.
+
+.. note:: For every host which accesses the local insecure registry, you will need to repeat this step on the host.
+
+Next, push your container image to your local registry.
+
+Then run bootstrap using the ``--image`` flag with your container image. For example:
+
+.. prompt:: bash #
+
+   cephadm --image *<hostname>*:5000/ceph/ceph bootstrap --mon-ip *<mon-ip>*
+
 
-.. _cluster network: ../rados/configuration/network-config-ref#cluster-network
+.. _cluster network: ../rados/configuration/network-config-ref#cluster-network
\ No newline at end of file