Skip to content

Commit 3a21854

Browse files
Jenkinsopenstack-gerrit
Jenkins
authored and
openstack-gerrit
committed
Merge "Initial docs for bare-metal service"
2 parents 499bf2e + 54e4055 commit 3a21854

File tree

9 files changed

+99
-0
lines changed

9 files changed

+99
-0
lines changed

‎doc/source/users/guides/bare_metal.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Using OpenStack Bare Metal
2+
===========================
3+
4+
Before working with the Bare Metal service, you'll need to create a
5+
connection to your OpenStack cloud by following the :doc:`connect` user
6+
guide. This will provide you with the ``conn`` variable used in the examples
7+
below.
8+
9+
.. TODO(Qiming): Implement this guide

‎doc/source/users/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ approach, this is where you'll want to begin.
2828
Connect to an OpenStack Cloud <guides/connect>
2929
Connect to an OpenStack Cloud Using a Config File <guides/connect_from_config>
3030
Logging <guides/logging>
31+
Bare Metal <guides/bare_metal>
3132
Block Store <guides/block_store>
3233
Cluster <guides/cluster>
3334
Compute <guides/compute>
@@ -69,6 +70,7 @@ but listed below are the ones provided by this SDK by default.
6970
.. toctree::
7071
:maxdepth: 1
7172

73+
Bare Metal <proxies/bare_metal>
7274
Block Store <proxies/block_store>
7375
Cluster <proxies/cluster>
7476
Compute <proxies/compute>
@@ -96,6 +98,7 @@ The following services have exposed *Resource* classes.
9698
.. toctree::
9799
:maxdepth: 1
98100

101+
Bare Metal <resources/bare_metal/index>
99102
Block Store <resources/block_store/index>
100103
Cluster <resources/cluster/index>
101104
Compute <resources/compute/index>

‎doc/source/users/proxies/bare_metal.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Bare Metal API
2+
==============
3+
4+
For details on how to use bare_metal, see :doc:`/users/guides/bare_metal`
5+
6+
.. automodule:: openstack.bare_metal.v1._proxy
7+
8+
The BareMetal Class
9+
--------------------
10+
11+
The bare_metal high-level interface is available through the ``bare_metal``
12+
member of a :class:`~openstack.connection.Connection` object.
13+
The ``bare_metal`` member will only be added if the service is detected.
14+
15+
.. autoclass:: openstack.bare_metal.v1._proxy.Proxy
16+
:members:

‎doc/source/users/resources/bare_metal/index.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Bare Metal Resources
2+
=====================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
v1/driver
8+
v1/chassis
9+
v1/node
10+
v1/port
11+
v1/portgroup

‎doc/source/users/resources/bare_metal/v1/chassis.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.bare_metal.v1.chassis
2+
===============================
3+
4+
.. automodule:: openstack.bare_metal.v1.chassis
5+
6+
The Chassis Class
7+
-----------------
8+
9+
The ``Chassis`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.bare_metal.v1.chassis.Chassis
12+
:members:

‎doc/source/users/resources/bare_metal/v1/driver.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.bare_metal.v1.driver
2+
==============================
3+
4+
.. automodule:: openstack.bare_metal.v1.driver
5+
6+
The Driver Class
7+
----------------
8+
9+
The ``Driver`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.bare_metal.v1.driver.Driver
12+
:members:

‎doc/source/users/resources/bare_metal/v1/node.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.bare_metal.v1.Node
2+
============================
3+
4+
.. automodule:: openstack.bare_metal.v1.node
5+
6+
The Node Class
7+
--------------
8+
9+
The ``Node`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.bare_metal.v1.node.Node
12+
:members:

‎doc/source/users/resources/bare_metal/v1/port.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.bare_metal.v1.port
2+
============================
3+
4+
.. automodule:: openstack.bare_metal.v1.port
5+
6+
The Port Class
7+
--------------
8+
9+
The ``Port`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.bare_metal.v1.port.Port
12+
:members:

‎doc/source/users/resources/bare_metal/v1/port_group.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.bare_metal.v1.port_group
2+
==================================
3+
4+
.. automodule:: openstack.bare_metal.v1.port_group
5+
6+
The PortGroup Class
7+
-------------------
8+
9+
The ``PortGroup`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.bare_metal.v1.port_group.PortGroup
12+
:members:

0 commit comments

Comments
 (0)