|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/iscsi-formula.svg?branch=master :alt: Travis CI Build Status :scale: 100% :target: https://travis-ci.com/saltstack-formulas/iscsi-formula .. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg :alt: Semantic Release :scale: 100% :target: https://github.com/semantic-release/semantic-release
Configure iSCSI targets and initiator on GNU/Linux and FreeBSD.
.. contents:: Table of Contents :depth: 1
See the full SaltStack Formulas installation and usage instructions <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>_.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>_.
If you want to use this formula, please pay attention to the FORMULA file and/or git tag,
which contains the currently released version. This formula is versioned according to Semantic Versioning <http://semver.org/>_.
See Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>_ for more details.
The scope of this formula is Ethernet/Block
.. image:: link-transport-storage-protocols.png :target: https://github.com/saltstack-formulas/iscsi-formula :scale: 15 % :alt: Link/Transport and Storage protocol infographic
Commit message formatting is significant!!
Please see How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>_ for more details.
.. contents:: :local:
iscsi
^^^^^^^^^
Meta-state (This is a state that includes other states).
Deploy iSNS, iSCSI initiator, and iSCSI target packages, manage configuration files and then starts the associated iscsi services.
iscsi.target
^^^^^^^^^^^^^^^^
Install and configure the iSCSI Target service. Supported vendor implementations include-
/etc/ctl.conf for ctld(8) on FreeBSD/etc/target/saveconfig.json` forLIO`` on GNU/Linux/etc/targets.conf for tgt(8) on GNU/Linux/etc/ietd.conf for `ietd(8)`` on GNU/LinuxThe defaults targets are-
The default choice is modifable via the iscsi.target.provider pillar value.
New providers can be introduced via pull request.
iscsi.target.clean
^^^^^^^^^^^^^^^^^^^^^^
Meta-state (This is a state that includes other states).
this state will undo everything performed in the iscsi.target meta-state
in reverse order, i.e.
stops the service,
removes the configuration files and
then uninstalls the package.
iscsi.initiator
^^^^^^^^^^^^^^^^^^^
Install and configure the iSCSI initiator service-
/etc/iscsi.conf for FreeBSD/etc/iscsi/iscsid.conf or ~/.iscsid.conf for Open iSCSI on GNU/Linuxiscsi.initiator.clean
^^^^^^^^^^^^^^^^^^^^^^^^^
Meta-state (This is a state that includes other states).
this state will undo everything performed in the iscsi.initiator
meta-state in reverse order, i.e.
stops the service,
removes the configuration files and
then uninstalls the package.
iscsi.isns
^^^^^^^^^^^^^^
Install and configure iSCSI name service.
iscsi.isns.clean
^^^^^^^^^^^^^^^^^^^^
Meta-state (This is a state that includes other states).
this state will undo everything performed in the iscsi.isns
meta-state in reverse order, i.e.
stops the service,
removes the configuration files and
then uninstalls the package.
.. contents:: :local:
iscsi.target.package
^^^^^^^^^^^^^^^^^^^^^^^^
Install iSCSI target related packages.
iscsi.target.package.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI target related packages.
iscsi.target.config
^^^^^^^^^^^^^^^^^^^^^^^
Install iSCSI target related configuration files.
iscsi.target.config.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI target related configuration files.
iscsi.target.kernel
^^^^^^^^^^^^^^^^^^^^^^^
Load iSCSI target related kernel modules.
iscsi.target.kernel.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unload iSCSI target related kernel modules.
iscsi.target.make
^^^^^^^^^^^^^^^^^^^^^
Make iSCSI related packages from git source on FreeBSD.
iscsi.target.make.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI related package binaries on FreeBSD.
iscsi.target.service
^^^^^^^^^^^^^^^^^^^^^^^^
Install iSCSI target services.
iscsi.target.service.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Stop and disable SCSI target services.
iscsi.initiator.package
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install iSCSI initiator related packages.
iscsi.initiator.package.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI initiator related packages.
iscsi.initiator.config
^^^^^^^^^^^^^^^^^^^^^^^^^^
Install iSCSI initiator related configuration files.
iscsi.initiator.config.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI initiator related configuration files.
iscsi.initiator.kernel
^^^^^^^^^^^^^^^^^^^^^^^^^^
Load iSCSI initiator related kernel modules.
iscsi.initiator.kernel.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unload iSCSI initiator related kernel modules.
iscsi.initiator.make
^^^^^^^^^^^^^^^^^^^^^^^^
Make iSCSI related packages from git source for FreeBSD.
iscsi.initiator.make.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI related package binaries on FreeBSD.
iscsi.initiator.service
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install iSCSI initiator services.
iscsi.initiator.service.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Stop and disable iSCSI initiator services.
iscsi.isns.package
^^^^^^^^^^^^^^^^^^^^^^
Install iSCSI isns packages.
iscsi.isns.package.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI isns packages.
iscsi.isns.config
^^^^^^^^^^^^^^^^^^^^^
Customises iscsi isns configuration.
Requires iscsi.isns.package via include list.
iscsi.isns.config.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove iSCSI isns configuration files.
iscsi.isns.make
^^^^^^^^^^^^^^^^^^^
This state makes iscsi isns services on FreeBSD.
iscsi.isns.make.clean
^^^^^^^^^^^^^^^^^^^^^^^^^
Removes iSCSI isns binaries on FreeBSD.
iscsi.isns.service
^^^^^^^^^^^^^^^^^^^^^^
Start iscsi isns services.
Requires iscsi.isns.config via include list.
iscsi.isns.service.clean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Meta-state (This is a state that includes other states).
this state will undo everything performed in the iscsi.isns meta-state
in reverse order, i.e.
stops the service,
removes the configuration files and
then uninstalls the package.
Linux testing is done with kitchen-salt.
Requirements ^^^^^^^^^^^^
.. code-block:: bash
$ gem install bundler $ bundle install $ bin/kitchen test [platform]
Where [platform] is the platform name defined in kitchen.yml,
e.g. debian-9-2019-2-py3.
bin/kitchen converge
^^^^^^^^^^^^^^^^^^^^^^^^
Creates the docker instance and runs the iscsi main state, ready for testing.
bin/kitchen verify
^^^^^^^^^^^^^^^^^^^^^^
Runs the inspec tests on the actual instance.
bin/kitchen destroy
^^^^^^^^^^^^^^^^^^^^^^^
Removes the docker instance.
bin/kitchen test
^^^^^^^^^^^^^^^^^^^^
Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.
bin/kitchen login
^^^^^^^^^^^^^^^^^^^^^
Gives you SSH access to the instance for manual testing.