Deploy the S3 Object Browser through the Ceph Dashboard

Deploy the S3 Object Browser by creating and managing a service in the IBM Storage Ceph Dashboard.

Before you begin

Before you begin, make sure that you have the following prerequisites in place:

  • Access to the Ceph Dashboard with sufficient permissions to create services
  • Configured Ceph Object Gateway (RGW) service
  • S3 access key and secret key.

    To get the key, from the Ceph Dashboard, go to User Management, select the user account and click Show S3 Key. The access and secret keys can be copied.

  • A prepared storage environment that meets the required configuration

About this task

Important: Deploying the IBM Storage Ceph S3 Object Browser service through the Ceph Dashboard is only supported on nodes that are part of the Ceph cluster. For systems that are not part of the cluster, deploy the S3 Object Browser as a standalone container by using the CLI method.

For standalone deployment information, see Deploy the S3 Object Browser as a standalone container.

You can deploy the S3 Object Browser by creating a service in the Ceph Dashboard. The dashboard manages the deployment of the Object Browser as a containerized service.

For more information about the Ceph Dashboard, see Dashboard in IBM Storage Ceph documentation.

Procedure

Complete all steps through the Ceph Dashboard, unless otherwise indicated.
  1. Verify that the Ceph Object Gateway (rgw) service is running.
    Go to Administration > Services, expand rgw.DAEMON, and confirm that all daemons are running.
  2. Verify gateway availability.
    Go to Object > Gateways and confirm that gateways are available.
  3. Verify that Cross-Origin Resource Sharing (CORS) is configured on the Ceph Object Gateway.
    ceph dashboard set-object-browser-image OBJECT_IMAGE 
    For example,
    ceph dashboard set-object-browser-image cp.stg.icr.io/cp/ibm-ceph/object-browser:1.0.0"
  4. Restart the Ceph Object Gateway service.
    ceph orch restart rgw.DAEMON
  5. Verify that updated CORS values appear in the configuration table.
    Go to Administration > Configuration.
  6. Create the Object Browser service.
    Go to Administration > Services and click Create.
  7. Configure the service.
    Select object-browser from the Type drop-down.

    Fill in any required fields, including the the access key, secret key, and Endpoint URL information.

  8. Click Create service.
    A notification confirms that the service is created.
  9. Optional: Verify that the service is created, from the CLI.
    1. Verify that the image is listed in the output of the podman ps command.
    2. Verify that the service is listed in the output of the ceph orch ls command.

What to do next

After the new object-browser service is created, verify that the service is running. If needed, refresh the status.

You can now access the IBM Storage Ceph S3 Object Browser.

After deployment, access the Object Browser by using the URL assigned to the service. The URL includes the host and port configured during deployment. For detailed access information, see Access the S3 Object Browser.