From fd0b5fe2f55257a6e6e6ddcd034395a7e329213b Mon Sep 17 00:00:00 2001
From: Christian Zunker <christian.zunker@codecentric.cloud>
Date: Mon, 16 Jul 2018 13:04:25 +0200
Subject: [PATCH] Explain how to configure public endpoint

This is needed for Magnum and might also be needed in other setups.

Change-Id: Ifcfc00fd860f555c17486bcd8060d3cd0d88f604
Closes-Bug: #1780385
---
 doc/source/index.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 2039fc0..3eb1072 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -56,3 +56,19 @@ This role supports two tags: ``heat-install`` and
 ``heat-config``. The ``heat-install`` tag can be used to install
 and upgrade. The ``heat-config`` tag can be used to maintain the
 configuration of the service.
+
+Heat client endpoints
+~~~~~~~~~~~~~~~~~~~~~
+
+When your VMs need to talk to your API, you might have to change the Heat
+config. By default Heat is configured to use the internal API endpoints.
+Should instances or created containers need to access the API (e.g.
+Magnum, Heat Signaling) the public endpoints will need to be used as in
+the following example:
+
+.. code-block:: yaml
+
+    heat_heat_conf_overrides:
+      clients_keystone:
+        endpoint_type: publicURL
+        auth_uri: "{{ keystone_service_publicurl }}"