openstack/openstack-ansible
Code Issues Proposed changes

Remove reference to the 'one step' script.

Browse Source 
The single step script is outdated and unmaintained, and less reliable
than the methods detailed in later sections.

Change-Id: I43789c79316103350d64b9b7e525de36c9262de2
This commit is contained in:
Nolan Brubaker 2016-01-26 12:17:17 -05:00
parent a6c19dc4a4
commit 7eec6be887
2 changed files with 10 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/source/developer-docs/quickstart-aio.rst
View File

@ -33,26 +33,12 @@ virtual machines will perform poorly.
.. _hardware-assisted virtualization: https://en.wikipedia.org/wiki/Hardware-assisted_virtualization
Running an AIO build in one step
--------------------------------
For a one-step build, there is a `convenient script`_ within the
Openstack-Ansible repository that will run a AIO build with defaults:
Building an AIO
---------------
.. _convenient script: https://raw.githubusercontent.com/openstack/openstack-ansible/master/scripts/run-aio-build.sh
.. code-block:: bash
curl https://raw.githubusercontent.com/openstack/openstack-ansible/master/scripts/run-aio-build.sh | sudo bash
It's advised to run this build within a terminal muxer, like tmux or screen,
so that you don't lose your progress if you're disconnected from your terminal
session.
Running a customized AIO build
------------------------------
There are four main steps for running a customized AIO build:
There are three steps to running an AIO build, with an optional first step
should you need to customize your build:
* Configuration *(this step is optional)*
* Install and bootstrap Ansible
@ -161,8 +147,8 @@ in that container.
.. _Install Guide: ../install-guide/
Rebooting the AIO
-----------------
Rebooting an AIO
----------------
As the AIO includes all three cluster members of MariaDB/Galera, the cluster
has to be re-initialized after the host is rebooted.
@ -178,8 +164,8 @@ please make use of the `Galera Cluster Recovery`_ page in the Install Guide.
.. _Galera Cluster Recovery: ../install-guide/ops-galera-recovery.html
Rebuilding the AIO
------------------
Rebuilding an AIO
-----------------
Sometimes it may be useful to destroy all the containers and rebuild the AIO.
While it is preferred that the AIO is entirely destroyed and rebuilt, this
isn't always practical. As such the following may be executed instead:
@ -268,8 +254,8 @@ To follow along with the progress, ssh to your running instance and execute:
tail -F /var/log/cloud-init-output.log
Reference Diagram for the AIO Build
-----------------------------------
Reference Diagram for an AIO Build
----------------------------------
Here is a basic diagram that attempts to illustrate what the resulting AIO
deployment looks like.

82
scripts/run-aio-build.sh
View File

@ -1,82 +0,0 @@
#!/usr/bin/env bash
# Copyright 2014, Rackspace US, 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.
#
# ----------------------------------------------------------------------------
#
# This script configures an all-in-one (AIO) deployment. For more details, see
# the quick start documentation for openstack-ansible:
#
# http://docs.openstack.org/developer/openstack-ansible/developer-docs/quickstart-aio.html#running-an-aio-build-in-one-step
## Shell Opts ----------------------------------------------------------------
set -e -u +x
## Variables -----------------------------------------------------------------
export REPO_URL=${REPO_URL:-"https://github.com/openstack/openstack-ansible.git"}
export REPO_BRANCH=${REPO_BRANCH:-"master"}
export WORKING_FOLDER=${WORKING_FOLDER:-"/opt/openstack-ansible"}
## Main ----------------------------------------------------------------------
# Set verbosity
set -x
# Install git so that we can fetch various git repositories.
# Note: the redirect of stdin to /dev/null is necessary for when this script is
# run as part of a curl-pipe-shell. otherwise apt-get will consume the rest of
# this file as if it was its own stdin (despite using -y to skip interaction).
apt-get update && apt-get install -y git < /dev/null
# Fetch the openstack-ansible repository.
git clone -b ${REPO_BRANCH} ${REPO_URL} ${WORKING_FOLDER}
# Change into the expected root directory.
cd ${WORKING_FOLDER}
# Start by bootstrapping Ansible from source.
source scripts/bootstrap-ansible.sh
# Next, bootstrap the AIO host.
source scripts/bootstrap-aio.sh
# Finally, run all of the playbooks.
bash scripts/run-playbooks.sh
# Add a MOTD to explain to the deployer what is accessible once the build
# is complete.
cat > /etc/update-motd.d/20-openstack<< EOF
#!/usr/bin/env bash
echo ""
echo "############ openstack-ansible all-in-one build #############"
echo ""
echo " OpenStack Services are now listening on $(ip -o -4 addr show dev eth0 | awk -F '[ /]+' '/global/ {print $4}')"
echo ""
EOF
chmod +x /etc/update-motd.d/20-openstack
# Add a MOTD to explain to the deployer how to restart galera properly after a
# reboot.
cat > /etc/update-motd.d/21-galera<< EOF
#!/usr/bin/env bash
echo ""
echo "If this server has been rebooted, you will need to re-bootstrap"
echo "Galera to get the cluster operational. To do this execute:"
echo ""
echo "This requires you to identify the most advanced node. For details see http://galeracluster.com/documentation-webpages/quorumreset.html
echo ""
EOF
chmod +x /etc/update-motd.d/21-galera