Documentation #49488: Document service specs for iSCSI deployment - Orchestrator - Ceph

Actions

Copy link

Documentation #49488

closed

Document service specs for iSCSI deployment

Added by Tim Serong about 3 years ago. Updated about 3 years ago.

Status:

Resolved

Priority:

Normal

Assignee:

Category:

Target version:

% Done:

Tags:

Backport:

Reviewed:

Affected Versions:

Pull request ID:

Description

There's currently no documentation on how to deploy iSCSI gateways (or, if there is, I can't find it beyond what's listed in the API documentation at https://docs.ceph.com/en/latest/api/mon_command_api/?highlight=iscsi#orch-apply-iscsi). We should at least add an example service spec somewhere which includes all possible parameters, e.g.:

service_type: iscsi
service_id: SERVICE_ID
placement:
  hosts:
  - [...]
spec:
  pool: ISCSI_POOL
  trusted_ip_list: "IP_ADDRESS_1,IP_ADDRESS_2,IP_ADDRESS_3,..." 
  api_user: API_USERNAME
  api_password: API_PASSWORD
  api_secure: true
  ssl_cert: |
    -----BEGIN CERTIFICATE-----
    MIIDtTCCAp2gAwIBAgIYMC4xNzc1NDQxNjEzMzc2MjMyXzxvQ7EcMA0GCSqGSIb3
    DQEBCwUAMG0xCzAJBgNVBAYTAlVTMQ0wCwYDVQQIDARVdGFoMRcwFQYDVQQHDA5T
    [...]
    -----END CERTIFICATE-----
  ssl_key: |
    -----BEGIN PRIVATE KEY-----
    MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC5jdYbjtNTAKW4
    /CwQr/7wOiLGzVxChn3mmCIF3DwbL/qvTFTX2d8bDf6LjGwLYloXHscRfxszX/4h
    [...]
    -----END PRIVATE KEY-----