From c110a8454bb5c6c8f348c5c311fcd30cfd319f4d Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Fri, 25 Oct 2013 14:05:52 +0200 Subject: [PATCH] Install Guide: Edits on heat installation General edits Change-Id: I7a514ed2575aed0be06262a8429220175ee64eb1 backport: havana --- doc/install-guide/section_heat-install.xml | 126 +++++++++++---------- 1 file changed, 64 insertions(+), 62 deletions(-) diff --git a/doc/install-guide/section_heat-install.xml b/doc/install-guide/section_heat-install.xml index fbed04db7c..c1d1ddb744 100644 --- a/doc/install-guide/section_heat-install.xml +++ b/doc/install-guide/section_heat-install.xml @@ -1,37 +1,36 @@ -
- Installing the Orchestration Service + Install the Orchestration Service - Install the Orchestration Service on the controller node: + Install the Orchestration Service on the controller + node: # apt-get install heat-api heat-api-cfn heat-engine # yum install openstack-heat-api openstack-heat-engine FIXME # zypper install openstack-heat-api openstack-heat-api-cfn openstack-heat-engine - - The Orchestration Service uses a database to store information. - Specify the location of the database in the configuration file. - In this guide, we use a MySQL database on the controller node - with the username heat. Replace - HEAT_DBPASS - with a suitable password for the database user. + In the configuration file, specify the location of the + database where the Orchestration Service stores data. The + examples in this guide use a MySQL database on the controller + node with the heat user name. Replace + HEAT_DBPASS + with the password for the database user: # openstack-config --set /etc/heat/heat.conf \ database connection mysql://heat:HEAT_DBPASS@controller/heat - Edit /etc/heat/heat.conf and change the [DEFAULT] section. - [database] + Edit the + /etc/heat/heat.conf file and change the + [DEFAULT] section: + [database] # The SQLAlchemy connection string used to connect to the database connection = mysql://heat:HEAT_DBPASS@controller/heat -... - +... - - First, we need to create a database user called heat, by logging in - as root using the password we set earlier. + Create a heat database user. Log in as + root by using the password that you set previously: # mysql -u root -p mysql> CREATE DATABASE heat; mysql> GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'localhost' \ @@ -40,16 +39,18 @@ IDENTIFIED BY 'HEAT_DBPASS'; IDENTIFIED BY 'HEAT_DBPASS'; - We now create the heat service tables: + Create the heat service tables: # heat-manage db_sync - - If you see DeprecationWarning errors, it is safe to ignore these. + + You can ignore any + DeprecationWarning errors. + - The Ubuntu packages do not correctly set up logging. - Edit /etc/heat/heat.conf and change the [DEFAULT] section. - -[DEFAULT] + The Ubuntu packages do not correctly set up logging. Edit + the /etc/heat/heat.conf file and change + the [DEFAULT] section: + [DEFAULT] ... # Print more verbose output (set logging level to INFO instead # of default WARNING level). (boolean value) @@ -57,24 +58,24 @@ verbose = True ... # (Optional) The base directory used for relative --log-file # paths (string value) -log_dir=/var/log/heat - +log_dir=/var/log/heat - - Create an Identity Service user called heat - that the Orchestration - Service can use to authenticate with the Identity Service. Use the - service tenant and give the user the - admin role. + + Create an Identity Service user named + heat that the Orchestration Service can + use to authenticate with the Identity Service. Use the + service tenant and give the user the + admin role: # keystone user-create --name=heat --pass=HEAT_PASS --email=heat@example.com # keystone user-role-add --user=heat --tenant=service --role=admin - - Add the credentials to the Image Service's configuration files. - Edit /etc/heat/api-paste.ini - and change the [filter:authtoken] section. - -... + + Add the credentials to the Image Service configuration + files. + Edit the /etc/heat/api-paste.ini file + and change the [filter:authtoken] + section: + ... [filter:authtoken] paste.filter_factory = heat.common.auth_token:filter_factory auth_host = controller @@ -83,46 +84,48 @@ auth_protocol = http admin_tenant_name = service admin_user = heat admin_password = HEAT_PASS -... - - +... - - Register the Orchestration Service (both Heat and CloudFormation APIs) - with the Identity Service so that other OpenStack services can locate - it. Register the service and specify the endpoint using the - keystone command. + + Register the Orchestration Service (both Heat and + CloudFormation APIs) with the Identity Service so that other + OpenStack services can locate it. Use the + keystone command to register the service + and specify the endpoint: # keystone service-create --name=heat --type=orchestration \ - --description="Heat Orchestration API" - Note the service's id property returned in the previous step and use it when - creating the endpoint. + --description="Heat Orchestration API" + + + Note the id property for the service + and use it to create the endpoint. # keystone endpoint-create \ --service-id=the_service_id_above \ --publicurl=http://controller:8004/v1/%\(tenant_id\)s \ --internalurl=http://controller:8004/v1/%\(tenant_id\)s \ --adminurl=http://controller:8004/v1/%\(tenant_id\)s # keystone service-create --name=heat-cfn --type=cloudformation \ - --description="Heat CloudFormation API" - Note the service's id property returned in the previous step and use it when - creating the endpoint. + --description="Heat CloudFormation API" + + + Note the id property for the service + and use it to create the endpoint. # keystone endpoint-create \ --service-id=the_service_id_above \ --publicurl=http://controller:8000/v1 \ --internalurl=http://controller:8000/v1 \ --adminurl=http://controller:8000/v1 - - We now restart the service with its new settings. -# service heat-api restart + Restart the service with its new settings: + # service heat-api restart # service heat-api-cfn restart # service heat-engine restart - - - Start the heat-api, heat-api-cfn and - heat-engine services and configure them to - start when the system boots. + + Start the heat-api, heat-api-cfn and heat-engine services. Also, + configure them to start when the system boots. # service openstack-heat-api start # service openstack-heat-api-cfn start # service openstack-heat-engine start @@ -130,6 +133,5 @@ admin_password = HEAT_PASS # chkconfig openstack-heat-api-cfn on # chkconfig openstack-heat-engine on -