ca6b01ba8e
... and also run Tempest like other jobs Change-Id: I787eef42db98e1524e1cb9742cd3e097adcacfa9 Depends-On: I31e1fe29491d2cbaa8ed9cd35ee84bbb1d455154 |
||
|---|---|---|
| ci-scripts | ||
| config | ||
| doc/source | ||
| library | ||
| playbooks | ||
| releasenotes | ||
| roles | ||
| test_plugins | ||
| zuul.d | ||
| .gitignore | ||
| .gitreview | ||
| ansible_ssh_env.sh | ||
| ansible-role-requirements.yml | ||
| ansible.cfg | ||
| devmode.sh | ||
| LICENSE | ||
| other-requirements.txt | ||
| quickstart-extras-requirements.txt | ||
| quickstart-role-requirements.txt | ||
| quickstart.sh | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
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.
Note
Running quickstart.sh commands as root is not suggested or supported.
The SSH server on your $VIRTHOST must be accessible via
public keys for both the root and stack users.
A quick way to test that root to your virthost machine is ready to rock is:
ssh root@$VIRTHOST uname -aThe stack user is not added until the quickstart deploy
runs, so this cannot be tested in advance. However, if you lock down on
a per-user basis, ensure AllowUsers includes
stack.
Timeouts can be an issue if the SSH server is configured to disconnect users after periods of inactivity. This can be addressed for example by:
ClientAliveInterval 120
ClientAliveCountMax 720The quickstart 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
curl:
curl -O https://raw.githubusercontent.com/openstack/tripleo-quickstart/master/quickstart.shAlternatively, 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-depsDeploying with instructions
Deploy your virtual environment by running:
bash quickstart.sh $VIRTHOSTWhere $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, pike
is used.
Deploying without instructions
bash quickstart.sh --tags all $VIRTHOSTYou 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.2Please 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 $VIRTHOSTThe 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 separated 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 $VIRTHOSTTo only deploy one node, the undercloud node do the following.:
bash quickstart.sh --tags all --playbook quickstart.yml -e overcloud_nodes="" $VIRTHOSTDocumentation
The full documentation is in the doc/source directory,
it can be built using:
tox -e docsAn up-to-date HTML version is available on docs.openstack.org.
Copyright
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.