From 044f47092d6f3f170729dc8af6d2f9b218f3ec8e Mon Sep 17 00:00:00 2001
From: Giulio Fidente <gfidente@redhat.com>
Date: Tue, 31 May 2016 17:54:20 +0200
Subject: [PATCH] Add instructions on how to configure Ceph with arbitrary
 settings

Change-Id: Id5ba6dbbe9763c8444c112aa64a33cecae7a0eb9
---
 .../advanced_deployment.rst                   |  1 +
 .../advanced_deployment/ceph_config.rst       | 49 +++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 doc/source/advanced_deployment/ceph_config.rst

diff --git a/doc/source/advanced_deployment/advanced_deployment.rst b/doc/source/advanced_deployment/advanced_deployment.rst
index 1b74f37c..24e649ae 100644
--- a/doc/source/advanced_deployment/advanced_deployment.rst
+++ b/doc/source/advanced_deployment/advanced_deployment.rst
@@ -19,6 +19,7 @@ In this chapter you will find advanced deployment of various |project| areas.
    network_isolation_virt
    deploy_manila
    cinder_netapp
+   ceph_config
    neutron_midonet
    ssl
    node_placement
diff --git a/doc/source/advanced_deployment/ceph_config.rst b/doc/source/advanced_deployment/ceph_config.rst
new file mode 100644
index 00000000..2ee65249
--- /dev/null
+++ b/doc/source/advanced_deployment/ceph_config.rst
@@ -0,0 +1,49 @@
+Configuring Ceph with Custom Config Settings
+============================================
+
+This guide assumes that your undercloud is already installed and ready to
+deploy an overcloud.
+
+Customizing ceph.conf
+---------------------
+
+Ceph demands for more careful configuration when deployed at scale.
+
+It is possible to override any of the configuration parameters supported by
+`puppet-ceph`_ at deployment time via Heat environment files. For example::
+
+  parameter_defaults:
+    ExtraConfig:
+      ceph::profile::params::osd_journal_size: 2048
+
+will customize the default `osd_journal_size` overriding any default
+provided in the `ceph.yaml static hieradata`_.
+
+Remember to add such an environment file to the deploy commandline::
+
+    openstack overcloud deploy --templates --ceph-storage-scale <number of nodes> -e /usr/share/openstack-tripleo-heat-templates/environments/storage-environment.yaml -e ~/my-ceph-settings.yaml
+
+It is also possible to provide arbitrary stanza/key/value lines for `ceph.conf`
+using the special `ceph::conf` configuration class. For example by using::
+
+  parameter_defaults:
+    ExtraConfig:
+      ceph::conf::args:
+        global/max_open_files:
+          value: 131072
+        global/my_setting:
+          value: my_value
+
+the resulting `ceph.conf` file should be populated with the following::
+
+  [global]
+  max_open_files: 131072
+  my_setting: my_value
+
+.. note::
+
+    The :doc:`extra_config` doc has a more details on the usage of the different
+    ExtraConfig interfaces.
+
+.. _`puppet-ceph`: https://github.com/openstack/puppet-ceph
+.. _`ceph.yaml static hieradata`: https://github.com/openstack/tripleo-heat-templates/blob/master/puppet/hieradata/ceph.yaml