diff --git a/doc/source/users/guides/bare_metal.rst b/doc/source/users/guides/bare_metal.rst new file mode 100644 index 00000000..10e96561 --- /dev/null +++ b/doc/source/users/guides/bare_metal.rst @@ -0,0 +1,9 @@ +Using OpenStack Bare Metal +=========================== + +Before working with the Bare Metal service, you'll need to create a +connection to your OpenStack cloud by following the :doc:`connect` user +guide. This will provide you with the ``conn`` variable used in the examples +below. + +.. TODO(Qiming): Implement this guide diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index b03cb4c9..b4a97c61 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -28,6 +28,7 @@ approach, this is where you'll want to begin. Connect to an OpenStack Cloud Connect to an OpenStack Cloud Using a Config File Logging + Bare Metal Block Store Cluster Compute @@ -69,6 +70,7 @@ but listed below are the ones provided by this SDK by default. .. toctree:: :maxdepth: 1 + Bare Metal Block Store Cluster Compute @@ -96,6 +98,7 @@ The following services have exposed *Resource* classes. .. toctree:: :maxdepth: 1 + Bare Metal Block Store Cluster Compute diff --git a/doc/source/users/proxies/bare_metal.rst b/doc/source/users/proxies/bare_metal.rst new file mode 100644 index 00000000..58c7d23b --- /dev/null +++ b/doc/source/users/proxies/bare_metal.rst @@ -0,0 +1,16 @@ +Bare Metal API +============== + +For details on how to use bare_metal, see :doc:`/users/guides/bare_metal` + +.. automodule:: openstack.bare_metal.v1._proxy + +The BareMetal Class +-------------------- + +The bare_metal high-level interface is available through the ``bare_metal`` +member of a :class:`~openstack.connection.Connection` object. +The ``bare_metal`` member will only be added if the service is detected. + +.. autoclass:: openstack.bare_metal.v1._proxy.Proxy + :members: diff --git a/doc/source/users/resources/bare_metal/index.rst b/doc/source/users/resources/bare_metal/index.rst new file mode 100644 index 00000000..4aa391c8 --- /dev/null +++ b/doc/source/users/resources/bare_metal/index.rst @@ -0,0 +1,11 @@ +Bare Metal Resources +===================== + +.. toctree:: + :maxdepth: 1 + + v1/driver + v1/chassis + v1/node + v1/port + v1/portgroup diff --git a/doc/source/users/resources/bare_metal/v1/chassis.rst b/doc/source/users/resources/bare_metal/v1/chassis.rst new file mode 100644 index 00000000..30389637 --- /dev/null +++ b/doc/source/users/resources/bare_metal/v1/chassis.rst @@ -0,0 +1,12 @@ +openstack.bare_metal.v1.chassis +=============================== + +.. automodule:: openstack.bare_metal.v1.chassis + +The Chassis Class +----------------- + +The ``Chassis`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.bare_metal.v1.chassis.Chassis + :members: diff --git a/doc/source/users/resources/bare_metal/v1/driver.rst b/doc/source/users/resources/bare_metal/v1/driver.rst new file mode 100644 index 00000000..d45379e3 --- /dev/null +++ b/doc/source/users/resources/bare_metal/v1/driver.rst @@ -0,0 +1,12 @@ +openstack.bare_metal.v1.driver +============================== + +.. automodule:: openstack.bare_metal.v1.driver + +The Driver Class +---------------- + +The ``Driver`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.bare_metal.v1.driver.Driver + :members: diff --git a/doc/source/users/resources/bare_metal/v1/node.rst b/doc/source/users/resources/bare_metal/v1/node.rst new file mode 100644 index 00000000..7900c559 --- /dev/null +++ b/doc/source/users/resources/bare_metal/v1/node.rst @@ -0,0 +1,12 @@ +openstack.bare_metal.v1.Node +============================ + +.. automodule:: openstack.bare_metal.v1.node + +The Node Class +-------------- + +The ``Node`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.bare_metal.v1.node.Node + :members: diff --git a/doc/source/users/resources/bare_metal/v1/port.rst b/doc/source/users/resources/bare_metal/v1/port.rst new file mode 100644 index 00000000..b0ed31b4 --- /dev/null +++ b/doc/source/users/resources/bare_metal/v1/port.rst @@ -0,0 +1,12 @@ +openstack.bare_metal.v1.port +============================ + +.. automodule:: openstack.bare_metal.v1.port + +The Port Class +-------------- + +The ``Port`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.bare_metal.v1.port.Port + :members: diff --git a/doc/source/users/resources/bare_metal/v1/port_group.rst b/doc/source/users/resources/bare_metal/v1/port_group.rst new file mode 100644 index 00000000..3feb4e2f --- /dev/null +++ b/doc/source/users/resources/bare_metal/v1/port_group.rst @@ -0,0 +1,12 @@ +openstack.bare_metal.v1.port_group +================================== + +.. automodule:: openstack.bare_metal.v1.port_group + +The PortGroup Class +------------------- + +The ``PortGroup`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.bare_metal.v1.port_group.PortGroup + :members: