upcoming: [M3-8296] - APIv4, Validation & Endpoints for OBJGen2 #10677

jaalah-akamai · 2024-07-15T14:59:05Z

Description 📝

Under this proposal, Cloud Manager uses this to determine which S3 endpoints or types of endpoints are available to the requesting customer when using the API to create a bucket in a particular region.

Changes 🔄

Added new /v4/object-storage/endpoints

{
  region: string;
  endpoint_type: 'E0' | 'E1' | 'E2' | 'E3';
  s3_endpoint: string | null;
}

Modified Access Key Endpoint (GET)
- regions array will contain new endpoint_type field
Modified Create Bucket Request (POST)
- Cloud Manager currently omits cors_enabled upon creation because it defaults to true. This behavior should be updated to explicitly set cors_enabled to either true or false.
Added new fields to Modify Bucket Response (GET)
- s3_endpoint and endpoint_type
Modified Bucket Access (GET)
- If Gen2 is enabled, the values for cors_enabled and cors_xml will be null

Note

When the new API features are disabled, this endpoint will silently ignore any new request fields, even if they are present and non-null. APIv4 will safely discard these fields instead of passing them to OSA.

Target release date 🗓️

N/A

Preview 📷

No visual changes

How to test 🧪

No testing to be done, just review the endpoint, spelling, and typescript types
When reviewing, compare type to the API specification linked on the internal ticket

…J Gen2

jaalah-akamai · 2024-07-15T16:57:24Z

packages/manager/src/features/ObjectStorage/BucketDetail/AccessSelect.tsx

+          if (typeof cors_enabled === 'boolean') {
+            setCORSData(cors_enabled);
+            setSelectedCORSOption(cors_enabled);
+          }


Type guard needed based on the way this was originally written. We are utilizing getAccess as a general entrypoint for calling getBucketAccess or getObjectACL which have different type signatures. Not a fan, so I may clean up in a future PR.

github-actions · 2024-07-15T17:21:10Z

Coverage Report: ✅
Base Coverage: 82.34%
Current Coverage: 82.34%

jaalah-akamai · 2024-07-15T17:44:17Z

Looking at both E2E tests 👀

Edit: I see... going to put this back into draft temporarily until I update factories

jaalah-akamai · 2024-07-15T19:37:09Z

packages/manager/cypress/e2e/core/objectStorage/access-key.e2e.spec.ts

@@ -120,7 +120,7 @@ describe('object storage access key end-to-end tests', () => {
  it('can create an access key with limited access - e2e', () => {
    const bucketLabel = randomLabel();
    const bucketCluster = 'us-east-1';
-    const bucketRequest = objectStorageBucketFactory.build({
+    const bucketRequest = createObjectStorageBucketFactory.build({


Note: This is the start of cleaning up the factories. We were using the response interface as the type signature for the payload which I fixed here.

AzureLatte

Looks good

bnussman-akamai

Didn't observe any issues with Object Storage ✅

bnussman-akamai · 2024-07-16T15:40:04Z

packages/api-v4/src/object-storage/types.ts

@@ -88,16 +89,23 @@ export interface ObjectStorageObjectURL {
  url: string;
 }

+export interface ObjectStorageEndpointsResponse {


Should drop the Response in this type name and make Endpoint singular?

Suggested change

export interface ObjectStorageEndpointsResponse {

export interface ObjectStorageEndpoint {

Agreed - I'll update

I'll actually make this name change in my next PR which deals with semantics.

packages/api-v4/src/object-storage/types.ts

jaalah-akamai · 2024-07-16T20:24:52Z

Waiting to merge until after release is cut ✂️

upcoming: [M3-8296] - APIv4, Validation, Factories & Endpoints for OB…

1cb89ed

…J Gen2

jaalah-akamai self-assigned this Jul 15, 2024

jaalah-akamai added @linode/api-v4 Changes are made to the @linode/api-v4 package @linode/validation Changes are made to the @linode/validation package Object Storage Gen2 labels Jul 15, 2024

jaalah-akamai changed the title ~~upcoming: [M3-8296] - APIv4, Validation, Factories & Endpoints for OBJGen2~~ upcoming: [M3-8296] - APIv4, Validation & Endpoints for OBJGen2 Jul 15, 2024

jaalah-akamai marked this pull request as ready for review July 15, 2024 16:48

jaalah-akamai requested a review from a team as a code owner July 15, 2024 16:48

jaalah-akamai requested review from bnussman-akamai and AzureLatte and removed request for a team July 15, 2024 16:48

Add changesets

e3697ed

jaalah-akamai commented Jul 15, 2024

View reviewed changes

jaalah-akamai marked this pull request as draft July 15, 2024 17:54

jaalah-akamai added the Work in Progress label Jul 15, 2024

First of many updates to mocks and factories

fa11b50

jaalah-akamai commented Jul 15, 2024

View reviewed changes

jaalah-akamai marked this pull request as ready for review July 15, 2024 19:37

jaalah-akamai requested a review from a team as a code owner July 15, 2024 19:37

jaalah-akamai requested review from jdamore-linode and removed request for a team July 15, 2024 19:37

jaalah-akamai removed the Work in Progress label Jul 15, 2024

AzureLatte approved these changes Jul 16, 2024

View reviewed changes

bnussman-akamai approved these changes Jul 16, 2024

View reviewed changes

jaalah-akamai added the Approved Multiple approvals and ready to merge! label Jul 16, 2024

jaalah-akamai mentioned this pull request Jul 17, 2024

upcoming: [M3-8350] - Cleanup Types for Object Storage #10686

Merged

Adding comments and optional operator back - Not sure why it was removed

ce1749f

jaalah-akamai merged commit e60faef into linode:develop Jul 17, 2024
19 checks passed

This was referenced Aug 1, 2024

Release v1.125.0 - release → staging #10741

Merged

Release v1.125.0 - staging → master #10748

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

upcoming: [M3-8296] - APIv4, Validation & Endpoints for OBJGen2 #10677

upcoming: [M3-8296] - APIv4, Validation & Endpoints for OBJGen2 #10677

jaalah-akamai commented Jul 15, 2024 •

edited

Loading

jaalah-akamai Jul 15, 2024

github-actions bot commented Jul 15, 2024 •

edited

Loading

jaalah-akamai commented Jul 15, 2024 •

edited

Loading

jaalah-akamai Jul 15, 2024 •

edited

Loading

AzureLatte left a comment

bnussman-akamai left a comment

bnussman-akamai Jul 16, 2024

jaalah-akamai Jul 16, 2024 •

edited

Loading

jaalah-akamai Jul 16, 2024

jaalah-akamai commented Jul 16, 2024

	export interface ObjectStorageEndpointsResponse {
	export interface ObjectStorageEndpoint {

upcoming: [M3-8296] - APIv4, Validation & Endpoints for OBJGen2 #10677

upcoming: [M3-8296] - APIv4, Validation & Endpoints for OBJGen2 #10677

Conversation

jaalah-akamai commented Jul 15, 2024 • edited Loading

Description 📝

Changes 🔄

Target release date 🗓️

Preview 📷

How to test 🧪

jaalah-akamai Jul 15, 2024

Choose a reason for hiding this comment

github-actions bot commented Jul 15, 2024 • edited Loading

jaalah-akamai commented Jul 15, 2024 • edited Loading

jaalah-akamai Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

AzureLatte left a comment

Choose a reason for hiding this comment

bnussman-akamai left a comment

Choose a reason for hiding this comment

bnussman-akamai Jul 16, 2024

Choose a reason for hiding this comment

jaalah-akamai Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

jaalah-akamai Jul 16, 2024

Choose a reason for hiding this comment

jaalah-akamai commented Jul 16, 2024

jaalah-akamai commented Jul 15, 2024 •

edited

Loading

github-actions bot commented Jul 15, 2024 •

edited

Loading

jaalah-akamai commented Jul 15, 2024 •

edited

Loading

jaalah-akamai Jul 15, 2024 •

edited

Loading

jaalah-akamai Jul 16, 2024 •

edited

Loading