Browse Source

Improve docs formatting

- Make numerated list look properly.
- Fix hierarchy of headers.

Change-Id: I18d50221aa7bdd6b85d19f8d55b42439aa292a2f
Andrey Volkov 6 months ago
parent
commit
a648dcb2db
1 changed files with 21 additions and 15 deletions
  1. 21
    15
      doc/source/index.rst

+ 21
- 15
doc/source/index.rst View File

@@ -18,6 +18,7 @@ Divingbell
18 18
 ==========
19 19
 
20 20
 Divingbell is a lightweight solution for:
21
+
21 22
 1. Bare metal configuration management for a few very targeted use cases
22 23
 2. Bare metal package manager orchestration
23 24
 
@@ -25,6 +26,7 @@ What problems does it solve?
25 26
 ----------------------------
26 27
 
27 28
 The needs identified for Divingbell were:
29
+
28 30
 1. To plug gaps in day 1 tools (e.g., Drydock) for node configuration
29 31
 2. To provide a day 2 solution for managing these configurations going forward
30 32
 3. [Future] To provide a day 2 solution for system level host patching
@@ -122,8 +124,11 @@ access. Ex::
122 124
           - ssh-rsa AAAAB3N... key1-comment
123 125
           - ssh-rsa AAAAVY6... key2-comment
124 126
 
127
+Operations
128
+----------
129
+
125 130
 Setting user passwords
126
-""""""""""""""""""""""
131
+^^^^^^^^^^^^^^^^^^^^^^
127 132
 
128 133
 Including ``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
145 150
 login option.
146 151
 
147 152
 Setting user sudo
148
-"""""""""""""""""
153
+^^^^^^^^^^^^^^^^^
149 154
 
150 155
 Including ``user_sudo`` to set user sudo access is optional. The default value
151 156
 is ``false``.
@@ -154,7 +159,7 @@ At least one user must be defined with sudo access in order for the built-in
154 159
 ``ubuntu`` account to be disabled.
155 160
 
156 161
 SSH keys
157
-""""""""
162
+^^^^^^^^
158 163
 
159 164
 Including ``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
173 178
 built-in ``ubuntu`` account to be disabled.
174 179
 
175 180
 Purging expired users
176
-"""""""""""""""""""""
181
+^^^^^^^^^^^^^^^^^^^^^
177 182
 
178 183
 Including the ``purge_expired_users`` key-value pair is optional. The default
179 184
 value is ``false``.
@@ -238,19 +243,20 @@ Overrides example with sysctl daemonset::
238 243
                 fs.file-max: 23456
239 244
 
240 245
 Caveats:
241
-1. For a given node, at most one override operation applies. If a node meets
242
-override criteria for both a label and a host, then the host overrides take
243
-precedence and are used for that node. The label overrides are not used in this
244
-case. This is especially important to note if you are defining new host
245
-overrides for a node that is already consuming matching label overrides, as
246
-defining a host override would make those label overrides no longer apply.
247
-2. In the event of label conflicts, the last applicable label override defined
248
-takes precedence. In this example, overrides defined for "another_label" would
249
-take precedence and be applied to nodes that contained both of the defined
250
-labels.
246
+
247
+1. For a given node, at most one override operation applies. If a node
248
+   meets override criteria for both a label and a host, then the host
249
+   overrides take precedence and are used for that node. The label
250
+   overrides are not used in this case. This is especially important
251
+   to note if you are defining new host overrides for a node that is
252
+   already consuming matching label overrides, as defining a host
253
+   override would make those label overrides no longer apply.
254
+2. In the event of label conflicts, the last applicable label override
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
 
252 259
 Recorded Demo
253 260
 -------------
254 261
 
255 262
 A recorded demo of using Divingbell can be found `here <https://asciinema.org/a/beJQZpRPdOctowW0Lxkxrhz17>`_.
256
-

Loading…
Cancel
Save