Browse code

docs: cleanup install docs

This does a few things to the home page and all-in-one single
machine install guide:

* Uses code blocks for formatting
* Adds the customary "$" to the console blocks in the
all-in-one single machine install guide
* Instructs to use "sudo su stack" and adds a note about
"sudo visudo" in the all-in-one single machine doc
* Creates a symbolic link to the sample local.conf and links to
it from the install guide (note that local.conf might be old
by now)
* Fixes the .gitignore file to only ignore local.conf in the root
of the repository, otherwise it would ignore local.conf everywhere
including the samples and doc/source/assets directories.

Change-Id: I50ae7bd32c4c1caa2ac8551fc54b31dd2dfae568

Matt Riedemann authored on 2018/12/13 22:22:12
Showing 4 changed files
... ...
@@ -28,7 +28,7 @@ files/get-pip.py*
28 28
 files/ir-deploy*
29 29
 files/ironic-inspector*
30 30
 files/etcd*
31
-local.conf
31
+^local.conf
32 32
 local.sh
33 33
 localrc
34 34
 proto
35 35
new file mode 120000
... ...
@@ -0,0 +1 @@
0
+../../../samples/local.conf
0 1
\ No newline at end of file
... ...
@@ -45,31 +45,37 @@ We need to add a user to install DevStack. (if you created a user during
45 45
 install you can skip this step and just give the user sudo privileges
46 46
 below)
47 47
 
48
-::
48
+.. code-block:: console
49 49
 
50
-    useradd -s /bin/bash -d /opt/stack -m stack
50
+    $ sudo useradd -s /bin/bash -d /opt/stack -m stack
51 51
 
52 52
 Since this user will be making many changes to your system, it will need
53 53
 to have sudo privileges:
54 54
 
55
-::
55
+.. code-block:: console
56 56
 
57
-    apt-get install sudo -y || yum install -y sudo
58
-    echo "stack ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
57
+    $ apt-get install sudo -y || yum install -y sudo
58
+    $ echo "stack ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
59
+
60
+.. note:: On some systems you may need to use ``sudo visudo``.
59 61
 
60 62
 From here on you should use the user you created. **Logout** and
61
-**login** as that user.
63
+**login** as that user:
64
+
65
+.. code-block:: console
66
+
67
+    $ sudo su stack && cd ~
62 68
 
63 69
 Download DevStack
64 70
 -----------------
65 71
 
66 72
 We'll grab the latest version of DevStack via https:
67 73
 
68
-::
74
+.. code-block:: console
69 75
 
70
-    sudo apt-get install git -y || sudo yum install -y git
71
-    git clone https://git.openstack.org/openstack-dev/devstack
72
-    cd devstack
76
+    $ sudo apt-get install git -y || sudo yum install -y git
77
+    $ git clone https://git.openstack.org/openstack-dev/devstack
78
+    $ cd devstack
73 79
 
74 80
 Run DevStack
75 81
 ------------
... ...
@@ -97,7 +103,7 @@ do the following:
97 97
 
98 98
 ``local.conf`` should look something like this:
99 99
 
100
-::
100
+.. code-block:: ini
101 101
 
102 102
     [[local|localrc]]
103 103
     FLOATING_RANGE=192.168.1.224/27
... ...
@@ -109,11 +115,14 @@ do the following:
109 109
     RABBIT_PASSWORD=flopsymopsy
110 110
     SERVICE_PASSWORD=iheartksl
111 111
 
112
+.. note:: There is a sample :download:`local.conf </assets/local.conf>` file
113
+    under the *samples* directory in the devstack repository.
114
+
112 115
 Run DevStack:
113 116
 
114
-::
117
+.. code-block:: console
115 118
 
116
-    ./stack.sh
119
+    $ ./stack.sh
117 120
 
118 121
 A seemingly endless stream of activity ensues. When complete you will
119 122
 see a summary of ``stack.sh``'s work, including the relevant URLs,
... ...
@@ -55,14 +55,14 @@ are usually fine).
55 55
 
56 56
 You can quickly create a separate `stack` user to run DevStack with
57 57
 
58
-::
58
+.. code-block:: console
59 59
 
60 60
    $ sudo useradd -s /bin/bash -d /opt/stack -m stack
61 61
 
62 62
 Since this user will be making many changes to your system, it should
63 63
 have sudo privileges:
64 64
 
65
-::
65
+.. code-block:: console
66 66
 
67 67
     $ echo "stack ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/stack
68 68
     $ sudo su - stack
... ...
@@ -70,7 +70,7 @@ have sudo privileges:
70 70
 Download DevStack
71 71
 -----------------
72 72
 
73
-::
73
+.. code-block:: console
74 74
 
75 75
    $ git clone https://git.openstack.org/openstack-dev/devstack
76 76
    $ cd devstack
... ...
@@ -83,7 +83,8 @@ Create a local.conf
83 83
 
84 84
 Create a ``local.conf`` file with 4 passwords preset at the root of the
85 85
 devstack git repo.
86
-::
86
+
87
+.. code-block:: ini
87 88
 
88 89
    [[local|localrc]]
89 90
    ADMIN_PASSWORD=secret
... ...
@@ -93,12 +94,15 @@ devstack git repo.
93 93
 
94 94
 This is the minimum required config to get started with DevStack.
95 95
 
96
+.. note:: There is a sample :download:`local.conf </assets/local.conf>` file
97
+    under the *samples* directory in the devstack repository.
98
+
96 99
 Start the install
97 100
 -----------------
98 101
 
99
-::
102
+.. code-block:: console
100 103
 
101
-   ./stack.sh
104
+   $ ./stack.sh
102 105
 
103 106
 This will take a 15 - 20 minutes, largely depending on the speed of
104 107
 your internet connection. Many git trees and packages will be