ceph/doc/cephadm/iscsi.rst

   1 =============
   2 iSCSI Service
   3 =============
   4
   5 .. _cephadm-iscsi:
   6
   7 Deploying iSCSI
   8 ===============
   9
  10 To deploy an iSCSI gateway, create a yaml file containing a
  11 service specification for iscsi:
  12
  13 .. code-block:: yaml
  14
  15     service_type: iscsi
  16     service_id: iscsi
  17     placement:
  18       hosts:
  19         - host1
  20         - host2
  21     spec:
  22       pool: mypool  # RADOS pool where ceph-iscsi config data is stored.
  23       trusted_ip_list: "IP_ADDRESS_1,IP_ADDRESS_2"
  24       api_port: ... # optional
  25       api_user: ... # optional
  26       api_password: ... # optional
  27       api_secure: true/false # optional
  28       ssl_cert: | # optional
  29         ...
  30       ssl_key: | # optional
  31         ...
  32
  33 For example:
  34
  35 .. code-block:: yaml
  36
  37     service_type: iscsi
  38     service_id: iscsi
  39     placement:
  40       hosts:
  41       - [...]
  42     spec:
  43       pool: iscsi_pool
  44       trusted_ip_list: "IP_ADDRESS_1,IP_ADDRESS_2,IP_ADDRESS_3,..."
  45       api_user: API_USERNAME
  46       api_password: API_PASSWORD
  47       api_secure: true
  48       ssl_cert: |
  49         -----BEGIN CERTIFICATE-----
  50         MIIDtTCCAp2gAwIBAgIYMC4xNzc1NDQxNjEzMzc2MjMyXzxvQ7EcMA0GCSqGSIb3
  51         DQEBCwUAMG0xCzAJBgNVBAYTAlVTMQ0wCwYDVQQIDARVdGFoMRcwFQYDVQQHDA5T
  52         [...]
  53         -----END CERTIFICATE-----
  54       ssl_key: |
  55         -----BEGIN PRIVATE KEY-----
  56         MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC5jdYbjtNTAKW4
  57         /CwQr/7wOiLGzVxChn3mmCIF3DwbL/qvTFTX2d8bDf6LjGwLYloXHscRfxszX/4h
  58         [...]
  59         -----END PRIVATE KEY-----
  60
  61
  62 The specification can then be applied using:
  63
  64 .. prompt:: bash #
  65
  66    ceph orch apply -i iscsi.yaml
  67
  68
  69 See :ref:`orchestrator-cli-placement-spec` for details of the placement specification.