Find out how to join customized S3 storage to VMware Cloud Director Object Storage Extension

0
55


VMware Object Storage Extension (OSE) is a plugin that helps you connect S3 appropriate storage to VMware Cloud Director. The presently 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 important unstructured knowledge, vApps, and Catalogs. Since OSE 2.1, you too can use it for backing up and restoring your Kubernetes clusters!

Determine 1: OSE Structure and Community Connections

Let’s see
how this works.

OSIS Implementation Course of

Suppose you may have determined to combine your customized S3 object storage with Cloud Director. In that case, you have to have the OSIS adapter developed for the S3 storage that you just use, then deploy OSIS and configure Object Storage Extension to connect with OSIS. Cloud Director tenants can devour 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 Growth Requirement

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

OSIS Network Diagram
Determine 3: OSE Community Diagram

OSIS Development Course of

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

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

Let’s now see the whole listing of obligatory 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 consumer 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 consumer with consumer 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 consumer within the platform tenant.
 
GET /api/v1/customers/{canonicalUserId} Will get
the consumer with consumer canonical ID.
GET /api/v1/s3credentials/question Queries
S3 credentials of the platform consumer.
 
GET /api/v1/tenants/{tenantId}/customers/{userId}/s3credentials Lists
S3 credentials of the platform consumer.
 
POST /api/v1/tenants/{tenantId}/customers/{userId}/s3credentials Creates
S3 credential for the platform consumer.
 
GET /api/v1/s3credentials/{accessKey} Will get
S3 credential of the platform consumer.
GET /api/v1/s3capabilities Will get
S3 capabilities of the platform.
 
GET /api/information Will get
the REST companies data.
 

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

Right here is the
full listing of non-obligatory APIs that OSIS also can 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 consumer exists
 
PATCH /api/v1/s3credentials/{accessKey} Allow
or disable S3 credential for the platform consumer
 
DELETE /api/v1/s3credentials/{accessKey} Delete
the S3 credential of the platform consumer
 
GET /api/v1/utilization Get
the utilization of the platform tenant or consumer
 
GET /api/v1/bucket-list Get
the bucket listing 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 consumer id and identify of the platform.  
GET /api/v1/console Get
the console URI of the platform or platform tenant
 

OSIS Tenant and Person Mapping

Tenant and consumer mapping is a place to begin in OSIS improvement. OSIS works as a dealer between OSE and the customized S3 storage. It gives unified administrative interfaces for OSE to devour the S3 storage like consumer administration, credential administration, and so forth. Additionally, it maps the OSIS knowledge mannequin with the S3 storage knowledge mannequin.

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

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

The tenant and consumer mapping should be developed in response to the specifics of the storage platform. For extra data on map the OSIS tenant and consumer mannequin with the storage ones, see for reference: Object Storage Interoperability Service (OSIS) Growth Information.

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

OSIS
TENANT
CEPH
USER
tenant_id tenant, user_id
energetic 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
energetic 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 venture might be accessed right here. It contains data on design, construct, and configure your OSIS adapter for the CEPH storage. Take a look on the documentation of the venture to deploy your OSIS adapter and begin utilizing CEPH with OSE.

Further Sources

For extra data on develop and deploy an OSIS adapter, test the next data: Object Storage Interoperability Service (OSIS) Growth Information

For extra data on OSE, test its official documentation.

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