Prepare documentation for a release-0.2

1) Update git clone information
2) Rename murano-manual to developers-guide
3) Update known issues

Change-Id: I90423126b5e4a49ef424fcf63373de5472804235
This commit is contained in:
Ekaterina Fedorova 2013-09-04 16:38:21 +04:00
parent 03d5dd736a
commit b5f7b95fd2
64 changed files with 137 additions and 1272 deletions

View File

@ -6,8 +6,9 @@ Murano project. It includes:
* API Specification
* Architecture
* Installation
For more details, see the `Murano <http://murano.mirantis.com>`_.
For more details, see the `Murano <http://murano-docs.github.io>`_.
Prerequisites
@ -32,19 +33,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/murano-manual
cd docs/src/developers-guide
mvn clean generate-sources
The generated PDF documentation file is::
docs/src/murano-manual/src/target/docbkx/pdf/murano-manual.pdf
docs/src/developers-guide/src/target/docbkx/pdf/developers-guide.pdf
The root of the generated HTML documentation is::
docs/src/murano-manual/src/target/docbkx/webhelp/murano-manual/content/index.html
docs/src/developers-guide/src/target/docbkx/webhelp/developers-guide/content/index.html
Installing
==========
Refer to http://murano.openstack.org to see where these documents are published
and to learn more about the Murano project.
Refer to http://murano.openstack.org Learn more about the Murano project.

View File

@ -1,125 +0,0 @@
.ddsmoothmenu{
margin-top: 20px
}
.ddsmoothmenu ul{
z-index:100;
margin: 0;
padding: 0;
list-style-type: none;
}
/*Top level list items*/
.ddsmoothmenu ul li{
position: relative;
display: inline;
float: left;
}
/*Top level menu link items style*/
.ddsmoothmenu ul li a {
display: block;
height: 23px;
width: 74px;
margin-left: 5px;
line-height: 23px;
font-size: 13px;
font-family: Georgia, "Times New Roman", Times, serif;
color: #a9a2a2;
text-align: center;
text-decoration: none;
font-weight: 400;
outline: none;
}
* html .ddsmoothmenu ul li a{ /*IE6 hack to get sub menu links to behave correctly*/
display: inline-block;
}
.ddsmoothmenu ul li a.selected, .ddsmoothmenu ul li a:hover { /*CSS class that's dynamically added to the currently active menu items' LI A element*/
color: #f00;
background: url(../images/templatemo_menu_hover.png)
}
/*1st sub level menu*/
.ddsmoothmenu ul li ul {
position: absolute;
width: 160px;
margin: 10px 0 0 5px;
left: 0;
display: none; /*collapse all sub menus to begin with*/
visibility: hidden;
background: url(../images/templatemo_smm.png) repeat-y
}
.ddsmoothmenu ul li ul span.top { position: absolute; width: 160px; height: 5px; top: -5px; left: 0; background: url(../images/templatemo_smt.png) no-repeat; }
.ddsmoothmenu ul li ul span.bottom { position: absolute; width: 160px; height: 5px; bottom: -5px; left: 0; background: url(../images/templatemo_smb.png) no-repeat; }
/*Sub level menu list items (undo style from Top level List Items)*/
.ddsmoothmenu ul li ul li{
display: list-item;
float: none;
}
/*All subsequent sub menu levels vertical offset after 1st level sub menu */
.ddsmoothmenu ul li ul li ul{
top: 0;
}
/* Sub level menu links style */
.ddsmoothmenu ul li ul li a{
font-weight: 500;
width: 140px; /*width of sub menus*/
height: 28px;
line-height: 28px;
margin: 0 10px;
font-size: 12px;
text-align: left;
background: none;
color: #a9a2a2;
border-bottom: 1px solid #151515
}
.ddsmoothmenu ul li ul li .last {
border-bottom: none;
}
.ddsmoothmenu ul li ul li a.selected, .ddsmoothmenu ul li ul li a:hover {
color: #f00;
width: 129px;
margin-left: 11px;
background: none;
}
/* Holly Hack for IE \*/
* html .ddsmoothmenu{height: 1%;} /*Holly Hack for IE7 and below*/
/* ######### CSS classes applied to down and right arrow images ######### */
.downarrowclass{
position: absolute;
top: 12px;
right: 7px;
}
.rightarrowclass{
position: absolute;
top: 6px;
right: 5px;
}
/* ######### CSS for shadow added to sub menus ######### */
.ddshadow{
position: absolute;
left: 0;
top: 0;
width: 0;
height: 0;
}
.toplevelshadow{ /*shadow opacity. Doesn't work in IE*/
opacity: 0.5;
}
/* menu */

View File

@ -1,202 +0,0 @@
/* line 7, ../sass/lightbox.sass */
body:after {
content: url(../images/close.png) url(../images/loading.gif) url(../images/prev.png) url(../images/next.png);
display: none;
}
/* line 11, ../sass/lightbox.sass */
.lightboxOverlay {
position: absolute;
top: 0;
left: 0;
z-index: 9999;
background-color: black;
filter: progid:DXImageTransform.Microsoft.Alpha(Opacity=80);
opacity: 0.8;
display: none;
}
/* line 20, ../sass/lightbox.sass */
.lightbox {
position: absolute;
left: 0;
width: 100%;
z-index: 10000;
text-align: center;
line-height: 0;
font-weight: normal;
}
/* line 28, ../sass/lightbox.sass */
.lightbox .lb-image {
display: block;
height: auto;
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
-ms-border-radius: 3px;
-o-border-radius: 3px;
border-radius: 3px;
}
/* line 32, ../sass/lightbox.sass */
.lightbox a img {
border: none;
}
/* line 35, ../sass/lightbox.sass */
.lb-outerContainer {
position: relative;
background-color: white;
*zoom: 1;
width: 250px;
height: 250px;
margin: 0 auto;
-webkit-border-radius: 4px;
-moz-border-radius: 4px;
-ms-border-radius: 4px;
-o-border-radius: 4px;
border-radius: 4px;
}
/* line 38, ../../../../.rvm/gems/ruby-1.9.3-p392/gems/compass-0.12.2/frameworks/compass/stylesheets/compass/utilities/general/_clearfix.scss */
.lb-outerContainer:after {
content: "";
display: table;
clear: both;
}
/* line 44, ../sass/lightbox.sass */
.lb-container {
padding: 4px;
}
/* line 47, ../sass/lightbox.sass */
.lb-loader {
position: absolute;
top: 43%;
left: 0%;
height: 25%;
width: 100%;
text-align: center;
line-height: 0;
}
/* line 56, ../sass/lightbox.sass */
.lb-cancel {
display: block;
width: 32px;
height: 32px;
margin: 0 auto;
background: url(../images/loading.gif) no-repeat;
}
/* line 63, ../sass/lightbox.sass */
.lb-nav {
position: absolute;
top: 0;
left: 0;
height: 100%;
width: 100%;
z-index: 10;
}
/* line 71, ../sass/lightbox.sass */
.lb-container > .nav {
left: 0;
}
/* line 74, ../sass/lightbox.sass */
.lb-nav a {
outline: none;
}
/* line 77, ../sass/lightbox.sass */
.lb-prev, .lb-next {
width: 49%;
height: 100%;
cursor: pointer;
/* Trick IE into showing hover */
display: block;
}
/* line 84, ../sass/lightbox.sass */
.lb-prev {
left: 0;
float: left;
}
/* line 87, ../sass/lightbox.sass */
.lb-prev:hover {
background: url(../images/prev.png) left 48% no-repeat;
}
/* line 90, ../sass/lightbox.sass */
.lb-next {
right: 0;
float: right;
}
/* line 93, ../sass/lightbox.sass */
.lb-next:hover {
background: url(../images/next.png) right 48% no-repeat;
}
/* line 96, ../sass/lightbox.sass */
.lb-dataContainer {
margin: 0 auto;
padding-top: 5px;
*zoom: 1;
width: 100%;
-moz-border-radius-bottomleft: 4px;
-webkit-border-bottom-left-radius: 4px;
border-bottom-left-radius: 4px;
-moz-border-radius-bottomright: 4px;
-webkit-border-bottom-right-radius: 4px;
border-bottom-right-radius: 4px;
}
/* line 38, ../../../../.rvm/gems/ruby-1.9.3-p392/gems/compass-0.12.2/frameworks/compass/stylesheets/compass/utilities/general/_clearfix.scss */
.lb-dataContainer:after {
content: "";
display: table;
clear: both;
}
/* line 103, ../sass/lightbox.sass */
.lb-data {
padding: 0 4px;
color: #bbbbbb;
}
/* line 106, ../sass/lightbox.sass */
.lb-data .lb-details {
width: 85%;
float: left;
text-align: left;
line-height: 1.1em;
}
/* line 111, ../sass/lightbox.sass */
.lb-data .lb-caption {
font-size: 13px;
font-weight: bold;
line-height: 1em;
}
/* line 115, ../sass/lightbox.sass */
.lb-data .lb-number {
display: block;
clear: left;
padding-bottom: 1em;
font-size: 12px;
color: #999999;
}
/* line 121, ../sass/lightbox.sass */
.lb-data .lb-close {
display: block;
float: right;
width: 30px;
height: 30px;
background: url(../images/close.png) top right no-repeat;
text-align: right;
outline: none;
filter: progid:DXImageTransform.Microsoft.Alpha(Opacity=70);
opacity: 0.7;
}
/* line 130, ../sass/lightbox.sass */
.lb-data .lb-close:hover {
cursor: pointer;
filter: progid:DXImageTransform.Microsoft.Alpha(Opacity=100);
opacity: 1;
}

View File

@ -1,683 +0,0 @@
/*
Credit: http://www.templatemo.com
*/
body {
margin: 0;
padding: 0;
color: #6e6e6e;
font-family: Tahoma, Geneva, sans-serif;
font-size: 13px;
line-height: 1.4em;
background-color: #3b3939;
background-repeat: repeat-x;
background-position: top;
}
#home {
background-image: url(../images/templatemo_bg_homepage.jpg);
}
#subpage {
background-image: url(../images/templatemo_bg_subpage.jpg);
}
a, a:link, a:visited {
color: #7f0d0d;
font-weight: normal;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
a.more {
display: inline-block;
padding-left: 12px;
background: url(../images/templatemo_list.png) no-repeat 0 4px;
}
p {
margin: 0 0 10px 0;
padding: 0;
}
img {
border: none;
}
blockquote {
font-style: italic;
margin: 0 0 0 10px;
}
cite {
font-weight: bold;
color:#000;
}
cite a, cite a:link, cite a:visited {
font-size: 12px;
text-decoration: none;
font-style: normal;
}
cite span {
font-weight: 400;
color: #7f0d0d;
}
h1, h2, h3, h4, h5, h6 { color: #2c2c2c; font-weight: normal; }
h1 { font-size: 48px; margin: 0 0 30px; padding: 5px 0 }
h2 { font-size: 30px; margin: 0 0 25px; padding: 5px 0 }
h3 { font-size: 24px; margin: 0 0 20px; padding: 0; }
h4 { font-size: 18px; margin: 0 0 15px; padding: 0; }
h5 { font-size: 16px; margin: 0 0 10px; padding: 0; }
h6 { font-size: 12px; margin: 0 0 5px; padding: 0; }
.cleaner { clear: both }
.h10 { height: 10px }
.h20 { height: 20px }
.h30 { height: 30px }
.h40 { height: 40px }
.h50 { height: 50px }
.divider { margin-bottom: 40px; padding-bottom: 20px; background: url(../images/templatemo_divider.png) repeat-x bottom; }
.image_fl { float: left; margin: 3px 20px 5px 0 }
.image_fr { float: right; margin: 3px 0 5px 20px }
.float_l { float: left }
.float_r { float: right }
.templatemo_list {
margin: 10px 0 10px 15px;
padding: 0;
list-style: none;
}
.templatemo_list li {
color:#52493a;
margin: 0 0 10px 0;
padding: 0 5px 0 15px;
background: url(../images/templatemo_list.png) no-repeat scroll 0 4px;
}
.templatemo_list li a {
color: #52493a;
font-weight: normal;
}
.templatemo_list li a:hover {
color: #52493a;
}
#templatemo_header_wrapper {
width: 960px;
margin: 0 auto;
padding: 40px 10px 20px;
background: url(../images/templatemo_header_dividier.png) repeat-x bottom
}
#templatemo_slider {
width: 960px;
margin: 0 auto;
padding: 0 10px 10px;
}
#templatemo_main {
width: 960px;
margin: 0 auto;
padding: 40px 10px 20px;
background: #f6f3f3;
border: 1px solid #fff;
margin-bottom: 40px;
}
#content {
float: left;
width: 600px;
padding-right: 20px;
}
#sidebar {
float: right;
width: 300px;
}
#templatemo_bottom_wrapper {
width: 100%;
background: #272525;
}
#templatemo_bottom {
width: 960px;
margin: 0 auto;
padding: 0 10px 20px;
}
#templatemo_footer_wrapper {
width: 100%;
background: #181818;
}
#templatemo_footer {
width: 960px;
margin: 0 auto;
padding: 10px;
text-align: center;
position: relative;
}
.footer_img_link{
position: absolute;
margin: 0 0 0 -50px;
cursor: default;
}
#templatemo_footer a {
color: #6e6e6e;
}
#site_title {
float: left;
padding-right: 50px;
}
#site_title h1 {
margin: 0;
padding: 0;
}
#site_title h1 a {
display: block;
font-size: 12px;
width: 150px;
height: 45px;
color: #acacac;
text-indent: -10000px;
background: url(../images/templatemo_logo.png) no-repeat center left;
}
#templatemo_menu { float: right }
#slider-left-but {
display: block;
width: 30px;
height: 30px;
border: none;
background: url(../images/templatemo_slider_left.png);
margin-right: 10px;
}
#slider-right-but {
display: block;
width: 30px;
height: 30px;
border: none;
background: url(../images/templatemo_slider_right.png);
}
.rp_pp {
margin-bottom: 10px;
padding-bottom: 10px;
border-bottom: 1px dotted #ced4dc;
}
.rp_pp img {
float: left;
margin-right: 15px;
border: 3px solid #fff;
}
.rp_pp p {
font-size: 10px;
}
.about_box {
clear: both;
margin-bottom: 40px;
}
.about_box img {
float: left;
margin-right: 40px;
}
.about_box h4 {
font-size: 14px;
font-weight: bold;
font-style: italic;
margin-bottom: 0px;
}
p.position {
color: #f3a706;
font-weight: bold;
font-size: 12px;
font-style: italic;
margin-bottom: 10px;
}
.recent_post {
margin: 0;
padding:0;
list-style: none;
}
.recent_post li {
margin: 0 0 15px;
padding: 0 0 15px;
font-size: 11px;
border-bottom: 1px solid #ccc;
}
.recent_post li a {
display: block;
font-weight: 700;
}
.post {
clear: both;
margin-bottom: 60px;
}
.post img {
margin-bottom: 10px;
}
.post h2.home {
color: #ba8c00;
font-size: 18px;
margin-bottom: 0;
}
.post h2 {
margin-bottom: 0;
line-height: 38px;
border-bottom: 1px solid #999;
margin-bottom: 20px;
}
.post .meta {
font-size: 10px;
margin-bottom: 20px;
border: 1px solid #ccc;
border-left: none;
border-right: none;
}
.post .meta span {
float: left;
display: block;
margin-right: 20px;
padding: 5px 0 5px 30px;
}
.post .meta span.admin {
background: url(../images/agent.png) no-repeat;
}
.post .meta span.date {
background: url(../images/calendar.png) no-repeat;
}
.post .meta span.tag {
background: url(../images/tag.png) no-repeat;
}
.post .meta span.comment {
background: url(../images/chat.png) no-repeat;
}
.post .meta span.more_but {
float: right;
}
.post .meta span.more_but a {
color: #7f0d0d;
}
.post .meta a, .post .meta strong {
color: #7b7b7b;
font-weight: 700;
}
#comment_section {
clear: both;
margin-bottom: 60px;
width: 538px;
}
.first_level {
margin: 0; padding: 0;
}
.comments {
list-style: none;
}
.comments li {
margin-bottom: 10px;
list-style:none;
}
.comments li .commentbox1 {
border: 1px solid #d7cfbe;
}
.comments li .commentbox2 {
border: 1px solid #ccc;
}
.comments li .comment_box {
clear: both;
width:100%;
padding: 10px 30px 20px 30px;
margin-bottom: 40px;
}
.comment_box .gravatar {
float: left;
width: 75px;
margin-right: 30px;
}
.comment_box .gravatar img {
width: 75px;
height: 75px;
}
.comment_box .comment_text { }
.comment_box .comment_text p {
margin: 0;
}
.comment_text .comment_author {
font-size: 14px;
font-weight: bold;
color: #7f0d0d;
margin-bottom: 10px;
}
.comment_text .date {
font-size: 12px;
font-weight: normal;
color: #7b7b7b;
padding-left: 10px;
}
.comment_text .time {
font-size: 12px;
font-weight: normal;
color: #7b7b7b;
padding-left: 10px;
}
.comment_text .reply a {
display: block;
clear: both;
float: right;
color: #444;
font-weight: 700;
}
#comment_form {
clear: both;
}
#comment_form h3 {
font-size: 20px;
border-bottom: 1px solid #1b1b1b;
margin-bottom: 15px;
padding-bottom: 10px;
}
#comment_form form {
}
#comment_form textarea {
color: #000;
background:#fff;
border: 1px solid #ccc;
height:150px;
padding:5px;
width: 360px;
font-family: Tahoma, Geneva, sans-serif;
font-size: 12px;
margin-top: 5px;
}
#comment_form .form_row {
width: 100%;
margin-bottom: 15px;
}
#comment_form form input {
color: #000;
padding: 5px;
width: 200px;
background:#fff;
border: 1px solid #ccc;
font-family: Tahoma, Geneva, sans-serif;
font-size: 12px;
margin-top: 5px;
}
#comment_form .submit_btn {
width: 80px;
height: 30px;
color: #000;
background:#fff;
border: 1px solid #ccc;
}
.gallery_box {
margin-bottom: 40px;
}
.gallery_box img {
margin-bottom: 10px;
}
.gallery_box h5 {
font-size: 12px;
font-weight: 700;
margin-bottom:0;
}
.gallery_box p {
font-size: 11px;
}
.testimonial {
padding: 0 0 20px 70px;
margin-bottom: 30px;
border-bottom: 1px dotted #ced4dc;
display: block;
background: url(../images/speech_bubble_grey.png) left top no-repeat;
}
#contact_form {
padding: 0;
width: 410px;
margin-bottom: 40px;
}
#contact_form form {
margin: 0px;
padding: 0px;
}
#contact_form form .input_field {
width: 270px;
padding: 5px;
color: #333;
background: #fff;
border: 1px solid #dedede;
font-family: Tahoma, Geneva, sans-serif;
font-size: 12px;
margin-top: 5px;
}
#contact_form form label {
display: block;
width: 100px;
margin-right: 12px;
font-size: 12px;
}
#contact_form form textarea {
width: 398px;
height: 200px;
padding: 5px;
color: #333;
background: #fff;
border: 1px solid #dedede;
font-family: Tahoma, Geneva, sans-serif;
font-size: 12px;
margin-top: 5px;
}
#contact_form form .submit_btn {
display: block;
width: 80px;
height: 25px;
background: url(../images/templatemo_button_02.png);
border: 1px solid #bb4d17;
color: #fff;
font-size:13px;
border: none;
margin: 10px 0px;
}
#templatemo_bottom h4 {
display: block;
position: relative;
height: 27px;
padding-top: 5px;
margin-left: 27px;
color: #fff;
background:url(../images/templatemo_footer_header_right.png) no-repeat right
}
#templatemo_bottom h4 span {
position: absolute;
top: 0;
left: -27px;
width: 27px;
height: 32px;
background: url(../images/templatemo_footer_header_left.png) no-repeat left;
}
#templatemo_bottom .bottom_box {
padding: 0 30px;
}
#templatemo_bottom a {
color: #aca6a6;
}
.footer_list {
margin: 0;
padding: 0;
list-style: none;
}
.footer_list li {
margin: 0 0 5px;
padding: 0 0 5px;
border-bottom: 1px dotted #313030;
}
.footer_list li a {
color: #aca6a6;
}
.twitter_post {
margin: 0;
padding: 0;
list-style: none;
}
.twitter_post li {
margin: 0 0 10px;
padding: 0 0 7px;
border-bottom: 1px dotted #313030;
}
.footer_social_button {
clear: both;
margin-bottom: 40px;
}
.footer_social_button a {
margin-right: 5px;
}
.col {
float: left;
margin: 0 20px 20px 0;
}
.half {
width: 450px;
}
#sidebar, .one_third {
width: 300px;
}
.two-third {
width: 620px;
}
.padding_right {
padding-right: 20px;
}
.one_fourth {
width: 220px;
}
.no_margin_right {
margin-right: 0;
}
.last_box {
margin-bottom: 0;
background: none;
}
.pagging {
margin: 0 0 20px;
padding: 0;
}
.pagging ul {
margin: 0;
padding: 0;
list-style: none;
}
.pagging ul li {
margin: 0;
padding: 0;
display: inline;
}
.pagging ul li a {
float: left;
display: block;
color: #333;
text-decoration: none;
margin-right: 5px;
padding: 5px 10px;
background: #fff;
border: 1px solid #ccc;
}
.pagging ul li a:hover {
background: #7f0d0d;
border: 1px solid #fff;
color: #fff;
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 280 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 268 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 233 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 353 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 470 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 192 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 215 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 385 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 406 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 183 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 122 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 190 B

View File

@ -1,110 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Murano Documentation</title>
<link href="css/templatemo_style.css" rel="stylesheet" type="text/css" />
<link href="css/lightbox.css" rel="stylesheet" type="text/css" />
<link rel="stylesheet" type="text/css" href="css/ddsmoothmenu.css" />
<script type="text/javascript" src="js/jquery-1.10.2.min.js"></script>
<script type="text/javascript" src="js/jquery-migrate-1.2.1.min.js"></script>
<script type="text/javascript" src="js/lightbox-2.6.min.js"></script>
<script type="text/javascript" src="js/modernizr.custom.js"></script>
<!-- Load the CloudCarousel JavaScript file -->
<script type="text/JavaScript" src="js/cloud-carousel.1.0.5.min.js"></script>
<script type="text/javascript">
$(document).ready(function(){
// This initialises carousels on the container elements specified, in this case, carousel1.
$("#carousel1").CloudCarousel(
{
reflHeight: 40,
reflGap:2,
titleBox: $('#da-vinci-title'),
altBox: $('#da-vinci-alt'),
buttonLeft: $('#slider-left-but'),
buttonRight: $('#slider-right-but'),
yRadius:30,
xPos: 480,
yPos: 32,
speed:0.15,
}
);
});
</script>
</head>
<body id="home">
<div id="templatemo_header_wrapper">
<div id="site_title"><h1><a href="http://murano.github.io">Murano Documentation</a></h1></div>
<div id="templatemo_menu" class="ddsmoothmenu">
<ul>
<li><a href="index.html" class="selected">Docs</a></li>
<li><a href="https://wiki.openstack.org/wiki/Murano">Wiki</a>
<li><a href="http://launchpad.net/murano">Launchpad</a></li>
</ul>
<br style="clear: left" />
</div> <!-- end of templatemo_menu -->
<div class="cleaner"></div>
</div> <!-- END of templatemo_header_wrapper -->
<div id="templatemo_slider">
<!-- This is the container for the carousel. -->
<div id = "carousel1" style="width:960px; height:280px;background:none;overflow:scroll; margin-top: 20px">
<!-- All images with class of "cloudcarousel" will be turned into carousel items -->
<!-- You can place links around these images -->
<a href="images/slider/01.png" data-lightbox="image-01"><img class="cloudcarousel" src="images/slider/01_small.png" /></a>
<a href="images/slider/02.png" data-lightbox="image-02"><img class="cloudcarousel" src="images/slider/02_small.png" /></a>
<a href="images/slider/03.png" data-lightbox="image-03"><img class="cloudcarousel" src="images/slider/03_small.png" /></a>
<a href="images/slider/04.png" data-lightbox="image-04"><img class="cloudcarousel" src="images/slider/04_small.png" /></a>
<a href="images/slider/05.png" data-lightbox="image-05"><img class="cloudcarousel" src="images/slider/05_small.png" /></a>
<a href="images/slider/06.png" data-lightbox="image-06"><img class="cloudcarousel" src="images/slider/06_small.png" /></a>
<a href="images/slider/07.png" data-lightbox="image-07"><img class="cloudcarousel" src="images/slider/07_small.png" /></a>
<a href="images/slider/08.png" data-lightbox="image-08"><img class="cloudcarousel" src="images/slider/08_small.png" /></a>
</div>
<!-- Define left and right buttons. -->
<center>
<input id="slider-left-but" type="button" value="" />
<input id="slider-right-but" type="button" value="" />
</center>
</div>
<div id="templatemo_main">
<div class="col one_third fp_services">
<h2>Overview</h2>
<p>
Mirantis proposes to introduce a new service which will allow a non-experienced user to deploy
reliable Windows based environments in a “push-the-button” manner. The key goal is to provide a UI
and API enabling the deployment and operation of Windows Environments at the Windows Services
abstraction level. The service should be able to orchestrate complex circular dependent cases in
order to set up a complex Windows Environment with multiple dependant services.
</p>
</div>
<div class="col one_third fp_services">
<h2>Key Features</h2>
<ul>
<li><p>Native to OpenStack</p></li>
<li><p>Introduces abstraction level for Windows Environments</p></li>
<li><p>Supports Availability Zones and Disaster Recovery scenarios</p></li>
<li><p>Uses native Windows features for HA solutions</p></li>
</ul>
</div>
<div class="col one_third no_margin_right fp_services">
<h2>Manuals</h2>
<ul>
<li><a href="docs/murano-manual/content/ch01.html">User Manual</a> (<a href="docs/murano-manual/murano-manual.pdf">download pdf</a>)</li>
<li><a href="docs/murano-deployment-guide/content/ch01.html">Deployment Guide</a> (<a href="docs/murano-deployment-guide/murano-deployment-guide.pdf">download pdf</a>)</li>
</ul>
</div>
<div class="cleaner"></div>
</div> <!-- END of templatemo_main -->
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -19,7 +19,7 @@
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.murano</groupId>
<artifactId>murano-manual</artifactId>
<artifactId>developers-guide</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Murano Project Documentation</name>
@ -41,7 +41,7 @@
<xincludeSupported>true</xincludeSupported>
<chunkSectionDepth>100</chunkSectionDepth>
<postProcess>
<copy todir="target/docbkx/webhelp/murano-manual/figures">
<copy todir="target/docbkx/webhelp/developers-guide/figures">
<fileset dir="src/docbkx/figures">
<include name="**/*.png"/>
</fileset>

View File

@ -185,6 +185,24 @@
</para>
</section>
</section>
<section xml:id="releases">
<title>Releases</title>
<itemizedlist>
<listitem>
<para> <emphasis>Release-0.1</emphasis>
has 0.1 tag in all Murano repositories. Released 2013-06-19.
</para>
</listitem>
<listitem>
<para>
<emphasis>Release-0.2</emphasis>
has 0.2 tag in all Murano repositories. Released
2013-05-30.
</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Integration with Heat</title>
<para>Heat is a cloud resource management engine that allows you to manipulate resources that represent

View File

@ -33,13 +33,13 @@
<para>Murano supports the following operating systems:</para>
<orderedlist>
<listitem>
<para>Ubuntu</para>
<para>Ubuntu 12.04</para>
</listitem>
<listitem>
<para>RHEL/CentOS</para>
<para>RHEL/CentOS 6.4</para>
</listitem>
</orderedlist>
<para>Ensure that these packages are installed before Murano installation using your OS package manager:</para>
<para>These system packages are requred for Murano:</para>
<orderedlist>
<listitem>
<para>python-dev</para>
@ -64,7 +64,7 @@
<title>Install</title>
<itemizedlist>
<listitem>
<para>We need to have superuser privileges in order to install and configure system packages. Let's switch to root account:</para>
<para>Superuser privileges is required to install and configure system packages. Let's switch to root account:</para>
<programlisting>
<![CDATA[
sudo su
@ -72,30 +72,23 @@ sudo su
</programlisting>
</listitem>
<listitem>
<para>Clone Murano API Service from repository</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
</para>
<para>Clone Murano API git repository:</para>
<programlisting>
<![CDATA[
apt-get install -y git
git clone https://github.com/stackforge/murano-api
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
</para>
<para>Stable version one of our <link linkend="releases"> releases</link> can be checked by tag:</para>
<programlisting>
<![CDATA[
yum install -y git gcc python-paste-deploy python-routes
git clone https://github.com/stackforge/murano-api
]]>
git checkout 0.2
]]>
</programlisting>
</listitem>
<listitem>
<para>Switch to just created directory and them perform installation</para>
<para>Switch to just created directory and then perform installation</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
<![CDATA[
@ -104,7 +97,7 @@ sh setup.sh install
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
<![CDATA[
@ -122,7 +115,7 @@ Successfully installed muranoapi
Cleaning up...
LOG:> Making sample configuration files at "/etc/murano-api"
LOG:> Reloading initctl
LOG:> Please, make proper configugation,located at "/etc/murano-api", before starting the "murano-api" daemon!
LOG:> Please, make proper configuration,located at "/etc/murano-api", before starting the "murano-api" daemon!
]]>
</programlisting>
</listitem>
@ -245,7 +238,7 @@ keystone endpoint-create
<listitem>
<para>Run Murano API service:</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
<![CDATA[
@ -253,7 +246,7 @@ service murano-api start
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
<![CDATA[
@ -269,7 +262,7 @@ initctl start murano-api
<para>Conductor is a Murano orchestration engine that transforms object model sent by REST API service into
a series of Heat and Murano-Agent commands.
</para>
<para>This document describes Conductor for contributors of the project.</para>
<para>This chapter describes Conductor for contributors of the project.</para>
<section>
<title>Install</title>
<itemizedlist>
@ -293,7 +286,7 @@ initctl start murano-api
</para>
</listitem>
<listitem>
<para>Need to work as root</para>
<para>Superuser privileges is required to install and configure system packages. Let's switch to root account:</para>
<programlisting>
<![CDATA[
sudo su
@ -301,34 +294,26 @@ sudo su
</programlisting>
</listitem>
<listitem>
<para>Navigate to the temporary directory and clone Murano Conductor Service from repository</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
</para>
<para>Clone Murano Conductor repository from the github.</para>
<programlisting>
<![CDATA[
mkdir -p /tmp/murano
cd /tmp/murano
apt-get install -y git
git clone https://github.com/stackforge/murano-conductor
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
<para>Stable version one of our
<link linkend="releases">releases</link>
can be checked out by tag:
</para>
<programlisting>
<![CDATA[
mkdir -p /tmp/murano
cd /tmp/murano
yum install -y git
git clone https://github.com/stackforge/murano-conductor
]]>
git checkout 0.2
]]>
</programlisting>
</listitem>
<listitem>
<para>Switch to just created directory and then perform installation</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
<![CDATA[
@ -337,7 +322,7 @@ sh setup.sh install
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
<![CDATA[
@ -354,7 +339,7 @@ sh setup-centos.sh install
<title>Configure</title>
<itemizedlist>
<listitem>
<para>Edit configuration file where each parameter has a comment:</para>
<para>Edit configuration file and take a look at inline comments:</para>
<programlisting>
<![CDATA[
cd /etc/murano-conductor
@ -447,7 +432,7 @@ virtual_host = muranovhost
<listitem>
<para>Run Murano Conductor service:</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
<![CDATA[
@ -455,7 +440,7 @@ service murano-conductor start
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
<![CDATA[
@ -473,7 +458,7 @@ initctl start murano-conductor
<title>Install</title>
<itemizedlist>
<listitem>
<para>Need to work as root</para>
<para>Superuser privileges is required to install and configure system packages. Let's switch to root account:</para>
<programlisting>
<![CDATA[
sudo su
@ -481,47 +466,30 @@ sudo su
</programlisting>
</listitem>
<listitem>
<para>Navigate to the temporary directory and clone Murano Dashboard Service from repository</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
</para>
<para>Clone Murano Dashboard repository from the github:</para>
<programlisting>
<![CDATA[
mkdir -p /tmp/murano
cd /tmp/murano
apt-get install -y git
git clone https://github.com/stackforge/murano-dashboard
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
</para>
<programlisting>
<![CDATA[
mkdir -p /tmp/murano
cd /tmp/murano
yum install -y git
git clone https://github.com/stackforge/murano-dashboard
]]>
</programlisting>
</listitem>
<listitem>
<para>Switch to just created directory and run installation script</para>
<para>
<emphasis>Ubuntu Linux 12.04 / 12.10</emphasis>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
<![CDATA[
cd /tmp/murano/murano-dashboard
cd murano-dashboard
sh setup.sh install
]]>
</programlisting>
<para>
<emphasis>CentOS 6.x</emphasis>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
<![CDATA[
cd /tmp/murano/murano-dashboard
cd murano-dashboard
sh setup-centos.sh install
]]>
</programlisting>
@ -540,10 +508,10 @@ sh setup-centos.sh install
</para>
<programlisting>
<![CDATA[
[ssl]
cert_file = PATH
key_file = PATH
ca_file = PATH
[ssl]
cert_file = PATH
key_file = PATH
ca_file = PATH
]]>
</programlisting>
<itemizedlist>
@ -596,7 +564,7 @@ sh setup-centos.sh install
self-signed certificates.
</para>
<programlisting>
<![CDATA[
<![CDATA[
[rabbitmq]
# Use SSL for RabbitMQ connections (True or False)
@ -604,7 +572,7 @@ sh setup-centos.sh install
# Path to SSL CA certificate or empty to allow self signed server certificate
ca_certs =
]]>
]]>
</programlisting>
</section>
<section>
@ -616,7 +584,7 @@ sh setup-centos.sh install
self-signed certificates.
</para>
<programlisting>
<![CDATA[
<![CDATA[
[rabbitmq]
# Use SSL for RabbitMQ connections (True or False)
@ -624,7 +592,7 @@ sh setup-centos.sh install
# Path to SSL CA certificate or empty to allow self signed server certificate
ca_certs = /home/user/certificates/example.crt
]]>
]]>
</programlisting>
</section>
<section>
@ -636,7 +604,7 @@ sh setup-centos.sh install
Take a look at appSettings section:
</para>
<programlisting>
<![CDATA[
<![CDATA[
<appSettings>
<add key="rabbitmq.host" value="%RABBITMQ_HOST%"/>
<add key="rabbitmq.port" value="%RABBITMQ_PORT%"/>
@ -655,7 +623,7 @@ sh setup-centos.sh install
<add key="rabbitmq.allowInvalidCA" value="true"/>
<add key="rabbitmq.sslServerName" value=""/>
</appSettings>
]]>
]]>
</programlisting>
<para>
Desired parameter should be set directly to the value of the key

View File

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xlink="http://www.w3.org/1999/xlink"
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"
version="5.0">
<title>Known Issues</title>
<para>
Actual bug state can be found in Murano launchpad
<link xlink:href="https://bugs.launchpad.net/murano"> page.
</link>
</para>
<itemizedlist>
<listitem>
<para>
Due to current Heat limitation services that involve
load-balancer creation (farms) can be deployed only by tenant administrators.
</para>
</listitem>
<listitem>
<para>
When Heat creates different clients for Nova, Cinder and others
it doesn't pass SSL-related options to clients' constructor.
If Nova is configured to have SSL endpoints and self-signed
certificates Heat will fail to create instances because there
is no way to disable server certificate validation as there is
no "insecure" flag passed etc.
</para>
</listitem>
<listitem>
<para>Active Directory service can not be created on Win2008 image.</para>
</listitem>
<listitem>
<para>Murano-Conductor doesn't work with python-heatclient>0.2.1.</para>
</listitem>
</itemizedlist>
</chapter>

View File

@ -23,6 +23,13 @@
version="5.0">
<title>Overview</title>
<para>Welcome to Murano Project.
Murano is intended to get opportunity for non-experienced
users to deploy reliable Windows-based environments with 1-Click.
Key goal is to provide UI and API which
allows to deploy and operate Windows environments on the "Windows
Services" abstraction level. The Service should be able to orchestrate
complex circular dependent cases in order to setup complete Windows
environments with many dependant services.
</para>
<section>
<title>Intended Audience</title>
@ -58,16 +65,4 @@
</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>

View File

@ -22,7 +22,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"
version="5.0">
<title>Murano User Guide</title>
<title>Murano Developers Guide</title>
<info>
<author>
<personname>
@ -39,7 +39,7 @@
</copyright>
<releaseinfo>v0.1</releaseinfo>
<productname>Murano™</productname>
<pubdate>2013-04-04</pubdate>
<pubdate>2013-09-04</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the template. Change
@ -50,8 +50,7 @@
</legalnotice>
<abstract>
<para>This document is intended for individuals who wish to
configure
and use our product or intend to contribute.
use our product or intend to contribute.
</para>
</abstract>
<cover>
@ -74,12 +73,12 @@
FreeNode. Typically somebody from our team will be online at irc from 6:00 to 20:00 UTC. You can also
contact
Murano community directly by
<link xlink:href="mailto:murano-all@lists.launchpad.net">murano-all@lists.launchpad.net</link>
<link xlink:href="mailto:openstack-dev@lists.openstack.org">openstack-dev@lists.openstack.org</link>
(please, note that your email address should be registered in launchpad, otherwise your mail will be ignored
by mailing system).
</para>
<para>
Were going to hold public weekly meetings on Mondays at 17:00 UTC on #openstack-meeting-alt irc channel.
Were going to hold public weekly meetings on Mondays at 15:00 UTC on #openstack-meeting-alt irc channel.
</para>
<para>If you want to contribute either to docs or to code, simply send us change request via
<link xlink:href="http://review.openstack.org">review.openstack.org</link>

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

View File

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

View File

Before

Width:  |  Height:  |  Size: 214 KiB

After

Width:  |  Height:  |  Size: 214 KiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 234 KiB

After

Width:  |  Height:  |  Size: 234 KiB

View File

Before

Width:  |  Height:  |  Size: 325 KiB

After

Width:  |  Height:  |  Size: 325 KiB

View File

Before

Width:  |  Height:  |  Size: 278 KiB

After

Width:  |  Height:  |  Size: 278 KiB

View File

Before

Width:  |  Height:  |  Size: 267 KiB

After

Width:  |  Height:  |  Size: 267 KiB

View File

@ -1,28 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xlink="http://www.w3.org/1999/xlink"
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"
version="5.0">
<title>Known Issues</title>
<para>Due to current Heat limitations services that involve load-balancer creation (farms) can be deployed only by users having tenant administrator rights.
</para>
</chapter>