RETIRED, Ansible based project for setting up TripleO virtual environments

Go to file

xhzhf 8a961d3988 modify test-requirement according to requirements project the OpenStack requirements project has modify version requirement of docutils/oslosphinx. The link is below https://review.openstack.org/#/c/418772/ So modify test-requirement like other project Closes-Bug: #1666149 Change-Id: I97f1b58890f4205c5ba9387f3d55219ed2da8959		2017-02-20 18:19:59 +08:00
ci-scripts	Merge "Replace "ara generate" by "ara generate html""	2017-02-17 20:23:04 +00:00
config	Add artcl_create_docs_payload to minmal_pacemaker	2017-02-08 10:52:43 -05:00
doc/source	Add new feature to consume external images	2017-01-18 17:33:35 +01:00
library	Fix H102 Apache 2.0 license header not found	2016-07-29 14:08:00 -04:00
playbooks	Merge "config for containerized-compute"	2016-12-21 20:23:18 +00:00
releasenotes	Add release notes for Ocata 2.0.0	2017-02-03 15:39:57 -05:00
roles	Merge "provision/remote: add missing become lines"	2017-02-16 22:41:58 +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 "provide instructions on how to only use quickstart as instack-virt-setup"	2017-02-16 23:19:25 +00:00
ansible-role-requirements.yml	Switch to using standalone role for image building	2016-04-13 09:43:16 -04:00
ansible.cfg	Add the ARA Ansible callback generate a static playbook reports	2017-01-16 01:15:42 +00:00
ansible_ssh_env.sh	Use export in ansible_ssh_env file	2016-10-20 17:11:08 +00:00
devmode.sh	Fix unused variable in devmode.sh script	2017-01-03 15:07:24 +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	doc: clarify what VIRTHOST means	2017-01-24 13:06:57 +01:00
requirements.txt	Revert Ansible version back to 2.2.0.0	2017-01-17 16:29:39 -05:00
setup.cfg	Update author and author-email	2016-12-01 17:21:41 +08:00
setup.py	Add installation and setup machinery	2015-11-30 17:16:00 -05:00
test-requirements.txt	modify test-requirement according to requirements project	2017-02-20 18:19:59 +08:00
tox.ini	Fix and improve flake8 test.	2017-02-09 10:24:26 +01:00

README.rst

Team and repository tags

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.

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 localhost

Please note the following when using quickstart to deploy tripleo directly on localhost. 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

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

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.