Edit 'Environment' chapter in user-guide
Change-Id: I284f014c0c82f701651bdea66a004aee04f164aa
@ -29,6 +29,9 @@
|
|||||||
<listitem>
|
<listitem>
|
||||||
<para>Create;</para>
|
<para>Create;</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Edit;</para>
|
||||||
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Delete;</para>
|
<para>Delete;</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
@ -43,16 +46,20 @@
|
|||||||
<para>Once you installed all Murano components and logged-in to horizon dashboard successfully you will see Murano tab:</para>
|
<para>Once you installed all Murano components and logged-in to horizon dashboard successfully you will see Murano tab:</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_panel.png" scalefit="1" width="100%" contentdepth="100%"/>
|
<imagedata fileref="../images/Environments/main-envs.png" scalefit="1" width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
<para>
|
<para>
|
||||||
First thing you need to do is to create an environment.
|
First thing you need to do is to create an environment.
|
||||||
To do this, navigate to the "Environments" page and click the "Create Environment". After setting name to your virtual environment it will be created.
|
To do this, navigate to the
|
||||||
|
<filename>Deployment > Environments</filename>
|
||||||
|
page and click to the
|
||||||
|
<filename>"Create Environment"</filename>
|
||||||
|
. After setting name to your virtual environment it will be created.
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_btn.png" scalefit="1"
|
<imagedata fileref="../images/Environments/create-env.png" scalefit="1"
|
||||||
width="100%" contentdepth="100%"/>
|
width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
@ -61,38 +68,42 @@
|
|||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_created.png" scalefit="1"
|
<imagedata fileref="../images/Environments/created-env.jpg" scalefit="1"
|
||||||
width="100%" contentdepth="100%"/>
|
width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Creating service prototype</title>
|
<title>Adding application to the environment</title>
|
||||||
<para >
|
<para >
|
||||||
All services should be created in the context of Environment. After Environment is created, you need to create service prototypes
|
After Environment is created, you need to add applications to this environment
|
||||||
and then deploy the Environment. When deploy process is done instances
|
and then deploy the Environment. When deploy process is done instances
|
||||||
with your services will be spawned in Openstack.
|
with your aplications will be spawned in OpenStack.
|
||||||
To create a service prototype navigate to page with the list of environment services by
|
To add an application navigate to page with the list of environment services by
|
||||||
clicking on the environment name (or on the "Services" button) and then, click
|
clicking on the environment name (or on the "Services" button) and then, click
|
||||||
the "Create Service" button.
|
the
|
||||||
|
<filename>"Add Application"</filename>button.
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/service_btn.png" scalefit="1" width="100%" contentdepth="100%"/>
|
<imagedata fileref="../images/Environments/add-app-btn.png" scalefit="1" width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
<para>
|
<para>
|
||||||
You have an opportunity to create one of the following services:
|
After clicking on the button you will be redirected to the "Application Catalog" page.
|
||||||
|
Here you can see all applications: public applications and application uploaded by yourself.
|
||||||
|
(Information about how to upload your own package to repository is availiable in appropriate chapter.)
|
||||||
|
You have an opportunity to add some of them. Base public applications are following:
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/service_list.png" scalefit="1" width="100%" contentdepth="50%" />
|
<imagedata fileref="../images/Application_Catalog/AppCatalog.png" scalefit="1" width="100%" contentdepth="50%" />
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
<para>
|
<para>
|
||||||
Once you choose service that you want to create click "Next" and fill the form.
|
Once you choose application that you want to add click "Add to Env" and fill the form.
|
||||||
Forms for each service are specific.
|
Forms for each application are specific.
|
||||||
To see more information about filling the form for a specific service follow one of the link below:
|
To see more information about filling the form for a specific application follow one of the link below:
|
||||||
</para>
|
</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -132,6 +143,13 @@
|
|||||||
Apache HTTP Server is a web server application notable for playing a key role in the initial growth of the World Wide Web.
|
Apache HTTP Server is a web server application notable for playing a key role in the initial growth of the World Wide Web.
|
||||||
This service can install Apache with PHP module or without it.
|
This service can install Apache with PHP module or without it.
|
||||||
</para>
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<emphasis role="bold">
|
||||||
|
<link linkend="Tomcat">Apache Tomcat:</link></emphasis>
|
||||||
|
Apache Tomcat is an open source software implementation of the Java Servlet and JavaServer Pages technologies.
|
||||||
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
@ -180,9 +198,18 @@
|
|||||||
SQL Server Cluster the way you want.
|
SQL Server Cluster the way you want.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<emphasis role="bold">
|
||||||
|
<link linkend="PostgreSQL">PostgreSQL:</link>
|
||||||
|
</emphasis>
|
||||||
|
PostgreSQL, often simply "Postgres", is an object-relational database management
|
||||||
|
system with an emphasis on extensibility and standards-compliance.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
<para>
|
<para>
|
||||||
On the last step of creating service prototype you have opportunity to set
|
On the last step of creating application prototype you have opportunity to set
|
||||||
the hardware flavor of the instance which will be created -
|
the hardware flavor of the instance which will be created -
|
||||||
and the image with the operating system, which will be installed on
|
and the image with the operating system, which will be installed on
|
||||||
the instance. Also you may select availability zone, if there are more
|
the instance. Also you may select availability zone, if there are more
|
||||||
@ -586,12 +613,12 @@
|
|||||||
<section>
|
<section>
|
||||||
<title>Deploying environment</title>
|
<title>Deploying environment</title>
|
||||||
<para>
|
<para>
|
||||||
Once all services are prepared you can send environment to deploy.
|
Once all application are added you can send environment to deploy.
|
||||||
Just press the "Deploy Environment" button.
|
Just press the <filename>"Deploy This Environment"</filename> button.
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/deploy_btn.png" scalefit="1" width="100%" contentdepth="100%"/>
|
<imagedata fileref="../images/Environments/deploy-env-btn.png" scalefit="1" width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
<para>
|
<para>
|
||||||
@ -600,7 +627,7 @@
|
|||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/deploy_started.png" scalefit="1"
|
<imagedata fileref="../images/Environments/deploy_started.png" scalefit="1"
|
||||||
width="100%" contentdepth="100%"/>
|
width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
@ -624,12 +651,12 @@
|
|||||||
<para>
|
<para>
|
||||||
As long as installation and configuration are in progress, environment
|
As long as installation and configuration are in progress, environment
|
||||||
is in <emphasis>Deploy in progress</emphasis> state. Depending on how many
|
is in <emphasis>Deploy in progress</emphasis> state. Depending on how many
|
||||||
services you are deploying or how many nodes in your cluster, process of spawning instances,
|
applications you are deploying or how many nodes in your cluster, process of spawning instances,
|
||||||
installation and post installation settings takes from 10 minutes up to one hour.
|
installation and post installation settings takes from 10 minutes up to one hour.
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_deploy.png" scalefit="1" width="100%" contentdepth="100%"/>
|
<imagedata fileref="../images/Environments/deploy-in-prg.png" scalefit="1" width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
<para>
|
<para>
|
||||||
@ -645,8 +672,8 @@
|
|||||||
<section>
|
<section>
|
||||||
<title>Working with deployed environment</title>
|
<title>Working with deployed environment</title>
|
||||||
<para>
|
<para>
|
||||||
Congratulations! After some time waiting you are able to operate with the services.
|
Congratulations! After some time waiting you are able to operate with the applications.
|
||||||
To get information about installed services, navigate to service detailed page.
|
To get information about installed application, navigate to service detailed page.
|
||||||
To do that click on the environment name and then on the name of the service you what to know about.
|
To do that click on the environment name and then on the name of the service you what to know about.
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
@ -675,13 +702,13 @@
|
|||||||
<para>There are more things you can do with Murano Environment:</para>
|
<para>There are more things you can do with Murano Environment:</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para><link linkend="redeploy">Add new services and deploy it again;</link></para>
|
<para><link linkend="redeploy">Add new application and deploy it again;</link></para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para><link linkend="delete">Delete outdated and unnecessary environments or services;</link></para>
|
<para><link linkend="delete">Delete outdated and unnecessary environments or applications;</link></para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para><link linkend="deployments">Browse deployment history and service installation logs;</link></para>
|
<para><link linkend="deployments">Browse deployment history and application installation logs;</link></para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para><link linkend="edit">Rename your environment.</link></para>
|
<para><link linkend="edit">Rename your environment.</link></para>
|
||||||
@ -698,13 +725,13 @@
|
|||||||
</section>
|
</section>
|
||||||
<section xml:id="delete">
|
<section xml:id="delete">
|
||||||
<title>Deleting</title>
|
<title>Deleting</title>
|
||||||
<para>Services as well as environments can be easily deleted.</para>
|
<para>Applications as well as environments can be easily deleted.</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>To delete an environment go to the environment index page and click "More" -> "Delete Environment" in Actions column of ready to delete environment.</para>
|
<para>To delete an environment go to the Deployment > Environments index page and click "More" -> "Delete Environment" in Actions column of ready to delete environment.</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_delete.png"
|
<imagedata fileref="../images/Environments/delete-env.png"
|
||||||
scalefit="1" width="100%"
|
scalefit="1" width="100%"
|
||||||
contentdepth="100%"/>
|
contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
@ -716,9 +743,9 @@
|
|||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
To delete a service go service list page and click the "Delete Service" button in Actions column. <emphasis role="bold">Note:</emphasis>
|
To delete an application go to the application list page and click the "Delete Service" button in Actions column. <emphasis role="bold">Note:</emphasis>
|
||||||
If you are deleting service that was already deployed you'll need to <emphasis>Deploy</emphasis> the environment again by pressing corresponding button.
|
If you are deleting application that was already deployed you'll need to <emphasis>Deploy</emphasis> the environment again by pressing corresponding button.
|
||||||
In case you want to delete service prototype - it has <emphasis>"Service draft created"</emphasis> in the <emphasis>
|
In case you want to delete application prototype - it has <emphasis>"Service draft created"</emphasis> in the <emphasis>
|
||||||
Last operation</emphasis> column (see the screenshot below) - changes applies right away.
|
Last operation</emphasis> column (see the screenshot below) - changes applies right away.
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
@ -740,7 +767,7 @@
|
|||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_show.png" scalefit="1" width="100%" contentdepth="100%"/>
|
<imagedata fileref="../images/Environments/show-env.png" scalefit="1" width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
<para>
|
<para>
|
||||||
@ -778,16 +805,16 @@
|
|||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_edit.png" scalefit="1" width="100%" contentdepth="100%"/>
|
<imagedata fileref="../images/Environments/edit-env.png" scalefit="1" width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
<para>
|
<para>
|
||||||
Environment name is not involved in service creation process so you can use spaces and any other
|
Environment name is not involved in application creation process but environment name have to corresponds with
|
||||||
characters you want.
|
heat stack name. So name must contains only alphanumeric characters (case sensitive) and start with an alpha character.
|
||||||
</para>
|
</para>
|
||||||
<mediaobject>
|
<mediaobject>
|
||||||
<imageobject role="fo">
|
<imageobject role="fo">
|
||||||
<imagedata fileref="../images/env_edit2.png" scalefit="1"
|
<imagedata fileref="../images/Environments/rename-env.png" scalefit="1"
|
||||||
width="100%" contentdepth="100%"/>
|
width="100%" contentdepth="100%"/>
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
|
@ -23,14 +23,14 @@
|
|||||||
Metadata property of Glance image is used. Murano Dashboard allows to
|
Metadata property of Glance image is used. Murano Dashboard allows to
|
||||||
add that property from a separate view. Navigate to the Murano tab
|
add that property from a separate view. Navigate to the Murano tab
|
||||||
and go to
|
and go to
|
||||||
<filename>Images</filename>
|
<filename>Manage > Images</filename>
|
||||||
panel.
|
panel.
|
||||||
<warning>
|
<warning>
|
||||||
<para>To operate with Glance Images you need to have admin
|
<para>To operate with Glance Images you need to have admin
|
||||||
rights!</para>
|
rights!</para>
|
||||||
</warning>
|
</warning>
|
||||||
<mediaobject><imageobject role="fo">
|
<mediaobject><imageobject role="fo">
|
||||||
<imagedata contentdepth="100%" fileref="../images/Images/index.png" scalefit="1" width="100%"/>
|
<imagedata contentdepth="100%" fileref="../images/Images/main-images.png" scalefit="1" width="100%"/>
|
||||||
</imageobject></mediaobject>
|
</imageobject></mediaobject>
|
||||||
You are browsing Glance images with correctly set
|
You are browsing Glance images with correctly set
|
||||||
"murano_image_info" property - image metadata. From this
|
"murano_image_info" property - image metadata. From this
|
||||||
|
BIN
src/user-guide/src/docbkx/images/Application_Catalog/AppCatalog.png
Executable file
After Width: | Height: | Size: 90 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/add-app-btn.png
Normal file
After Width: | Height: | Size: 46 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/create-env.png
Normal file
After Width: | Height: | Size: 39 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/created-env.jpg
Normal file
After Width: | Height: | Size: 59 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/delete-env.png
Normal file
After Width: | Height: | Size: 47 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/deploy-env-btn.png
Normal file
After Width: | Height: | Size: 64 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/deploy-in-prg.png
Normal file
After Width: | Height: | Size: 40 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/edit-env.png
Normal file
After Width: | Height: | Size: 46 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/main-envs.png
Normal file
After Width: | Height: | Size: 41 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/rename-env.png
Normal file
After Width: | Height: | Size: 40 KiB |
BIN
src/user-guide/src/docbkx/images/Environments/show-env.png
Normal file
After Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 30 KiB |
BIN
src/user-guide/src/docbkx/images/Images/main-images.png
Normal file
After Width: | Height: | Size: 89 KiB |
Before Width: | Height: | Size: 43 KiB |
Before Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 31 KiB |
@ -24,7 +24,7 @@
|
|||||||
version="5.0">
|
version="5.0">
|
||||||
<title>Murano User Guide</title>
|
<title>Murano User Guide</title>
|
||||||
<info>
|
<info>
|
||||||
<releaseinfo>v0.4</releaseinfo>
|
<releaseinfo>v0.5</releaseinfo>
|
||||||
<legalnotice role="apache2">
|
<legalnotice role="apache2">
|
||||||
<annotation>
|
<annotation>
|
||||||
<remark>Copyright details are filled in by the template. Change
|
<remark>Copyright details are filled in by the template. Change
|
||||||
|