@cofy-x/axern-sdk 0.2.0-bootstrap.0

package/dist/proto/axern/control/common/v1/common.proto

@@ -0,0 +1,171 @@
+syntax = "proto3";
+
+package axern.control.common.v1;
+
+option go_package = "github.com/cofy-x/axern/sdk/go/gen/axern/control/common/v1;commonv1";
+
+import "google/protobuf/timestamp.proto";
+import "axern/control/storage/v1/storage_types.proto";
+
+message ResourceQuantity {
+  int64 cpu_milli = 1;
+  int64 memory_bytes = 2;
+}
+
+message ResourceSpec {
+  ResourceQuantity requests = 1;
+  ResourceQuantity limits = 2;
+}
+
+enum PortProtocol {
+  PORT_PROTOCOL_UNSPECIFIED = 0;
+  PORT_PROTOCOL_TCP = 1;
+  PORT_PROTOCOL_UDP = 2;
+}
+
+message PortSpec {
+  string name = 1;
+  PortProtocol protocol = 2;
+  int32 container_port = 3;
+  int32 host_port = 4;
+}
+
+enum NetworkMode {
+  NETWORK_MODE_UNSPECIFIED = 0;
+  NETWORK_MODE_DEFAULT = 1;
+  NETWORK_MODE_ISOLATED = 2;
+  NETWORK_MODE_HOST = 3;
+}
+
+message NetworkSpec {
+  NetworkMode mode = 1;
+}
+
+message CapabilityRequirement {
+  string name = 1;
+  string value = 2;
+}
+
+message PlacementConstraints {
+  map<string, string> node_selector = 1;
+}
+
+message SecretEnvVar {
+  string name = 1;
+  string secret_id = 2;
+  string key = 3;
+  bool optional = 4;
+}
+
+message SecretFile {
+  string path = 1;
+  string secret_id = 2;
+  string key = 3;
+  uint32 mode = 4;
+  bool optional = 5;
+}
+
+message ServiceVolumeMount {
+  string name = 1;
+  string target = 2;
+  bool readonly = 3;
+  repeated string options = 4;
+  axern.control.storage.v1.VolumeReclaimPolicy reclaim_policy = 5;
+}
+
+message ImageMount {
+  string image = 1;
+  string target = 2;
+  bool readonly = 3;
+}
+
+message WorkspaceImageVariant {
+  string format = 1;
+  string image = 2;
+}
+
+message WorkspaceImageSource {
+  repeated WorkspaceImageVariant variants = 1;
+  string source_path = 2;
+  string target = 3;
+}
+
+// WorkspacePreparationFacts records the node-observed preparation result for
+// one allocation's immutable TaskSet workspace. These facts describe the
+// variant that was actually selected by the node, not the variant preference
+// declared by the client.
+message WorkspacePreparationFacts {
+  string payload_format = 1;
+  string payload_digest = 2;
+  bool cache_hit = 3;
+  int64 image_resolve_ms = 4;
+  int64 image_pull_ms = 5;
+  int64 cow_prepare_ms = 6;
+}
+
+message ExecutionConfig {
+  repeated string argv = 1;
+  map<string, string> env = 2;
+  string cwd = 3;
+  ResourceSpec resources = 4;
+  repeated PortSpec ports = 5;
+  NetworkSpec network = 6;
+  repeated CapabilityRequirement capability_requirements = 7;
+  PlacementConstraints placement = 8;
+  repeated SecretEnvVar secret_env = 9;
+  repeated SecretFile secret_files = 10;
+  repeated ServiceVolumeMount volume_mounts = 11;
+  string runtime_class = 12;
+  repeated ImageMount image_mounts = 13;
+  WorkspaceImageSource workspace_image = 14;
+}
+
+enum AllocationStatus {
+  ALLOCATION_STATUS_UNSPECIFIED = 0;
+  ALLOCATION_STATUS_RESERVED = 1;
+  ALLOCATION_STATUS_BOUND = 2;
+  ALLOCATION_STATUS_STARTING = 3;
+  ALLOCATION_STATUS_RUNNING = 4;
+  ALLOCATION_STATUS_EXITED = 5;
+  ALLOCATION_STATUS_FAILED = 6;
+  ALLOCATION_STATUS_RELEASING = 7;
+  ALLOCATION_STATUS_RELEASED = 8;
+}
+
+enum WorkloadDiagnosticCode {
+  WORKLOAD_DIAGNOSTIC_CODE_UNSPECIFIED = 0;
+  WORKLOAD_DIAGNOSTIC_CODE_SECRET_PROJECTION_ERROR = 1;
+  WORKLOAD_DIAGNOSTIC_CODE_REGISTRY_AUTH_ERROR = 2;
+  WORKLOAD_DIAGNOSTIC_CODE_IMAGE_RESOLUTION_ERROR = 3;
+  WORKLOAD_DIAGNOSTIC_CODE_NODE_SELECTION_ERROR = 4;
+  WORKLOAD_DIAGNOSTIC_CODE_RUNTIME_START_ERROR = 5;
+  WORKLOAD_DIAGNOSTIC_CODE_PROCESS_EXITED = 6;
+  WORKLOAD_DIAGNOSTIC_CODE_LIVENESS_PROBE_FAILED = 7;
+  WORKLOAD_DIAGNOSTIC_CODE_ADMISSION_BLOCKED = 8;
+  WORKLOAD_DIAGNOSTIC_CODE_STORAGE_TOPOLOGY_UNSATISFIED = 9;
+  WORKLOAD_DIAGNOSTIC_CODE_STORAGE_RESERVE_ERROR = 10;
+  WORKLOAD_DIAGNOSTIC_CODE_VOLUME_PUBLISH_ERROR = 11;
+  WORKLOAD_DIAGNOSTIC_CODE_VOLUME_RELEASE_ERROR = 12;
+  WORKLOAD_DIAGNOSTIC_CODE_VOLUME_SPEC_CONFLICT = 13;
+}
+
+enum LeaseType {
+  LEASE_TYPE_UNSPECIFIED = 0;
+  LEASE_TYPE_RUN = 1;
+  LEASE_TYPE_SERVICE = 2;
+  LEASE_TYPE_INVOKE = 3;
+}
+
+message ExecutionLease {
+  string lease_id = 1;
+  string allocation_id = 2;
+  string node_id = 3;
+  int64 attempt = 4;
+  LeaseType lease_type = 5;
+  string plaintext_token = 6;
+  int64 revision = 7;
+  google.protobuf.Timestamp expires_at = 8;
+  bool revoked = 9;
+  string node_target = 10;
+  string validation_token_hash = 11;
+}

package/dist/proto/axern/control/environment/v1/environment.proto

@@ -0,0 +1,94 @@
+syntax = "proto3";
+
+package axern.control.environment.v1;
+
+option go_package = "github.com/cofy-x/axern/sdk/go/gen/axern/control/environment/v1;environmentv1";
+
+import "axern/control/catalog/v1/catalog.proto";
+import "google/protobuf/timestamp.proto";
+
+message EnvironmentImageSource {
+  string ref = 1;
+  string digest = 2;
+  bool rootfs_readonly = 3;
+  string registry_credential_id = 4;
+}
+
+message EnvironmentSpec {
+  string namespace = 1;
+  string template_id = 2;
+  string template_version = 3;
+  EnvironmentImageSource image = 4;
+}
+
+enum EnvironmentStatus {
+  ENVIRONMENT_STATUS_UNSPECIFIED = 0;
+  ENVIRONMENT_STATUS_PENDING = 1;
+  ENVIRONMENT_STATUS_READY = 2;
+  ENVIRONMENT_STATUS_FAILED = 3;
+  ENVIRONMENT_STATUS_DELETING = 4;
+  ENVIRONMENT_STATUS_DELETED = 5;
+}
+
+message Environment {
+  string id = 1;
+  string namespace = 2;
+  EnvironmentStatus status = 3;
+  EnvironmentSpec spec = 4;
+  string spec_hash = 5;
+  axern.control.catalog.v1.RuntimeTemplate resolved_template = 6;
+  map<string, string> labels = 7;
+  int64 version = 8;
+  google.protobuf.Timestamp created_at = 9;
+  google.protobuf.Timestamp updated_at = 10;
+  string message = 11;
+}
+
+message ListFilter {
+  string namespace = 1;
+  repeated EnvironmentStatus statuses = 2;
+  map<string, string> labels = 3;
+  string cursor = 4;
+  int32 page_size = 5;
+}
+
+message CreateEnvironmentRequest {
+  EnvironmentSpec spec = 1;
+  map<string, string> labels = 2;
+}
+
+message CreateEnvironmentResponse {
+  Environment environment = 1;
+}
+
+message GetEnvironmentRequest {
+  string environment_id = 1;
+}
+
+message GetEnvironmentResponse {
+  Environment environment = 1;
+}
+
+message ListEnvironmentsRequest {
+  ListFilter filter = 1;
+}
+
+message ListEnvironmentsResponse {
+  repeated Environment environments = 1;
+  string next_cursor = 2;
+}
+
+message DeleteEnvironmentRequest {
+  string environment_id = 1;
+}
+
+message DeleteEnvironmentResponse {
+  Environment environment = 1;
+}
+
+service EnvironmentControl {
+  rpc CreateEnvironment(CreateEnvironmentRequest) returns (CreateEnvironmentResponse) {}
+  rpc GetEnvironment(GetEnvironmentRequest) returns (GetEnvironmentResponse) {}
+  rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) {}
+  rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (DeleteEnvironmentResponse) {}
+}

package/dist/proto/axern/control/function/v1/function.proto

@@ -0,0 +1,130 @@
+syntax = "proto3";
+
+package axern.control.function.v1;
+
+option go_package = "github.com/cofy-x/axern/sdk/go/gen/axern/control/function/v1;functionv1";
+
+import "axern/control/function/v1/function_types.proto";
+import "google/protobuf/duration.proto";
+
+message UploadFunctionBundleOpen {
+  string namespace = 1;
+  string name = 2;
+  string digest = 3;
+  string media_type = 4;
+  int64 size_bytes = 5;
+}
+
+message UploadFunctionBundleRequest {
+  oneof request {
+    UploadFunctionBundleOpen open = 1;
+    bytes chunk = 2;
+  }
+}
+
+message UploadFunctionBundleResponse {
+  FunctionBundleSource bundle = 1;
+}
+
+message DeployFunctionRequest {
+  string namespace = 1;
+  string name = 2;
+  FunctionSpec spec = 3;
+  FunctionSource source = 4;
+  map<string, string> labels = 5;
+  bool wait_ready = 6;
+  google.protobuf.Duration ready_timeout = 7;
+}
+
+message DeployFunctionResponse {
+  Function function = 1;
+  FunctionRevision revision = 2;
+  FunctionDeployment deployment = 3;
+}
+
+message GetFunctionRequest {
+  string function_id = 1;
+  string namespace = 2;
+  string name = 3;
+}
+
+message GetFunctionResponse {
+  Function function = 1;
+  FunctionRevision active_revision = 2;
+  FunctionDeployment deployment = 3;
+}
+
+message ListFunctionsRequest {
+  FunctionListFilter filter = 1;
+}
+
+message ListFunctionsResponse {
+  repeated Function functions = 1;
+  string next_cursor = 2;
+}
+
+message DeleteFunctionRequest {
+  string function_id = 1;
+  string namespace = 2;
+  string name = 3;
+}
+
+message DeleteFunctionResponse {
+  Function function = 1;
+}
+
+message InvokeFunctionRequest {
+  string namespace = 1;
+  string name = 2;
+  string function_id = 3;
+  string revision_id = 4;
+  FunctionInvocationMode mode = 5;
+  FunctionPayload payload = 6;
+  google.protobuf.Duration timeout = 7;
+  string request_id = 8;
+  map<string, string> labels = 9;
+}
+
+message InvokeFunctionResponse {
+  FunctionInvocation invocation = 1;
+}
+
+message GetFunctionInvocationRequest {
+  string invocation_id = 1;
+}
+
+message GetFunctionInvocationResponse {
+  FunctionInvocation invocation = 1;
+}
+
+message ListFunctionInvocationsRequest {
+  FunctionInvocationListFilter filter = 1;
+}
+
+message ListFunctionInvocationsResponse {
+  repeated FunctionInvocation invocations = 1;
+  string next_cursor = 2;
+}
+
+message ListFunctionEventsRequest {
+  string function_id = 1;
+  string invocation_id = 2;
+  string revision_id = 3;
+  int32 limit = 4;
+}
+
+message ListFunctionEventsResponse {
+  repeated FunctionEvent events = 1;
+}
+
+service FunctionControl {
+  rpc UploadFunctionBundle(stream UploadFunctionBundleRequest) returns (UploadFunctionBundleResponse) {}
+  rpc DeployFunction(DeployFunctionRequest) returns (DeployFunctionResponse) {}
+  rpc GetFunction(GetFunctionRequest) returns (GetFunctionResponse) {}
+  rpc ListFunctions(ListFunctionsRequest) returns (ListFunctionsResponse) {}
+  rpc DeleteFunction(DeleteFunctionRequest) returns (DeleteFunctionResponse) {}
+  rpc InvokeFunction(InvokeFunctionRequest) returns (InvokeFunctionResponse) {}
+  rpc GetFunctionInvocation(GetFunctionInvocationRequest) returns (GetFunctionInvocationResponse) {}
+  rpc ListFunctionInvocations(ListFunctionInvocationsRequest) returns (ListFunctionInvocationsResponse) {}
+  rpc ListFunctionEvents(ListFunctionEventsRequest) returns (ListFunctionEventsResponse) {}
+}

package/dist/proto/axern/control/function/v1/function_types.proto

@@ -0,0 +1,233 @@
+syntax = "proto3";
+
+package axern.control.function.v1;
+
+option go_package = "github.com/cofy-x/axern/sdk/go/gen/axern/control/function/v1;functionv1";
+
+import "axern/control/common/v1/common.proto";
+import "axern/control/environment/v1/environment.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+enum FunctionStatus {
+  FUNCTION_STATUS_UNSPECIFIED = 0;
+  FUNCTION_STATUS_DEPLOYING = 1;
+  FUNCTION_STATUS_READY = 2;
+  FUNCTION_STATUS_DEGRADED = 3;
+  FUNCTION_STATUS_FAILED = 4;
+  FUNCTION_STATUS_DELETING = 5;
+  FUNCTION_STATUS_DELETED = 6;
+}
+
+enum FunctionDeploymentStatus {
+  FUNCTION_DEPLOYMENT_STATUS_UNSPECIFIED = 0;
+  FUNCTION_DEPLOYMENT_STATUS_PENDING = 1;
+  FUNCTION_DEPLOYMENT_STATUS_WARMING = 2;
+  FUNCTION_DEPLOYMENT_STATUS_READY = 3;
+  FUNCTION_DEPLOYMENT_STATUS_SCALED_TO_ZERO = 4;
+  FUNCTION_DEPLOYMENT_STATUS_DEGRADED = 5;
+  FUNCTION_DEPLOYMENT_STATUS_FAILED = 6;
+}
+
+enum FunctionInvocationStatus {
+  FUNCTION_INVOCATION_STATUS_UNSPECIFIED = 0;
+  FUNCTION_INVOCATION_STATUS_ACCEPTED = 1;
+  FUNCTION_INVOCATION_STATUS_QUEUED = 2;
+  FUNCTION_INVOCATION_STATUS_RUNNING = 3;
+  FUNCTION_INVOCATION_STATUS_SUCCEEDED = 4;
+  FUNCTION_INVOCATION_STATUS_FAILED = 5;
+  FUNCTION_INVOCATION_STATUS_CANCELLED = 6;
+  FUNCTION_INVOCATION_STATUS_TIMED_OUT = 7;
+}
+
+enum FunctionInvocationMode {
+  FUNCTION_INVOCATION_MODE_UNSPECIFIED = 0;
+  FUNCTION_INVOCATION_MODE_SYNC = 1;
+  FUNCTION_INVOCATION_MODE_ASYNC = 2;
+}
+
+enum FunctionEventType {
+  FUNCTION_EVENT_TYPE_UNSPECIFIED = 0;
+  FUNCTION_EVENT_TYPE_DEPLOY_STARTED = 1;
+  FUNCTION_EVENT_TYPE_REVISION_CREATED = 2;
+  FUNCTION_EVENT_TYPE_REVISION_ACTIVATED = 3;
+  FUNCTION_EVENT_TYPE_WARM_POOL_READY = 4;
+  FUNCTION_EVENT_TYPE_INVOCATION_STARTED = 5;
+  FUNCTION_EVENT_TYPE_INVOCATION_SUCCEEDED = 6;
+  FUNCTION_EVENT_TYPE_INVOCATION_FAILED = 7;
+  FUNCTION_EVENT_TYPE_SCALING_DECISION = 8;
+  FUNCTION_EVENT_TYPE_CLEANUP = 9;
+}
+
+message Function {
+  string id = 1;
+  string namespace = 2;
+  string name = 3;
+  string active_revision_id = 4;
+  FunctionSpec spec = 5;
+  FunctionStatus status = 6;
+  FunctionDeploymentStatus deployment_status = 7;
+  map<string, string> labels = 8;
+  int64 version = 9;
+  google.protobuf.Timestamp created_at = 10;
+  google.protobuf.Timestamp updated_at = 11;
+  string message = 12;
+  axern.control.common.v1.WorkloadDiagnosticCode diagnostic_code = 13;
+}
+
+message FunctionRevision {
+  string id = 1;
+  string function_id = 2;
+  string namespace = 3;
+  string name = 4;
+  int64 revision_number = 5;
+  FunctionSpec spec = 6;
+  FunctionSource source = 7;
+  string source_digest = 8;
+  string manifest_digest = 9;
+  map<string, string> labels = 10;
+  google.protobuf.Timestamp created_at = 11;
+  string created_by = 12;
+}
+
+message FunctionDeployment {
+  string function_id = 1;
+  string active_revision_id = 2;
+  FunctionDeploymentStatus status = 3;
+  FunctionScalingSpec scaling = 4;
+  int32 desired_replicas = 5;
+  int32 ready_replicas = 6;
+  int32 active_invocations = 7;
+  google.protobuf.Timestamp updated_at = 8;
+  string message = 9;
+  axern.control.common.v1.WorkloadDiagnosticCode diagnostic_code = 10;
+  string worker_service_id = 11;
+}
+
+message FunctionInvocation {
+  string id = 1;
+  string function_id = 2;
+  string function_name = 3;
+  string namespace = 4;
+  string revision_id = 5;
+  FunctionInvocationStatus status = 6;
+  FunctionInvocationMode mode = 7;
+  FunctionPayload payload = 8;
+  FunctionResult result = 9;
+  FunctionError error = 10;
+  google.protobuf.Duration timeout = 11;
+  google.protobuf.Duration duration = 12;
+  string request_id = 13;
+  map<string, string> labels = 14;
+  google.protobuf.Timestamp created_at = 15;
+  google.protobuf.Timestamp started_at = 16;
+  google.protobuf.Timestamp completed_at = 17;
+  string message = 18;
+  axern.control.common.v1.WorkloadDiagnosticCode diagnostic_code = 19;
+}
+
+message FunctionEvent {
+  string id = 1;
+  string function_id = 2;
+  string invocation_id = 3;
+  string revision_id = 4;
+  FunctionEventType type = 5;
+  string message = 6;
+  map<string, string> details = 7;
+  google.protobuf.Timestamp created_at = 8;
+}
+
+message FunctionSpec {
+  string runtime = 1;
+  string handler = 2;
+  string initializer = 3;
+  FunctionSourceSpec source = 4;
+  google.protobuf.Duration timeout = 5;
+  axern.control.common.v1.ExecutionConfig config = 6;
+  FunctionScalingSpec scaling = 7;
+  FunctionRetentionPolicy retention = 8;
+  FunctionWorkerSource worker_source = 9;
+}
+
+message FunctionWorkerSource {
+  oneof source {
+    string environment_id = 1;
+    axern.control.environment.v1.EnvironmentSpec environment = 2;
+  }
+}
+
+message FunctionSourceSpec {
+  oneof source {
+    FunctionBundleSource bundle = 1;
+    FunctionImageSource image = 2;
+  }
+}
+
+message FunctionSource {
+  oneof source {
+    FunctionBundleSource bundle = 1;
+    FunctionImageSource image = 2;
+  }
+}
+
+message FunctionBundleSource {
+  string digest = 1;
+  string media_type = 2;
+  int64 size_bytes = 3;
+  string storage_uri = 4;
+}
+
+message FunctionImageSource {
+  string ref = 1;
+  string digest = 2;
+  string registry_credential_id = 3;
+}
+
+message FunctionScalingSpec {
+  int32 min_replicas = 1;
+  int32 max_replicas = 2;
+  int32 concurrency = 3;
+  google.protobuf.Duration idle_timeout = 4;
+}
+
+message FunctionRetentionPolicy {
+  google.protobuf.Duration invocation_retention = 1;
+  int32 max_invocations = 2;
+}
+
+message FunctionPayload {
+  string content_type = 1;
+  bytes data = 2;
+}
+
+message FunctionResult {
+  string content_type = 1;
+  bytes data = 2;
+}
+
+message FunctionError {
+  string code = 1;
+  string message = 2;
+  string type = 3;
+  string stack_trace = 4;
+  map<string, string> details = 5;
+}
+
+message FunctionListFilter {
+  string namespace = 1;
+  repeated FunctionStatus statuses = 2;
+  map<string, string> labels = 3;
+  string cursor = 4;
+  int32 page_size = 5;
+}
+
+message FunctionInvocationListFilter {
+  string namespace = 1;
+  string function_id = 2;
+  string function_name = 3;
+  string revision_id = 4;
+  repeated FunctionInvocationStatus statuses = 5;
+  map<string, string> labels = 6;
+  string cursor = 7;
+  int32 page_size = 8;
+}

package/dist/proto/axern/control/gateway/v1/gateway.proto

@@ -0,0 +1,60 @@
+syntax = "proto3";
+
+package axern.control.gateway.v1;
+
+option go_package = "github.com/cofy-x/axern/sdk/go/gen/axern/control/gateway/v1;gatewayv1";
+
+import "axern/control/common/v1/common.proto";
+import "axern/control/service/v1/service_types.proto";
+
+message ResolveServiceRouteRequest {
+  string namespace = 1;
+  string service_id = 2;
+  string port_ref = 3;
+  int64 ttl_seconds = 4;
+}
+
+message ServiceRoutePort {
+  string name = 1;
+  axern.control.common.v1.PortProtocol protocol = 2;
+  int32 container_port = 3;
+}
+
+message ServiceRouteEndpoint {
+  string allocation_id = 1;
+  string node_id = 2;
+  string node_target = 3;
+  int64 attempt = 4;
+  int32 container_port = 5;
+  axern.control.common.v1.PortProtocol protocol = 6;
+  bool ready = 7;
+  axern.control.common.v1.ExecutionLease lease = 8;
+}
+
+message ResolveServiceRouteResponse {
+  string service_id = 1;
+  string namespace = 2;
+  axern.control.service.v1.ServiceStatus service_status = 3;
+  ServiceRoutePort port = 4;
+  repeated ServiceRouteEndpoint endpoints = 5;
+}
+
+message ResolveAllocationTerminalRequest {
+  string allocation_id = 1;
+  int64 ttl_seconds = 2;
+}
+
+message ResolveAllocationTerminalResponse {
+  string allocation_id = 1;
+  string owner_type = 2;
+  string owner_id = 3;
+  string node_id = 4;
+  string node_target = 5;
+  int64 attempt = 6;
+  axern.control.common.v1.ExecutionLease lease = 7;
+}
+
+service GatewayControl {
+  rpc ResolveServiceRoute(ResolveServiceRouteRequest) returns (ResolveServiceRouteResponse) {}
+  rpc ResolveAllocationTerminal(ResolveAllocationTerminalRequest) returns (ResolveAllocationTerminalResponse) {}
+}