openstack/devstack
Code Issues Proposed changes

Merge "docs: cleanup install docs"

Browse Source
This commit is contained in:
Zuul 2018-12-17 06:46:48 +00:00 committed by Gerrit Code Review
commit 8c93374cdd
4 changed files with 34 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -28,7 +28,7 @@ files/get-pip.py*
files/ir-deploy* files/ir-deploy*
files/ironic-inspector* files/ironic-inspector*
files/etcd* files/etcd*
local.conf ^local.conf
local.sh local.sh
localrc localrc
proto proto

1
doc/source/assets/local.conf Symbolic link
View File

@ -0,0 +1 @@
../../../samples/local.conf

35
doc/source/guides/single-machine.rst
View File

@ -45,31 +45,37 @@ We need to add a user to install DevStack. (if you created a user during
install you can skip this step and just give the user sudo privileges install you can skip this step and just give the user sudo privileges
below) below)
:: .. code-block:: console
useradd -s /bin/bash -d /opt/stack -m stack $ sudo useradd -s /bin/bash -d /opt/stack -m stack
Since this user will be making many changes to your system, it will need Since this user will be making many changes to your system, it will need
to have sudo privileges: to have sudo privileges:
:: .. code-block:: console
apt-get install sudo -y || yum install -y sudo $ apt-get install sudo -y || yum install -y sudo
echo "stack ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers $ echo "stack ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
.. note:: On some systems you may need to use ``sudo visudo``.
From here on you should use the user you created. **Logout** and From here on you should use the user you created. **Logout** and
**login** as that user. **login** as that user:
.. code-block:: console
$ sudo su stack && cd ~
Download DevStack Download DevStack
----------------- -----------------
We'll grab the latest version of DevStack via https: We'll grab the latest version of DevStack via https:
:: .. code-block:: console
sudo apt-get install git -y || sudo yum install -y git $ sudo apt-get install git -y || sudo yum install -y git
git clone https://git.openstack.org/openstack-dev/devstack $ git clone https://git.openstack.org/openstack-dev/devstack
cd devstack $ cd devstack
Run DevStack Run DevStack
------------ ------------
@ -97,7 +103,7 @@ do the following:
``local.conf`` should look something like this: ``local.conf`` should look something like this:
:: .. code-block:: ini
[[local|localrc]] [[local|localrc]]
FLOATING_RANGE=192.168.1.224/27 FLOATING_RANGE=192.168.1.224/27
@ -109,11 +115,14 @@ do the following:
RABBIT_PASSWORD=flopsymopsy RABBIT_PASSWORD=flopsymopsy
SERVICE_PASSWORD=iheartksl SERVICE_PASSWORD=iheartksl
.. note:: There is a sample :download:`local.conf </assets/local.conf>` file
under the *samples* directory in the devstack repository.
Run DevStack: Run DevStack:
:: .. code-block:: console
./stack.sh $ ./stack.sh
A seemingly endless stream of activity ensues. When complete you will A seemingly endless stream of activity ensues. When complete you will
see a summary of ``stack.sh``'s work, including the relevant URLs, see a summary of ``stack.sh``'s work, including the relevant URLs,

16
doc/source/index.rst
View File

@ -55,14 +55,14 @@ are usually fine).
You can quickly create a separate `stack` user to run DevStack with You can quickly create a separate `stack` user to run DevStack with
:: .. code-block:: console
$ sudo useradd -s /bin/bash -d /opt/stack -m stack $ sudo useradd -s /bin/bash -d /opt/stack -m stack
Since this user will be making many changes to your system, it should Since this user will be making many changes to your system, it should
have sudo privileges: have sudo privileges:
:: .. code-block:: console
$ echo "stack ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/stack $ echo "stack ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/stack
$ sudo su - stack $ sudo su - stack
@ -70,7 +70,7 @@ have sudo privileges:
Download DevStack Download DevStack
----------------- -----------------
:: .. code-block:: console
$ git clone https://git.openstack.org/openstack-dev/devstack $ git clone https://git.openstack.org/openstack-dev/devstack
$ cd devstack $ cd devstack
@ -83,7 +83,8 @@ Create a local.conf
Create a ``local.conf`` file with 4 passwords preset at the root of the Create a ``local.conf`` file with 4 passwords preset at the root of the
devstack git repo. devstack git repo.
::
.. code-block:: ini
[[local|localrc]] [[local|localrc]]
ADMIN_PASSWORD=secret ADMIN_PASSWORD=secret
@ -93,12 +94,15 @@ devstack git repo.
This is the minimum required config to get started with DevStack. This is the minimum required config to get started with DevStack.
.. note:: There is a sample :download:`local.conf </assets/local.conf>` file
under the *samples* directory in the devstack repository.
Start the install Start the install
----------------- -----------------
:: .. code-block:: console
./stack.sh $ ./stack.sh
This will take a 15 - 20 minutes, largely depending on the speed of This will take a 15 - 20 minutes, largely depending on the speed of
your internet connection. Many git trees and packages will be your internet connection. Many git trees and packages will be