CyberCoveLLC/threshold
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(storage): Add support for Storage Bucket API

Browse Source
This commit is contained in:
Louis Ruch authored and Timothy Messier committed 2023-05-31 12:18:14 +00:00
1 parent feb87e717e
commit 8ea61054cd
27 files changed
+3380 -142
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

internal/proto/controller/api/resources/storagebuckets/v1/storage_bucket.proto
+85 -12
View File
@@ -6,28 +6,101 @@ syntax = "proto3";
package controller.api.resources.storagebuckets.v1;
import "controller/api/resources/plugins/v1/plugin.proto";
import "controller/api/resources/scopes/v1/scope.proto";
import "controller/custom_options/v1/options.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/storagebuckets;storagebuckets";
// TODO: this definition is not complete and
// is empty because the message is being used in
// plugin/v1/storage_plugin_service.proto
// StorageBucket manages external object stores
message StorageBucket {
// The name of the resource that is managed by an external object store service.
string bucket_name = 10; // @gotags: `class:"public"`
// Output only. The ID of the storage bucket.
string id = 10; // @gotags: `class:"public"`
// The prefix used to organize the data held within the external object store.
string bucket_prefix = 20; // @gotags: `class:"public"`
// The ID of the Scope of which this storage bucket is a part.
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
// Attributes specific to the storage bucket type.
google.protobuf.Struct attributes = 30 [(custom_options.v1.generate_sdk_option) = true]; // @gotags: `class:"public"`
// Output only. Scope information for this resource.
resources.scopes.v1.ScopeInfo scope = 30; // @gotags: `class:"public"`
// Secrets specific to the storage bucket type. These are never output.
google.protobuf.Struct secrets = 40 [(custom_options.v1.generate_sdk_option) = true];
// The ID of the plugin of which this storage bucket is created.
string plugin_id = 34 [
json_name = "plugin_id",
(custom_options.v1.generate_sdk_option) = true
]; // @gotags: `class:"public"`
// Output only. Plugin information for this resource.
resources.plugins.v1.PluginInfo plugin = 50;
resources.plugins.v1.PluginInfo plugin = 35; // @gotags: `class:"public"`
// Optional name for identification purposes.
google.protobuf.StringValue name = 40 [
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "name"
that: "Name"
}
]; // @gotags: `class:"public"`
// Optional user-set description for identification purposes.
google.protobuf.StringValue description = 50 [
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "description"
that: "Description"
}
]; // @gotags: `class:"public"`
// The name of the bucket within the external object store service.
string bucket_name = 60 [
json_name = "bucket_name",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "bucket_name"
that: "BucketName"
}
]; // @gotags: `class:"public"`
// The prefix used to organize the data held within the external object store.
string bucket_prefix = 70 [
json_name = "bucket_prefix",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "bucket_prefix"
that: "BucketPrefix"
}
]; // @gotags: `class:"public"`
// Output only. The time this resource was created.
google.protobuf.Timestamp created_time = 80 [json_name = "created_time"]; // @gotags: `class:"public"`
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 90 [json_name = "updated_time"]; // @gotags: `class:"secret"`
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 100; // @gotags: `class:"public"`
// Attributes specific to the catalog type.
google.protobuf.Struct attributes = 120 [(custom_options.v1.generate_sdk_option) = true]; // @gotags: `class:"public"`
// Secrets specific to the storage bucket type. These are never output.
google.protobuf.Struct secrets = 130 [(custom_options.v1.generate_sdk_option) = true]; // @gotags: `class:"public"`
// Output only. The HMAC of the last secrets supplied via the API, if any.
string secrets_hmac = 140; // @gotags: `class:"public"`
// Filters to the worker(s) that can handle requests for this storage bucket
string worker_filter = 150 [
json_name = "worker_filter",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "worker_filter"
that: "WorkerFilter"
}
]; // @gotags: `class:"public"`
// Output only. The available actions on this resource for this user.
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
}
internal/proto/controller/api/services/v1/storage_bucket_service.proto
+119
View File
@@ -0,0 +1,119 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
syntax = "proto3";
package controller.api.services.v1;
import "controller/api/resources/storagebuckets/v1/storage_bucket.proto";
import "controller/custom_options/v1/options.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/services;services";
option (custom_options.v1.domain) = "storage";
service StorageBucketService {
// GetStorageBucket returns a stored Storage Bucket if present. The provided
// request must include the ID for the Storage Bucket being retrieved.
// If missing, malformed, or referencing a non-existing resource an error is
// returned.
rpc GetStorageBucket(GetStorageBucketRequest) returns (GetStorageBucketResponse) {
option (google.api.http) = {
get: "/v1/storage-buckets/{id}"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Gets a single Storage Bucket."};
}
// ListStorageBuckets returns a list of stored Storage Buckets which exist inside
// the scope referenced in the request. The request must include the scope
// ID and if it is missing, malformed, or references a non-existing resource
// an error is returned.
rpc ListStorageBuckets(ListStorageBucketsRequest) returns (ListStorageBucketsResponse) {
option (google.api.http) = {get: "/v1/storage-buckets"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Gets a list of Storage Buckets."};
}
// CreateStorageBucket creates and stores a Storage Bucket in boundary. The
// provided request must include the scope ID in which the Storage Bucket will be
// created. If any of these required fields are missing, malformed, or reference a
// non-existing parent resource an error is returned.
rpc CreateStorageBucket(CreateStorageBucketRequest) returns (CreateStorageBucketResponse) {
option (google.api.http) = {
post: "/v1/storage-buckets"
body: "item"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Creates a Storage Bucket"};
}
// UpdateStorageBucket updates an existing Storage Bucket in Boundary. The
// provided Storage Bucket must not have any read only fields set. The update
// mask must be provided and include at least 1 mutable field. To unset a
// field's value include that field name in the update mask and don't set the
// field in the Storage Bucket.
rpc UpdateStorageBucket(UpdateStorageBucketRequest) returns (UpdateStorageBucketResponse) {
option (google.api.http) = {
patch: "/v1/storage-buckets/{id}"
body: "item"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Updates a Storage Bucket"};
}
// DeleteStorageBucket removes a Storage Bucket from Boundary.
// If the provided Storage Bucket ID is malformed or not
// provided DeleteStorageBucket returns an error.
rpc DeleteStorageBucket(DeleteStorageBucketRequest) returns (DeleteStorageBucketResponse) {
option (google.api.http) = {delete: "/v1/storage-buckets/{id}"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Deletes a Storage Bucket"};
}
}
message GetStorageBucketRequest {
string id = 1; // @gotags: `class:"public"`
}
message GetStorageBucketResponse {
api.resources.storagebuckets.v1.StorageBucket item = 1;
}
message ListStorageBucketsRequest {
string scope_id = 1 [json_name = "scope_id"]; // @gotags: `class:"public"`
bool recursive = 20 [json_name = "recursive"]; // @gotags: `class:"public"`
string filter = 30 [json_name = "filter"]; // @gotags: `class:"public"`
}
message ListStorageBucketsResponse {
repeated api.resources.storagebuckets.v1.StorageBucket items = 1;
}
message CreateStorageBucketRequest {
api.resources.storagebuckets.v1.StorageBucket item = 1;
// As an alternative to providing the plugin id in the provided StorageBucket,
// this field can be used to lookup the plugin using its name.
string plugin_name = 2 [json_name = "plugin_name"]; // @gotags: `class:"public"`
}
message CreateStorageBucketResponse {
string uri = 1; // @gotags: `class:"public"`
api.resources.storagebuckets.v1.StorageBucket item = 2;
}
message UpdateStorageBucketRequest {
string id = 1; // @gotags: `class:"public"`
api.resources.storagebuckets.v1.StorageBucket item = 2;
google.protobuf.FieldMask update_mask = 3;
}
message UpdateStorageBucketResponse {
api.resources.storagebuckets.v1.StorageBucket item = 1;
}
message DeleteStorageBucketRequest {
string id = 1; // @gotags: `class:"public"`
}
message DeleteStorageBucketResponse {}