anvil/docs/source/topics/gettingstarted.rst
Joshua Harlow 79af4e312b Add in the build step to the docs.
Change-Id: I421566a09e12e241092e93c29cb696746ce67d5b
2013-06-28 11:15:51 -07:00

8.1 KiB
Raw Blame History

Getting Started

Simple setup!

Made to be as simple as possible, but not too simple.

Prerequisites

RTFM

Read the great documentation for developers/admins at

This will vastly help you understand what the configurations and options do when ANVIL configures them.

Linux

One of the tested distributions.

  • RHEL 6.2+
  • CentOS 6.2+
  • Oracle Enteprise Linux 6.2+

You can get CentOS 6.2+ (64-bit is preferred) from https://www.centos.org/

Networking

Important!

Since networking can affect how your cloud runs please check out this link:

http://docs.openstack.org/trunk/openstack-compute/admin/content/configuring-networking-on-the-compute-node.html

Check out the root article and the sub-chapters there to understand more of what these settings mean.

This is typically one of the hardest aspects of OpenStack to configure and get right!


The following settings in conf/components/nova.yaml are an example of settings that will affect the configuration of your compute nodes network.

flat_network_bridge: br100
flat_interface: eth0
public_interface: eth0
fixed_range: 10.0.0.0/24
fixed_network_size: 256
floating_range: 172.24.4.224/28
test_floating_pool: test
test_floating_range: 192.168.253.0/29

Installation

Pre-setup

Since RHEL requires a tty to perform sudo commands we need to disable this so sudo can run without a tty. This seems needed since nova and other components attempt to do sudo commands. This isnt possible in RHEL unless you disable this (since those instances wont have a tty).

$ sudo visudo 

Then comment out line:

Default requiretty

Also disable selinux:

$ sudo vi /etc/sysconfig/selinux

Change SELINUX=enforcing to SELINUX=disabled then reboot.

$ sudo reboot

Also to avoid qemu errors please follow the solution @ https://bugs.launchpad.net/anvil/+bug/985786 which will ensure that the qemu user can write to your instances directory. If needed edit conf/components/nova.yaml and also adjust the instances_path option.

This can be typically solved by running the following (and then updating the instances_path option)

$ sudo mkdir -pv /home/openstack
$ sudo chmod -R a+rwx /home/openstack

Also as documented at http://docs.openstack.org/essex/openstack-compute/admin/content/qemu.html#fixes-rhel-qemu please run the following (after installation).

$ setsebool -P virt_use_execmem on
$ sudo ln -s /usr/libexec/qemu-kvm /usr/bin/qemu-system-x86_64
$ sudo service libvirtd restart

Get git!

$ sudo yum install git -y

Download

Well grab the latest version of ANVIL via git:

$ git clone git://github.com/stackforge/anvil.git

Configuration

Any configuration to be updated should now be done.

Please edit the corresponding files in conf/components/ or conf/components/personas to fit your desired configuration of nova/glance and the other OpenStack components.

If you are using a FlatManager and RH/Fedora then you might want to read and follow:

http://www.techotopia.com/index.php/Creating_an_RHEL_5_KVM_Networked_Bridge_Interface

Pre-installing

In order to ensure that anvil will have its correct dependencies you need to first run the bootstrapping code that will setup said dependencies for your operating system.

sudo ./smithy --bootstrap

Preparing

Now prepare OpenStacks components by running the following:

./smithy -a prepare

You should see a corresponding OpenStack repositories getting downloaded using git, python setups occurring and configuration files being written as well as source rpm packages being built and a repository setup from those components (if you desire more informational output add a -v to that command).

Building

Now build OpenStacks components by running the following:

sudo ./smithy -a build

You should see a corresponding OpenStack components and dependencies at this stage being packaged into rpm files and two repositories being setup for you. One will be the dependencies that the OpenStack components need to run and the other will be the OpenStack components themselves.

Installing

Now install OpenStacks components by running the following:

sudo ./smithy -a install

You should see a set of distribution packages and/or pips being installed and configuration files being written as ANVIL figures out how to install your desired components from the prepared packages built in the last step (if you desire more informational output add a -v to that command).

Testing

Now (if you choose) you can run each OpenStack components unit tests by running the following:

sudo ./smithy -a test

You should see a set of unit tests being ran (ideally with zero failures).

Starting

Now that you have installed OpenStack you can now start your OpenStack components by running the following.

sudo ./smithy -a start

Check horizon (if applicable)

Once that occurs you should be able to go to your hosts ip with a web browser and view horizon which can be logged in with the user admin and the password you entered when prompted for.

If you see a login page and can access horizon then:

Congratulations. You did it!

Command line tools

In your ANVIL directory:

source /etc/anvil/install.rc

This should set up the environment variables you need to run OpenStack CLI tools:

nova <command> [options] [args]
nova-manage <command> [options] [args]
keystone <command> [options] [args]
glance <command> [options] [args]
....

If you desire to use eucalyptus tools (ie euca2ools) which use the EC2 apis run the following to get your EC2 certs:

./tools/euca.sh $OS_USERNAME $OS_TENANT_NAME

It broke?

First run the following to check the status of each component.

sudo ./smithy -a status

If you do not see all green status then you should run the following and see if any of the stderr and stdout files will give you more information about what is occuring

sudo ./smithy -a status --show

This will dump out those files (truncated to not be to verbose) so that anything peculaliar can be seen. If nothing can be then go to the installation directory (typically ~/openstack) and check the traces directory of each component and check if anything looks fishy.

Stopping

Once you have started OpenStack services you can stop them by running the following:

sudo ./smithy -a stop

You should see a set of stop actions happening and stderr and stdout and pid files being removed (if you desire more informational output add a -v or a -vv to that command). This ensures the above a daemon that was started is now killed. A good way to check if it killed everything correctly is to run the following.

sudo ps -elf | grep python
sudo ps -elf | grep apache

There should be no entries like nova, glance, apache, httpd. If there are then the stop may have not occurred correctly. If this is the case run again with a -v or a -vv or check the stderr, stdout, pid files for any useful information on what is happening.

Uninstalling

Once you have stopped (if you have started it) OpenStack services you can uninstall them by running the following:

sudo ./smithy -a uninstall

You should see a set of packages, configuration and directories, being removed (if you desire more informational output add a -v or a -vv to that command). On completion the directory specified at ~/openstack be empty.

Issues

Please report issues/bugs to https://launchpad.net/anvil. Much appreciated!