blob: 7ea533fdb5d428e109fdc64b225f7ba05eb1c4ae (
plain)
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
|
============================================
Welcome to Ironic's developer documentation!
============================================
Introduction
============
Ironic is an OpenStack project which provisions bare metal (as opposed to
virtual) machines by leveraging common technologies such as PXE boot and IPMI
to cover a wide range of hardware, while supporting pluggable drivers to allow
vendor-specific functionality to be added.
If one thinks of traditional hypervisor functionality (eg, creating a VM,
enumerating virtual devices, managing the power state, loading an OS onto the
VM, and so on), then Ironic may be thought of as a *hypervisor API* gluing
together multiple drivers, each of which implement some portion of that
functionality with respect to physical hardware.
The developer documentation provided here is continually kept up-to-date based
on the latest code, and may not represent the state of the project at any
specific prior release.
Developer Guide
===============
Introduction
------------
.. toctree::
:maxdepth: 1
dev/architecture
dev/states
dev/contributing
.. toctree::
dev/dev-quickstart
dev/vendor-passthru
API References
--------------
.. toctree::
:maxdepth: 1
webapi/v1
dev/drivers
Admin Guide
===========
Overview
--------
.. toctree::
:maxdepth: 1
deploy/user-guide
deploy/install-guide
deploy/upgrade-guide
deploy/drivers
deploy/cleaning
Commands
--------
.. toctree::
:maxdepth: 1
cmds/ironic-dbsync
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|