From 181b57e46d0a6854d746eaac898fb86d836f7fcc Mon Sep 17 00:00:00 2001
From: Summer Long <slong@redhat.com>
Date: Fri, 10 Jan 2014 14:31:28 +1000
Subject: [PATCH] Added basic description and info for Orchestration.

Also included references to other guides and sections. Restructured a bit, using a 'Manage the OpenStack Environment' section, so that there aren't so many level-two headers in the CLI section.

Closes-Bug: #1267697

Change-Id: Ia717e2e8ef71154293a32dbfa7e80ebc8d00efda
---
 doc/user-guide-admin/ch_cli.xml               |  6 +---
 doc/user-guide-admin/ch_dashboard.xml         |  2 ++
 .../section_cli_admin_manage_environment.xml  | 13 ++++++++
 .../section_cli_admin_manage_stacks.xml       | 32 +++++++++++++++++++
 .../section_dashboard_admin_manage_stacks.xml | 28 ++++++++++++++++
 5 files changed, 76 insertions(+), 5 deletions(-)
 create mode 100644 doc/user-guide-admin/section_cli_admin_manage_environment.xml
 create mode 100644 doc/user-guide-admin/section_cli_admin_manage_stacks.xml
 create mode 100644 doc/user-guide-admin/section_dashboard_admin_manage_stacks.xml

diff --git a/doc/user-guide-admin/ch_cli.xml b/doc/user-guide-admin/ch_cli.xml
index 56cdfac87b..dc603081c3 100644
--- a/doc/user-guide-admin/ch_cli.xml
+++ b/doc/user-guide-admin/ch_cli.xml
@@ -29,11 +29,7 @@
     <?hard-pagebreak?>
     <xi:include href="section_cli_nova_manage_flavors.xml"/>
     <?hard-pagebreak?>
-    <xi:include href="section_cli_nova_specify_host.xml"/>
-    <?hard-pagebreak?>
-    <xi:include href="../common/section_cli_nova_evacuate.xml"/>
-    <?hard-pagebreak?>
-    <xi:include href="section_cli_nova_floating_ips.xml"/>
+    <xi:include href="section_cli_admin_manage_environment.xml"/>
     <?hard-pagebreak?>
     <xi:include href="section_cli_keystone_set_quotas.xml"/>
     <?hard-pagebreak?>
diff --git a/doc/user-guide-admin/ch_dashboard.xml b/doc/user-guide-admin/ch_dashboard.xml
index 0f018f2cdd..75a686f246 100644
--- a/doc/user-guide-admin/ch_dashboard.xml
+++ b/doc/user-guide-admin/ch_dashboard.xml
@@ -33,4 +33,6 @@
     <xi:include href="section_dashboard_admin_set_quotas.xml"/>
     <?hard-pagebreak?>
     <xi:include href="section_dashboard_admin_manage_resources.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="section_dashboard_admin_manage_stacks.xml"/>
 </chapter>
diff --git a/doc/user-guide-admin/section_cli_admin_manage_environment.xml b/doc/user-guide-admin/section_cli_admin_manage_environment.xml
new file mode 100644
index 0000000000..4851a1b910
--- /dev/null
+++ b/doc/user-guide-admin/section_cli_admin_manage_environment.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?><section xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink"
+    version="5.0" xml:id="section_cli_admin_manage_environment">
+    <title>Manage the OpenStack environment</title>
+    <para>This section includes tasks specific to the OpenStack environment.</para>
+    <xi:include href="section_cli_nova_specify_host.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="../common/section_cli_nova_evacuate.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="section_cli_nova_floating_ips.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="section_cli_admin_manage_stacks.xml"/>
+</section>
\ No newline at end of file
diff --git a/doc/user-guide-admin/section_cli_admin_manage_stacks.xml b/doc/user-guide-admin/section_cli_admin_manage_stacks.xml
new file mode 100644
index 0000000000..d44367c32e
--- /dev/null
+++ b/doc/user-guide-admin/section_cli_admin_manage_stacks.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink"
+    version="5.0" xml:id="section_cli_admin_manage_stacks">
+    <title>Launch and manage stacks</title>
+    <para>The Orchestration service provides a template-based orchestration engine
+        for the OpenStack cloud, which can be used to create and manage cloud
+        infrastructure resources such as storage, networking, instances, and
+        applications as a repeatable running environment.
+    </para>
+    <para>Templates are used to create stacks, which are collections of resources. For example,
+        a stack might include instances, floating IPs, volumes, security groups, or users.
+        The Orchestration service offers access to all OpenStack core services via a single modular template,
+        with additional orchestration capabilities such as auto-scaling and basic high availability.</para>
+    <para>For information about the:</para>
+    <para>
+        <itemizedlist>
+            <listitem>
+                <para>Basic creation and deletion of Orchestration stacks, refer to the
+                    <link xlink:href="http://docs.openstack.org/user-guide/content/dashboard_stacks.html">End User Guide</link>.</para>
+            </listitem>
+            <listitem>
+                <para><systemitem>heat</systemitem> CLI commands, see  <xref linkend="heat_client_commands"/></para>
+            </listitem>
+        </itemizedlist>
+    </para>
+    <para>As an administrator, you can also carry out stack functions on behalf of your users. For
+        example, to resume, suspend, or delete a stack, run:</para>
+        <screen><prompt>$</prompt> <userinput>action-resume <replaceable>stackID</replaceable></userinput>
+<prompt>$</prompt> <userinput>action-suspend <replaceable>stackID</replaceable></userinput>
+<prompt>$</prompt> <userinput>stack-delete <replaceable>stackID</replaceable></userinput></screen>
+</section>
diff --git a/doc/user-guide-admin/section_dashboard_admin_manage_stacks.xml b/doc/user-guide-admin/section_dashboard_admin_manage_stacks.xml
new file mode 100644
index 0000000000..3821e2c022
--- /dev/null
+++ b/doc/user-guide-admin/section_dashboard_admin_manage_stacks.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?><section xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink"
+    version="5.0" xml:id="section_dashboard_admin_manage_stacks">
+    <title>Launch and manage stacks</title>
+    <para>The Orchestration service provides a template-based orchestration engine
+        for the OpenStack cloud, which can be used to create and manage cloud
+        infrastructure resources such as storage, networking, instances, and
+        applications as a repeatable running environment.
+    </para>
+    <para>Templates are used to create stacks, which are collections of resources. For example,
+        a stack might include instances, floating IPs, volumes, security groups, or users.
+        The Orchestration service offers access to all OpenStack core services via a single modular template,
+        with additional orchestration capabilities such as auto-scaling and basic high availability.</para>
+    <para>For information about:</para>
+    <para>
+        <itemizedlist>
+            <listitem>
+                <para>Administrative tasks on the command line, see <xref linkend="section_cli_admin_manage_stacks"/>.
+                    <note><para>There are no administration-specific tasks that can be done through the dashboard.</para></note></para>
+            </listitem>
+            <listitem>
+                <para>The basic creation and deletion of Orchestration stacks, refer to the <link
+                        xlink:href="http://docs.openstack.org/user-guide/content/dashboard_stacks.html"
+                        >End User Guide</link>.</para>
+            </listitem>
+        </itemizedlist>
+    </para>
+</section>
\ No newline at end of file