986a6a015f
The Sphinx build was issuing hundreds of warning for duplicate labels. The reason for this was because all of the tables we had were named as .rst files. This would cause Sphinx to process them twice and it would think there were duplicated sections. There were two ways this could be handled: 1) Exclude the tables directory from the docs build. 2) Name the files as they should have always been so they weren't build twice. Given that option 1 just masked the problem, I am implementing this patch using option 2. So, all the tables we are including in our documentation have been named from .rst to .inc and the .. include:: directives that use them have also been updated to use the new file name. Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
160 lines
4.7 KiB
ReStructuredText
160 lines
4.7 KiB
ReStructuredText
===============================
|
|
NexentaEdge NBD & iSCSI drivers
|
|
===============================
|
|
|
|
NexentaEdge is designed from the ground-up to deliver high performance Block
|
|
and Object storage services and limitless scalability to next generation
|
|
OpenStack clouds, petabyte scale active archives and Big Data applications.
|
|
NexentaEdge runs on shared nothing clusters of industry standard Linux
|
|
servers, and builds on Nexenta IP and patent pending Cloud Copy On Write (CCOW)
|
|
technology to break new ground in terms of reliability, functionality and cost
|
|
efficiency.
|
|
|
|
For user documentation, see the
|
|
`Nexenta Documentation Center <https://nexenta.com/products/documentation>`_.
|
|
|
|
|
|
iSCSI driver
|
|
~~~~~~~~~~~~
|
|
|
|
The NexentaEdge cluster must be installed and configured according to the
|
|
relevant Nexenta documentation. A cluster, tenant, bucket must be pre-created,
|
|
as well as an iSCSI service on the NexentaEdge gateway node.
|
|
|
|
The NexentaEdge iSCSI driver is selected using the normal procedures for one
|
|
or multiple back-end volume drivers.
|
|
|
|
You must configure these items for each NexentaEdge cluster that the iSCSI
|
|
volume driver controls:
|
|
|
|
#. Make the following changes on the storage node ``/etc/cinder/cinder.conf``
|
|
file.
|
|
|
|
.. code-block:: ini
|
|
|
|
# Enable Nexenta iSCSI driver
|
|
volume_driver = cinder.volume.drivers.nexenta.nexentaedge.iscsi.NexentaEdgeISCSIDriver
|
|
|
|
# Specify the ip address for Rest API (string value)
|
|
nexenta_rest_address = MANAGEMENT-NODE-IP
|
|
|
|
# Port for Rest API (integer value)
|
|
nexenta_rest_port=8080
|
|
|
|
# Protocol used for Rest calls (string value, default=htpp)
|
|
nexenta_rest_protocol = http
|
|
|
|
# Username for NexentaEdge Rest (string value)
|
|
nexenta_user=USERNAME
|
|
|
|
# Password for NexentaEdge Rest (string value)
|
|
nexenta_password=PASSWORD
|
|
|
|
# Path to bucket containing iSCSI LUNs (string value)
|
|
nexenta_lun_container = CLUSTER/TENANT/BUCKET
|
|
|
|
# Name of pre-created iSCSI service (string value)
|
|
nexenta_iscsi_service = SERVICE-NAME
|
|
|
|
# IP address of the gateway node attached to iSCSI service above or
|
|
# virtual IP address if an iSCSI Storage Service Group is configured in
|
|
# HA mode (string value)
|
|
nexenta_client_address = GATEWAY-NODE-IP
|
|
|
|
|
|
#. Save the changes to the ``/etc/cinder/cinder.conf`` file and
|
|
restart the ``cinder-volume`` service.
|
|
|
|
Supported operations
|
|
--------------------
|
|
|
|
* Create, delete, attach, and detach volumes.
|
|
|
|
* Create, list, and delete volume snapshots.
|
|
|
|
* Create a volume from a snapshot.
|
|
|
|
* Copy an image to a volume.
|
|
|
|
* Copy a volume to an image.
|
|
|
|
* Clone a volume.
|
|
|
|
* Extend a volume.
|
|
|
|
|
|
NBD driver
|
|
~~~~~~~~~~
|
|
|
|
As an alternative to using iSCSI, Amazon S3, or OpenStack Swift protocols,
|
|
NexentaEdge can provide access to cluster storage via a Network Block Device
|
|
(NBD) interface.
|
|
|
|
The NexentaEdge cluster must be installed and configured according to the
|
|
relevant Nexenta documentation. A cluster, tenant, bucket must be pre-created.
|
|
The driver requires NexentaEdge Service to run on Hypervisor (Nova) node.
|
|
The node must sit on Replicast Network and only runs NexentaEdge service, does
|
|
not require physical disks.
|
|
|
|
You must configure these items for each NexentaEdge cluster that the NBD
|
|
volume driver controls:
|
|
|
|
#. Make the following changes on storage node ``/etc/cinder/cinder.conf``
|
|
file.
|
|
|
|
.. code-block:: ini
|
|
|
|
# Enable Nexenta NBD driver
|
|
volume_driver = cinder.volume.drivers.nexenta.nexentaedge.nbd.NexentaEdgeNBDDriver
|
|
|
|
# Specify the ip address for Rest API (string value)
|
|
nexenta_rest_address = MANAGEMENT-NODE-IP
|
|
|
|
# Port for Rest API (integer value)
|
|
nexenta_rest_port = 8080
|
|
|
|
# Protocol used for Rest calls (string value, default=htpp)
|
|
nexenta_rest_protocol = http
|
|
|
|
# Username for NexentaEdge Rest (string value)
|
|
nexenta_rest_user = USERNAME
|
|
|
|
# Password for NexentaEdge Rest (string value)
|
|
nexenta_rest_password = PASSWORD
|
|
|
|
# Path to bucket containing iSCSI LUNs (string value)
|
|
nexenta_lun_container = CLUSTER/TENANT/BUCKET
|
|
|
|
# Path to directory to store symbolic links to block devices
|
|
# (string value, default=/dev/disk/by-path)
|
|
nexenta_nbd_symlinks_dir = /PATH/TO/SYMBOLIC/LINKS
|
|
|
|
|
|
#. Save the changes to the ``/etc/cinder/cinder.conf`` file and
|
|
restart the ``cinder-volume`` service.
|
|
|
|
Supported operations
|
|
--------------------
|
|
|
|
* Create, delete, attach, and detach volumes.
|
|
|
|
* Create, list, and delete volume snapshots.
|
|
|
|
* Create a volume from a snapshot.
|
|
|
|
* Copy an image to a volume.
|
|
|
|
* Copy a volume to an image.
|
|
|
|
* Clone a volume.
|
|
|
|
* Extend a volume.
|
|
|
|
|
|
Driver options
|
|
~~~~~~~~~~~~~~
|
|
|
|
Nexenta Driver supports these options:
|
|
|
|
.. include:: ../../tables/cinder-nexenta_edge.inc
|