feat: Adds Startup and Liveness probes to Cloud Run v2 API client libraries

Google APIs · copybara-github · commit 778762cee044 · 2022-10-14T12:14:07.000-07:00
For more information about this feature, visit https://cloud.google.com/run/docs/configuring/healthchecks PiperOrigin-RevId: 481203788
diff --git a/google/cloud/run/v2/BUILD.bazel b/google/cloud/run/v2/BUILD.bazel
@@ -49,6 +49,7 @@ proto_library_with_info(
     deps = [
         ":run_proto",
         "//google/cloud:common_resources_proto",
+        "//google/cloud/location:location_proto",
     ],
 )
 
@@ -80,15 +81,18 @@ java_gapic_library(
     srcs = [":run_proto_with_info"],
     gapic_yaml = None,
     grpc_service_config = "run_grpc_service_config.json",
+    rest_numeric_enums = False,
     service_yaml = "run_v2.yaml",
     test_deps = [
         ":run_java_grpc",
+        "//google/cloud/location:location_java_grpc",
         "//google/iam/v1:iam_java_grpc",
     ],
     transport = "grpc+rest",
     deps = [
         ":run_java_proto",
         "//google/api:api_java_proto",
+        "//google/cloud/location:location_java_proto",
         "//google/iam/v1:iam_java_proto",
     ],
 )
@@ -148,10 +152,12 @@ go_gapic_library(
     grpc_service_config = "run_grpc_service_config.json",
     importpath = "cloud.google.com/go/run/apiv2;run",
     metadata = True,
+    rest_numeric_enums = False,
     service_yaml = "run_v2.yaml",
     transport = "grpc+rest",
     deps = [
         ":run_go_proto",
+        "//google/cloud/location:location_go_proto",
         "//google/iam/v1:iam_go_proto",
         "//google/longrunning:longrunning_go_proto",
         "@com_google_cloud_go//longrunning:go_default_library",
@@ -185,12 +191,14 @@ load(
     "@com_google_googleapis_imports//:imports.bzl",
     "py_gapic_assembly_pkg",
     "py_gapic_library",
+    "py_test",
 )
 
 py_gapic_library(
     name = "run_py_gapic",
     srcs = [":run_proto"],
     grpc_service_config = "run_grpc_service_config.json",
+    rest_numeric_enums = False,
     service_yaml = "run_v2.yaml",
     transport = "grpc+rest",
     deps = [
@@ -242,6 +250,7 @@ php_gapic_library(
     name = "run_php_gapic",
     srcs = [":run_proto_with_info"],
     grpc_service_config = "run_grpc_service_config.json",
+    rest_numeric_enums = False,
     service_yaml = "run_v2.yaml",
     deps = [
         ":run_php_grpc",
@@ -275,6 +284,7 @@ nodejs_gapic_library(
     extra_protoc_parameters = ["metadata"],
     grpc_service_config = "run_grpc_service_config.json",
     package = "google.cloud.run.v2",
+    rest_numeric_enums = False,
     service_yaml = "run_v2.yaml",
     deps = [],
 )
@@ -320,8 +330,10 @@ ruby_cloud_gapic_library(
         "ruby-cloud-wrapper-gem-override=google-cloud-run-client",
     ],
     grpc_service_config = "run_grpc_service_config.json",
+    rest_numeric_enums = False,
     ruby_cloud_description = "Cloud Run deploys and manages user provided container images that scale automatically based on incoming requests.",
     ruby_cloud_title = "Cloud Run V2",
+    service_yaml = "run_v2.yaml",
     deps = [
         ":run_ruby_grpc",
         ":run_ruby_proto",
@@ -365,6 +377,7 @@ csharp_gapic_library(
     srcs = [":run_proto_with_info"],
     common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
     grpc_service_config = "run_grpc_service_config.json",
+    rest_numeric_enums = False,
     service_yaml = "run_v2.yaml",
     deps = [
         ":run_csharp_grpc",
diff --git a/google/cloud/run/v2/condition.proto b/google/cloud/run/v2/condition.proto
@@ -162,6 +162,9 @@ message Condition {
     // A task reached its retry limit and the last attempt failed due to the
     // user container exiting with a non-zero exit code.
     NON_ZERO_EXIT_CODE = 2;
+
+    // The execution was cancelled by users.
+    CANCELLED = 3;
   }
 
   // type is used to communicate the status of the reconciliation process.
diff --git a/google/cloud/run/v2/k8s.min.proto b/google/cloud/run/v2/k8s.min.proto
@@ -93,6 +93,25 @@ message Container {
 
   // Volume to mount into the container's filesystem.
   repeated VolumeMount volume_mounts = 8;
+
+  // Container's working directory.
+  // If not specified, the container runtime's default will be used, which
+  // might be configured in the container image.
+  string working_dir = 9;
+
+  // Periodic probe of container liveness.
+  // Container will be restarted if the probe fails.
+  // More info:
+  // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+  Probe liveness_probe = 10;
+
+  // Startup probe of application within the container.
+  // All other probes are disabled if a startup probe is provided, until it
+  // succeeds. Container will not be added to service endpoints if the probe
+  // fails.
+  // More info:
+  // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+  Probe startup_probe = 11;
 }
 
 // ResourceRequirements describes the compute resource requirements.
@@ -215,7 +234,7 @@ message SecretVolumeSource {
   repeated VersionToPath items = 2;
 
   // Integer representation of mode bits to use on created files by default.
-  // Must be a value between 0000 and 0777 (octal), defaulting to 0644.
+  // Must be a value between 0000 and 0777 (octal), defaulting to 0444.
   // Directories within the path are not affected by  this setting.
   //
   // Notes
@@ -272,3 +291,66 @@ message CloudSqlInstance {
   // {project}:{location}:{instance}
   repeated string instances = 1;
 }
+
+// Probe describes a health check to be performed against a container to
+// determine whether it is alive or ready to receive traffic.
+message Probe {
+  // Number of seconds after the container has started before the probe is
+  // initiated.
+  // Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe
+  // is 3600. Maximum value for startup probe is 240.
+  // More info:
+  // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+  int32 initial_delay_seconds = 1;
+
+  // Number of seconds after which the probe times out.
+  // Defaults to 1 second. Minimum value is 1. Maximum value is 3600.
+  // Must be smaller than period_seconds.
+  // More info:
+  // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+  int32 timeout_seconds = 2;
+
+  // How often (in seconds) to perform the probe.
+  // Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe
+  // is 3600. Maximum value for startup probe is 240.
+  // Must be greater or equal than timeout_seconds.
+  int32 period_seconds = 3;
+
+  // Minimum consecutive failures for the probe to be considered failed after
+  // having succeeded. Defaults to 3. Minimum value is 1.
+  int32 failure_threshold = 4;
+
+  oneof probe_type {
+    // HTTPGet specifies the http request to perform.
+    // Exactly one of HTTPGet or TCPSocket must be specified.
+    HTTPGetAction http_get = 5;
+
+    // TCPSocket specifies an action involving a TCP port.
+    // Exactly one of HTTPGet or TCPSocket must be specified.
+    TCPSocketAction tcp_socket = 6;
+  }
+}
+
+// HTTPGetAction describes an action based on HTTP Get requests.
+message HTTPGetAction {
+  // Path to access on the HTTP server. Defaults to '/'.
+  string path = 1;
+
+  // Custom headers to set in the request. HTTP allows repeated headers.
+  repeated HTTPHeader http_headers = 4;
+}
+
+// HTTPHeader describes a custom header to be used in HTTP probes
+message HTTPHeader {
+  // Required. The header field name
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // The header field value
+  string value = 2;
+}
+
+// TCPSocketAction describes an action based on opening a socket
+message TCPSocketAction {
+  // Port number to access on the container. Must be in the range 1 to 65535.
+  int32 port = 1;
+}
diff --git a/google/cloud/run/v2/run_v2.yaml b/google/cloud/run/v2/run_v2.yaml
@@ -4,8 +4,10 @@ name: run.googleapis.com
 title: Cloud Run Admin API
 
 apis:
+- name: google.cloud.location.Locations
 - name: google.cloud.run.v2.Revisions
 - name: google.cloud.run.v2.Services
+- name: google.longrunning.Operations
 
 documentation:
   rules:
diff --git a/google/cloud/run/v2/service.proto b/google/cloud/run/v2/service.proto
@@ -157,8 +157,9 @@ service Services {
 
 // Request message for creating a Service.
 message CreateServiceRequest {
-  // Required. The location and project in which this service should be created.
-  // Format: projects/{projectnumber}/locations/{location}
+  // The location and project in which this service should be created.
+  // Format: projects/{project}/locations/{location}
+  // Only lowercase characters, digits, and hyphens.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -169,8 +170,9 @@ message CreateServiceRequest {
   // Required. The Service instance to create.
   Service service = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The unique identifier for the Service. The name of the service becomes
-  // {parent}/services/{service_id}.
+  // Required. The unique identifier for the Service. It must begin with letter,
+  // and may not end with hyphen; must contain fewer than 50 characters.
+  // The name of the service becomes {parent}/services/{service_id}.
   string service_id = 3 [(google.api.field_behavior) = REQUIRED];
 
   // Indicates that the request should be validated and default values
@@ -197,7 +199,7 @@ message UpdateServiceRequest {
 message ListServicesRequest {
   // Required. The location and project to list resources on.
   // Location must be a valid GCP region, and may not be the "-" wildcard.
-  // Format: projects/{projectnumber}/locations/{location}
+  // Format: projects/{project}/locations/{location}
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -229,7 +231,7 @@ message ListServicesResponse {
 // Request message for obtaining a Service by its full name.
 message GetServiceRequest {
   // Required. The full name of the Service.
-  // Format: projects/{projectnumber}/locations/{location}/services/{service}
+  // Format: projects/{project}/locations/{location}/services/{service}
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -241,7 +243,7 @@ message GetServiceRequest {
 // Request message to delete a Service by its full name.
 message DeleteServiceRequest {
   // Required. The full name of the Service.
-  // Format: projects/{projectnumber}/locations/{location}/services/{service}
+  // Format: projects/{project}/locations/{location}/services/{service}
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {

Original file line number	Diff line number	Diff line change
`@@ -162,6 +162,9 @@ message Condition {`
`162`	`162`	`// A task reached its retry limit and the last attempt failed due to the`
`163`	`163`	`// user container exiting with a non-zero exit code.`
`164`	`164`	`NON_ZERO_EXIT_CODE = 2;`
	`165`	`+`
	`166`	`+ // The execution was cancelled by users.`
	`167`	`+ CANCELLED = 3;`
`165`	`168`	`}`
`166`	`169`
`167`	`170`	`// type is used to communicate the status of the reconciliation process.`