Sunday, June 14, 2026
HomeCloud ComputingThe best way to join customized S3 storage to VMware Cloud Director...

The best way to join customized S3 storage to VMware Cloud Director Object Storage Extension

[ad_1]

VMware Object Storage Extension (OSE) is a plugin that helps you connect S3 appropriate storage to VMware Cloud Director. The at present supported S3 object storage platforms are Cloudian Hyperstore, Dell ECS, and Amazon S3.

To develop the mixing of appropriate S3 storage platforms with Cloud Director, OSE has launched OSIS (Object Storage Interoperability Service).

The Object Storage Interoperability Service helps you connect your customized S3 storage to Cloud Director and use it to backup your vital unstructured information, vApps, and Catalogs. Since OSE 2.1, it’s also possible to use it for backing up and restoring your Kubernetes clusters!

The best way to join customized S3 storage to VMware Cloud Director Object Storage Extension
Determine 1: OSE Structure and Community Connections

Let’s see
how this works.

OSIS Implementation Course of

Suppose you’ve gotten determined to combine your customized S3 object storage with Cloud Director. In that case, it is advisable have the OSIS adapter developed for the S3 storage that you simply use, then deploy OSIS and configure Object Storage Extension to connect with OSIS. Cloud Director tenants can eat the seller Object Storage in a unified method, no matter the kind of object storage platform that has been carried out.

See the
OSIS workflow within the following diagram.

OSIS Implementation Workflow
Determine 2: OSIS Integration Workflow

OSIS Improvement Requirement

The OSIS adapter must be developed as an API service out there to VMware Cloud Director Object Storage Extension. You may implement OSIS in any programming language and deploy it to any server setting. The one requirement for OSIS is community connectivity. It must be deployed in an intranet that the OSE server can connect with it, and OSIS can connect with the storage platform. See the diagram beneath.

OSIS Network Diagram
Determine 3: OSE Community Diagram

OSIS Development Course of

OSIS must be constructed up programmatically and implement the next necessary APIs.

The APIs are wanted to trade tenant and person info as OSIS connects the S3 storage and OSE.

Let’s now see the entire checklist of necessary APIs that OSIS must implement.

HTTP Technique Request URI Description
HEAD /api/v1/tenants/{tenantId} Checks
whether or not the tenant exists.
PATCH

/api/v1/tenants/{tenantId} Updates
Cloud Director tenant ID of the S3 storage platform tenant.
GET /api/v1/tenants Will get
the tenant.
POST /api/v1/tenants Lists
the tenants of the S3 storage platform.
 
GET /api/v1/tenants/question Queries
the tenants of the S3 storage platform.
 
GET /api/v1/customers/question Queries
customers of the platform tenant.
 
POST /api/v1/tenants/{tenantId}/customers Creates
a person within the platform tenant.
 
GET /api/v1/tenants/{tenantId}/customers Lists
customers of the platform tenant.
 
GET /api/v1/tenants/{tenantId}/customers/{userId} Will get
the person with person ID of the tenant.
 
PATCH /api/v1/tenants/{tenantId}/customers/{userId} Units
allow or disable standing within the tenant.
 
DELETE /api/v1/tenants/{tenantId}/customers/{userId} Deletes
the person within the platform tenant.
 
GET /api/v1/customers/{canonicalUserId} Will get
the person with person canonical ID.
GET /api/v1/s3credentials/question Queries
S3 credentials of the platform person.
 
GET /api/v1/tenants/{tenantId}/customers/{userId}/s3credentials Lists
S3 credentials of the platform person.
 
POST /api/v1/tenants/{tenantId}/customers/{userId}/s3credentials Creates
S3 credential for the platform person.
 
GET /api/v1/s3credentials/{accessKey} Will get
S3 credential of the platform person.
GET /api/v1/s3capabilities Will get
S3 capabilities of the platform.
 
GET /api/information Will get
the REST companies info.
 

There are non-obligatory APIs that the service may additionally implement relying in your wants. If not carried out, the related choices will stay hidden in Cloud Director.

Right here is the
full checklist of non-obligatory APIs that OSIS can even implement.

HTTP Technique Request URI Description
GET ​/api​/v1​/tenants​/{tenantId}   Get a tenant within the platform
DELETE /api/v1/tenants/{tenantId} Delete
a tenant within the platform
 
HEAD /api/v1/tenants/{tenantId}/customers/{userId} Test
whether or not the person exists
 
PATCH /api/v1/s3credentials/{accessKey} Allow
or disable S3 credential for the platform person
 
DELETE /api/v1/s3credentials/{accessKey} Delete
the S3 credential of the platform person
 
GET /api/v1/utilization Get
the utilization of the platform tenant or person
 
GET /api/v1/bucket-list Get
the bucket checklist of the platform tenant
 
GET ​/api​/v1​/bucket-logging-id   Get
the bucket logging id of the platform
 
GET /api/v1/anonymous-user Get the nameless person id and identify of the platform.  
GET /api/v1/console Get
the console URI of the platform or platform tenant
 

OSIS Tenant and Consumer Mapping

Tenant and person mapping is a place to begin in OSIS improvement. OSIS works as a dealer between OSE and the customized S3 storage. It supplies unified administrative interfaces for OSE to eat the S3 storage like person administration, credential administration, and many others. Additionally, it maps the OSIS information mannequin with the S3 storage information mannequin.

In different phrases, OSE is simply conscious of OSIS information fashions, however
not storage platform information fashions.

OSIS server accepts Cloud Director tenant/person mannequin from
OSE and returns platform tenant/person mannequin to OSE. The mapping from Cloud
Director to the storage platform is designed and maintained by the OSIS
implementation.

The tenant and person mapping should be developed in keeping with the specifics of the storage platform. For extra info on how one can map the OSIS tenant and person mannequin with the storage ones, see for reference: Object Storage Interoperability Service (OSIS) Improvement Information.

Right here is an instance of OSIS tenant and person mapping with CEPH.

OSIS
TENANT
CEPH
USER
tenant_id tenant, user_id
lively suspended
cd_tenant_ids display_name.cdtids
identify tenant
OSIS
USER
CEPH
USER
user_id user_id
canonical_user_id uid
tenant_id tenant
cd_user_id display_name.cduid
cd_tenant_id display_name.cdtid
username display_name.un
lively suspended
e mail e mail
function caps

OSIS Reference Venture

That can assist you design and deploy your OSIS adapter, there’s a reference OSIS implementation, which integrates CEPH (an open-source distributed storage) with OSE.

The reference undertaking may be accessed right here. It consists of info on how one can design, construct, and configure your OSIS adapter for the CEPH storage. Take a look on the documentation of the undertaking to deploy your OSIS adapter and begin utilizing CEPH with OSE.

Extra Assets

For extra info on how one can develop and deploy an OSIS adapter, test the next info: Object Storage Interoperability Service (OSIS) Improvement Information

For extra info on OSE, test its official documentation.

Have extra questions? Contact us at cloudproviderslack@vmware.com.

[ad_2]

RELATED ARTICLES

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Most Popular

Recent Comments