ceph/doc/rbd/iscsi-target-cli-manual-install.rst

   1 ==================================
   2 Manual ceph-iscsi-cli Installation
   3 ==================================
   4
   5 **Requirements**
   6
   7 The following packages will be used by ceph-iscsi-cli and target tools.
   8 They must be installed from your Linux distribution's software repository
   9 on each machine that will be a iSCSI gateway:
  10
  11 -  libnl3
  12 -  libkmod
  13 -  librbd1
  14 -  pyparsing
  15 -  python kmod
  16 -  python pyudev
  17 -  python gobject
  18 -  python kmod
  19 -  python pyudev
  20 -  python gobject
  21 -  python urwid
  22 -  python pyparsing
  23 -  python rados
  24 -  python rbd
  25 -  python netaddr
  26 -  python netifaces
  27 -  python crypto
  28 -  python requests
  29 -  python flask
  30 -  pyOpenSSL
  31
  32 **Packages**
  33
  34 -  Linux Kernel
  35
  36    If not using a distro kernel that contains the required Ceph iSCSI patches,
  37    then Linux kernel v4.17 or newer or the ceph-client ceph-iscsi-test
  38    branch must be used. To get the branch run:
  39
  40    ::
  41
  42        > git clone https://github.com/ceph/ceph-client.git
  43        > git checkout ceph-iscsi-test
  44
  45    .. warning::
  46        ceph-iscsi-test is not for production use. It should only be used
  47        for proof of concept setups and testing. The kernel is only updated
  48        with Ceph iSCSI patches. General security and bug fixes from upstream
  49        are not applied.
  50
  51    Check your distro's docs for specific instructions on how to build a
  52    kernel. The only Ceph iSCSI specific requirements are the following
  53    build options must be enabled:
  54
  55    ::
  56
  57        CONFIG_TARGET_CORE=m
  58        CONFIG_TCM_USER2=m
  59        CONFIG_ISCSI_TARGET=m
  60
  61 -  tcmu-runner
  62
  63    Installation:
  64
  65    ::
  66
  67        > git clone https://github.com/open-iscsi/tcmu-runner
  68        > cd tcmu-runner
  69
  70    Ceph iSCSI requires systemd so the following build command must be used:
  71
  72    ::
  73
  74        > cmake -Dwith-glfs=false -Dwith-qcow=false -DSUPPORT_SYSTEMD=ON -DCMAKE_INSTALL_PREFIX=/usr
  75        > make install
  76
  77    Enable and start the daemon:
  78
  79    ::
  80
  81        > systemctl daemon-reload
  82        > systemctl enable tcmu-runner
  83        > systemctl start tcmu-runner
  84
  85 -  rtslib-fb
  86
  87    Installation:
  88
  89    ::
  90
  91        > git clone https://github.com/open-iscsi/rtslib-fb.git
  92        > cd rtslib-fb
  93        > python setup.py install
  94
  95 -  configshell-fb
  96
  97    Installation:
  98
  99    ::
 100
 101        > git clone https://github.com/open-iscsi/configshell-fb.git
 102        > cd configshell-fb
 103        > python setup.py install
 104
 105 -  targetcli-fb
 106
 107    Installation:
 108
 109    ::
 110
 111        > git clone https://github.com/open-iscsi/targetcli-fb.git
 112        > cd targetcli-fb
 113        > python setup.py install
 114        > mkdir /etc/target
 115        > mkdir /var/target
 116
 117    .. warning:: The ceph-iscsi tools assume they are managing all targets
 118       on the system. If targets have been setup and are being managed by
 119       targetcli the target service must be disabled.
 120
 121 -  ceph-iscsi-config
 122
 123    Installation:
 124
 125    ::
 126
 127        > git clone https://github.com/ceph/ceph-iscsi-config.git
 128        > cd ceph-iscsi-config
 129        > python setup.py install
 130        > cp usr/lib/systemd/system/rbd-target-gw.service /lib/systemd/system
 131
 132    Enable and start the daemon:
 133
 134    ::
 135
 136        > systemctl daemon-reload
 137        > systemctl enable rbd-target-gw
 138        > systemctl start rbd-target-gw
 139
 140 -  ceph-iscsi-cli
 141
 142    Installation:
 143
 144    ::
 145
 146        > git clone https://github.com/ceph/ceph-iscsi-cli.git
 147        > cd ceph-iscsi-cli
 148        > python setup.py install
 149        > cp usr/lib/systemd/system/rbd-target-api.service /lib/systemd/system
 150
 151
 152 Installation is complete. Proceed to the setup section in the
 153 `main ceph-iscsi-cli page`_.
 154
 155 .. _`main ceph-iscsi-cli page`: ../iscsi-target-cli