summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrey Volkov <av903u@att.com>2018-10-09 12:52:03 -0700
committerAndrey Volkov <av903u@att.com>2018-10-10 09:16:20 -0700
commita648dcb2db2b842656bfee08102081023080e4d5 (patch)
tree710d4f8ec581ac7f402f583fd488742f96498e8b
parent623779b66c0523336b739d188d0aa87e6b40a5ef (diff)
Improve docs formatting
- Make numerated list look properly. - Fix hierarchy of headers. Change-Id: I18d50221aa7bdd6b85d19f8d55b42439aa292a2f
Notes
Notes (review): Code-Review+1: Serge Kovaleff <sk607s@att.com> Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Code-Review+1: Drew Walters <drewwalters96@gmail.com> Code-Review+2: Aaron Sheffield <ajs@sheffieldfamily.net> Workflow+1: Aaron Sheffield <ajs@sheffieldfamily.net> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 23 Oct 2018 19:05:00 +0000 Reviewed-on: https://review.openstack.org/609114 Project: openstack/airship-divingbell Branch: refs/heads/master
-rw-r--r--doc/source/index.rst36
1 files changed, 21 insertions, 15 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 05f85b0..65d0b80 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -18,6 +18,7 @@ Divingbell
18========== 18==========
19 19
20Divingbell is a lightweight solution for: 20Divingbell is a lightweight solution for:
21
211. Bare metal configuration management for a few very targeted use cases 221. Bare metal configuration management for a few very targeted use cases
222. Bare metal package manager orchestration 232. Bare metal package manager orchestration
23 24
@@ -25,6 +26,7 @@ What problems does it solve?
25---------------------------- 26----------------------------
26 27
27The needs identified for Divingbell were: 28The needs identified for Divingbell were:
29
281. To plug gaps in day 1 tools (e.g., Drydock) for node configuration 301. To plug gaps in day 1 tools (e.g., Drydock) for node configuration
292. To provide a day 2 solution for managing these configurations going forward 312. To provide a day 2 solution for managing these configurations going forward
303. [Future] To provide a day 2 solution for system level host patching 323. [Future] To provide a day 2 solution for system level host patching
@@ -122,8 +124,11 @@ access. Ex::
122 - ssh-rsa AAAAB3N... key1-comment 124 - ssh-rsa AAAAB3N... key1-comment
123 - ssh-rsa AAAAVY6... key2-comment 125 - ssh-rsa AAAAVY6... key2-comment
124 126
127Operations
128----------
129
125Setting user passwords 130Setting user passwords
126"""""""""""""""""""""" 131^^^^^^^^^^^^^^^^^^^^^^
127 132
128Including ``user_crypt_passwd`` to set a user password is optional. 133Including ``user_crypt_passwd`` to set a user password is optional.
129 134
@@ -145,7 +150,7 @@ network access is unavailable, console username/password access will be the only
145login option. 150login option.
146 151
147Setting user sudo 152Setting user sudo
148""""""""""""""""" 153^^^^^^^^^^^^^^^^^
149 154
150Including ``user_sudo`` to set user sudo access is optional. The default value 155Including ``user_sudo`` to set user sudo access is optional. The default value
151is ``false``. 156is ``false``.
@@ -154,7 +159,7 @@ At least one user must be defined with sudo access in order for the built-in
154``ubuntu`` account to be disabled. 159``ubuntu`` account to be disabled.
155 160
156SSH keys 161SSH keys
157"""""""" 162^^^^^^^^
158 163
159Including ``user_sshkeys`` for defining one or more user SSH keys is optional. 164Including ``user_sshkeys`` for defining one or more user SSH keys is optional.
160 165
@@ -173,7 +178,7 @@ At least one user must be defined with an SSH key and sudo in order for the
173built-in ``ubuntu`` account to be disabled. 178built-in ``ubuntu`` account to be disabled.
174 179
175Purging expired users 180Purging expired users
176""""""""""""""""""""" 181^^^^^^^^^^^^^^^^^^^^^
177 182
178Including the ``purge_expired_users`` key-value pair is optional. The default 183Including the ``purge_expired_users`` key-value pair is optional. The default
179value is ``false``. 184value is ``false``.
@@ -238,19 +243,20 @@ Overrides example with sysctl daemonset::
238 fs.file-max: 23456 243 fs.file-max: 23456
239 244
240Caveats: 245Caveats:
2411. For a given node, at most one override operation applies. If a node meets 246
242override criteria for both a label and a host, then the host overrides take 2471. For a given node, at most one override operation applies. If a node
243precedence and are used for that node. The label overrides are not used in this 248 meets override criteria for both a label and a host, then the host
244case. This is especially important to note if you are defining new host 249 overrides take precedence and are used for that node. The label
245overrides for a node that is already consuming matching label overrides, as 250 overrides are not used in this case. This is especially important
246defining a host override would make those label overrides no longer apply. 251 to note if you are defining new host overrides for a node that is
2472. In the event of label conflicts, the last applicable label override defined 252 already consuming matching label overrides, as defining a host
248takes precedence. In this example, overrides defined for "another_label" would 253 override would make those label overrides no longer apply.
249take precedence and be applied to nodes that contained both of the defined 2542. In the event of label conflicts, the last applicable label override
250labels. 255 defined takes precedence. In this example, overrides defined for
256 "another_label" would take precedence and be applied to nodes that
257 contained both of the defined labels.
251 258
252Recorded Demo 259Recorded Demo
253------------- 260-------------
254 261
255A recorded demo of using Divingbell can be found `here <https://asciinema.org/a/beJQZpRPdOctowW0Lxkxrhz17>`_. 262A recorded demo of using Divingbell can be found `here <https://asciinema.org/a/beJQZpRPdOctowW0Lxkxrhz17>`_.
256