Renamed documentation project
This commit is contained in:
Serg Melikyan
parent
f5a08a6a22
commit
0024ab4823
0
manuals/.gitignore → docs/.gitignore
vendored
0
manuals/.gitignore → docs/.gitignore
vendored
176
docs/LICENSE
Normal file
176
docs/LICENSE
Normal file
@ -0,0 +1,176 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
47
docs/README.rst
Normal file
47
docs/README.rst
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
Glazier Manuals
|
||||||
|
+++++++++++++++++
|
||||||
|
|
||||||
|
This repository contains documentation for the
|
||||||
|
Glazier project. It includes:
|
||||||
|
|
||||||
|
* API Specification
|
||||||
|
* Architecture
|
||||||
|
|
||||||
|
For more details, see the `Glazier <http://glazier.mirantis.com>`_.
|
||||||
|
|
||||||
|
Prerequisites
|
||||||
|
=============
|
||||||
|
`Apache Maven <http://maven.apache.org/>`_ must be installed to build the
|
||||||
|
documentation.
|
||||||
|
|
||||||
|
To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later::
|
||||||
|
|
||||||
|
apt-get install maven
|
||||||
|
|
||||||
|
On Fedora 15 and later::
|
||||||
|
|
||||||
|
yum install maven3
|
||||||
|
|
||||||
|
Building
|
||||||
|
========
|
||||||
|
The different manuals are in subdirectories of the
|
||||||
|
``docs/src/`` directory.
|
||||||
|
|
||||||
|
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
|
||||||
|
mvn clean generate-sources
|
||||||
|
|
||||||
|
The generated PDF documentation file is::
|
||||||
|
|
||||||
|
docs/src/glazier-manual/src/target/docbkx/pdf/glazier-manual.pdf
|
||||||
|
|
||||||
|
The root of the generated HTML documentation is::
|
||||||
|
|
||||||
|
docs/src/glazier-manual/src/target/docbkx/webhelp/glazier-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.
|
||||||
54
docs/src/glazier-manual/pom.xml
Normal file
54
docs/src/glazier-manual/pom.xml
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (c) 2013 Mirantis, Inc.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
-->
|
||||||
|
<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.glazier</groupId>
|
||||||
|
<artifactId>manuals</artifactId>
|
||||||
|
<version>1.0.0-SNAPSHOT</version>
|
||||||
|
<packaging>jar</packaging>
|
||||||
|
<name>Glazier 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/glazier-manual/content/figures">
|
||||||
|
<fileset dir="src/docbkx/figures">
|
||||||
|
<include name="**/*.png"/>
|
||||||
|
</fileset>
|
||||||
|
</copy>
|
||||||
|
</postProcess>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
</project>
|
||||||
BIN
docs/src/glazier-manual/src/docbkx/figures/architecture_diagram.png
Executable file
BIN
docs/src/glazier-manual/src/docbkx/figures/architecture_diagram.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
161
docs/src/glazier-manual/src/docbkx/glazier-manual.xml
Normal file
161
docs/src/glazier-manual/src/docbkx/glazier-manual.xml
Normal file
@ -0,0 +1,161 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (c) 2013 Mirantis, Inc.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
-->
|
||||||
|
<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>Glazier 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>Glazier™</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 Glazier 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 Glazier Manual 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 Glazier architecture has the following components:
|
||||||
|
<itemizedlist spacing="compact">
|
||||||
|
<listitem>
|
||||||
|
<para>Glazier Dashboard - UI for the Glazier, extends
|
||||||
|
Horizon
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>REST API - exposes Glazier API via REST. Maintains
|
||||||
|
environment configurations in Database
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Glazier Python Client - Python client for Glazier
|
||||||
|
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 Glazier Agent commands for service
|
||||||
|
deployment
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Glazier Agent - built into Windows Server VM images.
|
||||||
|
Executes commands sent by Orchestration Engine
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</para>
|
||||||
|
</chapter>
|
||||||
|
</book>
|
||||||
@ -1,7 +0,0 @@
|
|||||||
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.
|
|
||||||
@ -1,38 +0,0 @@
|
|||||||
<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/keero-manual/content/figures">
|
|
||||||
<fileset dir="src/docbkx/figures">
|
|
||||||
<include name="**/*.png" />
|
|
||||||
</fileset>
|
|
||||||
</copy>
|
|
||||||
</postProcess>
|
|
||||||
</configuration>
|
|
||||||
</plugin>
|
|
||||||
</plugins>
|
|
||||||
</build>
|
|
||||||
|
|
||||||
</project>
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
@ -1,122 +0,0 @@
|
|||||||
<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>
|
|
||||||
Loading…
Reference in New Issue
Block a user