Skip to content

Commit

Permalink
feat(run): update the API
Browse files Browse the repository at this point in the history
#### run:v1

The following keys were changed:
- schemas.ObjectMeta.description
- schemas.ObjectMeta.properties.annotations.description
- schemas.RouteStatus.properties.url.description
- schemas.RunJobRequest.properties.overrides.description
- schemas.Service.properties.metadata.description
- schemas.ServiceStatus.properties.url.description

#### run:v2

The following keys were added:
- schemas.GoogleCloudRunV2NetworkInterface.description
- schemas.GoogleCloudRunV2NetworkInterface.id
- schemas.GoogleCloudRunV2NetworkInterface.properties.network.description
- schemas.GoogleCloudRunV2NetworkInterface.properties.network.type
- schemas.GoogleCloudRunV2NetworkInterface.properties.subnetwork.description
- schemas.GoogleCloudRunV2NetworkInterface.properties.subnetwork.type
- schemas.GoogleCloudRunV2NetworkInterface.properties.tags.description
- schemas.GoogleCloudRunV2NetworkInterface.properties.tags.items.type
- schemas.GoogleCloudRunV2NetworkInterface.properties.tags.type
- schemas.GoogleCloudRunV2NetworkInterface.type
- schemas.GoogleCloudRunV2Task.properties.scheduledTime.description
- schemas.GoogleCloudRunV2Task.properties.scheduledTime.format
- schemas.GoogleCloudRunV2Task.properties.scheduledTime.readOnly
- schemas.GoogleCloudRunV2Task.properties.scheduledTime.type
- schemas.GoogleCloudRunV2VpcAccess.properties.networkInterfaces.description
- schemas.GoogleCloudRunV2VpcAccess.properties.networkInterfaces.items.$ref
- schemas.GoogleCloudRunV2VpcAccess.properties.networkInterfaces.type

The following keys were changed:
- schemas.GoogleCloudRunV2GRPCAction.properties.service.description
- schemas.GoogleCloudRunV2VpcAccess.description
- schemas.GoogleCloudRunV2VpcAccess.properties.connector.description
  • Loading branch information
yoshi-automation authored and sofisl committed Sep 22, 2023
1 parent ba147af commit cf50ff6
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 20 deletions.
14 changes: 7 additions & 7 deletions discovery/run-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2289,7 +2289,7 @@
}
}
},
"revision": "20230806",
"revision": "20230917",
"rootUrl": "https://run.googleapis.com/",
"schemas": {
"Addressable": {
Expand Down Expand Up @@ -3583,14 +3583,14 @@
"type": "object"
},
"ObjectMeta": {
"description": "k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"description": "google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"id": "ObjectMeta",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.",
"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/disable-default-uri`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.",
"type": "object"
},
"clusterName": {
Expand Down Expand Up @@ -4038,7 +4038,7 @@
"type": "array"
},
"url": {
"description": "URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app",
"description": "URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: `https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app`",
"type": "string"
}
},
Expand All @@ -4050,7 +4050,7 @@
"properties": {
"overrides": {
"$ref": "Overrides",
"description": "Optional. Private preview feature. Currently only available by invitation. Overrides specification for a given execution of a job. The specified values update the specification of the created execution."
"description": "Optional. Overrides existing job configuration for one specific new job execution only, using the specified values to update the job configuration for the new execution."
}
},
"type": "object"
Expand Down Expand Up @@ -4152,7 +4152,7 @@
},
"metadata": {
"$ref": "ObjectMeta",
"description": "Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal."
"description": "Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/disable-default-uri` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal."
},
"spec": {
"$ref": "ServiceSpec",
Expand Down Expand Up @@ -4219,7 +4219,7 @@
"type": "array"
},
"url": {
"description": "URL that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app",
"description": "URL that will distribute traffic over the provided traffic targets. It generally has the form `https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app`",
"type": "string"
}
},
Expand Down
43 changes: 39 additions & 4 deletions discovery/run-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -1115,7 +1115,7 @@
}
}
},
"revision": "20230806",
"revision": "20230917",
"rootUrl": "https://run.googleapis.com/",
"schemas": {
"GoogleCloudRunV2BinaryAuthorization": {
Expand Down Expand Up @@ -1701,7 +1701,7 @@
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.",
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
Expand Down Expand Up @@ -1990,6 +1990,28 @@
},
"type": "object"
},
"GoogleCloudRunV2NetworkInterface": {
"description": "Direct VPC egress settings.",
"id": "GoogleCloudRunV2NetworkInterface",
"properties": {
"network": {
"description": "The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.",
"type": "string"
},
"subnetwork": {
"description": "The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.",
"type": "string"
},
"tags": {
"description": "Network tags applied to this Cloud Run resource.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudRunV2Probe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"id": "GoogleCloudRunV2Probe",
Expand Down Expand Up @@ -2772,6 +2794,12 @@
"readOnly": true,
"type": "boolean"
},
"scheduledTime": {
"description": "Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"serviceAccount": {
"description": "Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.",
"type": "string"
Expand Down Expand Up @@ -3019,11 +3047,11 @@
"type": "object"
},
"GoogleCloudRunV2VpcAccess": {
"description": "VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc",
"description": "VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.",
"id": "GoogleCloudRunV2VpcAccess",
"properties": {
"connector": {
"description": "VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number.",
"description": "VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.",
"type": "string"
},
"egress": {
Expand All @@ -3039,6 +3067,13 @@
"Only private IP ranges are routed through the VPC connector."
],
"type": "string"
},
"networkInterfaces": {
"description": "Direct VPC egress settings. Currently only single network interface is supported.",
"items": {
"$ref": "GoogleCloudRunV2NetworkInterface"
},
"type": "array"
}
},
"type": "object"
Expand Down

0 comments on commit cf50ff6

Please sign in to comment.