]> git.proxmox.com Git - ceph.git/blame - ceph/doc/cephadm/services/iscsi.rst
import ceph 16.2.7
[ceph.git] / ceph / doc / cephadm / services / iscsi.rst
CommitLineData
f67539c2
TL
1=============
2iSCSI Service
3=============
4
5.. _cephadm-iscsi:
6
7Deploying iSCSI
8===============
9
10To deploy an iSCSI gateway, create a yaml file containing a
11service 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
33For 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
f67539c2
TL
47 ssl_cert: |
48 -----BEGIN CERTIFICATE-----
49 MIIDtTCCAp2gAwIBAgIYMC4xNzc1NDQxNjEzMzc2MjMyXzxvQ7EcMA0GCSqGSIb3
50 DQEBCwUAMG0xCzAJBgNVBAYTAlVTMQ0wCwYDVQQIDARVdGFoMRcwFQYDVQQHDA5T
51 [...]
52 -----END CERTIFICATE-----
53 ssl_key: |
54 -----BEGIN PRIVATE KEY-----
55 MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC5jdYbjtNTAKW4
56 /CwQr/7wOiLGzVxChn3mmCIF3DwbL/qvTFTX2d8bDf6LjGwLYloXHscRfxszX/4h
57 [...]
58 -----END PRIVATE KEY-----
59
a4b75251
TL
60.. py:currentmodule:: ceph.deployment.service_spec
61
62.. autoclass:: IscsiServiceSpec
63 :members:
64
f67539c2
TL
65
66The specification can then be applied using:
67
68.. prompt:: bash #
69
70 ceph orch apply -i iscsi.yaml
71
72
73See :ref:`orchestrator-cli-placement-spec` for details of the placement specification.
a4b75251
TL
74
75See also: :ref:`orchestrator-cli-service-spec`.
76
77Further Reading
78===============
79
80* RBD: :ref:`ceph-iscsi`