stackforge-attic/murano-docs
Code Issues Proposed changes

Renamed glazier->murano

Browse Source
This commit is contained in:
Serg Melikyan 2013-04-25 14:02:24 +04:00
parent 14f2ed419e
commit aebf80bbd1
6 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -1,13 +1,13 @@
Glazier Manuals
Murano Manuals
+++++++++++++++++
This repository contains documentation for the
Glazier project. It includes:
Murano project. It includes:
* API Specification
* Architecture
For more details, see the `Glazier <http://glazier.mirantis.com>`_.
For more details, see the `Murano <http://murano.mirantis.com>`_.
Prerequisites
=============
@ -30,18 +30,18 @@ The different manuals are in subdirectories of the
To build a specific guide, look for a ``pom.xml`` file within a subdirectory,
then run the ``mvn`` command in that directory. For example::
cd docs/src/glazier-manual
cd docs/src/murano-manual
mvn clean generate-sources
The generated PDF documentation file is::
docs/src/glazier-manual/src/target/docbkx/pdf/glazier-manual.pdf
docs/src/murano-manual/src/target/docbkx/pdf/murano-manual.pdf
The root of the generated HTML documentation is::
docs/src/glazier-manual/src/target/docbkx/webhelp/glazier-manual/content/index.html
docs/src/murano-manual/src/target/docbkx/webhelp/murano-manual/content/index.html
Installing
==========
Refer to http://glazier.openstack.org to see where these documents are published
and to learn more about the Glazier project.
Refer to http://murano.openstack.org to see where these documents are published
and to learn more about the Murano project.

BIN
src/glazier-manual/src/docbkx/figures/architecture_diagram.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 29 KiB

6
src/glazier-manual/pom.xml → src/murano-manual/pom.xml
View File

@ -18,11 +18,11 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.mirantis.glazier</groupId>
<groupId>com.mirantis.murano</groupId>
<artifactId>manuals</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Glazier Project Documentation</name>
<name>Murano Project Documentation</name>
<build>
<plugins>
<plugin>
@ -41,7 +41,7 @@
<xincludeSupported>true</xincludeSupported>
<chunkSectionDepth>100</chunkSectionDepth>
<postProcess>
<copy todir="target/docbkx/webhelp/glazier-manual/content/figures">
<copy todir="target/docbkx/webhelp/murano-manual/content/figures">
<fileset dir="src/docbkx/figures">
<include name="**/*.png"/>
</fileset>

0
src/glazier-manual/src/docbkx/figures/api_workflow.png → src/murano-manual/src/docbkx/figures/api_workflow.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

BIN
src/murano-manual/src/docbkx/figures/architecture_diagram.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

30
src/glazier-manual/src/docbkx/glazier-manual.xml → src/murano-manual/src/docbkx/murano-manual.xml
View File

@ -23,7 +23,7 @@
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd
http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<title>Glazier Project Documentation</title>
<title>Murano Project Documentation</title>
<info>
<author>
<personname>
@ -39,7 +39,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
<holder>Mirantis, Inc.</holder>
</copyright>
<releaseinfo>v0.1</releaseinfo>
<productname>Glazier™</productname>
<productname>Murano™</productname>
<pubdate>2013-04-04</pubdate>
<legalnotice role="apache2">
<annotation>
@ -64,7 +64,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
</info>
<chapter>
<title>Overview</title>
<para>Welcome to Glazier Project.
<para>Welcome to Murano Project.
</para>
<section>
<title>Intended Audience</title>
@ -75,7 +75,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
</section>
<section>
<title>Document Change History</title>
<para>This version of the Glazier Manual replaces and obsoletes all
<para>This version of the Murano Manual replaces and obsoletes all
previous versions. The
most recent changes are described in the table below:
</para>
@ -115,7 +115,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
</chapter>
<chapter id="architecture">
<title>Architecture</title>
<figure xml:id="glazierarchitecture">
<figure xml:id="muranoarchitecture">
<title>Architecture</title>
<mediaobject>
<imageobject role="fo">
@ -128,20 +128,20 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
</mediaobject>
</figure>
<para>
The Glazier architecture has the following components:
The Murano architecture has the following components:
<itemizedlist spacing="compact">
<listitem>
<para>Glazier Dashboard - UI for the Glazier, extends
<para>Murano Dashboard - UI for the Murano, extends
Horizon
</para>
</listitem>
<listitem>
<para>REST API - exposes Glazier API via REST. Maintains
<para>REST API - exposes Murano API via REST. Maintains
environment configurations in Database
</para>
</listitem>
<listitem>
<para>Glazier Python Client - Python client for Glazier
<para>Murano Python Client - Python client for Murano
REST API
</para>
</listitem>
@ -149,12 +149,12 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
<para>Orchestration Engine - builds the environment as
configured by the user.
Turns environment configurations into a Heat templates
for VM provision and Glazier Agent commands for service
for VM provision and Murano Agent commands for service
deployment
</para>
</listitem>
<listitem>
<para>Glazier Agent - built into Windows Server VM images.
<para>Murano Agent - built into Windows Server VM images.
Executes commands sent by Orchestration Engine
</para>
</listitem>
@ -209,9 +209,9 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
</informaltable>
<section>
<title>Introduction</title>
<para>Glazier Service API is a programmatic interface used for interaction
with Glazier. Other interaction
mechanisms like Glazier Dashboard or Glazier CLI should use API as underlying
<para>Murano Service API is a programmatic interface used for interaction
with Murano. Other interaction
mechanisms like Murano Dashboard or Murano CLI should use API as underlying
protocol for interaction.
</para>
@ -292,7 +292,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
<section>
<title>Authentication</title>
<para>All requests include a Keystone authentication token header (X-Auth-Token). Clients must authenticate
with Keystone before interacting with the Glazier service.
with Keystone before interacting with the Murano service.
</para>
</section>
<section>