stackforge-attic/murano-conductor
Code Issues Proposed changes

Main Documentation Project

Browse Source
This commit is contained in:
Serg Melikyan 2013-04-04 16:35:35 +04:00
parent 1c9449dcd1
commit 2b55f14b0d
5 changed files with 176 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
manuals/.gitignore vendored Normal file
View File

@ -0,0 +1,9 @@
#IntelJ Idea
.idea/
#Build results
target
#Translation build
*.mo
*.pot

7
manuals/README.rst Normal file
View File

@ -0,0 +1,7 @@
README
======
To build the output, install Apache Maven (https://maven.apache.org/) and then run::
mvn clean generate-sources
in the directory containing the pom.xml file.

38
manuals/pom.xml Normal file
View File

@ -0,0 +1,38 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" 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.keero</groupId>
<artifactId>manuals</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Keero Project Documentation</name>
<build>
<plugins>
<plugin>
<groupId>com.agilejava.docbkx</groupId>
<artifactId>docbkx-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>generate-pdf</goal>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
</execution>
</executions>
<configuration>
<xincludeSupported>true</xincludeSupported>
<chunkSectionDepth>100</chunkSectionDepth>
<postProcess>
<copy todir="target/docbkx/webhelp/example/content/figures">
<fileset dir="src/docbkx/figures">
<include name="**/*.png" />
</fileset>
</copy>
</postProcess>
</configuration>
</plugin>
</plugins>
</build>
</project>

BIN
manuals/src/docbkx/figures/architecture_diagram.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

122
manuals/src/docbkx/keero-manual.xml Normal file
View File

@ -0,0 +1,122 @@
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" status="DRAFT">
<title>Keero Project Documentation</title>
<info>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Mirantis, Inc.</orgname>
</affiliation>
</author>
<copyright>
<year>2013</year>
<holder>Mirantis, Inc.</holder>
</copyright>
<releaseinfo>v0.1</releaseinfo>
<productname>Keero™</productname>
<pubdate>2013-04-04</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the template. Change the value of the role
attribute on the legalnotice element to change the license. </remark>
</annotation>
</legalnotice>
<abstract>
<para>This document is intended for individuals who wish to configure
and use our product or intend to contribute.
</para>
</abstract>
<cover>
<para>this is a placeholder for the front cover</para>
</cover>
<cover>
<para>this is a placeholder for the back cover</para>
</cover>
</info>
<chapter>
<title>Overview</title>
<para>Welcome to Keero Project.
</para>
<section>
<title>Intended Audience</title>
<para>This guide is intended to individuals who want to contribute to our
project.
</para>
</section>
<section>
<title>Document Change History</title>
<para>This version of the Maven Getting Started Guide replaces and obsoletes all previous versions. The
most recent changes are described in the table below:</para>
<informaltable rules="all">
<thead>
<tr>
<td align="center" colspan="1">Revision Date</td>
<td align="center" colspan="4">Summary of Changes</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1" align="center">April. 4, 2013</td>
<td colspan="4">
<itemizedlist spacing="compact">
<listitem>
<para>Initial document creation.</para>
</listitem>
</itemizedlist>
</td>
</tr>
</tbody>
</informaltable>
</section>
<section>
<title>Additional Resources</title>
<itemizedlist spacing="compact">
<listitem>
<para>
<link xlink:href="http://www.mirantis.com">
Mirantis - Cloud Software
</link>
</para>
</listitem>
</itemizedlist>
</section>
</chapter>
<chapter>
<title>Architecture</title>
<figure xml:id="keeroarchitecture">
<title>Architecture</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="figures/architecture_diagram.png" contentwidth="5in" />
</imageobject>
<imageobject role="html">
<imagedata fileref="figures/architecture_diagram.png"/>
</imageobject>
</mediaobject>
</figure>
<para>
The Keero architecture has the following components:
<itemizedlist spacing="compact">
<listitem>
<para>Keero Dashboard - UI for the Keero, extends Horizon</para>
</listitem>
<listitem>
<para>REST API - exposes Keero API via REST. Maintains environment configurations in Database</para>
</listitem>
<listitem>
<para>Keero Python Client - Python client for Keero REST API</para>
</listitem>
<listitem>
<para>Orchestration Engine - builds the environment as configured by the user. Turns environment configurations into a Heat templates for VM provision and Keero Agent commands for service deployment</para>
</listitem>
<listitem>
<para>Keero Agent - built into Windows Server VM images. Executes commands sent by Orchestration Engine</para>
</listitem>
</itemizedlist>
</para>
</chapter>
</book>