Difference between revisions of "Heat/GettingStartedUsingMasterOnUbuntu"
(25 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | '''NOTE (7/24/2014): this document is no longer maintained, Ubuntu users should refer to the documentation here:''' | |
+ | http://docs.openstack.org/developer/heat/getting_started/on_ubuntu.html | ||
+ | <hr> | ||
− | + | This guide will help to get the current git master of Heat to run on Ubuntu. It makes the following assumptions: | |
− | + | * The host is running Ubuntu 12.04 or 12.10 | |
+ | * There is a working [[OpenStack]] installation based on Essex or Folsom, or that one will be installed via the tools/openstack_ubuntu script described below | ||
+ | * Heat will be installed on the controller host of the existing [[OpenStack]] installation (or if doing a single-host evaluation, on the same host as all other [[OpenStack]] services) | ||
− | + | === Get Heat === | |
− | + | Clone the heat repository from GitHub: | |
− | = | + | <source lang="bash"> |
+ | git clone git://github.com/openstack/heat.git | ||
+ | </source> | ||
+ | === Install [[OpenStack]] === | ||
− | + | Note, this section may be skipped if you already have a working [[OpenStack]] installation | |
− | |||
− | |||
− | |||
+ | ==== Installing [[OpenStack]] on Ubuntu 12.04/12.10 ==== | ||
− | + | A script called openstack_ubuntu in the tools directory of the Heat repository will install and start [[OpenStack]] for you on Ubuntu: | |
+ | ''Note currently only tested on 12.04, if it works for you on 12.10, please let us know'' | ||
+ | <source lang="bash"> | ||
+ | cd heat | ||
+ | ./tools/openstack_ubuntu install -r ${MYSQL_ROOT_PASSWORD} | ||
+ | </source> | ||
+ | |||
+ | If you use this method, you will need to manually create a guest network. How this is done depends on your environment. An example network create operation: | ||
+ | |||
+ | <source lang="bash"> | ||
+ | sudo nova-manage network create --label=demonet --fixed_range_v4=${SUBNET} --bridge=demonetbr0 --bridge_interface=eth0" | ||
+ | </source> | ||
+ | |||
+ | Where ''${SUBNET}'' is of the form ''10.0.0.0/24''. The network range here, must *not* be one used on your existing physical network. It should be a range dedicated for the network that [[OpenStack]] will configure. So if ''10.0.0.0/24'' clashes with your local network, pick another subnet. | ||
− | + | The example above assumes you want to bridge with physical device ''eth0'' | |
− | |||
− | |||
+ | Currently, the bridge is not created immediately upon running this command, but is actually added when Nova first requires it. | ||
− | + | === Load keystone authentication into your environment and verify everything is ok. === | |
+ | <source lang="bash"> | ||
+ | . ~/.openstack/keystonerc | ||
+ | keystone user-list | ||
+ | glance index | ||
+ | nova list | ||
+ | </source> | ||
− | + | Note ''~/.openstack/keystonerc'' is created by tools/openstack_ubuntu, replace this step with your own credentials file for an admin user if [[OpenStack]] was installed by some other method | |
− | |||
− | |||
− | + | == Install prerequisites == | |
− | < | + | <source lang="bash"> |
− | sudo apt-get | + | sudo apt-get install python-pip gcc python2.7-dev |
− | |||
sudo apt-get install git | sudo apt-get install git | ||
sudo apt-get install build-essential devscripts debhelper python-all gdebi-core | sudo apt-get install build-essential devscripts debhelper python-all gdebi-core | ||
− | sudo apt-get install python-setuptools python-prettytable | + | sudo apt-get install python-setuptools python-prettytable python-lxml |
sudo apt-get install libguestfs* | sudo apt-get install libguestfs* | ||
− | + | </source> | |
− | |||
− | </ | ||
+ | == Install python-heatclient (optional) == | ||
+ | * NOTE* If running 12.04 LTS with the packaged Openstack Essex release, do not install python-heatclient, as it will break your [[OpenStack]] installation, because it explicitly requires a version of the prettytable library (>0.6) which causes problems with the Essex cli tools (keystone/nova/glance) in 12.04 : https://bugs.launchpad.net/keystone/+bug/995976 The packaged python-prettytable (0.5 version) works OK | ||
− | + | <source lang="bash"> | |
− | + | sudo pip install extras python-heatclient | |
− | + | </source> | |
− | |||
− | |||
− | |||
− | < | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | source | ||
− | |||
− | |||
+ | == Install Heat from master == | ||
− | = | + | <source lang="bash"> |
− | + | git clone git://github.com/openstack/heat.git | |
− | git clone git://github.com/ | ||
cd heat | cd heat | ||
sudo ./install.sh | sudo ./install.sh | ||
− | </ | + | </source> |
− | |||
− | === Modify | + | === Modify configuration for admin password === |
+ | Later a keystone user called '''heat''' will be created. At this point a password for that user needs to be chosen. | ||
+ | The following files will need editing: | ||
− | + | * /etc/heat/heat-api-cfn-paste.ini | |
− | + | * /etc/heat/heat-api-cloudwatch-paste.ini | |
− | + | * /etc/heat/heat-api-paste.ini | |
− | |||
− | + | <source lang="ini"> | |
− | |||
− | |||
− | = | ||
− | |||
− | |||
[filter:authtoken] | [filter:authtoken] | ||
− | admin_password=<admin password> | + | admin_password=<heat admin password> |
− | </ | + | </source> |
− | |||
− | |||
=== Create the MySQL Heat database: === | === Create the MySQL Heat database: === | ||
− | < | + | <source lang="bash"> |
sudo heat-db-setup deb -r <mysql password> | sudo heat-db-setup deb -r <mysql password> | ||
− | </ | + | </source> |
− | |||
=== Create the keystone authentication parameters === | === Create the keystone authentication parameters === | ||
− | < | + | <source lang="bash"> |
− | sudo -E ./ | + | sudo -E ./bin/heat-keystone-setup |
− | </ | + | </source> |
+ | == Install Oz from the upstream master location == | ||
− | = | + | <source lang="bash"> |
− | + | git clone https://github.com/clalancette/oz.git | |
− | |||
− | git clone https://github.com/clalancette/oz.git | ||
cd oz | cd oz | ||
make deb | make deb | ||
cd .. | cd .. | ||
− | sudo | + | sudo dpkg -i oz_*_all.deb |
− | </ | + | sudo apt-get -f install |
+ | </source> | ||
Note: Select yes to "Create or update supermin appliance.". This will rebuild the guestfs appliance to work with latest updates of Ubuntu. Oz will not work properly without updating the guestfs appliance. | Note: Select yes to "Create or update supermin appliance.". This will rebuild the guestfs appliance to work with latest updates of Ubuntu. Oz will not work properly without updating the guestfs appliance. | ||
Line 194: | Line 124: | ||
The heat-jeos tool builds virtual machine images for use with Heat. | The heat-jeos tool builds virtual machine images for use with Heat. | ||
− | + | <source lang="bash"> | |
− | + | git clone git://github.com/sdake/heat-jeos.git | |
− | git clone git://github.com/ | ||
cd heat-jeos | cd heat-jeos | ||
sudo python setup.py install | sudo python setup.py install | ||
− | </ | + | </source> |
− | |||
== Download ISO images for various distributions == | == Download ISO images for various distributions == | ||
Line 210: | Line 138: | ||
After download completes, copy the iso image to the location heat-jeos expects: | After download completes, copy the iso image to the location heat-jeos expects: | ||
− | < | + | <source lang="bash"> |
sudo cp Downloads/ubuntu-10.04.4-server-amd64.iso /var/lib/libvirt/images | sudo cp Downloads/ubuntu-10.04.4-server-amd64.iso /var/lib/libvirt/images | ||
− | </ | + | </source> |
− | |||
== Configure your host to work with Heat == | == Configure your host to work with Heat == | ||
Line 219: | Line 146: | ||
=== Create SSH key and add it to the Nova sshkey list === | === Create SSH key and add it to the Nova sshkey list === | ||
− | < | + | <source lang="bash"> |
ssh-keygen -t rsa | ssh-keygen -t rsa | ||
nova keypair-add --pub_key ~/.ssh/id_rsa.pub ${USER}_key | nova keypair-add --pub_key ~/.ssh/id_rsa.pub ${USER}_key | ||
− | </ | + | </source> |
− | |||
Note: If running in a VM, modify /etc/libvirt/qemu/networks/default.xml: | Note: If running in a VM, modify /etc/libvirt/qemu/networks/default.xml: | ||
change network to not conflict with host (default 192.168.122.x) | change network to not conflict with host (default 192.168.122.x) | ||
− | < | + | <source lang="bash"> |
sudo service libvirt-bin restart | sudo service libvirt-bin restart | ||
− | </ | + | </source> |
− | |||
=== If dnsmasq is not running on the default network === | === If dnsmasq is not running on the default network === | ||
− | < | + | <source lang="bash"> |
sudo virsh net-destroy default | sudo virsh net-destroy default | ||
sudo virsh net-start default | sudo virsh net-start default | ||
− | </ | + | </source> |
− | |||
=== Configure libguestfs (required by Oz) to work in latest Ubuntu 12 === | === Configure libguestfs (required by Oz) to work in latest Ubuntu 12 === | ||
Some files shipped with Ubuntu 12 are incompatible with libguestfs used by the image creation software Oz. To allow heat-jeos to work properly, run the following commands: | Some files shipped with Ubuntu 12 are incompatible with libguestfs used by the image creation software Oz. To allow heat-jeos to work properly, run the following commands: | ||
− | < | + | <source lang="bash"> |
sudo chmod 644 /boot/vmlinuz* | sudo chmod 644 /boot/vmlinuz* | ||
sudo update-guestfs-appliance | sudo update-guestfs-appliance | ||
− | </ | + | </source> |
Note: For more details see: http://permalink.gmane.org/gmane.comp.emulators.guestfs/1382 | Note: For more details see: http://permalink.gmane.org/gmane.comp.emulators.guestfs/1382 | ||
Line 258: | Line 182: | ||
== Create the Heat JEOS image == | == Create the Heat JEOS image == | ||
− | < | + | <source lang="bash"> |
sudo -E heat-jeos -y create U10-x86_64-cfntools --register-with-glance | sudo -E heat-jeos -y create U10-x86_64-cfntools --register-with-glance | ||
− | </ | + | </source> |
Note: The -E option to sudo preserves the environment, specifically the keystone credentials, when heat-jeos is run as root. | Note: The -E option to sudo preserves the environment, specifically the keystone credentials, when heat-jeos is run as root. | ||
Line 269: | Line 193: | ||
=== Execute the heat api services === | === Execute the heat api services === | ||
− | < | + | <source lang="bash"> |
sudo heat-engine & | sudo heat-engine & | ||
+ | sudo heat-api & | ||
sudo heat-api-cfn & | sudo heat-api-cfn & | ||
− | sudo heat- | + | sudo heat-api-cloudwatch & |
− | </ | + | </source> |
− | |||
=== Run the debian wordpress example === | === Run the debian wordpress example === | ||
− | < | + | <source lang="bash"> |
− | heat - | + | heat stack-create wordpress --template-file=templates/WordPress_Single_Instance_deb.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpassword;KeyName=${USER}_key;LinuxDistribution=U10" |
− | </ | + | </source> |
− | |||
=== List stacks === | === List stacks === | ||
− | + | <source lang="bash"> | |
− | + | heat stack-list | |
− | heat list | + | </source> |
− | </ | ||
− | |||
=== List stack events === | === List stack events === | ||
− | + | <source lang="bash"> | |
− | < | ||
heat event-list wordpress | heat event-list wordpress | ||
− | </ | + | </source> |
− | |||
=== Describe the wordpress stack === | === Describe the wordpress stack === | ||
+ | <source lang="bash"> | ||
+ | heat stack-show wordpress | ||
+ | </source> | ||
− | + | Note: After a few seconds, the Status should change from IN_PROGRESS to CREATE_COMPLETE. | |
− | |||
− | |||
− | |||
− | Note: After a few seconds, the | ||
=== Verify instance creation === | === Verify instance creation === | ||
Line 312: | Line 230: | ||
Because the software takes some time to install from the repository, it may be a few minutes before the Wordpress intance is in a running state. | Because the software takes some time to install from the repository, it may be a few minutes before the Wordpress intance is in a running state. | ||
− | Point a web browser at the location given by the WebsiteURL Output as shown by heat | + | Point a web browser at the location given by the WebsiteURL Output as shown by heat show-stack wordpress:: |
− | + | <source lang="bash"> | |
− | < | ||
wget ${WebsiteURL} | wget ${WebsiteURL} | ||
− | </ | + | </source> |
− | |||
=== Delete the instance when done === | === Delete the instance when done === | ||
− | < | + | <source lang="bash"> |
− | heat delete wordpress | + | heat stack-delete wordpress |
− | heat list | + | heat stack-list |
− | </ | + | </source> |
− | |||
Note: This operation will show no running stack. | Note: This operation will show no running stack. | ||
Line 332: | Line 247: | ||
== Troubleshooting == | == Troubleshooting == | ||
− | If you encounter issues running heat, see if the solution to the issue is documented on the [http://wiki.openstack.org/Heat/ | + | If you encounter issues running heat, see if the solution to the issue is documented on the [http://wiki.openstack.org/Heat/TroubleShooting Troubleshooting wiki page]. If not, let us know about the problem in the #heat IRC channel on freenode. |
Latest revision as of 19:04, 24 July 2014
NOTE (7/24/2014): this document is no longer maintained, Ubuntu users should refer to the documentation here:
http://docs.openstack.org/developer/heat/getting_started/on_ubuntu.html
This guide will help to get the current git master of Heat to run on Ubuntu. It makes the following assumptions:
- The host is running Ubuntu 12.04 or 12.10
- There is a working OpenStack installation based on Essex or Folsom, or that one will be installed via the tools/openstack_ubuntu script described below
- Heat will be installed on the controller host of the existing OpenStack installation (or if doing a single-host evaluation, on the same host as all other OpenStack services)
Contents
- 1 Get Heat
- 2 Install OpenStack
- 3 Load keystone authentication into your environment and verify everything is ok.
- 4 Install prerequisites
- 5 Install python-heatclient (optional)
- 6 Install Heat from master
- 7 Install Oz from the upstream master location
- 8 Install heat-jeos from master
- 9 Download ISO images for various distributions
- 10 Configure your host to work with Heat
- 11 Create the Heat JEOS image
- 12 Experiment with Heat
- 13 Troubleshooting
Get Heat
Clone the heat repository from GitHub:
git clone git://github.com/openstack/heat.git
Install OpenStack
Note, this section may be skipped if you already have a working OpenStack installation
Installing OpenStack on Ubuntu 12.04/12.10
A script called openstack_ubuntu in the tools directory of the Heat repository will install and start OpenStack for you on Ubuntu: Note currently only tested on 12.04, if it works for you on 12.10, please let us know
cd heat
./tools/openstack_ubuntu install -r ${MYSQL_ROOT_PASSWORD}
If you use this method, you will need to manually create a guest network. How this is done depends on your environment. An example network create operation:
sudo nova-manage network create --label=demonet --fixed_range_v4=${SUBNET} --bridge=demonetbr0 --bridge_interface=eth0"
Where ${SUBNET} is of the form 10.0.0.0/24. The network range here, must *not* be one used on your existing physical network. It should be a range dedicated for the network that OpenStack will configure. So if 10.0.0.0/24 clashes with your local network, pick another subnet.
The example above assumes you want to bridge with physical device eth0
Currently, the bridge is not created immediately upon running this command, but is actually added when Nova first requires it.
Load keystone authentication into your environment and verify everything is ok.
. ~/.openstack/keystonerc
keystone user-list
glance index
nova list
Note ~/.openstack/keystonerc is created by tools/openstack_ubuntu, replace this step with your own credentials file for an admin user if OpenStack was installed by some other method
Install prerequisites
sudo apt-get install python-pip gcc python2.7-dev
sudo apt-get install git
sudo apt-get install build-essential devscripts debhelper python-all gdebi-core
sudo apt-get install python-setuptools python-prettytable python-lxml
sudo apt-get install libguestfs*
Install python-heatclient (optional)
- NOTE* If running 12.04 LTS with the packaged Openstack Essex release, do not install python-heatclient, as it will break your OpenStack installation, because it explicitly requires a version of the prettytable library (>0.6) which causes problems with the Essex cli tools (keystone/nova/glance) in 12.04 : https://bugs.launchpad.net/keystone/+bug/995976 The packaged python-prettytable (0.5 version) works OK
sudo pip install extras python-heatclient
Install Heat from master
git clone git://github.com/openstack/heat.git
cd heat
sudo ./install.sh
Modify configuration for admin password
Later a keystone user called heat will be created. At this point a password for that user needs to be chosen. The following files will need editing:
- /etc/heat/heat-api-cfn-paste.ini
- /etc/heat/heat-api-cloudwatch-paste.ini
- /etc/heat/heat-api-paste.ini
[filter:authtoken]
admin_password=<heat admin password>
Create the MySQL Heat database:
sudo heat-db-setup deb -r <mysql password>
Create the keystone authentication parameters
sudo -E ./bin/heat-keystone-setup
Install Oz from the upstream master location
git clone https://github.com/clalancette/oz.git
cd oz
make deb
cd ..
sudo dpkg -i oz_*_all.deb
sudo apt-get -f install
Note: Select yes to "Create or update supermin appliance.". This will rebuild the guestfs appliance to work with latest updates of Ubuntu. Oz will not work properly without updating the guestfs appliance.
Note: We recommend cloning oz from the latest master. The debian packaging is broken in older versions and U10/U12 support is not available in Oz shipped with distros.
Install heat-jeos from master
The heat-jeos tool builds virtual machine images for use with Heat.
git clone git://github.com/sdake/heat-jeos.git
cd heat-jeos
sudo python setup.py install
Download ISO images for various distributions
If you just want to try a basic wordpress template, download [Ubuntu 10.04.4 Server](http://releases.ubuntu.com/10.04.4/ubuntu-10.04.4-server-amd64.iso)
If you want to try more templates, also download [Fedora 17](http://download.fedoraproject.org/pub/fedora/linux/releases/17/Fedora/x86_64/iso/Fedora-17-x86_64-DVD.iso)
After download completes, copy the iso image to the location heat-jeos expects:
sudo cp Downloads/ubuntu-10.04.4-server-amd64.iso /var/lib/libvirt/images
Configure your host to work with Heat
Create SSH key and add it to the Nova sshkey list
ssh-keygen -t rsa
nova keypair-add --pub_key ~/.ssh/id_rsa.pub ${USER}_key
Note: If running in a VM, modify /etc/libvirt/qemu/networks/default.xml: change network to not conflict with host (default 192.168.122.x)
sudo service libvirt-bin restart
If dnsmasq is not running on the default network
sudo virsh net-destroy default
sudo virsh net-start default
Configure libguestfs (required by Oz) to work in latest Ubuntu 12
Some files shipped with Ubuntu 12 are incompatible with libguestfs used by the image creation software Oz. To allow heat-jeos to work properly, run the following commands:
sudo chmod 644 /boot/vmlinuz*
sudo update-guestfs-appliance
Note: For more details see: http://permalink.gmane.org/gmane.comp.emulators.guestfs/1382 and http://libguestfs.org/guestfs-faq.1.html
Note: If you want to create F17 images, you may need a new libguestfs binary of version 1.18.0 or later. Ubuntu Precise may not have this version yet.
You can use the Debian Wheezy version including the [guestfs shared library](http://packages.debian.org/wheezy/amd64/libguestfs0/download), the [tools](http://packages.debian.org/wheezy/amd64/libguestfs-tools/download) and the and the [python libraries](http://packages.debian.org/wheezy/amd64/python-guestfs/download).
Create the Heat JEOS image
sudo -E heat-jeos -y create U10-x86_64-cfntools --register-with-glance
Note: The -E option to sudo preserves the environment, specifically the keystone credentials, when heat-jeos is run as root.
Note: heat-jeos must be run as root in order to create the cfntools disk image.
Experiment with Heat
Execute the heat api services
sudo heat-engine &
sudo heat-api &
sudo heat-api-cfn &
sudo heat-api-cloudwatch &
Run the debian wordpress example
heat stack-create wordpress --template-file=templates/WordPress_Single_Instance_deb.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpassword;KeyName=${USER}_key;LinuxDistribution=U10"
List stacks
heat stack-list
List stack events
heat event-list wordpress
Describe the wordpress stack
heat stack-show wordpress
Note: After a few seconds, the Status should change from IN_PROGRESS to CREATE_COMPLETE.
Verify instance creation
Because the software takes some time to install from the repository, it may be a few minutes before the Wordpress intance is in a running state.
Point a web browser at the location given by the WebsiteURL Output as shown by heat show-stack wordpress::
wget ${WebsiteURL}
Delete the instance when done
heat stack-delete wordpress
heat stack-list
Note: This operation will show no running stack.
Troubleshooting
If you encounter issues running heat, see if the solution to the issue is documented on the Troubleshooting wiki page. If not, let us know about the problem in the #heat IRC channel on freenode.