We have three populated sections: - install - user - reference There are three docs removed, as they served little useful purpose and were mostly unreferenced. Sphinx's 'warning-is-error' option is enabled to catch the few issues that has snuck into the docs. Change-Id: I04e426faf337f0b03175f439c80b3369d4066733
1.1 KiB
1.1 KiB
Tutorial
This tutorial is intended as an introduction to working with os-brick.
Prerequisites
Before we start, make sure that you have the
os-brick distribution installed </install/index>. In the Python shell,
the following should run without raising an exception:
>>> import os_brickFetch all of the initiator information from the host
An example of how to collect the initiator information that is needed to export a volume to this host.
from os_brick.initiator import connector
# what helper do you want to use to get root access?
root_helper = "sudo"
# The ip address of the host you are running on
my_ip = "192.168.1.1"
# Do you want to support multipath connections?
multipath = True
# Do you want to enforce that multipath daemon is running?
enforce_multipath = False
initiator = connector.get_connector_properties(root_helper, my_ip,
multipath,
enforce_multipath)