diff --git a/src/administrators-guide/src/docbkx/content/installation-guide.xml b/src/administrators-guide/src/docbkx/content/installation-guide.xml index 8a7b41c..ce7b4e0 100644 --- a/src/administrators-guide/src/docbkx/content/installation-guide.xml +++ b/src/administrators-guide/src/docbkx/content/installation-guide.xml @@ -57,21 +57,34 @@ Press Enter to edit /etc/murano-deployment/lab-binding.rc, then 'i' to enter INSERT mode. After editing press ESC and type :wq to write and exit from VI. -LAB_HOST='lab_IP_or_hostname' -ADMIN_USER='admin' -ADMIN_PASSWORD='admin_pass' -RABBITMQ_LOGIN='muranouser' -RABBITMQ_PASSWORD='murano' -RABBITMQ_VHOST='muranovhost' +LAB_HOST='' + +ADMIN_USER='' +ADMIN_PASSWORD='' + +RABBITMQ_LOGIN='' +RABBITMQ_PASSWORD='' +RABBITMQ_VHOST='' RABBITMQ_PORT='' #RABBITMQ_HOST='' -#RABBITMQ_HOST_ALT +#RABBITMQ_HOST_ALT='' + +#FILE_SHARE_HOST='' + BRANCH_NAME='master' + +# Only 'true' or 'false' values are allowed! SSL_ENABLED='false' SSL_CA_FILE='' SSL_CERT_FILE='' SSL_KEY_FILE='' - + +#BRANCH_MURANO_API='' +#BRANCH_MURANO_DASHBOARD='' +#BRANCH_MURANO_CLIENT='' +#BRANCH_MURANO_CONDUCTOR='' +#BRANCH_MURANO_REPOSITORY='' + LAB_HOST - IP or hostname of the lab. @@ -99,11 +112,12 @@ SSL_KEY_FILE='' RABBITMQ_HOST - (optional) IP address or hostname of - the host where RabbitMQ is installed IF it is not the same host as LAB_HOST points to. + the host where RabbitMQ is installed IF it is not the same host as LAB_HOST points to. + This parameter can be skipped and in this case LAB_HOST will be used. RABBITMQ_HOST_ALT - (optional) IP address or hostname of - the RabbitMQ host to connect from inside the Windows instance. In some cases the + the RabbitMQ host to connect from inside the instance. In some cases the addresses like LAB_HOST or RABBITMQ_HOST are inaccessible from instances, and they must use different address. @@ -113,8 +127,8 @@ SSL_KEY_FILE='' LAB_HOST points to. - BRANCH_NAME - branch name from which all Murano - components will be fetched for installation. + BRANCH_MURANO_* - (optional) code from specified branch name for a selected Murano + component will be installed. By default code from 'master' branch will be fetched. SSL_ENABLED - Set 'true' if @@ -124,6 +138,12 @@ SSL_KEY_FILE='' SSL_CA_FILE - Path to CA certificate for certificate validation on client side. Leave it empty when used self-signed certificates. + + SSL_CERT_FILE - Path to the valid SSL certificate. + + + SSL_KEY_FILE - Path to the valid key file. + @@ -150,10 +170,13 @@ SSL_KEY_FILE='' - Automatic installation Murano can be installed in automatic way. Script will install all - necessary packages to your system. Find out more about this in - - Getting Started Guide + Automatic installation + + Murano can be installed in automatic way. Script will install all + necessary packages to your system. Find out more about this in + + Getting Started Guide +
@@ -221,7 +244,7 @@ SSL_KEY_FILE=''
Murano API Service Murano API provides access to the Murano orchestration engine via API. - This chapter describes the procedure of installation and condiguration of Murano API. + This chapter describes the procedure of installation and configuration of Murano API.
Install @@ -244,9 +267,9 @@ sudo su - git clone https://github.com/stackforge/murano-api ]]> - Stable version one of our releases can be checked by the tag: + Stable version one of our releases can be checked by the tag: -cd murano-api && git checkout 0.2 +cd murano-api && git checkout 0.4 @@ -274,9 +297,9 @@ sh setup-centos.sh install Making sample configuration files at "/etc/murano-api" +LOG:> Making sample configuration files at "/etc/murano" LOG:> Reloading initctl -LOG:> Please, make proper configuration,located at "/etc/murano-api", before starting the "murano-api" daemon! +LOG:> Please, make proper configuration,located at "/etc/murano", before starting the "murano-api" daemon! ]]> @@ -289,7 +312,7 @@ LOG:> Please, make proper configuration,located at "/etc/murano-api", before sta Copy and edit configuration files: @@ -301,11 +324,14 @@ cp murano-api-paste.ini.sample murano-api-paste.ini [DEFAULT] section sets up logging. + + + [database]sets database connection. + - - [reports] - section allows you to set up names for new rabbitMQ queues. + [reports] section defines names of RabbitMQ queues. + This naming should correspond to a similar parameter in conductor config file. @@ -323,6 +349,11 @@ rabbitmqctl set_permissions -p muranovhost muranouser ".*" ".*" ".*" ]]> + + [ssl] sets up SSL parameters - paths to required files in case of ssl connection. + For more information how to configure SSL take a look at SSL configuration chapter + + In [keystone_authtoken] configure parameters of Openstack Keystone service. For more information see @@ -334,17 +365,16 @@ rabbitmqctl set_permissions -p muranovhost muranouser ".*" ".*" ".*" Another murano-api configuration file located at - /etc/murano-api/murano-api-paste.ini and does + /etc/murano/murano-api-paste.ini and does not require any changes. - For more information how to configure SSL take a look at SSL configuration chapter - Register murano-api service in Openstack. To do that perform the folowwing commands: + Register murano-api service in Openstack. To do that perform the following commands: You need to be authorized in Openstack to run this commands - OpenStack Heat require Key Pair for Load Balancer instances. Murano Conductor uses - LoadBalancer for IIS Farms and ASP.NET Farms. The default name for Key Pair is "murano-lb-key", - you can change this parameter in file - + OpenStack Heat requires Key Pair for Load Balancer instances. + Murano Conductor uses LoadBalancer for IIS Farms and ASP.NET Farms. @@ -436,12 +462,9 @@ sudo su - git clone https://github.com/stackforge/murano-conductor ]]> - Stable version one of our - releases - can be checked out by tag: - + Stable version one of our releases can be checked out by tag: -cd murano-conductor && git checkout 0.2 +cd murano-conductor && git checkout 0.4 @@ -472,81 +495,135 @@ sh setup-centos.sh install Copy example of the configuration file: Configure conductor.conf file according to your environment. - + + + [DEFAULT] section is responsible for logging. + + - [DEFAULT]section is responsible for logging. + [keystone] defines where kestone is located. [heat]points where heat is running. + + [neutron] sets up parameters for interconnection with neutron. + + [rabbitmq]section points where your rabbitMQ installed and configured. - - + + - + @@ -576,6 +653,164 @@ initctl start murano-conductor
+
+ Murano Repository Service + Murano Repository provides access to metadata for Murano Conductor and Murano dashboard. + It also allows to managemetadata objects via API. + This chapter describes the procedure of installation and configuration of Murano Repository. +
+ Install + + + Superuser privileges is required to install and configure system packages. Let's switch to root account: + + + + + + Make sure that additional linux repositories are installed. See the appendix for information about preparing a virtual machine for murano installation. + + + + Clone Murano Repository from git: + + + + Stable version one of our releases can be checked by the tag: + +cd murano-repository && git checkout 0.4 + + + + And perform installation: + + Ubuntu + + + + + + CentOS + + + + + + + Successful installation ends with message like this: + + Making sample configuration files at "/etc/murano" +LOG:> Reloading initctl +LOG:> Please, make proper configuration,located at "/etc/murano", before starting the "murano-repository" daemon! + ]]> + + + +
+
+ Configure + + + Copy and edit configuration files: + + + + + + Configure murano-repository.conf according to your environment: + + + [DEFAULT] section sets up main server parameters: port and address. + Folder to store cache and logging parameters also defined in this section. + + + manifests parameter points out to directory with metadata objects: manifests should be on the first level. + All other objects are kept in a separates folders. This folders are configured in the parameters described below: + + ui sets up directory name for keeping Murano dashboard ui definitions + workflows sets up directory name for keeping Murano Conductor workflows + heat sets up directory name for keeping Heat templates + agentsets up directory name for keeping Murano Agent templates + scripts sets up directory name for keeping Murano Execution Plans + + + + + [output] defines result archive structure. + This parameters applies to archive structure that clients (Murano Conductor) request from Metadata Repository. + + + + In [keystone] + configure parameters of Openstack Keystone service. For more information see + + Auth-Token Middleware with Username and Password + + + + + + + + + Register murano-repository service in Openstack. To do that perform the following commands: + You need to be authorized in Openstack to run this commands + + + + + +
+
+ Run + + + Run Murano Repository service: + + Ubuntu + + + + + + CentOS + + + + + + +
+
Murano Dashboard Murano Dashboard provides Web UI for Murano Project. @@ -633,12 +868,10 @@ git clone https://github.com/stackforge/murano-dashboard - Stable version one of our - releases - can be checked out by tag: + Stable version one of our releases can be checked out by tag: -cd murano-dashboard && git checkout 0.2 +cd murano-dashboard && git checkout 0.4 @@ -721,7 +954,7 @@ sh setup-centos.sh install HTTPS for Murano API SSL for Murano API service can be configured in ssl section in - /etc/murano-api/murano-api.conf. Just point to a valid SSL certificate. + /etc/murano/murano-api.conf. Just point to a valid SSL certificate. See the example below: @@ -775,7 +1008,7 @@ ca_file = PATH Murano API -> Rabbit MQ exchange - Edit rabbitmq section in /etc/murano-api/murano-api.conf + Edit rabbitmq section in /etc/murano/murano-api.conf and set ssl option to True to enable SSL. Specify the path to the SSL CA certificate in regular format: /path/to/file without quotes or leave it empty to allow self-signed certificates. @@ -793,7 +1026,7 @@ ca_certs = Rabbit MQ -> Murano Conductor exchange - Open /etc/murano-conductor/conductor.conf + Open /etc/murano/conductor.conf and configure rabbitmq section in the same way: enable ssl option to True and set CA certificate path or leave it empty to allow self-signed certificates. @@ -815,7 +1048,7 @@ ca_certs = /home/user/certificates/example.crt By default all Murano Conductor configuration settings apply to Murano Agent. If you want to configure Murano Agent in a different way change the default template. It can be found - here:/etc/murano-conductor/data/templates/agent-config/Default.template. + here:/etc/murano/data/templates/agent-config/Default.template. Take a look at appSettings section: