Difference between revisions of "ISCSI Target"

From ArchWiki
Jump to: navigation, search
(Setup with LIO Target: update for new versions of targetcli-fb)
m (add ja link)
 
(12 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
[[Category:Storage]]
 
[[Category:Storage]]
 
[[Category:Networking]]
 
[[Category:Networking]]
{{Article summary start}}
+
[[ja:ISCSI ターゲット]]
{{Article summary text|How to set up an iSCSI Target using different tools.}}
+
[[zh-CN:ISCSI Target]]
{{Article summary heading|Series}}
+
{{Related articles start}}
{{Article summary wiki|iSCSI Target}}
+
{{Related|iSCSI Initiator}}
{{Article summary wiki|iSCSI Initiator}}
+
{{Related|iSCSI Boot}}
{{Article summary heading|Related}}
+
{{Related articles end}}
{{Article summary wiki|iSCSI Boot}}
+
With [[Wikipedia:iSCSI|iSCSI]] you can access storage over an IP-based network.
{{Article summary end}}
+
  
With [[Wikipedia:iSCSI]] you can access storage over an IP-based network.
+
The exported storage entity is the '''target''' and the importing entity is the '''[[iSCSI Initiator|initiator]]'''. There are different modules available to set up the target:
 
+
* The [http://stgt.berlios.de/ SCSI Target Framework (STGT/TGT)] was the standard before linux 2.6.38.
The exported storage entity is the '''target''' and the importing entity is the '''[[iSCSI Initiator|initiator]]'''.
+
* The current standard is the [http://linux-iscsi.org/ LIO target].
 
+
* The [http://iscsitarget.sourceforge.net/ iSCSI Enterprise Target (IET)] is an old implementation and [http://scst.sourceforge.net/ SCSI Target Subsystem (SCST)] is the successor of IET and was a possible candidate for kernel inclusion before the decision fell for LIO.
There are different modules available to set up the target.
+
The [http://stgt.berlios.de/ SCSI Target Framework (STGT/TGT)] was the standard before linux 2.6.38.
+
The current standard is the [http://linux-iscsi.org/ LIO target].
+
The [http://iscsitarget.sourceforge.net/ iSCSI Enterprise Target (IET)] is an old implementation and [http://scst.sourceforge.net/ SCSI Target Subsystem (SCST)] is the successor of IET and was a possible candidate for kernel inclusion before the decision fell for LIO.
+
 
+
There are packages available for LIO, STGT and IET in the [[AUR]] (see below).
+
  
 
== Setup with LIO Target ==
 
== Setup with LIO Target ==
Line 26: Line 19:
 
The important kernel modules are ''target_core_mod'' and ''iscsi_target_mod'', which should be in the kernel and loaded automatically.
 
The important kernel modules are ''target_core_mod'' and ''iscsi_target_mod'', which should be in the kernel and loaded automatically.
  
It is highly recommended to use the free branch versions of the packages: {{AUR|targetcli-fb}}, {{AUR|python-rtslib-fb}} and {{AUR|python-configshell-fb}}. The original {{AUR|targetcli}} is also available but has a different way of saving the configuration using the deprecated ''lio-utils'' and depends on ''epydoc''.
+
It is highly recommended to use the free branch versions of the packages: {{AUR|targetcli-fb}}, {{AUR|python-rtslib-fb}} and {{AUR|python-configshell-fb}}. The original {{AUR|targetcli}}{{Broken package link|{{aur-mirror|targetcli}}}} is also available but has a different way of saving the configuration using the deprecated ''lio-utils'' and depends on ''epydoc''.
  
A systemd {{ic|target.service}} is included in {{AUR|python3-rtslib-fb}} when you use the free branch and a {{ic|/etc/rc.d/target}} in {{AUR|lio-utils}} when you use the original ''targetcli'' or ''lio-utils'' directly.
+
A systemd {{ic|target.service}} is included in {{AUR|python-rtslib-fb}} when you use the free branch and a {{ic|/etc/rc.d/target}} in {{AUR|lio-utils}}{{Broken package link|{{aur-mirror|lio-utils}}}} when you use the original ''targetcli'' or ''lio-utils'' directly.
  
 
You start LIO target with {{bc|# systemctl start target}}
 
You start LIO target with {{bc|# systemctl start target}}
Line 35: Line 28:
 
With {{bc|# targetcli status}} you can show some information about the running configuration (only with the free branch).
 
With {{bc|# targetcli status}} you can show some information about the running configuration (only with the free branch).
  
You might want to enable the lio target on boot with {{bc|# systemctl enable target}}.
+
You might want to enable the lio target on boot with {{bc|# systemctl enable target}}
  
 
You can use '''targetcli''' to create the whole configuration or you can alternatively use the '''lio utils''' tcm_* and lio_* directly (deprecated).
 
You can use '''targetcli''' to create the whole configuration or you can alternatively use the '''lio utils''' tcm_* and lio_* directly (deprecated).
Line 45: Line 38:
 
At any point in the shell you can type {{ic|help}} in order to see what commands you can issue here.
 
At any point in the shell you can type {{ic|help}} in order to see what commands you can issue here.
 
{{Tip|You can use tab-completion in this shell}}
 
{{Tip|You can use tab-completion in this shell}}
 +
{{Tip|You can type {{ic|cd}} in this shell to view & select paths}}
  
 
After starting the target (see above) you enter the configuration shell with {{bc|# targetcli}}
 
After starting the target (see above) you enter the configuration shell with {{bc|# targetcli}}
Line 55: Line 49:
  
 
In order to tell LIO that your block device should get used as ''backstore'' for the target you issue
 
In order to tell LIO that your block device should get used as ''backstore'' for the target you issue
 +
{{Note|Remember that you can type {{ic|cd}} to select the path of your <iqn>/tpg1}}
 
{{bc|.../tpg1> cd luns<br>.../tpg1/luns> create /backstores/block/md_block0}}
 
{{bc|.../tpg1> cd luns<br>.../tpg1/luns> create /backstores/block/md_block0}}
  
Line 89: Line 84:
 
  ...> get auth
 
  ...> get auth
 
will show you the current authentication credentials.
 
will show you the current authentication credentials.
  ...> set auth userid=foo
+
  ...> set auth userid=<username in target>
  ...> set auth password=bar
+
  ...> set auth password=<password in target>
Would enable authentication with foo:bar.
+
...> set auth mutual_userid=<username in initiator>  (optional)
 +
...> set auth mutual_password=<password in initiator>  (optional)
 +
 
 +
The first two fields are the username and password of the target. The initiator will use this to log into the target. The last two fields (prefixed with "mutual_") are the username and password of the initiators (note that all initiators will have the same username and password). These two are optional parameters and it ensures that initiators will only accept connections from permitted targets.
  
 
=== Using (plain) LIO utils ===
 
=== Using (plain) LIO utils ===
You have to install {{AUR|lio-utils}} from [[AUR]] and the dependencies (python2).
+
You have to install {{AUR|lio-utils}}{{Broken package link|{{aur-mirror|lio-utils}}}} from [[AUR]] and the dependencies (python2).
  
 
=== Tips & Tricks ===
 
=== Tips & Tricks ===
Line 110: Line 108:
  
 
== Setup with iSCSI Enterprise Target (IET) ==
 
== Setup with iSCSI Enterprise Target (IET) ==
You will need {{AUR|iscsitarget-kernel}} and {{AUR|iscsitarget-usr}} from [[AUR]].
+
You will need {{AUR|iscsitarget-kernel}}{{Broken package link|{{aur-mirror|iscsitarget-kernel}}}} and {{AUR|iscsitarget-usr}}{{Broken package link|{{aur-mirror|iscsitarget-usr}}}} from [[AUR]].
  
 
=== Create the Target ===  
 
=== Create the Target ===  
Line 128: Line 126:
  
 
=== Start server services ===
 
=== Start server services ===
 +
{{Out of date|Mentions rc.d scripts and rc.conf.}}
 
  rc.d start iscsi-target
 
  rc.d start iscsi-target
  

Latest revision as of 10:02, 28 November 2016

Related articles

With iSCSI you can access storage over an IP-based network.

The exported storage entity is the target and the importing entity is the initiator. There are different modules available to set up the target:

Setup with LIO Target

LIO target is included in the kernel since 2.6.38. However, the iSCSI target fabric is included since linux 3.1.

The important kernel modules are target_core_mod and iscsi_target_mod, which should be in the kernel and loaded automatically.

It is highly recommended to use the free branch versions of the packages: targetcli-fbAUR, python-rtslib-fbAUR and python-configshell-fbAUR. The original targetcliAUR[broken link: archived in aur-mirror] is also available but has a different way of saving the configuration using the deprecated lio-utils and depends on epydoc.

A systemd target.service is included in python-rtslib-fbAUR when you use the free branch and a /etc/rc.d/target in lio-utilsAUR[broken link: archived in aur-mirror] when you use the original targetcli or lio-utils directly.

You start LIO target with
# systemctl start target

This will load necessary modules, mount the configfs and load previously saved iscsi target configuration.

With
# targetcli status
you can show some information about the running configuration (only with the free branch). You might want to enable the lio target on boot with
# systemctl enable target

You can use targetcli to create the whole configuration or you can alternatively use the lio utils tcm_* and lio_* directly (deprecated).

Using targetcli

The external manual is only available in the free branch. targetd is not in AUR yet, but this depends on the free branch.

The config shell creates most names and numbers for you automatically, but you can also provide your own settings. At any point in the shell you can type help in order to see what commands you can issue here.

Tip: You can use tab-completion in this shell
Tip: You can type cd in this shell to view & select paths
After starting the target (see above) you enter the configuration shell with
# targetcli

In this shell you include a block device (here: /dev/disk/by-id/md-name-nas:iscsi) to use with

/> cd backstores/block
/backstores/block> create md_block0 /dev/disk/by-id/md-name-nas:iscsi
Note: You can use any block device, also raid and lvm devices. You can also use files when you go to fileio instead of block.
You then create an iSCSI Qualified Name (iqn) and a target portal group (tpg) with
...> cd /iscsi
/iscsi> create
Note: With appending an iqn of your choice to create you can keep targetcli from automatically creating an iqn

In order to tell LIO that your block device should get used as backstore for the target you issue

Note: Remember that you can type cd to select the path of your <iqn>/tpg1
.../tpg1> cd luns
.../tpg1/luns> create /backstores/block/md_block0

Then you need to create a portal, making a daemon listen for incoming connections:

.../luns/lun0> cd ../../portals
.../portals> create

Targetcli will tell you the IP and port where LIO is listening for incoming connections (defaults to 0.0.0.0 (all)). You will need at least the IP for the clients. The port should be the standard port 3260.

In order for a client/initiator to connect you need to include the iqn of the initiator in the target configuration:

...> cd ../../acls
.../acls> create iqn.2005-03.org.open-iscsi:SERIAL

Instead of iqn.2005-03.org.open-iscsi:SERIAL you use the iqn of an initiator. It can normally be found in /etc/iscsi/initiatorname.iscsi. You have to do this for every initiator that needs to connect. Targetcli will automatically map the created lun to the newly created acl.

Note: You can change the mapped luns and whether the access should be rw or ro. See help create at this point in the targetcli shell.

The last thing you have to do in targetcli when everything works is saving the configuration with:

...> cd /
/> saveconfig

The will the configuration in /etc/target/saveconfig.json. You can now safely start and stop target.service without losing your configuration.

Tip: You can give a filename as a parameter to saveconfig and also clear a configuration with clearconfig

Authentication

Authentication per CHAP is enabled per default for your targets. You can either setup passwords or disable this authentication.

Disable Authentication

Navigate targetcli to your target (i.e. /iscsi/iqn.../tpg1) and

.../tpg1> set attribute authentication=0
Warning: With this setting everybody that knows the iqn of one of your clients (initiators) can access the target. This is for testing or home purposes only.
Set Credentials

Navigate to a certain acl of your target (i.e. /iscsi/iqn.../tpg1/acls/iqn.../) and

...> get auth

will show you the current authentication credentials.

...> set auth userid=<username in target>
...> set auth password=<password in target>
...> set auth mutual_userid=<username in initiator>  (optional)
...> set auth mutual_password=<password in initiator>  (optional)

The first two fields are the username and password of the target. The initiator will use this to log into the target. The last two fields (prefixed with "mutual_") are the username and password of the initiators (note that all initiators will have the same username and password). These two are optional parameters and it ensures that initiators will only accept connections from permitted targets.

Using (plain) LIO utils

You have to install lio-utilsAUR[broken link: archived in aur-mirror] from AUR and the dependencies (python2).

Tips & Tricks

  • With targetcli sessions you can list the current open sessions. This command is included in the targetcli-fbAUR package, but not in lio-utils or the original targetcli.

Upstream Documentation

Setup with SCSI Target Framework (STGT/TGT)

You will need the Package tgtAUR from AUR.

See: TGT iSCSI Target

Setup with iSCSI Enterprise Target (IET)

You will need iscsitarget-kernelAUR[broken link: archived in aur-mirror] and iscsitarget-usrAUR[broken link: archived in aur-mirror] from AUR.

Create the Target

Modify /etc/iet/ietd.conf accordingly

Hard Drive Target

Target iqn.2010-06.ServerName:desc
Lun 0 Path=/dev/sdX,Type=blockio

File based Target

Use "dd" to create a file of the required size, this example is 10GB.

dd if=/dev/zero of=/root/os.img bs=1G count=10
Target iqn.2010-06.ServerName:desc
Lun 0 Path=/root/os.img,Type=fileio

Start server services

Tango-view-refresh-red.pngThis article or section is out of date.Tango-view-refresh-red.png

Reason: Mentions rc.d scripts and rc.conf. (Discuss in Talk:ISCSI Target#)
rc.d start iscsi-target

Also you can "iscsi-target" to DAEMONS in /etc/rc.conf so that it starts up during boot.

See also