Introduction:
In response to the dynamic landscape of cloud services and the evolving needs of our partner, we are proposing strategic enhancements to the client-cloud-service package within the Manage Learn service. Amidst these changes, the focus is on accommodating the unique requirements of the Adoptor initiative. Adoptor, our valued partner, operates on NIC servers with a distinct S3 protocol-based storage system, necessitating the introduction of an S3 Storage Service. This pivotal addition not only aligns our services with Adoptors infrastructure but also ensures compatibility with AWS, reinforcing our commitment to versatility and client-centric solutions. This proposal outlines the tailored modifications required for the Adoptor, emphasizing seamless integration while maintaining the generic nature of the client-cloud-service package.
Objective:
The current client-cloud-service package is designed to manage file uploads, providing pre-signed URLs for AWS, OCI, GCP, and Azure. However, we've identified a need to enhance our services to cater to clients utilizing a custom storage service following the S3 protocol, hosted on NIC servers.
Problem Statement:
As we strive to meet the diverse needs of our stakeholders. Adoptor is looking to adopt our services and capabilities, specifically focusing on Observation & Survey functionalities. However, ML services will be hosted on NIC servers, and they do not utilize the standard set of service providers such as AWS, OCI, GCP, and Azure.
In the course of our engagement with Adoptor, it has become apparent that their storage infrastructure is based on a custom storage service adhering to the S3 protocol. Furthermore, our Proof of Concept (POC) using the aws-sdk library has confirmed the feasibility of integrating our services with their unique infrastructure.
Proposed Changes:
Introduction of S3 Storage Service:
We propose the addition of a new storage service within the client-cloud-service package specifically tailored for S3 protocol-based storage. This enhancement aims to accommodate clients utilizing NIC servers and their custom storage service while ensuring compatibility with AWS.
Custom Configuration Parameters:
The existing methods for AWS, OCI, GCP, and Azure require certain configuration parameters such as access key, secret key, and region. The new S3 Storage Service will be designed to accept custom configuration parameters relevant to the NIC server's S3 protocol-based storage.
Additionally, considering the NIC S3 bucket does not work with region-specific configurations, the S3 Storage Service will be configured to handle this unique requirement.
Library Compatibility:
To ensure seamless integration with the NIC server's storage service, a Proof of Concept (POC) has been conducted using the aws-sdk library. The proposed S3 Storage Service will be developed with compatibility for this library, making it easy for clients to integrate our services with their existing infrastructure.
Generic Nature of the Client-Cloud-Service Package:
Recognizing the generic nature of the client-cloud-service package, the new S3 Storage Service will be implemented as an extension to maintain the package's versatility. Clients can easily include the S3StorageService and provide extended values through the index file, allowing for a smooth integration process.
Implementation Steps:
Code Modification:
Implement the S3 Storage Service within the client-cloud-service package.
Update the package to accept custom configuration parameters for the S3 Storage Service, including adjustments to handle the NIC S3 bucket's unique characteristics.
Compatibility Testing:
Conduct thorough testing to ensure compatibility with the aws-sdk library, considering the NIC server's storage service peculiarities.
Documentation Update:
Revise documentation to include details about the new S3 Storage Service, its configuration parameters, and integration steps. Clearly outline the handling of NIC S3 buckets without region-specific configurations.
Benefits:
Expanded Compatibility:
The addition of the S3 Storage Service broadens the compatibility of our client-cloud-service package, catering to clients with diverse storage solutions.
Seamless Integration:
Clients can easily adopt our services for NIC server storage without significant modifications, thanks to the generic nature of the client-cloud-service package.
Enhanced Service Adoption:
The proposed changes enable us to meet the evolving needs of clients, fostering greater adoption of our services.