From 866182d799f72d35f99ffafcb309dfd24847cf71 Mon Sep 17 00:00:00 2001 From: "ashish.billore" Date: Tue, 23 May 2017 15:28:56 +0900 Subject: [PATCH] Add more details to example template A minor update to existing example template. Added details about what the example template does and what to expect from the example template and cluster created based on this example template. Change-Id: I53c4b9d0921555fd35fb89a5ef1f8696720c4eda --- contrib/templates/example/README.rst | 5 +++++ contrib/templates/example/example_template/example.yaml | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/contrib/templates/example/README.rst b/contrib/templates/example/README.rst index dfcc578613..b20dd67f3f 100644 --- a/contrib/templates/example/README.rst +++ b/contrib/templates/example/README.rst @@ -2,4 +2,9 @@ Example Cluster Template ======================== +The purpose of this example template is to demonstrate working with cluster +templates using magnum service. +The Heat template used in this example (example.yaml) provisions a single +server instance and does not produce a usable cluster. + See ``_ for instructions. diff --git a/contrib/templates/example/example_template/example.yaml b/contrib/templates/example/example_template/example.yaml index bd9379f502..91888a530a 100644 --- a/contrib/templates/example/example_template/example.yaml +++ b/contrib/templates/example/example_template/example.yaml @@ -1,7 +1,8 @@ heat_template_version: 2014-10-16 description: > - This is just an example template. It does not produce a usable bay. + This is just an example Heat template. It only provisions a single server + instance and does not produce a usable cluster. parameters: #