diff --git a/manuals/.gitignore b/manuals/.gitignore new file mode 100644 index 0000000..c4c2ae4 --- /dev/null +++ b/manuals/.gitignore @@ -0,0 +1,9 @@ +#IntelJ Idea +.idea/ + +#Build results +target + +#Translation build +*.mo +*.pot diff --git a/manuals/README.rst b/manuals/README.rst new file mode 100644 index 0000000..a2a0ba8 --- /dev/null +++ b/manuals/README.rst @@ -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. diff --git a/manuals/pom.xml b/manuals/pom.xml new file mode 100644 index 0000000..3a6b6f7 --- /dev/null +++ b/manuals/pom.xml @@ -0,0 +1,38 @@ + + 4.0.0 + com.mirantis.keero + manuals + 1.0.0-SNAPSHOT + jar + Keero Project Documentation + + + + + com.agilejava.docbkx + docbkx-maven-plugin + + + + generate-pdf + generate-webhelp + + generate-sources + + + + true + 100 + + + + + + + + + + + + + diff --git a/manuals/src/docbkx/figures/architecture_diagram.png b/manuals/src/docbkx/figures/architecture_diagram.png new file mode 100755 index 0000000..fe2f631 Binary files /dev/null and b/manuals/src/docbkx/figures/architecture_diagram.png differ diff --git a/manuals/src/docbkx/keero-manual.xml b/manuals/src/docbkx/keero-manual.xml new file mode 100644 index 0000000..eebf3bf --- /dev/null +++ b/manuals/src/docbkx/keero-manual.xml @@ -0,0 +1,122 @@ + + Keero Project Documentation + + + + + + + + Mirantis, Inc. + + + + 2013 + Mirantis, Inc. + + v0.1 + Keero™ + 2013-04-04 + + + Copyright details are filled in by the template. Change the value of the role + attribute on the legalnotice element to change the license. + + + + This document is intended for individuals who wish to configure + and use our product or intend to contribute. + + + + this is a placeholder for the front cover + + + this is a placeholder for the back cover + + + + Overview + Welcome to Keero Project. + +
+ Intended Audience + This guide is intended to individuals who want to contribute to our + project. + +
+
+ Document Change History + This version of the Maven Getting Started Guide replaces and obsoletes all previous versions. The + most recent changes are described in the table below: + + + + Revision Date + Summary of Changes + + + + + April. 4, 2013 + + + + Initial document creation. + + + + + + +
+
+ Additional Resources + + + + + Mirantis - Cloud Software + + + + +
+
+ + Architecture +
+ Architecture + + + + + + + + +
+ + The Keero architecture has the following components: + + + Keero Dashboard - UI for the Keero, extends Horizon + + + REST API - exposes Keero API via REST. Maintains environment configurations in Database + + + Keero Python Client - Python client for Keero REST API + + + 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 + + + Keero Agent - built into Windows Server VM images. Executes commands sent by Orchestration Engine + + + +
+