Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 12. Management of iSCSI gateway using the Ceph Orchestrator (Limited Availability)

As a storage administrator, you can use Ceph Orchestrator to deploy the iSCSI gateway. The iSCSI Gateway presents a Highly Available (HA) iSCSI target that exports RADOS Block Device (RBD) images as SCSI disks.

You can deploy an iSCSI gateway by either using the placement specification or the service specification, like an YAML file.

Note

This technology is Limited Availability. See the Deprecated functionality chapter for additional information.

This section covers the following administrative tasks:

12.1. Prerequisites
Copy link

  • A running Red Hat Ceph Storage cluster.
  • Root-level access to all the nodes.
  • Hosts are added to the cluster.
  • All manager, monitor and OSD daemons are deployed.

Using the Ceph Orchestrator, you can deploy the iSCSI gateway using the ceph orch command in the command line interface.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • Hosts are added to the cluster.
  • All manager, monitor and OSD daemons are deployed.

Procedure

  1. Log into the Cephadm shell:

    Example

    [root@host01 ~]# cephadm shell
    Copy to Clipboard Toggle word wrap

  2. Create the pool:

    Syntax

    ceph osd pool create POOL_NAME
    Copy to Clipboard Toggle word wrap

    Example

    [ceph: root@host01 /]# ceph osd pool create mypool
    Copy to Clipboard Toggle word wrap

  3. Deploy iSCSI gateway using command line interface:

    Syntax

    ceph orch apply iscsi POOLNAME admin admin --placement="NUMBER_OF_DAEMONS HOST_NAME_1 HOST_NAME_2"
    Copy to Clipboard Toggle word wrap

    Example

    [ceph: root@host01 /]# ceph orch apply iscsi mypool admin admin --placement="1 host01"
    Copy to Clipboard Toggle word wrap

Verification

  • List the service:

    Example

    [ceph: root@host01 /]# ceph orch ls
    Copy to Clipboard Toggle word wrap

  • List the hosts and process:

    Syntax

    ceph orch ps --daemon_type=DAEMON_NAME
    Copy to Clipboard Toggle word wrap

    Example

    [ceph: root@host01 /]# ceph orch ps --daemon_type=iscsi
    Copy to Clipboard Toggle word wrap

Using the Ceph Orchestrator, you can deploy the iSCSI gateway using the service specification.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • Hosts are added to the cluster.
  • All manager, monitor and OSD daemons are deployed.

Procedure

  1. Create the iscsi.yml file:

    Example

    [root@host01 ~]# touch iscsi.yml
    Copy to Clipboard Toggle word wrap

  2. Edit the iscsi.yml file to include the following details:

    Syntax

    service_type: iscsi
service_id: iscsi
placement:
  hosts:
    - HOST_NAME_1
    - HOST_NAME_2
spec:
  pool: POOL_NAME  # RADOS pool where ceph-iscsi config data is stored.
  trusted_ip_list: "IP_ADDRESS_1,IP_ADDRESS_2" # optional
  api_port: ... # optional
  api_user: API_USERNAME # optional
  api_password: API_PASSWORD # optional
  api_secure: true/false # optional
  ssl_cert: | # optional
  ...
  ssl_key: | # optional
  ...
    Copy to Clipboard Toggle word wrap

    Example

    service_type: iscsi
service_id: iscsi
placement:
  hosts:
    - host01
spec:
  pool: mypool
    Copy to Clipboard Toggle word wrap

  3. Mount the YAML file under a directory in the container:

    Example

    [root@host01 ~]# cephadm shell --mount iscsi.yaml:/var/lib/ceph/iscsi.yaml
    Copy to Clipboard Toggle word wrap

  4. Navigate to the following directory:

    Syntax

    cd /var/lib/ceph/DAEMON_PATH/
    Copy to Clipboard Toggle word wrap

    Example

    [ceph: root@host01 /]# cd /var/lib/ceph/
    Copy to Clipboard Toggle word wrap

  5. Deploy iSCSI gateway using service specification:

    Syntax

    ceph orch apply -i FILE_NAME.yml
    Copy to Clipboard Toggle word wrap

    Example

    [ceph: root@host01 iscsi]# ceph orch apply -i iscsi.yml
    Copy to Clipboard Toggle word wrap

Verification

  • List the service:

    Example

    [ceph: root@host01 /]# ceph orch ls
    Copy to Clipboard Toggle word wrap

  • List the hosts, daemons, and processes:

    Syntax

    ceph orch ps --daemon_type=DAEMON_NAME
    Copy to Clipboard Toggle word wrap

    Example

    [ceph: root@host01 /]# ceph orch ps --daemon_type=iscsi
    Copy to Clipboard Toggle word wrap

You can remove the iSCSI gateway daemons using the ceph orch rm command.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • Root-level access to all the nodes.
  • Hosts are added to the cluster.
  • At least one iSCSI gateway daemon deployed on the hosts.

Procedure

  1. Log into the Cephadm shell:

    Example

    [root@host01 ~]# cephadm shell
    Copy to Clipboard Toggle word wrap

  2. List the service:

    Example

    [ceph: root@host01 /]# ceph orch ls
    Copy to Clipboard Toggle word wrap

    1. Remove the service

      Syntax

      ceph orch rm SERVICE_NAME
      Copy to Clipboard Toggle word wrap

      Example

      [ceph: root@host01 /]# ceph orch rm iscsi.iscsi
      Copy to Clipboard Toggle word wrap

Verification

  • List the hosts, daemons, and processes:

    Syntax

    ceph orch ps
    Copy to Clipboard Toggle word wrap

    Example

    [ceph: root@host01 /]# ceph orch ps
    Copy to Clipboard Toggle word wrap

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat