diff --git a/src/user-guide/pom.xml b/src/user-guide/pom.xml index f9a889c..af44b0c 100644 --- a/src/user-guide/pom.xml +++ b/src/user-guide/pom.xml @@ -20,7 +20,7 @@ 4.0.0 com.mirantis.murano user-guide - 0.3 + 0.5 jar Murano User Guide diff --git a/src/user-guide/src/docbkx/content/app_catalog.xml b/src/user-guide/src/docbkx/content/app_catalog.xml new file mode 100644 index 0000000..1b03bb4 --- /dev/null +++ b/src/user-guide/src/docbkx/content/app_catalog.xml @@ -0,0 +1,1114 @@ + + + + Application Catalog +
+ Environments + + Application Catalog Environment + - a virtual unit to store different services (applications). + They can be connected with each other or be individual. The + following actions with environment are available: + + + Create; + + + Edit; + + + Delete; + + + Deploy. + + + More information about actions with environment are described in + this chapter. + +
+ Creating environment + Once you installed all Murano components and logged-in to + horizon dashboard successfully you will see Murano tab: + + + + + + + + First thing you need to do is to create an environment. + To do this, navigate to the + Application Catalog > Environments + page and click to the + "Create Environment" + . After setting name to your virtual environment it will be + created. + + + + + + + + Just created environment has status Ready to configure. + + + + + + +
+
+ Adding application to the environment + + After Environment is created, you need to add applications to + this environment + and then send the environment to deploy. When deploy process is + done instances + with your applications will be spawned in OpenStack. + To add an application, navigate to the page with the list of + environment components by + clicking on the environment name (or on the "Components" + button) and then, click + the + "Add Application"button. + + + + + + + + After that, you will be redirected to the "Applications" page. + Here you can see all applications: tenant applications and + public applications. + (Information about how to upload your own application package to repository + is available in appropriate chapter.) + Base Murano public applications are described below. + + + + + + + + Once you choose application that you want to add click "Add to + Env" and fill the form. + Forms for each application are specific. + To see more information about filling the form for a specific + application follow one of the link below: + + + + + + ASP.NET Application: + + is a server-side Web application framework designed for + Web + development to produce dynamic Web pages. Application + is able + to install custom services onto one IIS Web Server. + Murano installs + all needed components and makes proper configuration. + + + + + + ASP.NET Farm Application: + + + ASP.NET Farm Application installs a custom application + on a + load-balanced array of IIS servers. + + + + + + Active Directory: + + Active Directory is a directory application implemented + by Microsoft for Windows domain networks. + In one installation, in addition to primary Domain + Controller, + you can add optional count of secondary Domain + Controllers. + Any other applications you are intending to create can + be + joined to that domain. + + + + + + Apache Application: + + Apache HTTP Server is a web server application notable + for playing a key role in the initial growth of the + World Wide Web. + This application can install Apache with PHP module or + without it. + + + + + + Apache Tomcat: + + Apache Tomcat is an open source software implementation + of the Java Servlet and JavaServer Pages technologies. + + + + + + Demo Application: + + Installs test application that demonstrates how to + Murano interconnects with Murano Demo Agent. + For this application light-weight Linux Cirros image + can be used. + + + + + + Internet Information + Application: + + + IIS is a web server and a set of feature extension + modules. + + + + + + Internet Information Web + Farm Application: + + + Murano installs the Web Farm Framework on the + controller server, + configures the primary server and prepares the + secondary servers. + In addition load balancer is installed to monitor + application statuses. + + + + + + Linux Telnet: + + "AD + Telnet - is a network protocol used to provide a + bidirectional interactive + text-oriented communication facility using a virtual + terminal connection. + + + + + + MS SQL Application: + + Microsoft SQL Application is a relational database + management system. + + + + + + MS SQL Server Failover + Cluster: + + + Murano installs all needed components and configures + your + SQL Server Cluster the way you want. + + + + + + PostgreSQL: + + PostgreSQL, often simply "Postgres", is an + object-relational database management + system with an emphasis on extensibility and + standards-compliance. + + + + + On the last step of creating application prototype you have + opportunity to set + the hardware flavor of the instance which will be created - + and the image with the operating system, which will be + installed on + the instance. Also you may select availability zone, if there + are more + then one in your environment. + + + + + + +
+ Active Directory + + After you picked the Active Directory application you'll + see the following form: + + + + + + + + Enter or select values for this fields: + + + + + + + + Domain name + + + + Enter a desired name for a new domain. This + name should fit to + DNS Domain Name requirements: it should + contain + only A-Z, a-z, 0-9, (.) and (-) and should + not end with a dash. + DNS server will be automatically set up on + each of the Domain + Controller instances. + Period characters are allowed only when + they + are used to delimit the components of + domain style + names. Single-level domain is not + appropriate. + Note: Only first 15 characters or + characters + before first period is used as NetBIOS + name. + + + + + + Instance Count + + + + You can create several Active Directory + instances by setting + instance number larger than one. One + primary + Domain Controller and a few secondary DCs + will be created. + + + + + + Account Name + + + + You account will have Active Directory + administrator rights. + So initial value is "Administrator" but you + can change it to any name you like. + + + + + + Administrator password + + + + Windows requires strong password for + service administration. Your password + should have at least one letter + in each register, a number and a special + character. + Password length should be a minimum of 7 + characters. + + Once you forget your password you won't be + able to operate the service until recovery + password would be entered. So it's better + for Recovery and Administrator password + to be different. + + + + + + Confirm password + + + Password confirmation is required. + + + + + Recovery password + + + + Restrictions are the same as for the + Administrator password. + Please provide password that is different + from Administrator. It's not required for + form validation though. + + + + + + Confirm password + + + Password confirmation is required. + + + + +
+
+ Internet Information Service + + + + + +
+
+ Internet Information Web Farm Service + + + + + +
+
+ ASP.NET Service + + + + + +
+
+ ASP.NET Farm Service + + + + + +
+
+ MS SQL Service + + + + + +
+
+ MS SQL Server Failover Cluster + + + + + + Enter or select values for the following fields: + + + + + + + Service Name + + + + Enter a desired name for a service. Just + A-Z, + a-z, 0-9, dash and underline are allowed. + + + + + + Administrator password + + + + Windows requires strong password for + service + administration. + Your password should have at least one + letter + in each register, a number and a special + character. + Password length should be a minimum of 7 + characters. + + + + + + Confirm password + + + Password confirmation is required. + + + + + Active Directory is configured by the + System Administrator + + + + + Enable this option only if you have + properly configured rules + that will include service to the domain, + that already exists in you environment. + Once you set this option to true, + additional fields will appear. (See + information below) + + + + + + Domain + + + + Application should be joined to the Active + Directory + domain. Please, create Active Directory + Application + prototype first. + + + + + + Mixed-mode Authentication + + + + Mixed authentication mode allows the use of + Windows + credentials but supplements them with local + SQL + Server user accounts that the administrator + may create and + maintain within SQL Server. If this mode is + on SA password is required + + + + + + SA Password + + + + Set system administrator password for the + MS SQL Server. + Password requirements are the same as + previous. + + + + + + + In case pre-configured AD is enabled following fields will + appeared: + + + + + + + + + + + + + Active Directory User + Active Directory Password + + + + Specify administrator user credentials to + the existent AD domain + (to which application will be join + according to your system automation setup) + + + + + + + + + + + + + + + +
+
+ Linux Apache Application + + + + + + + + + + + + Application Name + + + + Enter a desired name for an application. + Just A-Z, a-z, 0-9, dash and + underline are allowed. + + + + + + PHP module + + + + PHP module can be installed with Apache. + Enable or disable this options via + checkbox. + + + + + + Key Pair + + + + Select SSH Key Pair from the existing to + control access to your instance. + + + + + + Hostname + + + + Machine hostname. + If blank - random name will be used. + + + + + +
+
+ Linux Telnet Application + + + + + + + + + + + + Service Name + + + + Enter a desired name for a service. Just + A-Z, + a-z, 0-9, dash and underline are allowed. + + + + + + Key Pair + + + + Select SSH Key Pair from the existing. + + + + + + Hostname + + + + Machine hostname. + If blank - random name will be used. + + + + + +
+
+
+ Deploying environment + + Once environment has all applications, it can be sent to + deploy. Just press the + "Deploy This Environment" button. + + + + + + + + And you'll see a message about successful start of deploying + your services in Openstack. Since now all you have to do is + just wait for a little bit + while Murano is installing and configuring your applications. + + + + + + + + You can monitor deploying process. Just go to the Log tab on + application detailed page, where you can get by clicking on + the application name. + And now you can see installation logs. + + + + + + + + As long as installation and configuration are in progress, + environment is in + Deploy in progress + state. Depending on how many + 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. + + + + + + + + If installation process finished without any errors, + environment changes its status to + Ready: + + + + + + +
+
+ Working with deployed environment + + Congratulations! After some time waiting you are able to + operate with the applications. + To get information about installed application, navigate to + application detailed page. + To do that click on the environment name and then on the name + of the application you what to know about. + + + + + + + + Now you are seeing general information about the application in + terms of Murano Environment. + To get information about the instance in Openstack terms follow + the link on application instance name. + + + + + + + + You can log in to the virtual machine directly from the horizon + (if your Openstack installation allows you) or by RDP protocol. + + + + + + + There are more things you can do with Murano Environment: + + + + + Add new application and deploy + it again; + + + + + + Delete outdated and unnecessary + environments or applications; + + + + + + Browse deployment history + and application installation logs; + + + + + + Rename your environment. + + + +
+ Redeploy Murano Environment + + Murano gives an opportunity to supplement already deployed + environment. + Thus if you already deployed the Active Directory + application and want to add any other applications just + create desired application prototype and click the + "Deploy This Environment" button. During application + prototype creation you can join this application + to the existent Active Directory domain. + +
+
+ Delete + Applications as well as environments can be easily + deleted. + + + + To delete an environment go to the Application Catalog > + Environments index page and click "More" -> "Delete + Environment" in Actions column of ready to delete + environment. + + + + + + + + Environment deletion means to kill all services + with instances on which they are installed. + Instances will be scheduled to delete right after + you choose the "Delete Environment" action. + + + + + To delete an application go to the application list + page and click the "Delete Service" button in + Actions column. + Note: + If you are deleting application that was already + deployed you'll need to + Deploy + the environment again by pressing corresponding + button. + In case you want to delete application prototype - + it has + "Service draft created" + in the + + Last operation + + column (see the screenshot below) - changes applies + right away. + + + + + + + + +
+
+ Browse Murano Deployment + + Since Murano Environment can be deployed many times you may + want + to see the history of its deployments. To do that click the + "More-> Show deployments" + button on environments index page: + + + + + + + + From this page it's easy to see how many times and when + Murano Environment was deployed: + + + + + + + + For each deployment you can get a detailed information by + clicking the "Show Details" button. + You always can go back to any level using navigation string + at the page header. + From here you can observe which applications were installed + during deployment: + + + + + + + Also deployment logs are available at the "Logs" tab: + + + + + + +
+
+ Rename Murano Environment + + It's possible to change the name of your environment: just + click the "More-> Edit Environment" button on environment + index page: + + + + + + + + Environment name will correspond with heat stack name. So + the name must contains only alphanumeric characters (case + sensitive) and - character. + + + + + + +
+
+
+
+ Applications + At the + Application Catalog -> Applications + page all applications, registered in Application Catalog, are shown. + + + + + + + + To see the full description of an application just click on the + Details + button. + + + + + + And you will see all information about the application, its + requirements and licence. + From here you can add application to the current environment by + pressing the corresponding button. + + + + + + If there are more then six applications you can use navigation bar + underneath. + + Desired application can be easily found with the + Search + button. It's located on the right side. + You can enter any words or digits: applications will be searched by + there names, tags, categories or by date of + creation or modification. + + + + + + Applications can be added to the existing environment. To select + the environment witch you want to add application just click to + the environment selector button. + + + + + + You can filter applications by categories with category selector. + It's located on the top of the page. Click on the desired category + name and all applications not related to that category will be + hidden. + + + + + + +
+ diff --git a/src/user-guide/src/docbkx/content/environments.xml b/src/user-guide/src/docbkx/content/environments.xml deleted file mode 100644 index e8001d8..0000000 --- a/src/user-guide/src/docbkx/content/environments.xml +++ /dev/null @@ -1,922 +0,0 @@ - - - - Environments - - Murano Environment - a virtual unit to store different services (applications). - They can be connected with each other or be individual. The following actions with environment are available: - - - Create; - - - Edit; - - - Delete; - - - Deploy. - - - More information about actions with environment are described in this chapter. - -
- Creating environment - Once you installed all Murano components and logged-in to horizon dashboard successfully you will see Murano tab: - - - - - - - First thing you need to do is to create an environment. - To do this, navigate to the - Deployment > Environments - page and click to the - "Create Environment" - . After setting name to your virtual environment it will be created. - - - - - - - - Just created environment has status Ready to configure. - - - - - - -
-
- Adding application to the environment - - After Environment is created, you need to add applications to this environment - and then deploy the Environment. When deploy process is done instances - with your aplications will be spawned in OpenStack. - 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 - the - "Add Application"button. - - - - - - - - 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: - - - - - - - - Once you choose application that you want to add click "Add to Env" and fill the form. - Forms for each application are specific. - To see more information about filling the form for a specific application follow one of the link below: - - - - - - ASP.NET Service: - - is a server-side Web application framework designed for Web - development to produce dynamic Web pages. Service is able - to install custom application onto one IIS Web Server. Murano installs - all needed components and makes proper configuration. - - - - - - ASP.NET Farm Service: - - ASP.NET Farm Service installs a custom application on a - load-balanced array of IIS servers. - - - - - Active Directory: - Active Directory is a directory service implemented by Microsoft for Windows domain networks. - In one installation, in addition to primary Domain Controller, - you can add optional count of secondary Domain Controllers. - Any other services you are intending to create can be - joined to that domain. - - - - - - Apache Service: - 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. - - - - - - Apache Tomcat: - Apache Tomcat is an open source software implementation of the Java Servlet and JavaServer Pages technologies. - - - - - - Demo Service: - Installs test service that demonstrates how to Murano interconnects with Murano Demo Agent. - For this service light-weight Linux Cirros image can be used. - - - - - - Internet Information Service: - IIS is a web server and a set of feature extension modules. - - - - - - Internet Information Web Farm Service: - - Murano installs the Web Farm Framework on the controller server, - configures the primary server and prepares the secondary servers. - In addition load balancer is installed to monitor service statuses. - - - - - Linux Telnet: - Telnet - is a network protocol used to provide a bidirectional interactive - text-oriented communication facility using a virtual terminal connection. - - - - - MS SQL Service: - Microsoft SQL Service is a relational database management system. - - - - - - MS SQL Server Failover Cluster: - - Murano installs all needed components and configures your - SQL Server Cluster the way you want. - - - - - - PostgreSQL: - - PostgreSQL, often simply "Postgres", is an object-relational database management - system with an emphasis on extensibility and standards-compliance. - - - - - On the last step of creating application prototype you have opportunity to set - the hardware flavor of the instance which will be created - - and the image with the operating system, which will be installed on - the instance. Also you may select availability zone, if there are more - then one in your environment. - - - - - - -
- Active Directory - - After you picked the Active Directory service in service creation - wizard you'll see the following form: - - - - - - - - Enter or select values for this fields: - - - - - - - - Domain name - - - - Enter a desired name for a new domain. This name should fit to - DNS Domain Name requirements: it should contain - only A-Z, a-z, 0-9, (.) and (-) and should not end with a dash. - DNS server will be automatically set up on each of the Domain - Controller instances. - Period characters are allowed only when they - are used to delimit the components of domain style - names. Single-level domain is not appropriate. - Note: Only first 15 characters or characters - before first period is used as NetBIOS name. - - - - - Instance Count - - - You can create several Active Directory instances by setting - instance number larger than one. One primary - Domain Controller and a few secondary DCs will be created. - - - - - Account Name - - - You account will have Active Directory administrator rights. - So initial value is "Administrator" but you can change it to any name you like. - - - - - Administrator password - - - Windows requires strong password for service administration. - Your password should have at least one letter - in each - register, a number and a special character. - Password length should be - a minimum of 7 characters. - - Once you forget your password you won't be able - to - operate the service until recovery password - would be entered. So it's - better for Recovery and Administrator password - to be different. - - - - - Confirm password - - Password confirmation is required. - - - - Recovery password - - - Restrictions are the same as for the Administrator password. - Please provide password that is different from Administrator. - It's not required for form validation though. - - - - - Confirm password - - Password confirmation is required. - - - - -
-
- Internet Information Service - - - - - -
-
- Internet Information Web Farm Service - - - - - -
-
- ASP.NET Service - - - - - -
-
- ASP.NET Farm Service - - - - - -
-
- MS SQL Service - - - - - -
-
- MS SQL Server Failover Cluster - - - - - - Enter or select values for the following fields: - - - - - - - Service Name - - - - Enter a desired name for a service. Just A-Z, - a-z, 0-9, dash and underline are allowed. - - - - - - Administrator password - - - - Windows requires strong password for service - administration. - Your password should have at least one letter - in each register, a number and a special character. - Password length should be a minimum of 7 characters. - - - - - - Confirm password - - - Password confirmation is required. - - - - - Active Directory is configured by the System Administrator - - - - - Enable this option only if you have properly configured rules - that will include service to the domain, that already exists in you environment. - Once you set this option to true, additional fields will appear. (See information below) - - - - - - Domain - - - - Service should be joined to the Active - Directory - domain. Please, create Active Directory Service - prototype first. - - - - - - Mixed-mode Authentication - - - - Mixed authentication mode allows the use of Windows - credentials but supplements them with local SQL - Server user accounts that the administrator may create and - maintain within SQL Server. If this mode is on SA password is required - - - - - - SA Password - - - - Set system administrator password for the MS SQL Server. - Password requirements are the same as previous. - - - - - - - In case pre-configured AD is enabled following fields will appeared: - - - - - - - - - - - - - Active Directory User - Active Directory Password - - - - Specify administrator user credentials to the existent AD domain - (to which service service will be join according to your system automation setup) - - - - - - - - - - - - - - - -
-
- Linux Apache Service - - - - - - - - - - - - Service Name - - - - Enter a desired name for a service. Just A-Z, - a-z, 0-9, dash and underline are allowed. - - - - - - PHP module - - - - PHP module can be installed with Apache. - Enable or disable this options via checkbox. - - - - - - Key Pair - - - - Select SSH Key Pair from the existing to - control access to your instance. - - - - - - Hostname - - - - Machine hostname. - If blank - random name will be used. - - - - - -
-
- Linux Telnet Service - - - - - - - - - - - - Service Name - - - - Enter a desired name for a service. Just A-Z, - a-z, 0-9, dash and underline are allowed. - - - - - - Key Pair - - - - Select SSH Key Pair from the existing. - - - - - - Hostname - - - - Machine hostname. - If blank - random name will be used. - - - - - -
-
-
- Deploying environment - - Once all application are added you can send environment to deploy. - Just press the "Deploy This Environment" button. - - - - - - - - And you'll see a message about successful start of deploying your services in Openstack. Since now all you have to do is just wait for a little bit - while Murano installing and configuring your services. - - - - - - - - You can monitor deploying process. Just go to the Log tab on service - detailed page, where you can get by clicking on the service name. - - - - - - - - And now you can see installation progress. - - - - - - - - As long as installation and configuration are in progress, environment - is in Deploy in progress state. Depending on how many - 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. - - - - - - - - If installation process finished without any errors, environment changes its status to - Ready: - - - - - - -
-
- Working with deployed environment - - Congratulations! After some time waiting you are able to operate with the applications. - 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. - - - - - - - - Now you are seeing general information about the service in terms of Murano Environment. - To get information about the instance in Openstack terms follow the link on service instance name. - - - - - - - - You can login to the virtual machine directly from the horizon (if your Openstack installation allows you) or by RDP protocol. - - - - - - - There are more things you can do with Murano Environment: - - - Add new application and deploy it again; - - - Delete outdated and unnecessary environments or applications; - - - Browse deployment history and application installation logs; - - - Rename your environment. - - -
- Redeploying Murano Environment - - Murano gives an opportunity to supplement already deployed environment. - Thus if you already deployed the Active Directory service and want to add - any other services just create desired service prototype and click the "Deploy This Environment" button. - During service prototype creation you can join this service to the existent Active Directory domain. - -
-
- Deleting - Applications as well as environments can be easily deleted. - - - To delete an environment go to the Deployment > Environments index page and click "More" -> "Delete Environment" in Actions column of ready to delete environment. - - - - - - - Environment deletion means to kill all services with instances on which they are installed. - Instances will be scheduled to delete right after you choose the "Delete Environment" action. - - - - - To delete an application go to the application list page and click the "Delete Service" button in Actions column. Note: - If you are deleting application that was already deployed you'll need to Deploy the environment again by pressing corresponding button. - In case you want to delete application prototype - it has "Service draft created" in the - Last operation column (see the screenshot below) - changes applies right away. - - - - - - - - -
-
- Browsing Murano Deployment - - Since Murano Environment can be deployed many times you may want - to see the history of its deployments. To do that click the "More-> Show deployments" - button on environments index page: - - - - - - - - From this page it's easy to see how many times and when Murano Environment was deployed: - - - - - - - - For each deployment you can get a detailed information by clicking the "Show Details" button. - You always can go back to any level using navigation string at the page header. - From here you can observe what services were installed during deployment: - - - - - - - Also deployment logs are available at the "Logs" tab: - - - - - -
-
- Renaming Murano Environment - - It's possible to change a name of your environment: just click the "More-> Edit Environment" button on environment index page: - - - - - - - - Environment name is not involved in application creation process but environment name have to corresponds with - heat stack name. So name must contains only alphanumeric characters (case sensitive) and start with an alpha character. - - - - - - -
-
-
- Troubleshooting - How to debug OpenStack Heat? - - If you can execute Heat command via console interface - all good. It is - the most simple way to check Heat state on the node - just execute CLI - command 'heat list'. - - See more information about Heat in openstack wiki - page - - If 'heat list' returns 503 error - - It means that OpenStack Heat configuration files contain incorrect - credentials. Need to set 'user' = 'heat' and change passwords - 'verybadpass' in all configuration files from directory /etc/heat/ - - If 'heat list' hangs up - - Sometimes you can see that 'heat list' hangs up. The root of this - problem - connection to the rabbitMQ. - - How I can connect to LoadBalancer instance in Server Farms? - - First of all you should have KeyPair file 'murano-lb-key'. You can - create this file using commands - - murano-lb-key.priv -chmod 600 murano-lb-key.priv - ]]> - - And after that server farms need to be created with this KeyPair. - The second step is to 'how to connect to VM with LoadBalancer': - - - - - Murano dashboard can not connect to Murano API. How I can fix it? - - This problem has two ways to fix: - Add string - - - - to the /etc/openstack-dashboard/local_settings (or - /etc/openstack-dashboard/local_settings.py - it depends on OpenStack - configuration) - and after that web server restart is needed. - Add keystone endpoints for Murano API - - - - - - Murano API Service does not work on CentOS 6.x. WebUI can not connect - to this service. How to fix this? - - - The problem in pip lib routes. Need to upgrade this lib and restart - Murano API: - - - - - - Error 'Unexpected state' during the deployment of Web Farms. What the - problem? - - - Sometimes we can see in deployments logs: - - - - The root of this problem is incorrect configuration - Heat can not - create Load Balancer instance. Please, remember that you should have - admin access for the project in OpenStack to deploy LoadBalancer and also, - you should have KeyPair with default name 'murano-lb-key'. - - Error in Murano API logs 'No module named helpers.token_sanitizer' - - This pip version problem. Need to install pip 1.4 and after that reinstall murano-client, murano-common and murano-api. - -
- diff --git a/src/user-guide/src/docbkx/content/management.xml b/src/user-guide/src/docbkx/content/management.xml new file mode 100644 index 0000000..16be1af --- /dev/null +++ b/src/user-guide/src/docbkx/content/management.xml @@ -0,0 +1,266 @@ + + + + Murano Management +
+ Package definitions + + Cloud administrator has rights to manage applications in the + catalog: upload new applications, modify existing, disable or + delete them. + All this actions are available in Murano UI and will be described + in this section. Go to the Manage ->Package + Definitions page. + + + + + + + + + Upload Package + provides a form for uploading an application package. + After this operation your application will be + acceptable from application catalog. + + + + + + + + You'll need to provide path to the package with your + application. It should be in a zip format. + See + + here + + for more information on how to prepare an application + package. Also select one category to which your application belongs too. + + + + + Toggle Active + makes an application + active or disabled depending on the current state. + + + + + Delete Packages + removes applications from the catalog + + + + + Modify Package + gives you opportunity to modify meta information about + the application. + + + + + + + The following properties are allowed to edit: + + + + Name + - visible application name + + + + + Categories + - change application category + + + + + Tags + - specify comma-separated list of words, + associated with the application + + + + + Public + - indicates access for non-admin users from + all tenants + + + + + Active + - indicates if this application is enabled + or disabled + + + + + Description + + - extend information about application, + which will be shown at the Application + Details page + + + + + + + + Download Package + saves application definition as zip archive, as it was + uploaded + + + + +
+
+ Murano Images + + Murano uses preconfigured images for spawning instances. Image + suitable for Murano should have Murano Agent installed at least. + See + + here + + how to build Murano images and upload it to Glance. Since Murano + supports different operating systems it's not possible to use + one image to build every single application. To classify images + Metadata property of Glance image is used. Murano Dashboard allows + to + add that property from a separate view. Navigate to the Murano tab + and go to + Images + panel. + + To operate with Glance Images you need to have admin + rights! + + + + + + + + You are browsing Glance images with correctly set + "murano_image_info" property - image metadata. From this + view you are able to: + + + Delete an existing image metadata with + "Delete + Metadata" + button (only image's property get deleted, + the image itself stays in Glance) + + + + Add new murano metadata to an image that is already + registered in Glance by clicking on + "Mark Image" button + + + + Take a look at the "Mark Image" form: + + + + + + + + + + + + + + Image + + + From all images registered in Glance pick one + that was created with + + Murano Image Builder. + + + + + + Title + + + Set name for a selected image to recognize it + easier during + service creation. + + + + + + Type + + + + For now there are three supported types: + + + Windows Server 2012 - used to + build Windows-based + applications + + + + Murano Demo - light-weight Linux + Cirros image with + Murano Demo Agent + + + + Generic Linux - used to build + Linux-based + applications + + + + + + + + + +
+ diff --git a/src/user-guide/src/docbkx/content/metadata.xml b/src/user-guide/src/docbkx/content/metadata.xml deleted file mode 100644 index 3748b6b..0000000 --- a/src/user-guide/src/docbkx/content/metadata.xml +++ /dev/null @@ -1,208 +0,0 @@ - - - - Metadata Repository - This chapter describes how to operate with Murano Metadata - Repository via UI. - - Metadata Repository is a REST API server stores all data - necessary for a service deployment. Information about service and - it's dependencies is called service definition - or manifest. Murano Conductor and Dashboard will - load these service definitions and service or application will be available - for creation. Besides manifests Murano Repository stores this types - of data: - - - ui - UI definitions for Murano - dashboard - - - workflows - set of rules for Murano - Conductor - - - heat - templates for spawning instance - with Heat - - - agent - Murano Agent templates - - - scripts - Murano Execution Plans - - - In "Murano" tab go to the "Service Definitions" panel: - - - - - - From this view you are able to perform the following actions: - - - Compose Service provides a form for - creating new service manifest. After this operation is complete new service - will appear in Service Definitions table and you will be allowed - to download this service definition, modify or delete it. - - - Upload Service provides a form for - uploading tar.gz archive with already composed service manifest and - other dependency files. - - - Manage Files button will redirect you to - a view where you can manipulate with all files stored in Metadata - Repository: download, delete or upload new ones. - - - Toggle Active button will make service - active or inactive depending on the current state. - - - Modify Service gives you opportunity to - modify attributes of service definition. - - - Manage Service redirects you to a view - with information about selected service and service files for all - data types that Murano Repository supports. From here you can - upload file and add it to service dependency in one click. - - - Download Service saves archive with all - files used by specified service. - - - Delete Service removes service manifest - and all dependencies that are not used by other services from - Murano Repository server. - - - - -
- - Compose Service - - - Let's review service creation in details. - After clicking on "Compose Service" button from "Service Definitions" view you'll see the following form: - - - - It consists of several tabs. On the first tab you need to fill up general information about service. - On the next tab select one of the UI definitions you want to use for this service. - You can upload new definition in the Manage Files view. - - - - All other tabs correspond to data types. Navigate to desired tab and select files for service dependency. - The only mandatory requirement for a new service is a UI definition file - if a service doesn't reference any, it won't be shown in the - "Create Service" form. All other tabs refer to a files required for a service's deployment phase. - - - - -
-
- Manage Files - - Murano Repository table shows all files stored in Metadata - Repository. Files are divided into categories by data types. - Button name of each category also contains the number of files in that category. - Click on the type name to browse all files of this type. - - - - The following actions are available: - - - Download file, - - - Delete file, - - - Upload file. - - - To upload file to repository you need to fill up this form: - - - - - - - - - - Murano Repository File - - - Select file for uploading. It should be not bigger than 5Mb. - - - - - File Type - - - - Select one of supported type. It will be loaded directly to a directory that stores corresponding file types. - - - - - - -
-
- - Manage Service - - - Manage Service view displays general information about service and list of file dependency grouped by a separate tables. - - - - In the following view these actions are available: - - - - View service detail information. - - - - - Download File. - - - - Delete file. - - - - Upload file of the exact type by pressing the <File type>" button in the appropriate table. - - - - -
- diff --git a/src/user-guide/src/docbkx/content/overview.xml b/src/user-guide/src/docbkx/content/overview.xml index 16f7aad..b5bc1b0 100644 --- a/src/user-guide/src/docbkx/content/overview.xml +++ b/src/user-guide/src/docbkx/content/overview.xml @@ -21,14 +21,16 @@ 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"> - How can I use Murano Service? + Overview - Murano is intended to get opportunity for non-experienced - users to deploy different kinds of applications extremely simple. - To use Murano you should be familiar with Openstack. - Murano Dashboard is just a plugin to Openstack dashboard - Horizon. - Please visit horizon user guide first to see how dashboard is organized and how to login into it. - This document describes Murano Dashboard usage in detail. + Murano is an Application catalog for Openstack. + Full information about Murano in Openstack wiki page. + Murano Project introduces an application catalog, which allows application developers and cloud administrators to publish various cloud-ready applications + in a browsable categorised catalog. + It may be used by the cloud users to pick-up the needed applications and services and composes the reliable environments out of them in a “push-the-button” manner. + Murano UI is just a plugin to Openstack dashboard - Horizon. + Please visit horizon user guide first to see how dashboard is organized and how to log in to it. + This document describes Murano Application Catalog usage in detail.
Document change history @@ -36,7 +38,7 @@ - + Revision Date @@ -46,10 +48,10 @@ - September. 4, 2013 + September 4, 2013 - + Update for Release-0.2 @@ -58,16 +60,28 @@ - December. 9, 2013 + December 9, 2013 - + Update for Release-0.4 + + + April 22, 2014 + + + + + Update for Release-0.5 + + + + diff --git a/src/user-guide/src/docbkx/content/troubleshooting.xml b/src/user-guide/src/docbkx/content/troubleshooting.xml new file mode 100644 index 0000000..47a710d --- /dev/null +++ b/src/user-guide/src/docbkx/content/troubleshooting.xml @@ -0,0 +1,118 @@ + + + + Troubleshooting +
+ FQN + How to debug OpenStack Heat? + + If you can execute Heat command via console interface - all good. It is + the most simple way to check Heat state on the node - just execute CLI + command 'heat list'. + + See more information about Heat in openstack wiki + page + + If 'heat list' returns 503 error + + It means that OpenStack Heat configuration files contain incorrect + credentials. Need to set 'user' = 'heat' and change passwords + 'verybadpass' in all configuration files from directory /etc/heat/ + + If 'heat list' hangs up + + Sometimes you can see that 'heat list' hangs up. The root of this + problem - connection to the rabbitMQ. + + How I can connect to LoadBalancer instance in Server Farms? + + First of all you should have KeyPair file 'murano-lb-key'. You can + create this file using commands + + murano-lb-key.priv +chmod 600 murano-lb-key.priv + ]]> + + And after that server farms need to be created with this KeyPair. + The second step is to 'how to connect to VM with LoadBalancer': + + + + + Murano dashboard can not connect to Murano API. How I can fix it? + + This problem has two ways to fix: + Add string + + + + to the /etc/openstack-dashboard/local_settings (or + /etc/openstack-dashboard/local_settings.py - it depends on OpenStack + configuration) + and after that web server restart is needed. + Add keystone endpoints for Murano API + + + + + + Murano API Service does not work on CentOS 6.x. WebUI can not connect + to this service. How to fix this? + + + The problem in pip lib routes. Need to upgrade this lib and restart + Murano API: + + + + + + Error 'Unexpected state' during the deployment of Web Farms. What the + problem? + + + Sometimes we can see in deployments logs: + + + + The root of this problem is incorrect configuration - Heat can not + create Load Balancer instance. Please, remember that you should have + admin access for the project in OpenStack to deploy LoadBalancer and also, + you should have KeyPair with default name 'murano-lb-key'. + + Error in Murano API logs 'No module named helpers.token_sanitizer' + + This pip version problem. Need to install pip 1.4 and after that reinstall murano-client, murano-common and murano-api. + +
+ diff --git a/src/user-guide/src/docbkx/images/Application_Catalog/AppCatalog.png b/src/user-guide/src/docbkx/images/Application_Catalog/AppCatalog.png deleted file mode 100755 index 69de640..0000000 Binary files a/src/user-guide/src/docbkx/images/Application_Catalog/AppCatalog.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Environments/add-app-btn.png b/src/user-guide/src/docbkx/images/Environments/add-app-btn.png deleted file mode 100644 index 94bb2c9..0000000 Binary files a/src/user-guide/src/docbkx/images/Environments/add-app-btn.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Environments/create-env.png b/src/user-guide/src/docbkx/images/Environments/create-env.png deleted file mode 100644 index 5788c61..0000000 Binary files a/src/user-guide/src/docbkx/images/Environments/create-env.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Environments/created-env.jpg b/src/user-guide/src/docbkx/images/Environments/created-env.jpg deleted file mode 100644 index 816759c..0000000 Binary files a/src/user-guide/src/docbkx/images/Environments/created-env.jpg and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Environments/deploy-env-btn.png b/src/user-guide/src/docbkx/images/Environments/deploy-env-btn.png deleted file mode 100644 index 4978371..0000000 Binary files a/src/user-guide/src/docbkx/images/Environments/deploy-env-btn.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Environments/deploy-in-prg.png b/src/user-guide/src/docbkx/images/Environments/deploy-in-prg.png deleted file mode 100644 index 018343c..0000000 Binary files a/src/user-guide/src/docbkx/images/Environments/deploy-in-prg.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Environments/main-envs.png b/src/user-guide/src/docbkx/images/Environments/main-envs.png deleted file mode 100644 index a539c71..0000000 Binary files a/src/user-guide/src/docbkx/images/Environments/main-envs.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Environments/show-env.png b/src/user-guide/src/docbkx/images/Environments/show-env.png deleted file mode 100644 index 3c4cc5d..0000000 Binary files a/src/user-guide/src/docbkx/images/Environments/show-env.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Images/Image 13.png b/src/user-guide/src/docbkx/images/Images/Image 13.png deleted file mode 100644 index 611fa33..0000000 Binary files a/src/user-guide/src/docbkx/images/Images/Image 13.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Images/main-images.png b/src/user-guide/src/docbkx/images/Images/main-images.png deleted file mode 100644 index b407a0a..0000000 Binary files a/src/user-guide/src/docbkx/images/Images/main-images.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Images/mark_image.png b/src/user-guide/src/docbkx/images/Images/mark_image.png deleted file mode 100644 index 63445c7..0000000 Binary files a/src/user-guide/src/docbkx/images/Images/mark_image.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/compose_service1.png b/src/user-guide/src/docbkx/images/Metadata/compose_service1.png deleted file mode 100644 index 7240c7f..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/compose_service1.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/compose_service2.png b/src/user-guide/src/docbkx/images/Metadata/compose_service2.png deleted file mode 100644 index 3e03da8..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/compose_service2.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/compose_service3.png b/src/user-guide/src/docbkx/images/Metadata/compose_service3.png deleted file mode 100644 index 1a945f7..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/compose_service3.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/index.png b/src/user-guide/src/docbkx/images/Metadata/index.png deleted file mode 100644 index 75b9836..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/index.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/manage_files.png b/src/user-guide/src/docbkx/images/Metadata/manage_files.png deleted file mode 100644 index a24d32e..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/manage_files.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png b/src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png deleted file mode 100644 index 0e4ee57..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/manage_service.png b/src/user-guide/src/docbkx/images/Metadata/manage_service.png deleted file mode 100644 index 93281c2..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/manage_service.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/Metadata/upload_tofile.png b/src/user-guide/src/docbkx/images/Metadata/upload_tofile.png deleted file mode 100644 index 2cd394c..0000000 Binary files a/src/user-guide/src/docbkx/images/Metadata/upload_tofile.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/app_catalog/category_selector.png b/src/user-guide/src/docbkx/images/app_catalog/category_selector.png new file mode 100644 index 0000000..4a46506 Binary files /dev/null and b/src/user-guide/src/docbkx/images/app_catalog/category_selector.png differ diff --git a/src/user-guide/src/docbkx/images/app_catalog/details.png b/src/user-guide/src/docbkx/images/app_catalog/details.png new file mode 100644 index 0000000..4837eff Binary files /dev/null and b/src/user-guide/src/docbkx/images/app_catalog/details.png differ diff --git a/src/user-guide/src/docbkx/images/app_catalog/details2.png b/src/user-guide/src/docbkx/images/app_catalog/details2.png new file mode 100644 index 0000000..2c14a2b Binary files /dev/null and b/src/user-guide/src/docbkx/images/app_catalog/details2.png differ diff --git a/src/user-guide/src/docbkx/images/app_catalog/env_selector.png b/src/user-guide/src/docbkx/images/app_catalog/env_selector.png new file mode 100644 index 0000000..4f6ead7 Binary files /dev/null and b/src/user-guide/src/docbkx/images/app_catalog/env_selector.png differ diff --git a/src/user-guide/src/docbkx/images/app_catalog/index.png b/src/user-guide/src/docbkx/images/app_catalog/index.png new file mode 100644 index 0000000..ebc2d10 Binary files /dev/null and b/src/user-guide/src/docbkx/images/app_catalog/index.png differ diff --git a/src/user-guide/src/docbkx/images/app_catalog/search.png b/src/user-guide/src/docbkx/images/app_catalog/search.png new file mode 100644 index 0000000..3d6d829 Binary files /dev/null and b/src/user-guide/src/docbkx/images/app_catalog/search.png differ diff --git a/src/user-guide/src/docbkx/images/deploy_started.png b/src/user-guide/src/docbkx/images/deploy_started.png deleted file mode 100644 index 41a9109..0000000 Binary files a/src/user-guide/src/docbkx/images/deploy_started.png and /dev/null differ diff --git a/src/user-guide/src/docbkx/images/environments/add-app-btn.png b/src/user-guide/src/docbkx/images/environments/add-app-btn.png new file mode 100644 index 0000000..1cc71da Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/add-app-btn.png differ diff --git a/src/user-guide/src/docbkx/images/environments/create-env.png b/src/user-guide/src/docbkx/images/environments/create-env.png new file mode 100644 index 0000000..79d3a11 Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/create-env.png differ diff --git a/src/user-guide/src/docbkx/images/environments/created.jpg b/src/user-guide/src/docbkx/images/environments/created.jpg new file mode 100644 index 0000000..522885b Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/created.jpg differ diff --git a/src/user-guide/src/docbkx/images/Environments/delete-env.png b/src/user-guide/src/docbkx/images/environments/delete-env.png similarity index 100% rename from src/user-guide/src/docbkx/images/Environments/delete-env.png rename to src/user-guide/src/docbkx/images/environments/delete-env.png diff --git a/src/user-guide/src/docbkx/images/environments/deploy-env-btn.png b/src/user-guide/src/docbkx/images/environments/deploy-env-btn.png new file mode 100644 index 0000000..a717c31 Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/deploy-env-btn.png differ diff --git a/src/user-guide/src/docbkx/images/environments/deploy-in-prg.png b/src/user-guide/src/docbkx/images/environments/deploy-in-prg.png new file mode 100644 index 0000000..7e01f70 Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/deploy-in-prg.png differ diff --git a/src/user-guide/src/docbkx/images/environments/deploy_started.png b/src/user-guide/src/docbkx/images/environments/deploy_started.png new file mode 100644 index 0000000..62581dd Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/deploy_started.png differ diff --git a/src/user-guide/src/docbkx/images/Environments/edit-env.png b/src/user-guide/src/docbkx/images/environments/edit-env.png similarity index 100% rename from src/user-guide/src/docbkx/images/Environments/edit-env.png rename to src/user-guide/src/docbkx/images/environments/edit-env.png diff --git a/src/user-guide/src/docbkx/images/environments/logs.png b/src/user-guide/src/docbkx/images/environments/logs.png new file mode 100644 index 0000000..b1fe839 Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/logs.png differ diff --git a/src/user-guide/src/docbkx/images/environments/main-envs.png b/src/user-guide/src/docbkx/images/environments/main-envs.png new file mode 100644 index 0000000..8396c1b Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/main-envs.png differ diff --git a/src/user-guide/src/docbkx/images/Environments/rename-env.png b/src/user-guide/src/docbkx/images/environments/rename-env.png similarity index 100% rename from src/user-guide/src/docbkx/images/Environments/rename-env.png rename to src/user-guide/src/docbkx/images/environments/rename-env.png diff --git a/src/user-guide/src/docbkx/images/environments/show-env.png b/src/user-guide/src/docbkx/images/environments/show-env.png new file mode 100644 index 0000000..9bdc505 Binary files /dev/null and b/src/user-guide/src/docbkx/images/environments/show-env.png differ diff --git a/src/user-guide/src/docbkx/images/images/index.png b/src/user-guide/src/docbkx/images/images/index.png new file mode 100644 index 0000000..ae55841 Binary files /dev/null and b/src/user-guide/src/docbkx/images/images/index.png differ diff --git a/src/user-guide/src/docbkx/images/images/mark_image.png b/src/user-guide/src/docbkx/images/images/mark_image.png new file mode 100644 index 0000000..30a6c14 Binary files /dev/null and b/src/user-guide/src/docbkx/images/images/mark_image.png differ diff --git a/src/user-guide/src/docbkx/images/manage/index.png b/src/user-guide/src/docbkx/images/manage/index.png new file mode 100644 index 0000000..865887d Binary files /dev/null and b/src/user-guide/src/docbkx/images/manage/index.png differ diff --git a/src/user-guide/src/docbkx/images/manage/modify.png b/src/user-guide/src/docbkx/images/manage/modify.png new file mode 100644 index 0000000..2a85435 Binary files /dev/null and b/src/user-guide/src/docbkx/images/manage/modify.png differ diff --git a/src/user-guide/src/docbkx/images/manage/upload.png b/src/user-guide/src/docbkx/images/manage/upload.png new file mode 100644 index 0000000..739bbf6 Binary files /dev/null and b/src/user-guide/src/docbkx/images/manage/upload.png differ diff --git a/src/user-guide/src/docbkx/user-guide.xml b/src/user-guide/src/docbkx/user-guide.xml index fc92095..b50bc6c 100644 --- a/src/user-guide/src/docbkx/user-guide.xml +++ b/src/user-guide/src/docbkx/user-guide.xml @@ -35,7 +35,7 @@ - - - + + +