Initial docs for bare-metal service
Change-Id: Ie7304ef5272869060d520c23181f19de81da5006
This commit is contained in:
		
							
								
								
									
										9
									
								
								doc/source/users/guides/bare_metal.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								doc/source/users/guides/bare_metal.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -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 | ||||
| @@ -28,6 +28,7 @@ approach, this is where you'll want to begin. | ||||
|    Connect to an OpenStack Cloud <guides/connect> | ||||
|    Connect to an OpenStack Cloud Using a Config File <guides/connect_from_config> | ||||
|    Logging <guides/logging> | ||||
|    Bare Metal <guides/bare_metal> | ||||
|    Block Store <guides/block_store> | ||||
|    Cluster <guides/cluster> | ||||
|    Compute <guides/compute> | ||||
| @@ -69,6 +70,7 @@ but listed below are the ones provided by this SDK by default. | ||||
| .. toctree:: | ||||
|    :maxdepth: 1 | ||||
|  | ||||
|    Bare Metal <proxies/bare_metal> | ||||
|    Block Store <proxies/block_store> | ||||
|    Cluster <proxies/cluster> | ||||
|    Compute <proxies/compute> | ||||
| @@ -96,6 +98,7 @@ The following services have exposed *Resource* classes. | ||||
| .. toctree:: | ||||
|    :maxdepth: 1 | ||||
|  | ||||
|    Bare Metal <resources/bare_metal/index> | ||||
|    Block Store <resources/block_store/index> | ||||
|    Cluster <resources/cluster/index> | ||||
|    Compute <resources/compute/index> | ||||
|   | ||||
							
								
								
									
										16
									
								
								doc/source/users/proxies/bare_metal.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								doc/source/users/proxies/bare_metal.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -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: | ||||
							
								
								
									
										11
									
								
								doc/source/users/resources/bare_metal/index.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								doc/source/users/resources/bare_metal/index.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,11 @@ | ||||
| Bare Metal Resources | ||||
| ===================== | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 1 | ||||
|  | ||||
|    v1/driver | ||||
|    v1/chassis | ||||
|    v1/node | ||||
|    v1/port | ||||
|    v1/portgroup | ||||
							
								
								
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/chassis.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/chassis.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -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: | ||||
							
								
								
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/driver.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/driver.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -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: | ||||
							
								
								
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/node.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/node.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -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: | ||||
							
								
								
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/port.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/port.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -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: | ||||
							
								
								
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/port_group.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								doc/source/users/resources/bare_metal/v1/port_group.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -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: | ||||
		Reference in New Issue
	
	Block a user
	 tengqm
					tengqm