RETIRED, Ansible based project for setting up TripleO virtual environments
Go to file
John Trowbridge 797cae92c1 Mitaka EOL commit
This commit will be used to do a final release of quickstart which
supports Mitaka.

Change-Id: If044af055ef0d61ed0d9a3503150c4a5ebd5dcfe
2017-07-17 19:39:46 +00:00
ci-scripts Merge "modify basic test to not require quickstart-extras" 2017-07-02 17:22:32 +00:00
config Merge "Add featureset for Heat convergence job" 2017-07-13 03:20:34 +00:00
doc/source Add featureset for Heat convergence job 2017-07-12 16:24:29 +03:00
library Fix H102 Apache 2.0 license header not found 2016-07-29 14:08:00 -04:00
playbooks Migrate quickstart-extras.yml --> TQE 2017-06-06 22:24:24 +00:00
releasenotes Mitaka EOL commit 2017-07-17 19:39:46 +00:00
roles allow output for ara logs 2017-07-12 16:06:03 +00:00
test_plugins Fix H102 Apache 2.0 license header not found 2016-07-29 14:08:00 -04:00
.gitignore Do not track Vim swap/backup files 2017-01-16 14:00:55 +00:00
.gitreview Fix .gitreview for move to openstack git 2016-04-01 11:08:07 -04:00
LICENSE Initial commit 2015-11-19 08:16:11 -05:00
README.rst Merge "explicitly call out running quickstart.sh as root is not supported" 2017-04-01 16:43:18 +00:00
ansible-role-requirements.yml Switch to using standalone role for image building 2016-04-13 09:43:16 -04:00
ansible.cfg Fact caching - remove trailing slash, descriptive name 2017-06-27 08:41:03 +00:00
ansible_ssh_env.sh Use export in ansible_ssh_env file 2016-10-20 17:11:08 +00:00
devmode.sh devmode: Add release switch 2017-06-07 20:26:17 +01:00
other-requirements.txt Add libffi devel package for the upstream gates 2016-11-14 16:09:15 +01:00
quickstart-extras-requirements.txt Start using tripleo-quickstart-extras 2016-11-22 15:25:05 +01:00
quickstart-role-requirements.txt Removing locking hash on undercloud post role 2016-09-14 03:33:22 -04:00
quickstart.sh formalize the notion of an environment configuration 2017-06-20 10:15:44 -04:00
requirements.txt Revert "Bump Ansible to 2.3" 2017-06-02 16:54:22 +02:00
setup.cfg break out general_config into config and topology 2017-03-13 13:36:13 -04:00
setup.py Add installation and setup machinery 2015-11-30 17:16:00 -05:00
test-requirements.txt Switch from oslosphinx to openstackdocstheme 2017-07-06 10:42:39 -07:00
tox.ini Merge "restrict bashate to files in repository" 2017-06-30 00:15:46 +00:00

README.rst

Team and repository tags

image

tripleo-quickstart

One of the barriers to entry for trying out TripleO and its derivatives has been the relative difficulty in getting an environment up quickly.

This set of ansible roles is meant to help.

Quickstart's default deployment method uses a physical machine, which is referred to as $VIRTHOST throughout this documentation. On this physical machine Quickstart sets up multiple virtual machines (VMs) and virtual networks using libvirt.

One of the VMs is set up as undercloud, an all-in-one OpenStack cloud used by system administrators to deploy the overcloud, the end-user facing OpenStack installation, usually consisting of multiple VMs.

You will need a $VIRTHOST with at least 16 GB of RAM, preferably 32 GB, and you must be able to ssh to the virthost machine as root without a password from the machine running ansible. Currently the virthost machine must be running a recent Red Hat-based Linux distribution (CentOS 7, RHEL 7, Fedora 22 - only CentOS 7 is currently tested), but we hope to add support for non-Red Hat distributions too.

Note

Running quickstart.sh commands as root is not suggested or supported.

A quick way to test that your virthost machine is ready to rock is:

ssh root@$VIRTHOST uname -a

The defaults are meant to "just work", so it is as easy as downloading and running the quickstart.sh script.

Getting the script

You can download the quickstart.sh script with wget:

wget https://raw.githubusercontent.com/openstack/tripleo-quickstart/master/quickstart.sh

Alternatively, you can clone this repository and run the script from there.

Requirements

You need some software available on your local system before you can run quickstart.sh. You can install the necessary dependencies by running:

bash quickstart.sh --install-deps

Deploying with instructions

Deploy your virtual environment by running:

bash quickstart.sh $VIRTHOST

Where $VIRTHOST is the name of the host on which you want to install your virtual triple0 environment. The quickstart.sh script will install this repository along with ansible in a virtual environment on your Ansible host and run the quickstart playbook. Note, the quickstart playbook will delete the stack user on $VIRTHOST and recreate it.

This script will output instructions at the end to access the deployed undercloud. If a release name is not given, newton is used.

Deploying without instructions

bash quickstart.sh --tags all $VIRTHOST

You may choose to execute an end to end deployment without displaying the instructions and scripts provided by default. Using the --tags all flag will instruct quickstart to provision the environment and deploy both the undercloud and overcloud. Additionally a validation test will be executed to ensure the overcloud is functional.

Deploying on localhost

bash quickstart.sh 127.0.0.2

Please note the following when using quickstart to deploy tripleo directly on localhost. Use the loopback address 127.0.0.2 in lieu of localhost as localhost is reserved by ansible and will not work correctly. The deployment should pass, however you may not be able to ssh to the overcloud nodes while using the default ssh config file. The ssh config file that is generated by quickstart e.g. ~/.quickstart/ssh.config.ansible will try to proxy through the localhost to ssh to the localhost and will cause an error if ssh is not setup to support it.

Enable Developer mode

If you are working on TripleO upstream development, and need to reproduce what runs in tripleo-ci, you will want to use developer mode.

This will fetch the images produced by tripleo-ci instead of the ones produced by RDO. The incantation for a job using the quickstart defaults other than developer mode would be:

bash devmode.sh $VIRTHOST

The full set of developer mode instructions are available in devmode

Feature Configuration and Nodes

In previous versions of triple-quickstart a config file was used to determine not only the features that would be enabled in tripleo and openstack but also the number of nodes to be used. For instance "config/general_config/ha.yml" would configure pacemaker and ensure three controller nodes were provisioned. This type of configuration is now deprecated but will still work through the Queens release.

The feature and node configuration have been seperated into two distinct configuration files to allow users to explicity select the configuration known as "feature sets" and the nodes to be provisioned. The feature set configuration can be found under tripleo-quickstart/config/general_config/ and the node configuration can be found under tripleo-quickstart/config/nodes/

A more in depth description of the feature sets can be found in the documentation under feature-configuration

A more in depth description of how to configure nodes can be found in the documentation under node-configuration

Working With Quickstart Extras

TripleO Quickstart is more than just a tool for quickly deploying a single machine TripleO instance; it is an easily extensible framework for deploying OpenStack.

For a how-to please see working-with-extras

Setting up libvirt guests only

At times it is useful to only setup or provision libvirt guests without installing any TripleO code or rpms. The tripleo-quickstart git repository is designed to provision libvirt guest environments. Some may be familiar with an older TripleO tool called instack-virt-setup, these steps would replace that function.

To deploy the undercloud node uninstalled and empty or blank overcloud nodes do the following.:

bash quickstart.sh --tags all --playbook quickstart.yml $VIRTHOST

To only deploy one node, the undercloud node do the following.:

bash quickstart.sh --tags all --playbook quickstart.yml -e overcloud_nodes="" $VIRTHOST

Documentation

The full documentation is in the doc/source directory, it can be built using:

tox -e docs

An up-to-date HTML version is available on docs.openstack.org.

Copyright 2015-2016 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.