1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
.. highlight: python
:linenothreshold: 5
.. figure:: figures/doc-logo-fox.jpg
:alt: Documentation Logo
:scale: 30%
:align: center
Demo documentation
==================
The demo documentation provides example markup for looking at the expected output.
.. sidebar:: Sidebar
This is a sidebar which may be used to provide related or reference
material. It is displayed in proximity to, but outside the main
text.
The project aims for simple implementation, massive scalability, and a rich set
of features. Cloud computing experts from around the world contribute to the project.
Glossary
~~~~~~~~
Here's an example glossary:
Cactus
An OpenStack grouped release of projects that came out in the spring of
2011. It included Compute (nova), Object Storage (swift), and the Image
service (glance). Cactus is a city in Texas, US and is the code name for
the third release of OpenStack. When OpenStack releases went from three to
six months long, the code name of the release changed to match a geography
nearest the previous summit.
CADF
Cloud Auditing Data Federation (CADF) is a specification for audit event
data. CADF is supported by OpenStack Identity.
CALL
One of the RPC primitives used by the OpenStack message queue software.
Sends a message and waits for a response.
Literal Blocks
~~~~~~~~~~~~~~
Here's an example configuration::
[DEFAULT]
...
my_ip = 10.0.0.31
vnc_enabled = True
vncserver_listen = 0.0.0.0
vncserver_proxyclient_address = 10.0.0.31
novncproxy_base_url = http://controller:6080/vnc_auto.html
Code Blocks
~~~~~~~~~~~
Here's another example that's python code:
.. code-block:: python
:linenos:
def builder_inited(app):
theme_dir = os.path.join(os.path.dirname(__file__), 'theme')
LOG.info('Using openstack theme from %s' % theme_dir)
# Insert our theme directory at the front of the search path and
# force the theme setting to use the one in the package. This is
# done here, instead of in setup(), because conf.py is read after
# setup() runs, so if the conf contains these values the user
# values overwrite these. That's not bad for the theme, but it
# breaks the search path.
app.config.html_theme_path.insert(0, theme_dir)
# Set the theme name
app.config.html_theme = 'openstack'
# Re-initialize the builder, if it has the method for setting up
# the templates and theme.
if hasattr(app.builder, 'init_templates'):
app.builder.init_templates()
Here's the same example but with ``..code-block: ini`` to test the pygments
lexer:
.. code-block:: ini
[DEFAULT]
...
my_ip = 10.0.0.31
vnc_enabled = True
vncserver_listen = 0.0.0.0
vncserver_proxyclient_address = 10.0.0.31
novncproxy_base_url = http://controller:6080/vnc_auto.html
Tables
~~~~~~
Here's a sample table:
.. list-table:: OpenStack projects
:header-rows: 1
:widths: 10, 10, 60
* - Name
- Role
- Description
* - Nova
- Compute
- To implement services and associated libraries to provide massively
scalable, on demand, self service access to compute resources, including
bare metal, virtual machines, and containers.
* - Neutron
- Networking
- OpenStack Neutron is an SDN networking project focused on delivering
networking-as-a-service (NaaS) in virtual compute environments.
* - Swift
- Object store
- Swift is a highly available, distributed, eventually consistent
object/blob store. Organizations can use Swift to store lots of data
efficiently, safely, and cheaply. It's built for scale and optimized for
durability, availability, and concurrency across the entire data set.
Swift is ideal for storing unstructured data that can grow without bound.
* - ...
- ...
- ...
Notices
~~~~~~~
Notices take these forms.
note
++++
.. note:: A comment with additional information that explains a part of the
text.
important
+++++++++
.. important:: Something you must be aware of before proceeding.
tip
+++
.. tip:: An extra but helpful piece of practical advice.
caution
+++++++
.. caution:: Helpful information that prevents the user from making mistakes.
seealso
+++++++
.. seealso::
A reference to another piece of related information, like a
related setting or upstream documentation
warning
+++++++
.. warning:: Critical information about the risk of data loss or security
issues.
Configuration addition and deprecation notices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. versionadded:: 9.0.0-Mitaka
.. versionadded:: 10.0.0-Newton
.. versionchanged:: 10.0.0-Newton
Added support for new tags!
.. versionchanged:: 11.0.0-Ocata
Showing that multiple notices work!
.. deprecated:: 11.0.0-Ocata
Use `Notices`_ instead.
.. deprecated:: 12.0.0-Pike
A second deprecation notice
.. toctree::
:maxdepth: 1
section_dashboard_access_and_security
dashboard_demo
configure_access_and_security_for_instances
create_and_manage_databases
create_and_manage_networks
launch-instance
Search
~~~~~~
* :ref:`search`
|
