Namespace Management APIs

temporal/api/cloud/cloudservice/v1/request_response.proto

@@ -6,13 +6,14 @@ option go_package = "go.temporal.io/api/cloud/cloudservice/v1;cloudservice";
 
 import "temporal/api/cloud/operation/v1/message.proto";
 import "temporal/api/cloud/identity/v1/message.proto";
+import "temporal/api/cloud/namespace/v1/message.proto";
 
 message GetUsersRequest {
     // The requested size of the page to retrieve
     int32 page_size = 1;
     // The page token
     string page_token = 2;
-    // Optional field to filter users by email address
+    // Filter users by email address - optional
     string email = 3;
 }
 
@@ -94,7 +95,7 @@ message SetUserNamespaceAccessRequest {
 }
 
 message SetUserNamespaceAccessResponse {
-    // The request status of the update operation
+    // The async operation
     temporal.api.cloud.operation.v1.AsyncOperation async_operation = 1;
 }
 
@@ -107,3 +108,95 @@ message GetAsyncOperationResponse {
     // The async operation
     temporal.api.cloud.operation.v1.AsyncOperation async_operation = 1;
 }
+
+message CreateNamespaceRequest {
+    // The prefix to use for the namespace
+    // will create a namespace that's available at '<namespace_prefix>.<account>.tmprl.cloud:7233'
+    string namespace_prefix = 1;
+    // The namespace specification
+    temporal.api.cloud.namespace.v1.NamespaceSpec spec = 2;
+    // The id to use for this async operation - optional
+    string async_operation_id = 3;
+}
+
+message CreateNamespaceResponse {
+    // The namespace that was created
+    string namespace = 1;
+    // The async operation
+    temporal.api.cloud.operation.v1.AsyncOperation async_operation = 1;
+}
+
+message GetNamespacesRequest {
+    // The requested size of the page to retrieve
+    int32 page_size = 1;
+    // The page token
+    string page_token = 2;
+}
+
+message GetNamespacesResponse {
+    // The list of namespaces
+    repeated temporal.api.cloud.namespace.v1.Namespace namespaces = 1;
+    // The next page's token
+    string next_page_token = 2;
+}
+
+message GetNamespaceRequest {
+    // The namespace to get
+    string namespace = 1;
+}
+
+message GetNamespaceResponse {
+    // The namespace
+    temporal.api.cloud.namespace.v1.Namespace namespace = 1;
+}
+
+message UpdateNamespaceRequest {
+    // The namespace to update
+    string namespace = 1;
+    // The new namespace specification
+    temporal.api.cloud.namespace.v1.NamespaceSpec spec = 2;
+    // The version of the namespace for which this update is intended for
+    // The latest version can be found in the namespace status
+    string resource_version = 3;
+    // The id to use for this async operation - optional
+    string async_operation_id = 4;
+}
+
+message UpdateNamespaceResponse {
+    // The async operation
+    temporal.api.cloud.operation.v1.AsyncOperation async_operation = 1;
+}
+
+message RenameCustomSearchAttributeRequest {
+    // The namespace to rename the custom search attribute for
+    string namespace = 1;
+    // The existing name of the custom search attribute to be renamed
+    string existing_custom_search_attribute_name = 2;
+    // The new name of the custom search attribute
+    string new_custom_search_attribute_name = 3;
+    // The version of the namespace for which this update is intended for
+    // The latest version can be found in the namespace status
+    string resource_version = 4;
+    // The id to use for this async operation - optional
+    string async_operation_id = 5;
+}
+
+message RenameCustomSearchAttributeResponse {
+    // The async operation
+    temporal.api.cloud.operation.v1.AsyncOperation async_operation = 1;
+}
+
+message DeleteNamespaceRequest {
+    // The namespace to delete
+    string namespace = 1;
+    // The version of the namespace for which this delete is intended for
+    // The latest version can be found in the namespace status
+    string resource_version = 2;
+    // The id to use for this async operation - optional
+    string async_operation_id = 3;
+}
+
+message DeleteNamespaceResponse {
+    // The async operation
+    temporal.api.cloud.operation.v1.AsyncOperation async_operation = 1;
+}

temporal/api/cloud/cloudservice/v1/service.proto

@@ -59,4 +59,49 @@ service CloudService {
             get: "/api/v1/operations/{async_operation_id}",
         };
     }
+
+    // Create a new namespace
+    rpc CreateNamespace (CreateNamespaceRequest) returns (CreateNamespaceResponse) {
+	option (google.api.http) = {
+            post: "/api/v1/namespaces",
+	    body: "*"
+        };
+    }
+
+    // Get all namespaces
+    rpc GetNamespaces (GetNamespacesRequest)  returns (GetNamespacesResponse) {
+	option (google.api.http) = {
+            get: "/api/v1/namespaces",
+        };
+    }
+
+    // Get a namespace
+    rpc GetNamespace (GetNamespaceRequest) returns (GetNamespaceResponse) {
+	option (google.api.http) = {
+            get: "/api/v1/namespaces/{namespace}",
+        };
+    }
+
+    // Update a namespace
+    rpc UpdateNamespace (UpdateNamespaceRequest) returns (UpdateNamespaceResponse) {
+	option (google.api.http) = {
+            post: "/api/v1/namespaces/{namespace}",
+	    body: "*"
+        };
+    }
+
+    // Rename an existing customer search attribute
+    rpc RenameCustomSearchAttribute (RenameCustomSearchAttributeRequest) returns (RenameCustomSearchAttributeResponse) {
+	option (google.api.http) = {
+            post: "/api/v1/namespaces/{namespace}/rename-custom-search-attribute",
+	    body: "*"
+        };
+    }
+
+    // Delete a namespace
+    rpc DeleteNamespace (DeleteNamespaceRequest) returns (DeleteNamespaceResponse) {
+	option (google.api.http) = {
+            delete: "/api/v1/namespaces/{namespace}",
+        };
+    }
 }

temporal/api/cloud/namespace/v1/message.proto

@@ -0,0 +1,93 @@
+syntax = "proto3";
+
+package temporal.api.cloud.namespace.v1;
+
+option go_package = "go.temporal.io/api/cloud/namespace/v1;namespace";
+
+import "temporal/api/cloud/sink/v1/message.proto";
+
+import "google/protobuf/timestamp.proto";
+
+message CertificateFilterSpec {
+    // The common_name in the certificate
+    string common_name = 1;
+    // The organization in the certificate
+    string organization = 2;
+    // The organizational_unit in the certificate
+    string organizational_unit = 3;
+    // The subject_alternative_name in the certificate
+    string subject_alternative_name = 4;
+}
+
+message CodecServerPropertySpec {
+    // Server endpoints
+    string endpoint = 1;
+    // Whether to pass access token, i.e. jwt
+    bool pass_access_token = 2;
+    // Whether to include credentials
+    bool include_credentials = 3;
+}
+
+message NamespaceSpec {
+    // The region where the namespace is (or will be) active
+    string region = 1;
+    // The base64 encoded ca cert(s) that the clients can use for authentication and authorization
+    string accepted_client_ca = 2;
+    // The number of days the workflows data will be retained for
+    int32 retention_days = 3;
+    // The custom search attributes to use for the namespace
+    // The name of the attribute is the key and the type is the value
+    // Supported attribute types: text, keyword, int, double, bool, datetime, keyword_list
+    map<string, string> search_attributes = 4;
+    // Certificate filters which, if specified, only allow connections from client certificates
+    // whose distinguished name properties match at least one of the filters
+    repeated CertificateFilterSpec certificate_filters = 5;
+    // Environment of the namespace. - optional
+    // NOTE: currently there is no additional SLA or functional guarantee implied by the value of this field.
+    // supported environments: dev, test, prod
+    string environment = 6;
+    // Codec server property spec needed for user to set and retrieve - optional
+    CodecServerPropertySpec codec_spec = 7;
+    // The regions where the namespace is (or will be) located - optional
+    repeated string passive_regions = 8;
+    // The export sink specifications keyed on the sink name - optional
+    map<string, temporal.api.cloud.sink.v1.ExportSinkSpec> export_sinks = 9;
+}
+
+message NamespaceURI {
+    // The web ui address
+    string web = 1;
+    // The grpc address
+    string grpc = 2;
+    // The list of private links
+    repeated string vpc_endpoint_service_names = 3;
+}
+
+message NamespaceEnvelope {
+    // The namespace may be throttled if its APS exceeds the limit
+    int32 actions_per_second_limit = 1;
+}
+
+message Namespace {
+    // The namespace name
+    string namespace = 1;
+    // The current version of the namespace specification
+    // The next update operation will have to include this version
+    string resource_version = 2;
+    // The namespace specification
+    NamespaceSpec spec = 3;
+    // The current state of the namespace
+    string state = 4;
+    // The id of the async operation that is creating/updating/deleting the namespace, if any
+    string async_operation_id = 5;
+    // The web uri for the namespace
+    NamespaceURI uri = 6;
+    // The envelope is a list of service level agreements (SLAs) that can be provided around a given namespace
+    NamespaceEnvelope envelope = 7;
+    // Allowed principals is a list of principals that allowed to access the private links on the namespace
+    repeated string allowed_principals = 8;
+    // The export sink status keyed on the sink name
+    map<string, temporal.api.cloud.sink.v1.ExportSink> export_sinks = 9;
+    // The date and time when the namespace was last modified
+    google.protobuf.Timestamp last_modified_time = 10;
+}

temporal/api/cloud/sink/v1/message.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+
+package temporal.api.cloud.sink.v1;
+
+option go_package = "go.temporal.io/api/cloud/sink/v1;sink";
+
+import "google/protobuf/timestamp.proto";
+
+message ExportSinkSpec {
+    // Whether the sink is enabled
+    bool enabled = 1;
+    // The destination of the sink
+    oneof destination {
+        // The AWS S3 destination spec
+	S3Spec s3_spec = 2;
+    }
+}
+
+message ExportSink {
+    // The state of the sink
+    string state = 1;
+    // The health of the sink
+    string health = 2;
+    // The error message of the sink if any
+    string error_message = 3;
+    // The latest data export time
+    google.protobuf.Timestamp latest_data_export_time = 4;
+    // The latest health check time
+    google.protobuf.Timestamp last_health_check_time = 5;
+}
+
+message S3Spec{
+    // The role to be created that Temporal Cloud assumes for writing records to customer's S3 bucket
+    string role_name = 1;
+    // Destination S3 bucket name for us to send data to.
+    string bucket_name = 2;
+    // The region of the S3 bucket
+    string region = 3;
+    // The kms key ARN used for encryption
+    string kms_arn = 4;
+    // The aws account id of s3 bucket and assumed role
+    string aws_account_id = 5;
+}
+
+