| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="run_v1.html">Cloud Run API</a> . <a href="run_v1.projects.html">projects</a> . <a href="run_v1.projects.locations.html">locations</a> . <a href="run_v1.projects.locations.services.html">services</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Create a service.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Delete a service.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Get information about a service.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Get the IAM Access Control policy currently in effect for the given</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(parent, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, labelSelector=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">List services.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#replaceService">replaceService(name, body=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Replace a service.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Sets the IAM Access control policy for the specified Service. Overwrites</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Returns permissions that a caller has on the specified Project.</p> |
| 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| 103 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 104 | <pre>Create a service. |
| 105 | |
| 106 | Args: |
| 107 | parent: string, The namespace in which the service should be created. |
| 108 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 109 | or number. (required) |
| 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # Service acts as a top-level container that manages a set of Routes and |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 114 | # Configurations which implement a network service. Service exists to provide a |
| 115 | # singular abstraction which can be access controlled, reasoned about, and |
| 116 | # which encapsulates software lifecycle decisions such as rollout policy and |
| 117 | # team resource ownership. Service acts only as an orchestrator of the |
| 118 | # underlying Routes and Configurations (much as a kubernetes Deployment |
| 119 | # orchestrates ReplicaSets). |
| 120 | # |
| 121 | # The Service's controller will track the statuses of its owned Configuration |
| 122 | # and Route, reflecting their statuses and conditions as its own. |
| 123 | # |
| 124 | # See also: |
| 125 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#service |
| 126 | "kind": "A String", # The kind of resource, in this case "Service". |
| 127 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Service, including name, namespace, labels, |
| 128 | # and annotations. |
| 129 | # persisted resources must have, which includes all objects users must create. |
| 130 | "annotations": { # (Optional) |
| 131 | # |
| 132 | # Annotations is an unstructured key value map stored with a resource that |
| 133 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 134 | # are not queryable and should be preserved when modifying objects. More |
| 135 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 136 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 138 | "generateName": "A String", # (Optional) |
| 139 | # |
| 140 | # Cloud Run fully managed: not supported |
| 141 | # |
| 142 | # Cloud Run for Anthos: supported |
| 143 | # |
| 144 | # GenerateName is an optional prefix, used by the server, to generate a |
| 145 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 146 | # used, the name returned to the client will be different than the name |
| 147 | # passed. This value will also be combined with a unique suffix. The provided |
| 148 | # value has the same validation rules as the Name field, and may be truncated |
| 149 | # by the length of the suffix required to make the value unique on the |
| 150 | # server. |
| 151 | # |
| 152 | # If this field is specified and the generated name exists, the server will |
| 153 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 154 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 155 | # time allotted, and the client should retry (optionally after the time |
| 156 | # indicated in the Retry-After header). |
| 157 | # |
| 158 | # Applied only if Name is not specified. |
| 159 | # More info: |
| 160 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 161 | # string generateName = 2; |
| 162 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 163 | # Is required when creating |
| 164 | # resources, although some resources may allow a client to request the |
| 165 | # generation of an appropriate name automatically. Name is primarily intended |
| 166 | # for creation idempotence and configuration definition. Cannot be updated. |
| 167 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 168 | # +optional |
| 169 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 170 | # |
| 171 | # Cloud Run fully managed: not supported |
| 172 | # |
| 173 | # Cloud Run for Anthos: supported |
| 174 | # |
| 175 | # Number of seconds allowed for this object to gracefully terminate before |
| 176 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 177 | # set. May only be shortened. Read-only. |
| 178 | "clusterName": "A String", # (Optional) |
| 179 | # |
| 180 | # Cloud Run fully managed: not supported |
| 181 | # |
| 182 | # Cloud Run for Anthos: supported |
| 183 | # |
| 184 | # The name of the cluster which the object belongs to. |
| 185 | # This is used to distinguish resources with same name and namespace in |
| 186 | # different clusters. This field is not set anywhere right now and apiserver |
| 187 | # is going to ignore it if set in create or update request. |
| 188 | "finalizers": [ # (Optional) |
| 189 | # |
| 190 | # Cloud Run fully managed: not supported |
| 191 | # |
| 192 | # Cloud Run for Anthos: supported |
| 193 | # |
| 194 | # Must be empty before the object is deleted from the registry. Each entry |
| 195 | # is an identifier for the responsible component that will remove the entry |
| 196 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 197 | # in this list can only be removed. |
| 198 | # +patchStrategy=merge |
| 199 | "A String", |
| 200 | ], |
| 201 | "deletionTimestamp": "A String", # (Optional) |
| 202 | # |
| 203 | # Cloud Run fully managed: not supported |
| 204 | # |
| 205 | # Cloud Run for Anthos: supported |
| 206 | # |
| 207 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 208 | # deleted. This field is set by the server when a graceful deletion is |
| 209 | # requested by the user, and is not directly settable by a client. The |
| 210 | # resource is expected to be deleted (no longer visible from resource lists, |
| 211 | # and not reachable by name) after the time in this field, once the |
| 212 | # finalizers list is empty. As long as the finalizers list contains items, |
| 213 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 214 | # be unset or be set further into the future, although it may be shortened or |
| 215 | # the resource may be deleted prior to this time. For example, a user may |
| 216 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 217 | # sending a graceful termination signal to the containers in the pod. After |
| 218 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 219 | # to the container and after cleanup, remove the pod from the API. In the |
| 220 | # presence of network partitions, this object may still exist after this |
| 221 | # timestamp, until an administrator or automated process can determine the |
| 222 | # resource is fully terminated. |
| 223 | # If not set, graceful deletion of the object has not been requested. |
| 224 | # |
| 225 | # Populated by the system when a graceful deletion is requested. |
| 226 | # Read-only. |
| 227 | # More info: |
| 228 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 229 | "ownerReferences": [ # (Optional) |
| 230 | # |
| 231 | # Cloud Run fully managed: not supported |
| 232 | # |
| 233 | # Cloud Run for Anthos: supported |
| 234 | # |
| 235 | # List of objects that own this object. If ALL objects in the list have |
| 236 | # been deleted, this object will be garbage collected. |
| 237 | { # OwnerReference contains enough information to let you identify an owning |
| 238 | # object. Currently, an owning object must be in the same namespace, so there |
| 239 | # is no namespace field. |
| 240 | "controller": True or False, # If true, this reference points to the managing controller. |
| 241 | # +optional |
| 242 | "kind": "A String", # Kind of the referent. |
| 243 | # More info: |
| 244 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 245 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 246 | # the owner cannot be deleted from the key-value store until this |
| 247 | # reference is removed. |
| 248 | # Defaults to false. |
| 249 | # To set this field, a user needs "delete" permission of the owner, |
| 250 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 251 | # +optional |
| 252 | "apiVersion": "A String", # API version of the referent. |
| 253 | "name": "A String", # Name of the referent. |
| 254 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 255 | "uid": "A String", # UID of the referent. |
| 256 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 257 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 258 | ], |
| 259 | "creationTimestamp": "A String", # (Optional) |
| 260 | # |
| 261 | # CreationTimestamp is a timestamp representing the server time when this |
| 262 | # object was created. It is not guaranteed to be set in happens-before order |
| 263 | # across separate operations. Clients may not set this value. It is |
| 264 | # represented in RFC3339 form and is in UTC. |
| 265 | # |
| 266 | # Populated by the system. |
| 267 | # Read-only. |
| 268 | # Null for lists. |
| 269 | # More info: |
| 270 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 271 | "labels": { # (Optional) |
| 272 | # |
| 273 | # Map of string keys and values that can be used to organize and categorize |
| 274 | # (scope and select) objects. May match selectors of replication controllers |
| 275 | # and routes. |
| 276 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 277 | "a_key": "A String", |
| 278 | }, |
| 279 | "generation": 42, # (Optional) |
| 280 | # |
| 281 | # A sequence number representing a specific generation of the desired state. |
| 282 | # Populated by the system. Read-only. |
| 283 | "resourceVersion": "A String", # (Optional) |
| 284 | # |
| 285 | # An opaque value that represents the internal version of this object that |
| 286 | # can be used by clients to determine when objects have changed. May be used |
| 287 | # for optimistic concurrency, change detection, and the watch operation on a |
| 288 | # resource or set of resources. Clients must treat these values as opaque and |
| 289 | # passed unmodified back to the server. They may only be valid for a |
| 290 | # particular resource or set of resources. |
| 291 | # |
| 292 | # Populated by the system. |
| 293 | # Read-only. |
| 294 | # Value must be treated as opaque by clients and . |
| 295 | # More info: |
| 296 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 297 | "selfLink": "A String", # (Optional) |
| 298 | # |
| 299 | # SelfLink is a URL representing this object. |
| 300 | # Populated by the system. |
| 301 | # Read-only. |
| 302 | # string selfLink = 4; |
| 303 | "uid": "A String", # (Optional) |
| 304 | # |
| 305 | # UID is the unique in time and space value for this object. It is typically |
| 306 | # generated by the server on successful creation of a resource and is not |
| 307 | # allowed to change on PUT operations. |
| 308 | # |
| 309 | # Populated by the system. |
| 310 | # Read-only. |
| 311 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 312 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 313 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 314 | # project ID or project number. |
| 315 | }, |
| 316 | "status": { # The current state of the Service. Output only. # Status communicates the observed state of the Service (from the |
| 317 | # controller). |
| 318 | "latestCreatedRevisionName": "A String", # From ConfigurationStatus. |
| 319 | # LatestCreatedRevisionName is the last revision that was created from this |
| 320 | # Service's Configuration. It might not be ready yet, for that use |
| 321 | # LatestReadyRevisionName. |
| 322 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 323 | # reconciliation processes that bring the "spec" inline with the observed |
| 324 | # state of the world. |
| 325 | # Service-specific conditions include: |
| 326 | # * "ConfigurationsReady": true when the underlying Configuration is ready. |
| 327 | # * "RoutesReady": true when the underlying Route is ready. |
| 328 | # * "Ready": true when both the underlying Route and Configuration are |
| 329 | # ready. |
| 330 | { # Condition defines a generic condition for a Resource |
| 331 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 332 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 333 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 334 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 335 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 336 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 337 | # See also: |
| 338 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 339 | # Types common to all resources include: |
| 340 | # * "Ready": True when the Resource is ready. |
| 341 | }, |
| 342 | ], |
| 343 | "address": { # Information for connecting over HTTP(s). # From RouteStatus. |
| 344 | # Similar to url, information on where the service is available on HTTP. |
| 345 | "url": "A String", |
| 346 | }, |
| 347 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 348 | # was last processed by the controller. |
| 349 | # |
| 350 | # Clients polling for completed reconciliation should poll until |
| 351 | # observedGeneration = metadata.generation and the Ready condition's status |
| 352 | # is True or False. |
| 353 | "url": "A String", # From RouteStatus. |
| 354 | # URL holds the url that will distribute traffic over the provided traffic |
| 355 | # targets. It generally has the form |
| 356 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 357 | "traffic": [ # From RouteStatus. |
| 358 | # Traffic holds the configured traffic distribution. |
| 359 | # These entries will always contain RevisionName references. |
| 360 | # When ConfigurationName appears in the spec, this will hold the |
| 361 | # LatestReadyRevisionName that we last observed. |
| 362 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 363 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 364 | # traffic. This is mutually exclusive with ConfigurationName. |
| 365 | # |
| 366 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 367 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 368 | # ready Revision of the Configuration should be used for this traffic |
| 369 | # target. When provided LatestRevision must be true if RevisionName is |
| 370 | # empty; it must be false when RevisionName is non-empty. |
| 371 | # |
| 372 | # +optional |
| 373 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 374 | # this target exclusively. |
| 375 | # |
| 376 | # Not currently supported in Cloud Run. |
| 377 | # +optional |
| 378 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 379 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 380 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 381 | # (e.g. basic auth, url path, etc. |
| 382 | # |
| 383 | # Not currently supported in Cloud Run. |
| 384 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 385 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 386 | # of the referenced configuration changes, we will automatically migrate |
| 387 | # traffic from the prior "latest ready" revision to the new one. This field |
| 388 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 389 | # with RevisionName. |
| 390 | # |
| 391 | # Cloud Run currently supports a single ConfigurationName. |
| 392 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 393 | # This defaults to zero if unspecified. |
| 394 | # |
| 395 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 396 | # TrafficTarget entry. |
| 397 | }, |
| 398 | ], |
| 399 | "latestReadyRevisionName": "A String", # From ConfigurationStatus. |
| 400 | # LatestReadyRevisionName holds the name of the latest Revision stamped out |
| 401 | # from this Service's Configuration that has had its "Ready" condition become |
| 402 | # "True". |
| 403 | }, |
| 404 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 405 | "spec": { # ServiceSpec holds the desired state of the Route (from the client), which # Spec holds the desired state of the Service (from the client). |
| 406 | # is used to manipulate the underlying Route and Configuration(s). |
| 407 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 408 | # Revisions and Configurations. |
| 409 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 410 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 411 | # traffic. This is mutually exclusive with ConfigurationName. |
| 412 | # |
| 413 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 414 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 415 | # ready Revision of the Configuration should be used for this traffic |
| 416 | # target. When provided LatestRevision must be true if RevisionName is |
| 417 | # empty; it must be false when RevisionName is non-empty. |
| 418 | # |
| 419 | # +optional |
| 420 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 421 | # this target exclusively. |
| 422 | # |
| 423 | # Not currently supported in Cloud Run. |
| 424 | # +optional |
| 425 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 426 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 427 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 428 | # (e.g. basic auth, url path, etc. |
| 429 | # |
| 430 | # Not currently supported in Cloud Run. |
| 431 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 432 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 433 | # of the referenced configuration changes, we will automatically migrate |
| 434 | # traffic from the prior "latest ready" revision to the new one. This field |
| 435 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 436 | # with RevisionName. |
| 437 | # |
| 438 | # Cloud Run currently supports a single ConfigurationName. |
| 439 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 440 | # This defaults to zero if unspecified. |
| 441 | # |
| 442 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 443 | # TrafficTarget entry. |
| 444 | }, |
| 445 | ], |
| 446 | "template": { # RevisionTemplateSpec describes the data a revision should have when created # Template holds the latest specification for the Revision to |
| 447 | # be stamped out. |
| 448 | # from a template. Based on: |
| 449 | # https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 |
| 450 | "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). |
| 451 | "containerConcurrency": 42, # (Optional) |
| 452 | # |
| 453 | # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) |
| 454 | # requests per container instance of the Revision. |
| 455 | # |
| 456 | # Cloud Run fully managed: supported, defaults to 80 |
| 457 | # |
| 458 | # Cloud Run for Anthos: supported, defaults to 0, which means concurrency |
| 459 | # to the application is not limited, and the system decides the |
| 460 | # target concurrency for the autoscaler. |
| 461 | "timeoutSeconds": 42, # TimeoutSeconds holds the max duration the instance is allowed for |
| 462 | # responding to a request. |
| 463 | # Not currently used by Cloud Run. |
| 464 | "serviceAccountName": "A String", # Email address of the IAM service account associated with the revision |
| 465 | # of the service. The service account represents the identity of the |
| 466 | # running revision, and determines what permissions the revision has. If |
| 467 | # not provided, the revision will use the project's default service account. |
| 468 | "containers": [ # Containers holds the single container that defines the unit of execution |
| 469 | # for this Revision. In the context of a Revision, we disallow a number of |
| 470 | # fields on this Container, including: name and lifecycle. |
| 471 | # In Cloud Run, only a single container may be provided. |
| 472 | # The runtime contract is documented here: |
| 473 | # https://github.com/knative/serving/blob/master/docs/runtime-contract.md |
| 474 | { # A single application container. |
| 475 | # This specifies both the container to run, the command to run in the container |
| 476 | # and the arguments to supply to it. |
| 477 | # Note that additional arguments may be supplied by the system to the container |
| 478 | # at runtime. |
| 479 | "securityContext": { # Cloud Run fully managed: not supported # (Optional) |
| 480 | # |
| 481 | # Cloud Run fully managed: not supported |
| 482 | # |
| 483 | # Cloud Run for Anthos: supported |
| 484 | # |
| 485 | # Security options the pod should run with. |
| 486 | # More info: https://kubernetes.io/docs/concepts/policy/security-context/ |
| 487 | # More info: |
| 488 | # https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| 489 | # |
| 490 | # Cloud Run for Anthos: supported |
| 491 | # |
| 492 | # SecurityContext holds security configuration that will be applied to a |
| 493 | # container. Some fields are present in both SecurityContext and |
| 494 | # PodSecurityContext. When both are set, the values in SecurityContext take |
| 495 | # precedence. |
| 496 | "runAsUser": 42, # (Optional) |
| 497 | # |
| 498 | # Cloud Run fully managed: not supported |
| 499 | # |
| 500 | # Cloud Run for Anthos: supported |
| 501 | # |
| 502 | # The UID to run the entrypoint of the container process. |
| 503 | # Defaults to user specified in image metadata if unspecified. |
| 504 | # May also be set in PodSecurityContext. If set in both SecurityContext and |
| 505 | # PodSecurityContext, the value specified in SecurityContext takes |
| 506 | # precedence. |
| 507 | }, |
| 508 | "livenessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 509 | # |
| 510 | # Cloud Run fully managed: not supported |
| 511 | # |
| 512 | # Cloud Run for Anthos: supported |
| 513 | # |
| 514 | # Periodic probe of container liveness. |
| 515 | # Container will be restarted if the probe fails. |
| 516 | # More info: |
| 517 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 518 | # |
| 519 | # Cloud Run for Anthos: supported |
| 520 | # |
| 521 | # Probe describes a health check to be performed against a container to |
| 522 | # determine whether it is alive or ready to receive traffic. |
| 523 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 524 | # |
| 525 | # Cloud Run fully managed: not supported |
| 526 | # |
| 527 | # Cloud Run for Anthos: supported |
| 528 | # |
| 529 | # HTTPGet specifies the http request to perform. |
| 530 | # |
| 531 | # A field inlined from the Handler message. |
| 532 | # |
| 533 | # Cloud Run for Anthos: supported |
| 534 | # |
| 535 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 536 | "host": "A String", # (Optional) |
| 537 | # |
| 538 | # Cloud Run fully managed: not supported |
| 539 | # |
| 540 | # Cloud Run for Anthos: supported |
| 541 | # |
| 542 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 543 | # "Host" in httpHeaders instead. |
| 544 | "scheme": "A String", # (Optional) |
| 545 | # |
| 546 | # Cloud Run fully managed: not supported |
| 547 | # |
| 548 | # Cloud Run for Anthos: supported |
| 549 | # |
| 550 | # Scheme to use for connecting to the host. |
| 551 | # Defaults to HTTP. |
| 552 | "httpHeaders": [ # (Optional) |
| 553 | # |
| 554 | # Cloud Run fully managed: not supported |
| 555 | # |
| 556 | # Cloud Run for Anthos: supported |
| 557 | # |
| 558 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 559 | { # Cloud Run fully managed: not supported |
| 560 | # |
| 561 | # Cloud Run for Anthos: supported |
| 562 | # |
| 563 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 564 | "name": "A String", # Cloud Run fully managed: not supported |
| 565 | # |
| 566 | # Cloud Run for Anthos: supported |
| 567 | # |
| 568 | # The header field name |
| 569 | "value": "A String", # Cloud Run fully managed: not supported |
| 570 | # |
| 571 | # Cloud Run for Anthos: supported |
| 572 | # |
| 573 | # The header field value |
| 574 | }, |
| 575 | ], |
| 576 | "path": "A String", # (Optional) |
| 577 | # |
| 578 | # Cloud Run fully managed: not supported |
| 579 | # |
| 580 | # Cloud Run for Anthos: supported |
| 581 | # |
| 582 | # Path to access on the HTTP server. |
| 583 | }, |
| 584 | "failureThreshold": 42, # (Optional) |
| 585 | # |
| 586 | # Cloud Run fully managed: not supported |
| 587 | # |
| 588 | # Cloud Run for Anthos: supported |
| 589 | # |
| 590 | # Minimum consecutive failures for the probe to be considered failed after |
| 591 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 592 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 593 | # |
| 594 | # Cloud Run fully managed: not supported |
| 595 | # |
| 596 | # Cloud Run for Anthos: supported |
| 597 | # |
| 598 | # One and only one of the following should be specified. |
| 599 | # Exec specifies the action to take. |
| 600 | # |
| 601 | # A field inlined from the Handler message. |
| 602 | # |
| 603 | # Cloud Run for Anthos: supported |
| 604 | # |
| 605 | # ExecAction describes a "run in container" action. |
| 606 | "command": "A String", # (Optional) |
| 607 | # |
| 608 | # Cloud Run fully managed: not supported |
| 609 | # |
| 610 | # Cloud Run for Anthos: supported |
| 611 | # |
| 612 | # Command is the command line to execute inside the container, the working |
| 613 | # directory for the command is root ('/') in the container's filesystem. The |
| 614 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 615 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 616 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 617 | # live/healthy and non-zero is unhealthy. |
| 618 | }, |
| 619 | "initialDelaySeconds": 42, # (Optional) |
| 620 | # |
| 621 | # Cloud Run fully managed: not supported |
| 622 | # |
| 623 | # Cloud Run for Anthos: supported |
| 624 | # |
| 625 | # Number of seconds after the container has started before liveness probes |
| 626 | # are initiated. More info: |
| 627 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 628 | "timeoutSeconds": 42, # (Optional) |
| 629 | # |
| 630 | # Cloud Run fully managed: not supported |
| 631 | # |
| 632 | # Cloud Run for Anthos: supported |
| 633 | # |
| 634 | # Number of seconds after which the probe times out. |
| 635 | # Defaults to 1 second. Minimum value is 1. |
| 636 | # More info: |
| 637 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 638 | "successThreshold": 42, # (Optional) |
| 639 | # |
| 640 | # Cloud Run fully managed: not supported |
| 641 | # |
| 642 | # Cloud Run for Anthos: supported |
| 643 | # |
| 644 | # Minimum consecutive successes for the probe to be considered successful |
| 645 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 646 | # is 1. |
| 647 | "periodSeconds": 42, # (Optional) |
| 648 | # |
| 649 | # Cloud Run fully managed: not supported |
| 650 | # |
| 651 | # Cloud Run for Anthos: supported |
| 652 | # |
| 653 | # How often (in seconds) to perform the probe. |
| 654 | # Default to 10 seconds. Minimum value is 1. |
| 655 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 656 | # |
| 657 | # Cloud Run fully managed: not supported |
| 658 | # |
| 659 | # Cloud Run for Anthos: supported |
| 660 | # |
| 661 | # TCPSocket specifies an action involving a TCP port. |
| 662 | # TCP hooks not yet supported |
| 663 | # |
| 664 | # A field inlined from the Handler message. |
| 665 | # |
| 666 | # Cloud Run for Anthos: supported |
| 667 | # |
| 668 | # TCPSocketAction describes an action based on opening a socket |
| 669 | "port": 42, # Cloud Run fully managed: not supported |
| 670 | # |
| 671 | # Cloud Run for Anthos: supported |
| 672 | # |
| 673 | # Number or name of the port to access on the container. |
| 674 | # Number must be in the range 1 to 65535. |
| 675 | # Name must be an IANA_SVC_NAME. |
| 676 | # |
| 677 | # This field is currently limited to integer types only because of proto's |
| 678 | # inability to properly support the IntOrString golang type. |
| 679 | "host": "A String", # (Optional) |
| 680 | # |
| 681 | # Cloud Run fully managed: not supported |
| 682 | # |
| 683 | # Cloud Run for Anthos: supported |
| 684 | # |
| 685 | # Optional: Host name to connect to, defaults to the pod IP. |
| 686 | }, |
| 687 | }, |
| 688 | "env": [ # (Optional) |
| 689 | # |
| 690 | # Cloud Run fully managed: supported |
| 691 | # |
| 692 | # Cloud Run for Anthos: supported |
| 693 | # |
| 694 | # List of environment variables to set in the container. |
| 695 | { # EnvVar represents an environment variable present in a Container. |
| 696 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| 697 | "valueFrom": { # Cloud Run fully managed: not supported # (Optional) |
| 698 | # |
| 699 | # Cloud Run fully managed: not supported |
| 700 | # |
| 701 | # Cloud Run for Anthos: supported |
| 702 | # |
| 703 | # Source for the environment variable's value. Cannot be used if value is not |
| 704 | # empty. |
| 705 | # |
| 706 | # Cloud Run for Anthos: supported |
| 707 | # |
| 708 | # EnvVarSource represents a source for the value of an EnvVar. |
| 709 | "configMapKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 710 | # |
| 711 | # Cloud Run fully managed: not supported |
| 712 | # |
| 713 | # Cloud Run for Anthos: supported |
| 714 | # |
| 715 | # Selects a key of a ConfigMap. |
| 716 | # |
| 717 | # Cloud Run for Anthos: supported |
| 718 | # |
| 719 | # Selects a key from a ConfigMap. |
| 720 | "optional": True or False, # (Optional) |
| 721 | # |
| 722 | # Cloud Run fully managed: not supported |
| 723 | # |
| 724 | # Cloud Run for Anthos: supported |
| 725 | # |
| 726 | # Specify whether the ConfigMap or its key must be defined |
| 727 | "key": "A String", # Cloud Run fully managed: not supported |
| 728 | # |
| 729 | # Cloud Run for Anthos: supported |
| 730 | # |
| 731 | # The key to select. |
| 732 | "name": "A String", # Cloud Run fully managed: not supported |
| 733 | # |
| 734 | # Cloud Run for Anthos: supported |
| 735 | # |
| 736 | # The ConfigMap to select from. |
| 737 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 738 | # directly into the message. Use the "name" field instead. |
| 739 | # |
| 740 | # Cloud Run for Anthos: supported |
| 741 | # |
| 742 | # LocalObjectReference contains enough information to let you locate the |
| 743 | # referenced object inside the same namespace. |
| 744 | "name": "A String", # (Optional) |
| 745 | # |
| 746 | # Cloud Run fully managed: not supported |
| 747 | # |
| 748 | # Cloud Run for Anthos: supported |
| 749 | # |
| 750 | # Name of the referent. |
| 751 | # More info: |
| 752 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 753 | }, |
| 754 | }, |
| 755 | "secretKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 756 | # |
| 757 | # Cloud Run fully managed: not supported |
| 758 | # |
| 759 | # Cloud Run for Anthos: supported |
| 760 | # |
| 761 | # Selects a key of a secret in the pod's namespace |
| 762 | # |
| 763 | # Cloud Run for Anthos: supported |
| 764 | # |
| 765 | # SecretKeySelector selects a key of a Secret. |
| 766 | "key": "A String", # Cloud Run fully managed: not supported |
| 767 | # |
| 768 | # Cloud Run for Anthos: supported |
| 769 | # |
| 770 | # The key of the secret to select from. Must be a valid secret key. |
| 771 | "name": "A String", # Cloud Run fully managed: not supported |
| 772 | # |
| 773 | # Cloud Run for Anthos: supported |
| 774 | # |
| 775 | # The name of the secret in the pod's namespace to select from. |
| 776 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 777 | # directly into the message. Use the "name" field instead. |
| 778 | # |
| 779 | # Cloud Run for Anthos: supported |
| 780 | # |
| 781 | # LocalObjectReference contains enough information to let you locate the |
| 782 | # referenced object inside the same namespace. |
| 783 | "name": "A String", # (Optional) |
| 784 | # |
| 785 | # Cloud Run fully managed: not supported |
| 786 | # |
| 787 | # Cloud Run for Anthos: supported |
| 788 | # |
| 789 | # Name of the referent. |
| 790 | # More info: |
| 791 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 792 | }, |
| 793 | "optional": True or False, # (Optional) |
| 794 | # |
| 795 | # Cloud Run fully managed: not supported |
| 796 | # |
| 797 | # Cloud Run for Anthos: supported |
| 798 | # |
| 799 | # Specify whether the Secret or its key must be defined |
| 800 | }, |
| 801 | }, |
| 802 | "value": "A String", # (Optional) |
| 803 | # |
| 804 | # Variable references $(VAR_NAME) are expanded |
| 805 | # using the previous defined environment variables in the container and |
| 806 | # any route environment variables. If a variable cannot be resolved, |
| 807 | # the reference in the input string will be unchanged. The $(VAR_NAME) |
| 808 | # syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped |
| 809 | # references will never be expanded, regardless of whether the variable |
| 810 | # exists or not. |
| 811 | # Defaults to "". |
| 812 | }, |
| 813 | ], |
| 814 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) |
| 815 | # |
| 816 | # Cloud Run fully managed: supported |
| 817 | # |
| 818 | # Cloud Run for Anthos: supported |
| 819 | # |
| 820 | # Compute Resources required by this container. |
| 821 | # More info: |
| 822 | # https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 823 | "limits": { # (Optional) |
| 824 | # |
| 825 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 826 | # supported value for CPU is '1'. |
| 827 | # |
| 828 | # Cloud Run for Anthos: supported |
| 829 | # |
| 830 | # Limits describes the maximum amount of compute resources allowed. |
| 831 | # The values of the map is string form of the 'quantity' k8s type: |
| 832 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 833 | "a_key": "A String", |
| 834 | }, |
| 835 | "requests": { # (Optional) |
| 836 | # |
| 837 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 838 | # supported value for CPU is '1'. |
| 839 | # |
| 840 | # Cloud Run for Anthos: supported |
| 841 | # |
| 842 | # Requests describes the minimum amount of compute resources required. |
| 843 | # If Requests is omitted for a container, it defaults to Limits if that is |
| 844 | # explicitly specified, otherwise to an implementation-defined value. |
| 845 | # The values of the map is string form of the 'quantity' k8s type: |
| 846 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 847 | "a_key": "A String", |
| 848 | }, |
| 849 | }, |
| 850 | "readinessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 851 | # |
| 852 | # Cloud Run fully managed: not supported |
| 853 | # |
| 854 | # Cloud Run for Anthos: supported |
| 855 | # |
| 856 | # Periodic probe of container service readiness. |
| 857 | # Container will be removed from service endpoints if the probe fails. |
| 858 | # More info: |
| 859 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 860 | # |
| 861 | # Cloud Run for Anthos: supported |
| 862 | # |
| 863 | # Probe describes a health check to be performed against a container to |
| 864 | # determine whether it is alive or ready to receive traffic. |
| 865 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 866 | # |
| 867 | # Cloud Run fully managed: not supported |
| 868 | # |
| 869 | # Cloud Run for Anthos: supported |
| 870 | # |
| 871 | # HTTPGet specifies the http request to perform. |
| 872 | # |
| 873 | # A field inlined from the Handler message. |
| 874 | # |
| 875 | # Cloud Run for Anthos: supported |
| 876 | # |
| 877 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 878 | "host": "A String", # (Optional) |
| 879 | # |
| 880 | # Cloud Run fully managed: not supported |
| 881 | # |
| 882 | # Cloud Run for Anthos: supported |
| 883 | # |
| 884 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 885 | # "Host" in httpHeaders instead. |
| 886 | "scheme": "A String", # (Optional) |
| 887 | # |
| 888 | # Cloud Run fully managed: not supported |
| 889 | # |
| 890 | # Cloud Run for Anthos: supported |
| 891 | # |
| 892 | # Scheme to use for connecting to the host. |
| 893 | # Defaults to HTTP. |
| 894 | "httpHeaders": [ # (Optional) |
| 895 | # |
| 896 | # Cloud Run fully managed: not supported |
| 897 | # |
| 898 | # Cloud Run for Anthos: supported |
| 899 | # |
| 900 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 901 | { # Cloud Run fully managed: not supported |
| 902 | # |
| 903 | # Cloud Run for Anthos: supported |
| 904 | # |
| 905 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 906 | "name": "A String", # Cloud Run fully managed: not supported |
| 907 | # |
| 908 | # Cloud Run for Anthos: supported |
| 909 | # |
| 910 | # The header field name |
| 911 | "value": "A String", # Cloud Run fully managed: not supported |
| 912 | # |
| 913 | # Cloud Run for Anthos: supported |
| 914 | # |
| 915 | # The header field value |
| 916 | }, |
| 917 | ], |
| 918 | "path": "A String", # (Optional) |
| 919 | # |
| 920 | # Cloud Run fully managed: not supported |
| 921 | # |
| 922 | # Cloud Run for Anthos: supported |
| 923 | # |
| 924 | # Path to access on the HTTP server. |
| 925 | }, |
| 926 | "failureThreshold": 42, # (Optional) |
| 927 | # |
| 928 | # Cloud Run fully managed: not supported |
| 929 | # |
| 930 | # Cloud Run for Anthos: supported |
| 931 | # |
| 932 | # Minimum consecutive failures for the probe to be considered failed after |
| 933 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 934 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 935 | # |
| 936 | # Cloud Run fully managed: not supported |
| 937 | # |
| 938 | # Cloud Run for Anthos: supported |
| 939 | # |
| 940 | # One and only one of the following should be specified. |
| 941 | # Exec specifies the action to take. |
| 942 | # |
| 943 | # A field inlined from the Handler message. |
| 944 | # |
| 945 | # Cloud Run for Anthos: supported |
| 946 | # |
| 947 | # ExecAction describes a "run in container" action. |
| 948 | "command": "A String", # (Optional) |
| 949 | # |
| 950 | # Cloud Run fully managed: not supported |
| 951 | # |
| 952 | # Cloud Run for Anthos: supported |
| 953 | # |
| 954 | # Command is the command line to execute inside the container, the working |
| 955 | # directory for the command is root ('/') in the container's filesystem. The |
| 956 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 957 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 958 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 959 | # live/healthy and non-zero is unhealthy. |
| 960 | }, |
| 961 | "initialDelaySeconds": 42, # (Optional) |
| 962 | # |
| 963 | # Cloud Run fully managed: not supported |
| 964 | # |
| 965 | # Cloud Run for Anthos: supported |
| 966 | # |
| 967 | # Number of seconds after the container has started before liveness probes |
| 968 | # are initiated. More info: |
| 969 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 970 | "timeoutSeconds": 42, # (Optional) |
| 971 | # |
| 972 | # Cloud Run fully managed: not supported |
| 973 | # |
| 974 | # Cloud Run for Anthos: supported |
| 975 | # |
| 976 | # Number of seconds after which the probe times out. |
| 977 | # Defaults to 1 second. Minimum value is 1. |
| 978 | # More info: |
| 979 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 980 | "successThreshold": 42, # (Optional) |
| 981 | # |
| 982 | # Cloud Run fully managed: not supported |
| 983 | # |
| 984 | # Cloud Run for Anthos: supported |
| 985 | # |
| 986 | # Minimum consecutive successes for the probe to be considered successful |
| 987 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 988 | # is 1. |
| 989 | "periodSeconds": 42, # (Optional) |
| 990 | # |
| 991 | # Cloud Run fully managed: not supported |
| 992 | # |
| 993 | # Cloud Run for Anthos: supported |
| 994 | # |
| 995 | # How often (in seconds) to perform the probe. |
| 996 | # Default to 10 seconds. Minimum value is 1. |
| 997 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 998 | # |
| 999 | # Cloud Run fully managed: not supported |
| 1000 | # |
| 1001 | # Cloud Run for Anthos: supported |
| 1002 | # |
| 1003 | # TCPSocket specifies an action involving a TCP port. |
| 1004 | # TCP hooks not yet supported |
| 1005 | # |
| 1006 | # A field inlined from the Handler message. |
| 1007 | # |
| 1008 | # Cloud Run for Anthos: supported |
| 1009 | # |
| 1010 | # TCPSocketAction describes an action based on opening a socket |
| 1011 | "port": 42, # Cloud Run fully managed: not supported |
| 1012 | # |
| 1013 | # Cloud Run for Anthos: supported |
| 1014 | # |
| 1015 | # Number or name of the port to access on the container. |
| 1016 | # Number must be in the range 1 to 65535. |
| 1017 | # Name must be an IANA_SVC_NAME. |
| 1018 | # |
| 1019 | # This field is currently limited to integer types only because of proto's |
| 1020 | # inability to properly support the IntOrString golang type. |
| 1021 | "host": "A String", # (Optional) |
| 1022 | # |
| 1023 | # Cloud Run fully managed: not supported |
| 1024 | # |
| 1025 | # Cloud Run for Anthos: supported |
| 1026 | # |
| 1027 | # Optional: Host name to connect to, defaults to the pod IP. |
| 1028 | }, |
| 1029 | }, |
| 1030 | "imagePullPolicy": "A String", # (Optional) |
| 1031 | # |
| 1032 | # Cloud Run fully managed: not supported |
| 1033 | # |
| 1034 | # Cloud Run for Anthos: supported |
| 1035 | # |
| 1036 | # Image pull policy. |
| 1037 | # One of Always, Never, IfNotPresent. |
| 1038 | # Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. |
| 1039 | # More info: |
| 1040 | # https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 1041 | "terminationMessagePath": "A String", # (Optional) |
| 1042 | # |
| 1043 | # Cloud Run fully managed: not supported |
| 1044 | # |
| 1045 | # Cloud Run for Anthos: supported |
| 1046 | # |
| 1047 | # Path at which the file to which the container's termination |
| 1048 | # message will be written is mounted into the container's filesystem. Message |
| 1049 | # written is intended to be brief final status, such as an assertion failure |
| 1050 | # message. Will be truncated by the node if greater than 4096 bytes. The |
| 1051 | # total message length across all containers will be limited to 12kb. |
| 1052 | # Defaults to /dev/termination-log. |
| 1053 | "volumeMounts": [ # (Optional) |
| 1054 | # |
| 1055 | # Cloud Run fully managed: not supported |
| 1056 | # |
| 1057 | # Cloud Run for Anthos: supported |
| 1058 | # |
| 1059 | # Pod volumes to mount into the container's filesystem. |
| 1060 | { # Cloud Run fully managed: not supported |
| 1061 | # |
| 1062 | # Cloud Run for Anthos: supported |
| 1063 | # |
| 1064 | # VolumeMount describes a mounting of a Volume within a container. |
| 1065 | "mountPath": "A String", # Cloud Run fully managed: not supported |
| 1066 | # |
| 1067 | # Cloud Run for Anthos: supported |
| 1068 | # |
| 1069 | # Path within the container at which the volume should be mounted. Must |
| 1070 | # not contain ':'. |
| 1071 | "subPath": "A String", # (Optional) |
| 1072 | # |
| 1073 | # Cloud Run fully managed: not supported |
| 1074 | # |
| 1075 | # Cloud Run for Anthos: supported |
| 1076 | # |
| 1077 | # Path within the volume from which the container's volume should be mounted. |
| 1078 | # Defaults to "" (volume's root). |
| 1079 | "name": "A String", # Cloud Run fully managed: not supported |
| 1080 | # |
| 1081 | # Cloud Run for Anthos: supported |
| 1082 | # |
| 1083 | # This must match the Name of a Volume. |
| 1084 | "readOnly": True or False, # (Optional) |
| 1085 | # |
| 1086 | # Cloud Run fully managed: not supported |
| 1087 | # |
| 1088 | # Cloud Run for Anthos: supported |
| 1089 | # |
| 1090 | # Only true is accepted. |
| 1091 | # Defaults to true. |
| 1092 | }, |
| 1093 | ], |
| 1094 | "args": [ # (Optional) |
| 1095 | # |
| 1096 | # Cloud Run fully managed: supported |
| 1097 | # |
| 1098 | # Cloud Run for Anthos: supported |
| 1099 | # |
| 1100 | # Arguments to the entrypoint. |
| 1101 | # The docker image's CMD is used if this is not provided. |
| 1102 | # Variable references $(VAR_NAME) are expanded using the container's |
| 1103 | # environment. If a variable cannot be resolved, the reference in the input |
| 1104 | # string will be unchanged. The $(VAR_NAME) syntax can be escaped with a |
| 1105 | # double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, |
| 1106 | # regardless of whether the variable exists or not. |
| 1107 | # More info: |
| 1108 | # https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| 1109 | "A String", |
| 1110 | ], |
| 1111 | "workingDir": "A String", # (Optional) |
| 1112 | # |
| 1113 | # Cloud Run fully managed: not supported |
| 1114 | # |
| 1115 | # Cloud Run for Anthos: supported |
| 1116 | # |
| 1117 | # Container's working directory. |
| 1118 | # If not specified, the container runtime's default will be used, which |
| 1119 | # might be configured in the container image. |
| 1120 | "ports": [ # (Optional) |
| 1121 | # |
| 1122 | # List of ports to expose from the container. Only a single port can be |
| 1123 | # specified. The specified ports must be listening on all interfaces |
| 1124 | # (0.0.0.0) within the container to be accessible. |
| 1125 | # |
| 1126 | # If omitted, a port number will be chosen and passed to the container |
| 1127 | # through the PORT environment variable for the container to listen on. |
| 1128 | { # ContainerPort represents a network port in a single container. |
| 1129 | "containerPort": 42, # (Optional) |
| 1130 | # |
| 1131 | # Port number the container listens on. |
| 1132 | # This must be a valid port number, 0 < x < 65536. |
| 1133 | "protocol": "A String", # (Optional) |
| 1134 | # |
| 1135 | # Cloud Run fully managed: not supported |
| 1136 | # |
| 1137 | # Cloud Run for Anthos: supported |
| 1138 | # |
| 1139 | # Protocol for port. Must be "TCP". |
| 1140 | # Defaults to "TCP". |
| 1141 | "name": "A String", # (Optional) |
| 1142 | # |
| 1143 | # Cloud Run fully managed: not supported |
| 1144 | # |
| 1145 | # Cloud Run for Anthos: supported |
| 1146 | # |
| 1147 | # If specified, used to specify which protocol to use. |
| 1148 | # Allowed values are "http1" and "h2c". |
| 1149 | }, |
| 1150 | ], |
| 1151 | "image": "A String", # Cloud Run fully managed: only supports containers from Google Container |
| 1152 | # Registry |
| 1153 | # |
| 1154 | # Cloud Run for Anthos: supported |
| 1155 | # |
| 1156 | # URL of the Container image. |
| 1157 | # More info: https://kubernetes.io/docs/concepts/containers/images |
| 1158 | "envFrom": [ # (Optional) |
| 1159 | # |
| 1160 | # Cloud Run fully managed: not supported |
| 1161 | # |
| 1162 | # Cloud Run for Anthos: supported |
| 1163 | # |
| 1164 | # List of sources to populate environment variables in the container. |
| 1165 | # The keys defined within a source must be a C_IDENTIFIER. All invalid keys |
| 1166 | # will be reported as an event when the container is starting. When a key |
| 1167 | # exists in multiple sources, the value associated with the last source will |
| 1168 | # take precedence. Values defined by an Env with a duplicate key will take |
| 1169 | # precedence. Cannot be updated. |
| 1170 | { # Cloud Run fully managed: not supported |
| 1171 | # |
| 1172 | # Cloud Run for Anthos: supported |
| 1173 | # |
| 1174 | # EnvFromSource represents the source of a set of ConfigMaps |
| 1175 | "secretRef": { # Cloud Run fully managed: not supported # (Optional) |
| 1176 | # |
| 1177 | # Cloud Run fully managed: not supported |
| 1178 | # |
| 1179 | # Cloud Run for Anthos: supported |
| 1180 | # |
| 1181 | # The Secret to select from |
| 1182 | # |
| 1183 | # Cloud Run for Anthos: supported |
| 1184 | # |
| 1185 | # SecretEnvSource selects a Secret to populate the environment |
| 1186 | # variables with. |
| 1187 | # |
| 1188 | # The contents of the target Secret's Data field will represent the |
| 1189 | # key-value pairs as environment variables. |
| 1190 | "name": "A String", # Cloud Run fully managed: not supported |
| 1191 | # |
| 1192 | # Cloud Run for Anthos: supported |
| 1193 | # |
| 1194 | # The Secret to select from. |
| 1195 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 1196 | # directly into the message. Use the "name" field instead. |
| 1197 | # |
| 1198 | # Cloud Run for Anthos: supported |
| 1199 | # |
| 1200 | # LocalObjectReference contains enough information to let you locate the |
| 1201 | # referenced object inside the same namespace. |
| 1202 | "name": "A String", # (Optional) |
| 1203 | # |
| 1204 | # Cloud Run fully managed: not supported |
| 1205 | # |
| 1206 | # Cloud Run for Anthos: supported |
| 1207 | # |
| 1208 | # Name of the referent. |
| 1209 | # More info: |
| 1210 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1211 | }, |
| 1212 | "optional": True or False, # (Optional) |
| 1213 | # |
| 1214 | # Cloud Run fully managed: not supported |
| 1215 | # |
| 1216 | # Cloud Run for Anthos: supported |
| 1217 | # |
| 1218 | # Specify whether the Secret must be defined |
| 1219 | }, |
| 1220 | "prefix": "A String", # (Optional) |
| 1221 | # |
| 1222 | # Cloud Run fully managed: not supported |
| 1223 | # |
| 1224 | # Cloud Run for Anthos: supported |
| 1225 | # |
| 1226 | # An optional identifier to prepend to each key in the ConfigMap. Must be a |
| 1227 | # C_IDENTIFIER. |
| 1228 | "configMapRef": { # Cloud Run fully managed: not supported # (Optional) |
| 1229 | # |
| 1230 | # Cloud Run fully managed: not supported |
| 1231 | # |
| 1232 | # Cloud Run for Anthos: supported |
| 1233 | # |
| 1234 | # The ConfigMap to select from |
| 1235 | # |
| 1236 | # Cloud Run for Anthos: supported |
| 1237 | # |
| 1238 | # ConfigMapEnvSource selects a ConfigMap to populate the environment |
| 1239 | # variables with. |
| 1240 | # |
| 1241 | # The contents of the target ConfigMap's Data field will represent the |
| 1242 | # key-value pairs as environment variables. |
| 1243 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 1244 | # directly into the message. Use the "name" field instead. |
| 1245 | # |
| 1246 | # Cloud Run for Anthos: supported |
| 1247 | # |
| 1248 | # LocalObjectReference contains enough information to let you locate the |
| 1249 | # referenced object inside the same namespace. |
| 1250 | "name": "A String", # (Optional) |
| 1251 | # |
| 1252 | # Cloud Run fully managed: not supported |
| 1253 | # |
| 1254 | # Cloud Run for Anthos: supported |
| 1255 | # |
| 1256 | # Name of the referent. |
| 1257 | # More info: |
| 1258 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1259 | }, |
| 1260 | "optional": True or False, # (Optional) |
| 1261 | # |
| 1262 | # Cloud Run fully managed: not supported |
| 1263 | # |
| 1264 | # Cloud Run for Anthos: supported |
| 1265 | # |
| 1266 | # Specify whether the ConfigMap must be defined |
| 1267 | "name": "A String", # Cloud Run fully managed: not supported |
| 1268 | # |
| 1269 | # Cloud Run for Anthos: supported |
| 1270 | # |
| 1271 | # The ConfigMap to select from. |
| 1272 | }, |
| 1273 | }, |
| 1274 | ], |
| 1275 | "name": "A String", # (Optional) |
| 1276 | # |
| 1277 | # Name of the container specified as a DNS_LABEL. |
| 1278 | "command": [ |
| 1279 | "A String", |
| 1280 | ], |
| 1281 | "terminationMessagePolicy": "A String", # (Optional) |
| 1282 | # |
| 1283 | # Cloud Run fully managed: not supported |
| 1284 | # |
| 1285 | # Cloud Run for Anthos: supported |
| 1286 | # |
| 1287 | # Indicate how the termination message should be populated. File will use the |
| 1288 | # contents of terminationMessagePath to populate the container status message |
| 1289 | # on both success and failure. FallbackToLogsOnError will use the last chunk |
| 1290 | # of container log output if the termination message file is empty and the |
| 1291 | # container exited with an error. The log output is limited to 2048 bytes or |
| 1292 | # 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 1293 | }, |
| 1294 | ], |
| 1295 | "volumes": [ |
| 1296 | { # Cloud Run fully managed: not supported |
| 1297 | # |
| 1298 | # Cloud Run for Anthos: supported |
| 1299 | # |
| 1300 | # Volume represents a named volume in a container. |
| 1301 | "configMap": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| 1302 | # |
| 1303 | # Cloud Run for Anthos: supported |
| 1304 | # |
| 1305 | # Cloud Run for Anthos: supported |
| 1306 | # |
| 1307 | # Adapts a ConfigMap into a volume. |
| 1308 | # The contents of the target ConfigMap's Data field will be presented in a |
| 1309 | # volume as files using the keys in the Data field as the file names, unless |
| 1310 | # the items element is populated with specific mappings of keys to paths. |
| 1311 | "optional": True or False, # (Optional) |
| 1312 | # |
| 1313 | # Cloud Run fully managed: not supported |
| 1314 | # |
| 1315 | # Cloud Run for Anthos: supported |
| 1316 | # |
| 1317 | # Specify whether the Secret or its keys must be defined. |
| 1318 | "name": "A String", # Cloud Run fully managed: not supported |
| 1319 | # |
| 1320 | # Cloud Run for Anthos: supported |
| 1321 | # |
| 1322 | # Name of the config. |
| 1323 | "defaultMode": 42, # (Optional) |
| 1324 | # |
| 1325 | # Cloud Run fully managed: not supported |
| 1326 | # |
| 1327 | # Cloud Run for Anthos: supported |
| 1328 | # |
| 1329 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 1330 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 1331 | # this setting. This might be in conflict with other options that affect the |
| 1332 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 1333 | "items": [ # (Optional) |
| 1334 | # |
| 1335 | # Cloud Run fully managed: not supported |
| 1336 | # |
| 1337 | # Cloud Run for Anthos: supported |
| 1338 | # |
| 1339 | # If unspecified, each key-value pair in the Data field of the referenced |
| 1340 | # Secret will be projected into the volume as a file whose name is the |
| 1341 | # key and content is the value. If specified, the listed keys will be |
| 1342 | # projected into the specified paths, and unlisted keys will not be |
| 1343 | # present. If a key is specified which is not present in the Secret, |
| 1344 | # the volume setup will error unless it is marked optional. |
| 1345 | { # Cloud Run fully managed: not supported |
| 1346 | # |
| 1347 | # Cloud Run for Anthos: supported |
| 1348 | # |
| 1349 | # Maps a string key to a path within a volume. |
| 1350 | "key": "A String", # Cloud Run fully managed: not supported |
| 1351 | # |
| 1352 | # Cloud Run for Anthos: supported |
| 1353 | # |
| 1354 | # The key to project. |
| 1355 | "path": "A String", # Cloud Run fully managed: not supported |
| 1356 | # |
| 1357 | # Cloud Run for Anthos: supported |
| 1358 | # |
| 1359 | # The relative path of the file to map the key to. |
| 1360 | # May not be an absolute path. |
| 1361 | # May not contain the path element '..'. |
| 1362 | # May not start with the string '..'. |
| 1363 | "mode": 42, # (Optional) |
| 1364 | # |
| 1365 | # Cloud Run fully managed: not supported |
| 1366 | # |
| 1367 | # Cloud Run for Anthos: supported |
| 1368 | # |
| 1369 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 1370 | # specified, the volume defaultMode will be used. This might be in conflict |
| 1371 | # with other options that affect the file mode, like fsGroup, and the result |
| 1372 | # can be other mode bits set. |
| 1373 | }, |
| 1374 | ], |
| 1375 | }, |
| 1376 | "name": "A String", # Cloud Run fully managed: not supported |
| 1377 | # |
| 1378 | # Cloud Run for Anthos: supported |
| 1379 | # |
| 1380 | # Volume's name. |
| 1381 | "secret": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| 1382 | # |
| 1383 | # Cloud Run for Anthos: supported |
| 1384 | # |
| 1385 | # Cloud Run for Anthos: supported |
| 1386 | # |
| 1387 | # The contents of the target Secret's Data field will be presented in a volume |
| 1388 | # as files using the keys in the Data field as the file names. |
| 1389 | "secretName": "A String", # Cloud Run fully managed: not supported |
| 1390 | # |
| 1391 | # Cloud Run for Anthos: supported |
| 1392 | # |
| 1393 | # Name of the secret in the container's namespace to use. |
| 1394 | "items": [ # (Optional) |
| 1395 | # |
| 1396 | # Cloud Run fully managed: not supported |
| 1397 | # |
| 1398 | # Cloud Run for Anthos: supported |
| 1399 | # |
| 1400 | # If unspecified, each key-value pair in the Data field of the referenced |
| 1401 | # Secret will be projected into the volume as a file whose name is the |
| 1402 | # key and content is the value. If specified, the listed keys will be |
| 1403 | # projected into the specified paths, and unlisted keys will not be |
| 1404 | # present. If a key is specified which is not present in the Secret, |
| 1405 | # the volume setup will error unless it is marked optional. |
| 1406 | { # Cloud Run fully managed: not supported |
| 1407 | # |
| 1408 | # Cloud Run for Anthos: supported |
| 1409 | # |
| 1410 | # Maps a string key to a path within a volume. |
| 1411 | "key": "A String", # Cloud Run fully managed: not supported |
| 1412 | # |
| 1413 | # Cloud Run for Anthos: supported |
| 1414 | # |
| 1415 | # The key to project. |
| 1416 | "path": "A String", # Cloud Run fully managed: not supported |
| 1417 | # |
| 1418 | # Cloud Run for Anthos: supported |
| 1419 | # |
| 1420 | # The relative path of the file to map the key to. |
| 1421 | # May not be an absolute path. |
| 1422 | # May not contain the path element '..'. |
| 1423 | # May not start with the string '..'. |
| 1424 | "mode": 42, # (Optional) |
| 1425 | # |
| 1426 | # Cloud Run fully managed: not supported |
| 1427 | # |
| 1428 | # Cloud Run for Anthos: supported |
| 1429 | # |
| 1430 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 1431 | # specified, the volume defaultMode will be used. This might be in conflict |
| 1432 | # with other options that affect the file mode, like fsGroup, and the result |
| 1433 | # can be other mode bits set. |
| 1434 | }, |
| 1435 | ], |
| 1436 | "optional": True or False, # (Optional) |
| 1437 | # |
| 1438 | # Cloud Run fully managed: not supported |
| 1439 | # |
| 1440 | # Cloud Run for Anthos: supported |
| 1441 | # |
| 1442 | # Specify whether the Secret or its keys must be defined. |
| 1443 | "defaultMode": 42, # (Optional) |
| 1444 | # |
| 1445 | # Cloud Run fully managed: not supported |
| 1446 | # |
| 1447 | # Cloud Run for Anthos: supported |
| 1448 | # |
| 1449 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 1450 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 1451 | # this setting. This might be in conflict with other options that affect the |
| 1452 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 1453 | }, |
| 1454 | }, |
| 1455 | ], |
| 1456 | }, |
| 1457 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Optional metadata for this Revision, including labels and annotations. Name |
| 1458 | # will be generated by the Configuration. |
| 1459 | # To set minimum instances for this revision, use the |
| 1460 | # "autoscaling.knative.dev/minScale" annotation key. |
| 1461 | # To set maximum instances for this revision, use the |
| 1462 | # "autoscaling.knative.dev/maxScale" annotation key. |
| 1463 | # To set Cloud SQL connections for the revision, use the |
| 1464 | # "run.googleapis.com/cloudsql-instances" annotation key. |
| 1465 | # persisted resources must have, which includes all objects users must create. |
| 1466 | "annotations": { # (Optional) |
| 1467 | # |
| 1468 | # Annotations is an unstructured key value map stored with a resource that |
| 1469 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1470 | # are not queryable and should be preserved when modifying objects. More |
| 1471 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 1472 | "a_key": "A String", |
| 1473 | }, |
| 1474 | "generateName": "A String", # (Optional) |
| 1475 | # |
| 1476 | # Cloud Run fully managed: not supported |
| 1477 | # |
| 1478 | # Cloud Run for Anthos: supported |
| 1479 | # |
| 1480 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1481 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1482 | # used, the name returned to the client will be different than the name |
| 1483 | # passed. This value will also be combined with a unique suffix. The provided |
| 1484 | # value has the same validation rules as the Name field, and may be truncated |
| 1485 | # by the length of the suffix required to make the value unique on the |
| 1486 | # server. |
| 1487 | # |
| 1488 | # If this field is specified and the generated name exists, the server will |
| 1489 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1490 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1491 | # time allotted, and the client should retry (optionally after the time |
| 1492 | # indicated in the Retry-After header). |
| 1493 | # |
| 1494 | # Applied only if Name is not specified. |
| 1495 | # More info: |
| 1496 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1497 | # string generateName = 2; |
| 1498 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1499 | # Is required when creating |
| 1500 | # resources, although some resources may allow a client to request the |
| 1501 | # generation of an appropriate name automatically. Name is primarily intended |
| 1502 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1503 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1504 | # +optional |
| 1505 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 1506 | # |
| 1507 | # Cloud Run fully managed: not supported |
| 1508 | # |
| 1509 | # Cloud Run for Anthos: supported |
| 1510 | # |
| 1511 | # Number of seconds allowed for this object to gracefully terminate before |
| 1512 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1513 | # set. May only be shortened. Read-only. |
| 1514 | "clusterName": "A String", # (Optional) |
| 1515 | # |
| 1516 | # Cloud Run fully managed: not supported |
| 1517 | # |
| 1518 | # Cloud Run for Anthos: supported |
| 1519 | # |
| 1520 | # The name of the cluster which the object belongs to. |
| 1521 | # This is used to distinguish resources with same name and namespace in |
| 1522 | # different clusters. This field is not set anywhere right now and apiserver |
| 1523 | # is going to ignore it if set in create or update request. |
| 1524 | "finalizers": [ # (Optional) |
| 1525 | # |
| 1526 | # Cloud Run fully managed: not supported |
| 1527 | # |
| 1528 | # Cloud Run for Anthos: supported |
| 1529 | # |
| 1530 | # Must be empty before the object is deleted from the registry. Each entry |
| 1531 | # is an identifier for the responsible component that will remove the entry |
| 1532 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1533 | # in this list can only be removed. |
| 1534 | # +patchStrategy=merge |
| 1535 | "A String", |
| 1536 | ], |
| 1537 | "deletionTimestamp": "A String", # (Optional) |
| 1538 | # |
| 1539 | # Cloud Run fully managed: not supported |
| 1540 | # |
| 1541 | # Cloud Run for Anthos: supported |
| 1542 | # |
| 1543 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1544 | # deleted. This field is set by the server when a graceful deletion is |
| 1545 | # requested by the user, and is not directly settable by a client. The |
| 1546 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1547 | # and not reachable by name) after the time in this field, once the |
| 1548 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1549 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1550 | # be unset or be set further into the future, although it may be shortened or |
| 1551 | # the resource may be deleted prior to this time. For example, a user may |
| 1552 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1553 | # sending a graceful termination signal to the containers in the pod. After |
| 1554 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1555 | # to the container and after cleanup, remove the pod from the API. In the |
| 1556 | # presence of network partitions, this object may still exist after this |
| 1557 | # timestamp, until an administrator or automated process can determine the |
| 1558 | # resource is fully terminated. |
| 1559 | # If not set, graceful deletion of the object has not been requested. |
| 1560 | # |
| 1561 | # Populated by the system when a graceful deletion is requested. |
| 1562 | # Read-only. |
| 1563 | # More info: |
| 1564 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1565 | "ownerReferences": [ # (Optional) |
| 1566 | # |
| 1567 | # Cloud Run fully managed: not supported |
| 1568 | # |
| 1569 | # Cloud Run for Anthos: supported |
| 1570 | # |
| 1571 | # List of objects that own this object. If ALL objects in the list have |
| 1572 | # been deleted, this object will be garbage collected. |
| 1573 | { # OwnerReference contains enough information to let you identify an owning |
| 1574 | # object. Currently, an owning object must be in the same namespace, so there |
| 1575 | # is no namespace field. |
| 1576 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1577 | # +optional |
| 1578 | "kind": "A String", # Kind of the referent. |
| 1579 | # More info: |
| 1580 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1581 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1582 | # the owner cannot be deleted from the key-value store until this |
| 1583 | # reference is removed. |
| 1584 | # Defaults to false. |
| 1585 | # To set this field, a user needs "delete" permission of the owner, |
| 1586 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1587 | # +optional |
| 1588 | "apiVersion": "A String", # API version of the referent. |
| 1589 | "name": "A String", # Name of the referent. |
| 1590 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1591 | "uid": "A String", # UID of the referent. |
| 1592 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1593 | }, |
| 1594 | ], |
| 1595 | "creationTimestamp": "A String", # (Optional) |
| 1596 | # |
| 1597 | # CreationTimestamp is a timestamp representing the server time when this |
| 1598 | # object was created. It is not guaranteed to be set in happens-before order |
| 1599 | # across separate operations. Clients may not set this value. It is |
| 1600 | # represented in RFC3339 form and is in UTC. |
| 1601 | # |
| 1602 | # Populated by the system. |
| 1603 | # Read-only. |
| 1604 | # Null for lists. |
| 1605 | # More info: |
| 1606 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1607 | "labels": { # (Optional) |
| 1608 | # |
| 1609 | # Map of string keys and values that can be used to organize and categorize |
| 1610 | # (scope and select) objects. May match selectors of replication controllers |
| 1611 | # and routes. |
| 1612 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1613 | "a_key": "A String", |
| 1614 | }, |
| 1615 | "generation": 42, # (Optional) |
| 1616 | # |
| 1617 | # A sequence number representing a specific generation of the desired state. |
| 1618 | # Populated by the system. Read-only. |
| 1619 | "resourceVersion": "A String", # (Optional) |
| 1620 | # |
| 1621 | # An opaque value that represents the internal version of this object that |
| 1622 | # can be used by clients to determine when objects have changed. May be used |
| 1623 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1624 | # resource or set of resources. Clients must treat these values as opaque and |
| 1625 | # passed unmodified back to the server. They may only be valid for a |
| 1626 | # particular resource or set of resources. |
| 1627 | # |
| 1628 | # Populated by the system. |
| 1629 | # Read-only. |
| 1630 | # Value must be treated as opaque by clients and . |
| 1631 | # More info: |
| 1632 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1633 | "selfLink": "A String", # (Optional) |
| 1634 | # |
| 1635 | # SelfLink is a URL representing this object. |
| 1636 | # Populated by the system. |
| 1637 | # Read-only. |
| 1638 | # string selfLink = 4; |
| 1639 | "uid": "A String", # (Optional) |
| 1640 | # |
| 1641 | # UID is the unique in time and space value for this object. It is typically |
| 1642 | # generated by the server on successful creation of a resource and is not |
| 1643 | # allowed to change on PUT operations. |
| 1644 | # |
| 1645 | # Populated by the system. |
| 1646 | # Read-only. |
| 1647 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1648 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1649 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1650 | # project ID or project number. |
| 1651 | }, |
| 1652 | }, |
| 1653 | }, |
| 1654 | } |
| 1655 | |
| 1656 | x__xgafv: string, V1 error format. |
| 1657 | Allowed values |
| 1658 | 1 - v1 error format |
| 1659 | 2 - v2 error format |
| 1660 | |
| 1661 | Returns: |
| 1662 | An object of the form: |
| 1663 | |
| 1664 | { # Service acts as a top-level container that manages a set of Routes and |
| 1665 | # Configurations which implement a network service. Service exists to provide a |
| 1666 | # singular abstraction which can be access controlled, reasoned about, and |
| 1667 | # which encapsulates software lifecycle decisions such as rollout policy and |
| 1668 | # team resource ownership. Service acts only as an orchestrator of the |
| 1669 | # underlying Routes and Configurations (much as a kubernetes Deployment |
| 1670 | # orchestrates ReplicaSets). |
| 1671 | # |
| 1672 | # The Service's controller will track the statuses of its owned Configuration |
| 1673 | # and Route, reflecting their statuses and conditions as its own. |
| 1674 | # |
| 1675 | # See also: |
| 1676 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#service |
| 1677 | "kind": "A String", # The kind of resource, in this case "Service". |
| 1678 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Service, including name, namespace, labels, |
| 1679 | # and annotations. |
| 1680 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1681 | "annotations": { # (Optional) |
| 1682 | # |
| 1683 | # Annotations is an unstructured key value map stored with a resource that |
| 1684 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1685 | # are not queryable and should be preserved when modifying objects. More |
| 1686 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 1687 | "a_key": "A String", |
| 1688 | }, |
| 1689 | "generateName": "A String", # (Optional) |
| 1690 | # |
| 1691 | # Cloud Run fully managed: not supported |
| 1692 | # |
| 1693 | # Cloud Run for Anthos: supported |
| 1694 | # |
| 1695 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1696 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1697 | # used, the name returned to the client will be different than the name |
| 1698 | # passed. This value will also be combined with a unique suffix. The provided |
| 1699 | # value has the same validation rules as the Name field, and may be truncated |
| 1700 | # by the length of the suffix required to make the value unique on the |
| 1701 | # server. |
| 1702 | # |
| 1703 | # If this field is specified and the generated name exists, the server will |
| 1704 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1705 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1706 | # time allotted, and the client should retry (optionally after the time |
| 1707 | # indicated in the Retry-After header). |
| 1708 | # |
| 1709 | # Applied only if Name is not specified. |
| 1710 | # More info: |
| 1711 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1712 | # string generateName = 2; |
| 1713 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1714 | # Is required when creating |
| 1715 | # resources, although some resources may allow a client to request the |
| 1716 | # generation of an appropriate name automatically. Name is primarily intended |
| 1717 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1718 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1719 | # +optional |
| 1720 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 1721 | # |
| 1722 | # Cloud Run fully managed: not supported |
| 1723 | # |
| 1724 | # Cloud Run for Anthos: supported |
| 1725 | # |
| 1726 | # Number of seconds allowed for this object to gracefully terminate before |
| 1727 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1728 | # set. May only be shortened. Read-only. |
| 1729 | "clusterName": "A String", # (Optional) |
| 1730 | # |
| 1731 | # Cloud Run fully managed: not supported |
| 1732 | # |
| 1733 | # Cloud Run for Anthos: supported |
| 1734 | # |
| 1735 | # The name of the cluster which the object belongs to. |
| 1736 | # This is used to distinguish resources with same name and namespace in |
| 1737 | # different clusters. This field is not set anywhere right now and apiserver |
| 1738 | # is going to ignore it if set in create or update request. |
| 1739 | "finalizers": [ # (Optional) |
| 1740 | # |
| 1741 | # Cloud Run fully managed: not supported |
| 1742 | # |
| 1743 | # Cloud Run for Anthos: supported |
| 1744 | # |
| 1745 | # Must be empty before the object is deleted from the registry. Each entry |
| 1746 | # is an identifier for the responsible component that will remove the entry |
| 1747 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1748 | # in this list can only be removed. |
| 1749 | # +patchStrategy=merge |
| 1750 | "A String", |
| 1751 | ], |
| 1752 | "deletionTimestamp": "A String", # (Optional) |
| 1753 | # |
| 1754 | # Cloud Run fully managed: not supported |
| 1755 | # |
| 1756 | # Cloud Run for Anthos: supported |
| 1757 | # |
| 1758 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1759 | # deleted. This field is set by the server when a graceful deletion is |
| 1760 | # requested by the user, and is not directly settable by a client. The |
| 1761 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1762 | # and not reachable by name) after the time in this field, once the |
| 1763 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1764 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1765 | # be unset or be set further into the future, although it may be shortened or |
| 1766 | # the resource may be deleted prior to this time. For example, a user may |
| 1767 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1768 | # sending a graceful termination signal to the containers in the pod. After |
| 1769 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1770 | # to the container and after cleanup, remove the pod from the API. In the |
| 1771 | # presence of network partitions, this object may still exist after this |
| 1772 | # timestamp, until an administrator or automated process can determine the |
| 1773 | # resource is fully terminated. |
| 1774 | # If not set, graceful deletion of the object has not been requested. |
| 1775 | # |
| 1776 | # Populated by the system when a graceful deletion is requested. |
| 1777 | # Read-only. |
| 1778 | # More info: |
| 1779 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1780 | "ownerReferences": [ # (Optional) |
| 1781 | # |
| 1782 | # Cloud Run fully managed: not supported |
| 1783 | # |
| 1784 | # Cloud Run for Anthos: supported |
| 1785 | # |
| 1786 | # List of objects that own this object. If ALL objects in the list have |
| 1787 | # been deleted, this object will be garbage collected. |
| 1788 | { # OwnerReference contains enough information to let you identify an owning |
| 1789 | # object. Currently, an owning object must be in the same namespace, so there |
| 1790 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1791 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1792 | # +optional |
| 1793 | "kind": "A String", # Kind of the referent. |
| 1794 | # More info: |
| 1795 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1796 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1797 | # the owner cannot be deleted from the key-value store until this |
| 1798 | # reference is removed. |
| 1799 | # Defaults to false. |
| 1800 | # To set this field, a user needs "delete" permission of the owner, |
| 1801 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1802 | # +optional |
| 1803 | "apiVersion": "A String", # API version of the referent. |
| 1804 | "name": "A String", # Name of the referent. |
| 1805 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1806 | "uid": "A String", # UID of the referent. |
| 1807 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1808 | }, |
| 1809 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1810 | "creationTimestamp": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1811 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1812 | # CreationTimestamp is a timestamp representing the server time when this |
| 1813 | # object was created. It is not guaranteed to be set in happens-before order |
| 1814 | # across separate operations. Clients may not set this value. It is |
| 1815 | # represented in RFC3339 form and is in UTC. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1816 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1817 | # Populated by the system. |
| 1818 | # Read-only. |
| 1819 | # Null for lists. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1820 | # More info: |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1821 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1822 | "labels": { # (Optional) |
| 1823 | # |
| 1824 | # Map of string keys and values that can be used to organize and categorize |
| 1825 | # (scope and select) objects. May match selectors of replication controllers |
| 1826 | # and routes. |
| 1827 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1828 | "a_key": "A String", |
| 1829 | }, |
| 1830 | "generation": 42, # (Optional) |
| 1831 | # |
| 1832 | # A sequence number representing a specific generation of the desired state. |
| 1833 | # Populated by the system. Read-only. |
| 1834 | "resourceVersion": "A String", # (Optional) |
| 1835 | # |
| 1836 | # An opaque value that represents the internal version of this object that |
| 1837 | # can be used by clients to determine when objects have changed. May be used |
| 1838 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1839 | # resource or set of resources. Clients must treat these values as opaque and |
| 1840 | # passed unmodified back to the server. They may only be valid for a |
| 1841 | # particular resource or set of resources. |
| 1842 | # |
| 1843 | # Populated by the system. |
| 1844 | # Read-only. |
| 1845 | # Value must be treated as opaque by clients and . |
| 1846 | # More info: |
| 1847 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1848 | "selfLink": "A String", # (Optional) |
| 1849 | # |
| 1850 | # SelfLink is a URL representing this object. |
| 1851 | # Populated by the system. |
| 1852 | # Read-only. |
| 1853 | # string selfLink = 4; |
| 1854 | "uid": "A String", # (Optional) |
| 1855 | # |
| 1856 | # UID is the unique in time and space value for this object. It is typically |
| 1857 | # generated by the server on successful creation of a resource and is not |
| 1858 | # allowed to change on PUT operations. |
| 1859 | # |
| 1860 | # Populated by the system. |
| 1861 | # Read-only. |
| 1862 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1863 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1864 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1865 | # project ID or project number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1866 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1867 | "status": { # The current state of the Service. Output only. # Status communicates the observed state of the Service (from the |
| 1868 | # controller). |
| 1869 | "latestCreatedRevisionName": "A String", # From ConfigurationStatus. |
| 1870 | # LatestCreatedRevisionName is the last revision that was created from this |
| 1871 | # Service's Configuration. It might not be ready yet, for that use |
| 1872 | # LatestReadyRevisionName. |
| 1873 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 1874 | # reconciliation processes that bring the "spec" inline with the observed |
| 1875 | # state of the world. |
| 1876 | # Service-specific conditions include: |
| 1877 | # * "ConfigurationsReady": true when the underlying Configuration is ready. |
| 1878 | # * "RoutesReady": true when the underlying Route is ready. |
| 1879 | # * "Ready": true when both the underlying Route and Configuration are |
| 1880 | # ready. |
| 1881 | { # Condition defines a generic condition for a Resource |
| 1882 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 1883 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 1884 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 1885 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 1886 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 1887 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 1888 | # See also: |
| 1889 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 1890 | # Types common to all resources include: |
| 1891 | # * "Ready": True when the Resource is ready. |
| 1892 | }, |
| 1893 | ], |
| 1894 | "address": { # Information for connecting over HTTP(s). # From RouteStatus. |
| 1895 | # Similar to url, information on where the service is available on HTTP. |
| 1896 | "url": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1897 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1898 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 1899 | # was last processed by the controller. |
| 1900 | # |
| 1901 | # Clients polling for completed reconciliation should poll until |
| 1902 | # observedGeneration = metadata.generation and the Ready condition's status |
| 1903 | # is True or False. |
| 1904 | "url": "A String", # From RouteStatus. |
| 1905 | # URL holds the url that will distribute traffic over the provided traffic |
| 1906 | # targets. It generally has the form |
| 1907 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 1908 | "traffic": [ # From RouteStatus. |
| 1909 | # Traffic holds the configured traffic distribution. |
| 1910 | # These entries will always contain RevisionName references. |
| 1911 | # When ConfigurationName appears in the spec, this will hold the |
| 1912 | # LatestReadyRevisionName that we last observed. |
| 1913 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 1914 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 1915 | # traffic. This is mutually exclusive with ConfigurationName. |
| 1916 | # |
| 1917 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 1918 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 1919 | # ready Revision of the Configuration should be used for this traffic |
| 1920 | # target. When provided LatestRevision must be true if RevisionName is |
| 1921 | # empty; it must be false when RevisionName is non-empty. |
| 1922 | # |
| 1923 | # +optional |
| 1924 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 1925 | # this target exclusively. |
| 1926 | # |
| 1927 | # Not currently supported in Cloud Run. |
| 1928 | # +optional |
| 1929 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 1930 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 1931 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 1932 | # (e.g. basic auth, url path, etc. |
| 1933 | # |
| 1934 | # Not currently supported in Cloud Run. |
| 1935 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 1936 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 1937 | # of the referenced configuration changes, we will automatically migrate |
| 1938 | # traffic from the prior "latest ready" revision to the new one. This field |
| 1939 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 1940 | # with RevisionName. |
| 1941 | # |
| 1942 | # Cloud Run currently supports a single ConfigurationName. |
| 1943 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 1944 | # This defaults to zero if unspecified. |
| 1945 | # |
| 1946 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 1947 | # TrafficTarget entry. |
| 1948 | }, |
| 1949 | ], |
| 1950 | "latestReadyRevisionName": "A String", # From ConfigurationStatus. |
| 1951 | # LatestReadyRevisionName holds the name of the latest Revision stamped out |
| 1952 | # from this Service's Configuration that has had its "Ready" condition become |
| 1953 | # "True". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1954 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1955 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 1956 | "spec": { # ServiceSpec holds the desired state of the Route (from the client), which # Spec holds the desired state of the Service (from the client). |
| 1957 | # is used to manipulate the underlying Route and Configuration(s). |
| 1958 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 1959 | # Revisions and Configurations. |
| 1960 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 1961 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 1962 | # traffic. This is mutually exclusive with ConfigurationName. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1963 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1964 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 1965 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 1966 | # ready Revision of the Configuration should be used for this traffic |
| 1967 | # target. When provided LatestRevision must be true if RevisionName is |
| 1968 | # empty; it must be false when RevisionName is non-empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1969 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1970 | # +optional |
| 1971 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 1972 | # this target exclusively. |
| 1973 | # |
| 1974 | # Not currently supported in Cloud Run. |
| 1975 | # +optional |
| 1976 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 1977 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 1978 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 1979 | # (e.g. basic auth, url path, etc. |
| 1980 | # |
| 1981 | # Not currently supported in Cloud Run. |
| 1982 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 1983 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 1984 | # of the referenced configuration changes, we will automatically migrate |
| 1985 | # traffic from the prior "latest ready" revision to the new one. This field |
| 1986 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 1987 | # with RevisionName. |
| 1988 | # |
| 1989 | # Cloud Run currently supports a single ConfigurationName. |
| 1990 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 1991 | # This defaults to zero if unspecified. |
| 1992 | # |
| 1993 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 1994 | # TrafficTarget entry. |
| 1995 | }, |
| 1996 | ], |
| 1997 | "template": { # RevisionTemplateSpec describes the data a revision should have when created # Template holds the latest specification for the Revision to |
| 1998 | # be stamped out. |
| 1999 | # from a template. Based on: |
| 2000 | # https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 |
| 2001 | "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). |
| 2002 | "containerConcurrency": 42, # (Optional) |
| 2003 | # |
| 2004 | # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) |
| 2005 | # requests per container instance of the Revision. |
| 2006 | # |
| 2007 | # Cloud Run fully managed: supported, defaults to 80 |
| 2008 | # |
| 2009 | # Cloud Run for Anthos: supported, defaults to 0, which means concurrency |
| 2010 | # to the application is not limited, and the system decides the |
| 2011 | # target concurrency for the autoscaler. |
| 2012 | "timeoutSeconds": 42, # TimeoutSeconds holds the max duration the instance is allowed for |
| 2013 | # responding to a request. |
| 2014 | # Not currently used by Cloud Run. |
| 2015 | "serviceAccountName": "A String", # Email address of the IAM service account associated with the revision |
| 2016 | # of the service. The service account represents the identity of the |
| 2017 | # running revision, and determines what permissions the revision has. If |
| 2018 | # not provided, the revision will use the project's default service account. |
| 2019 | "containers": [ # Containers holds the single container that defines the unit of execution |
| 2020 | # for this Revision. In the context of a Revision, we disallow a number of |
| 2021 | # fields on this Container, including: name and lifecycle. |
| 2022 | # In Cloud Run, only a single container may be provided. |
| 2023 | # The runtime contract is documented here: |
| 2024 | # https://github.com/knative/serving/blob/master/docs/runtime-contract.md |
| 2025 | { # A single application container. |
| 2026 | # This specifies both the container to run, the command to run in the container |
| 2027 | # and the arguments to supply to it. |
| 2028 | # Note that additional arguments may be supplied by the system to the container |
| 2029 | # at runtime. |
| 2030 | "securityContext": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2031 | # |
| 2032 | # Cloud Run fully managed: not supported |
| 2033 | # |
| 2034 | # Cloud Run for Anthos: supported |
| 2035 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2036 | # Security options the pod should run with. |
| 2037 | # More info: https://kubernetes.io/docs/concepts/policy/security-context/ |
| 2038 | # More info: |
| 2039 | # https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2040 | # |
| 2041 | # Cloud Run for Anthos: supported |
| 2042 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2043 | # SecurityContext holds security configuration that will be applied to a |
| 2044 | # container. Some fields are present in both SecurityContext and |
| 2045 | # PodSecurityContext. When both are set, the values in SecurityContext take |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2046 | # precedence. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2047 | "runAsUser": 42, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2048 | # |
| 2049 | # Cloud Run fully managed: not supported |
| 2050 | # |
| 2051 | # Cloud Run for Anthos: supported |
| 2052 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2053 | # The UID to run the entrypoint of the container process. |
| 2054 | # Defaults to user specified in image metadata if unspecified. |
| 2055 | # May also be set in PodSecurityContext. If set in both SecurityContext and |
| 2056 | # PodSecurityContext, the value specified in SecurityContext takes |
| 2057 | # precedence. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2058 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2059 | "livenessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2060 | # |
| 2061 | # Cloud Run fully managed: not supported |
| 2062 | # |
| 2063 | # Cloud Run for Anthos: supported |
| 2064 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2065 | # Periodic probe of container liveness. |
| 2066 | # Container will be restarted if the probe fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2067 | # More info: |
| 2068 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2069 | # |
| 2070 | # Cloud Run for Anthos: supported |
| 2071 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2072 | # Probe describes a health check to be performed against a container to |
| 2073 | # determine whether it is alive or ready to receive traffic. |
| 2074 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2075 | # |
| 2076 | # Cloud Run fully managed: not supported |
| 2077 | # |
| 2078 | # Cloud Run for Anthos: supported |
| 2079 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2080 | # HTTPGet specifies the http request to perform. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2081 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2082 | # A field inlined from the Handler message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2083 | # |
| 2084 | # Cloud Run for Anthos: supported |
| 2085 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2086 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 2087 | "host": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2088 | # |
| 2089 | # Cloud Run fully managed: not supported |
| 2090 | # |
| 2091 | # Cloud Run for Anthos: supported |
| 2092 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2093 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 2094 | # "Host" in httpHeaders instead. |
| 2095 | "scheme": "A String", # (Optional) |
| 2096 | # |
| 2097 | # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2098 | # |
| 2099 | # Cloud Run for Anthos: supported |
| 2100 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2101 | # Scheme to use for connecting to the host. |
| 2102 | # Defaults to HTTP. |
| 2103 | "httpHeaders": [ # (Optional) |
| 2104 | # |
| 2105 | # Cloud Run fully managed: not supported |
| 2106 | # |
| 2107 | # Cloud Run for Anthos: supported |
| 2108 | # |
| 2109 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 2110 | { # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2111 | # |
| 2112 | # Cloud Run for Anthos: supported |
| 2113 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2114 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 2115 | "name": "A String", # Cloud Run fully managed: not supported |
| 2116 | # |
| 2117 | # Cloud Run for Anthos: supported |
| 2118 | # |
| 2119 | # The header field name |
| 2120 | "value": "A String", # Cloud Run fully managed: not supported |
| 2121 | # |
| 2122 | # Cloud Run for Anthos: supported |
| 2123 | # |
| 2124 | # The header field value |
| 2125 | }, |
| 2126 | ], |
| 2127 | "path": "A String", # (Optional) |
| 2128 | # |
| 2129 | # Cloud Run fully managed: not supported |
| 2130 | # |
| 2131 | # Cloud Run for Anthos: supported |
| 2132 | # |
| 2133 | # Path to access on the HTTP server. |
| 2134 | }, |
| 2135 | "failureThreshold": 42, # (Optional) |
| 2136 | # |
| 2137 | # Cloud Run fully managed: not supported |
| 2138 | # |
| 2139 | # Cloud Run for Anthos: supported |
| 2140 | # |
| 2141 | # Minimum consecutive failures for the probe to be considered failed after |
| 2142 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 2143 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 2144 | # |
| 2145 | # Cloud Run fully managed: not supported |
| 2146 | # |
| 2147 | # Cloud Run for Anthos: supported |
| 2148 | # |
| 2149 | # One and only one of the following should be specified. |
| 2150 | # Exec specifies the action to take. |
| 2151 | # |
| 2152 | # A field inlined from the Handler message. |
| 2153 | # |
| 2154 | # Cloud Run for Anthos: supported |
| 2155 | # |
| 2156 | # ExecAction describes a "run in container" action. |
| 2157 | "command": "A String", # (Optional) |
| 2158 | # |
| 2159 | # Cloud Run fully managed: not supported |
| 2160 | # |
| 2161 | # Cloud Run for Anthos: supported |
| 2162 | # |
| 2163 | # Command is the command line to execute inside the container, the working |
| 2164 | # directory for the command is root ('/') in the container's filesystem. The |
| 2165 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 2166 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 2167 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 2168 | # live/healthy and non-zero is unhealthy. |
| 2169 | }, |
| 2170 | "initialDelaySeconds": 42, # (Optional) |
| 2171 | # |
| 2172 | # Cloud Run fully managed: not supported |
| 2173 | # |
| 2174 | # Cloud Run for Anthos: supported |
| 2175 | # |
| 2176 | # Number of seconds after the container has started before liveness probes |
| 2177 | # are initiated. More info: |
| 2178 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 2179 | "timeoutSeconds": 42, # (Optional) |
| 2180 | # |
| 2181 | # Cloud Run fully managed: not supported |
| 2182 | # |
| 2183 | # Cloud Run for Anthos: supported |
| 2184 | # |
| 2185 | # Number of seconds after which the probe times out. |
| 2186 | # Defaults to 1 second. Minimum value is 1. |
| 2187 | # More info: |
| 2188 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 2189 | "successThreshold": 42, # (Optional) |
| 2190 | # |
| 2191 | # Cloud Run fully managed: not supported |
| 2192 | # |
| 2193 | # Cloud Run for Anthos: supported |
| 2194 | # |
| 2195 | # Minimum consecutive successes for the probe to be considered successful |
| 2196 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 2197 | # is 1. |
| 2198 | "periodSeconds": 42, # (Optional) |
| 2199 | # |
| 2200 | # Cloud Run fully managed: not supported |
| 2201 | # |
| 2202 | # Cloud Run for Anthos: supported |
| 2203 | # |
| 2204 | # How often (in seconds) to perform the probe. |
| 2205 | # Default to 10 seconds. Minimum value is 1. |
| 2206 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 2207 | # |
| 2208 | # Cloud Run fully managed: not supported |
| 2209 | # |
| 2210 | # Cloud Run for Anthos: supported |
| 2211 | # |
| 2212 | # TCPSocket specifies an action involving a TCP port. |
| 2213 | # TCP hooks not yet supported |
| 2214 | # |
| 2215 | # A field inlined from the Handler message. |
| 2216 | # |
| 2217 | # Cloud Run for Anthos: supported |
| 2218 | # |
| 2219 | # TCPSocketAction describes an action based on opening a socket |
| 2220 | "port": 42, # Cloud Run fully managed: not supported |
| 2221 | # |
| 2222 | # Cloud Run for Anthos: supported |
| 2223 | # |
| 2224 | # Number or name of the port to access on the container. |
| 2225 | # Number must be in the range 1 to 65535. |
| 2226 | # Name must be an IANA_SVC_NAME. |
| 2227 | # |
| 2228 | # This field is currently limited to integer types only because of proto's |
| 2229 | # inability to properly support the IntOrString golang type. |
| 2230 | "host": "A String", # (Optional) |
| 2231 | # |
| 2232 | # Cloud Run fully managed: not supported |
| 2233 | # |
| 2234 | # Cloud Run for Anthos: supported |
| 2235 | # |
| 2236 | # Optional: Host name to connect to, defaults to the pod IP. |
| 2237 | }, |
| 2238 | }, |
| 2239 | "env": [ # (Optional) |
| 2240 | # |
| 2241 | # Cloud Run fully managed: supported |
| 2242 | # |
| 2243 | # Cloud Run for Anthos: supported |
| 2244 | # |
| 2245 | # List of environment variables to set in the container. |
| 2246 | { # EnvVar represents an environment variable present in a Container. |
| 2247 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| 2248 | "valueFrom": { # Cloud Run fully managed: not supported # (Optional) |
| 2249 | # |
| 2250 | # Cloud Run fully managed: not supported |
| 2251 | # |
| 2252 | # Cloud Run for Anthos: supported |
| 2253 | # |
| 2254 | # Source for the environment variable's value. Cannot be used if value is not |
| 2255 | # empty. |
| 2256 | # |
| 2257 | # Cloud Run for Anthos: supported |
| 2258 | # |
| 2259 | # EnvVarSource represents a source for the value of an EnvVar. |
| 2260 | "configMapKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 2261 | # |
| 2262 | # Cloud Run fully managed: not supported |
| 2263 | # |
| 2264 | # Cloud Run for Anthos: supported |
| 2265 | # |
| 2266 | # Selects a key of a ConfigMap. |
| 2267 | # |
| 2268 | # Cloud Run for Anthos: supported |
| 2269 | # |
| 2270 | # Selects a key from a ConfigMap. |
| 2271 | "optional": True or False, # (Optional) |
| 2272 | # |
| 2273 | # Cloud Run fully managed: not supported |
| 2274 | # |
| 2275 | # Cloud Run for Anthos: supported |
| 2276 | # |
| 2277 | # Specify whether the ConfigMap or its key must be defined |
| 2278 | "key": "A String", # Cloud Run fully managed: not supported |
| 2279 | # |
| 2280 | # Cloud Run for Anthos: supported |
| 2281 | # |
| 2282 | # The key to select. |
| 2283 | "name": "A String", # Cloud Run fully managed: not supported |
| 2284 | # |
| 2285 | # Cloud Run for Anthos: supported |
| 2286 | # |
| 2287 | # The ConfigMap to select from. |
| 2288 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 2289 | # directly into the message. Use the "name" field instead. |
| 2290 | # |
| 2291 | # Cloud Run for Anthos: supported |
| 2292 | # |
| 2293 | # LocalObjectReference contains enough information to let you locate the |
| 2294 | # referenced object inside the same namespace. |
| 2295 | "name": "A String", # (Optional) |
| 2296 | # |
| 2297 | # Cloud Run fully managed: not supported |
| 2298 | # |
| 2299 | # Cloud Run for Anthos: supported |
| 2300 | # |
| 2301 | # Name of the referent. |
| 2302 | # More info: |
| 2303 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 2304 | }, |
| 2305 | }, |
| 2306 | "secretKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 2307 | # |
| 2308 | # Cloud Run fully managed: not supported |
| 2309 | # |
| 2310 | # Cloud Run for Anthos: supported |
| 2311 | # |
| 2312 | # Selects a key of a secret in the pod's namespace |
| 2313 | # |
| 2314 | # Cloud Run for Anthos: supported |
| 2315 | # |
| 2316 | # SecretKeySelector selects a key of a Secret. |
| 2317 | "key": "A String", # Cloud Run fully managed: not supported |
| 2318 | # |
| 2319 | # Cloud Run for Anthos: supported |
| 2320 | # |
| 2321 | # The key of the secret to select from. Must be a valid secret key. |
| 2322 | "name": "A String", # Cloud Run fully managed: not supported |
| 2323 | # |
| 2324 | # Cloud Run for Anthos: supported |
| 2325 | # |
| 2326 | # The name of the secret in the pod's namespace to select from. |
| 2327 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 2328 | # directly into the message. Use the "name" field instead. |
| 2329 | # |
| 2330 | # Cloud Run for Anthos: supported |
| 2331 | # |
| 2332 | # LocalObjectReference contains enough information to let you locate the |
| 2333 | # referenced object inside the same namespace. |
| 2334 | "name": "A String", # (Optional) |
| 2335 | # |
| 2336 | # Cloud Run fully managed: not supported |
| 2337 | # |
| 2338 | # Cloud Run for Anthos: supported |
| 2339 | # |
| 2340 | # Name of the referent. |
| 2341 | # More info: |
| 2342 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 2343 | }, |
| 2344 | "optional": True or False, # (Optional) |
| 2345 | # |
| 2346 | # Cloud Run fully managed: not supported |
| 2347 | # |
| 2348 | # Cloud Run for Anthos: supported |
| 2349 | # |
| 2350 | # Specify whether the Secret or its key must be defined |
| 2351 | }, |
| 2352 | }, |
| 2353 | "value": "A String", # (Optional) |
| 2354 | # |
| 2355 | # Variable references $(VAR_NAME) are expanded |
| 2356 | # using the previous defined environment variables in the container and |
| 2357 | # any route environment variables. If a variable cannot be resolved, |
| 2358 | # the reference in the input string will be unchanged. The $(VAR_NAME) |
| 2359 | # syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped |
| 2360 | # references will never be expanded, regardless of whether the variable |
| 2361 | # exists or not. |
| 2362 | # Defaults to "". |
| 2363 | }, |
| 2364 | ], |
| 2365 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) |
| 2366 | # |
| 2367 | # Cloud Run fully managed: supported |
| 2368 | # |
| 2369 | # Cloud Run for Anthos: supported |
| 2370 | # |
| 2371 | # Compute Resources required by this container. |
| 2372 | # More info: |
| 2373 | # https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 2374 | "limits": { # (Optional) |
| 2375 | # |
| 2376 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 2377 | # supported value for CPU is '1'. |
| 2378 | # |
| 2379 | # Cloud Run for Anthos: supported |
| 2380 | # |
| 2381 | # Limits describes the maximum amount of compute resources allowed. |
| 2382 | # The values of the map is string form of the 'quantity' k8s type: |
| 2383 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 2384 | "a_key": "A String", |
| 2385 | }, |
| 2386 | "requests": { # (Optional) |
| 2387 | # |
| 2388 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 2389 | # supported value for CPU is '1'. |
| 2390 | # |
| 2391 | # Cloud Run for Anthos: supported |
| 2392 | # |
| 2393 | # Requests describes the minimum amount of compute resources required. |
| 2394 | # If Requests is omitted for a container, it defaults to Limits if that is |
| 2395 | # explicitly specified, otherwise to an implementation-defined value. |
| 2396 | # The values of the map is string form of the 'quantity' k8s type: |
| 2397 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 2398 | "a_key": "A String", |
| 2399 | }, |
| 2400 | }, |
| 2401 | "readinessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 2402 | # |
| 2403 | # Cloud Run fully managed: not supported |
| 2404 | # |
| 2405 | # Cloud Run for Anthos: supported |
| 2406 | # |
| 2407 | # Periodic probe of container service readiness. |
| 2408 | # Container will be removed from service endpoints if the probe fails. |
| 2409 | # More info: |
| 2410 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 2411 | # |
| 2412 | # Cloud Run for Anthos: supported |
| 2413 | # |
| 2414 | # Probe describes a health check to be performed against a container to |
| 2415 | # determine whether it is alive or ready to receive traffic. |
| 2416 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 2417 | # |
| 2418 | # Cloud Run fully managed: not supported |
| 2419 | # |
| 2420 | # Cloud Run for Anthos: supported |
| 2421 | # |
| 2422 | # HTTPGet specifies the http request to perform. |
| 2423 | # |
| 2424 | # A field inlined from the Handler message. |
| 2425 | # |
| 2426 | # Cloud Run for Anthos: supported |
| 2427 | # |
| 2428 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 2429 | "host": "A String", # (Optional) |
| 2430 | # |
| 2431 | # Cloud Run fully managed: not supported |
| 2432 | # |
| 2433 | # Cloud Run for Anthos: supported |
| 2434 | # |
| 2435 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 2436 | # "Host" in httpHeaders instead. |
| 2437 | "scheme": "A String", # (Optional) |
| 2438 | # |
| 2439 | # Cloud Run fully managed: not supported |
| 2440 | # |
| 2441 | # Cloud Run for Anthos: supported |
| 2442 | # |
| 2443 | # Scheme to use for connecting to the host. |
| 2444 | # Defaults to HTTP. |
| 2445 | "httpHeaders": [ # (Optional) |
| 2446 | # |
| 2447 | # Cloud Run fully managed: not supported |
| 2448 | # |
| 2449 | # Cloud Run for Anthos: supported |
| 2450 | # |
| 2451 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 2452 | { # Cloud Run fully managed: not supported |
| 2453 | # |
| 2454 | # Cloud Run for Anthos: supported |
| 2455 | # |
| 2456 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 2457 | "name": "A String", # Cloud Run fully managed: not supported |
| 2458 | # |
| 2459 | # Cloud Run for Anthos: supported |
| 2460 | # |
| 2461 | # The header field name |
| 2462 | "value": "A String", # Cloud Run fully managed: not supported |
| 2463 | # |
| 2464 | # Cloud Run for Anthos: supported |
| 2465 | # |
| 2466 | # The header field value |
| 2467 | }, |
| 2468 | ], |
| 2469 | "path": "A String", # (Optional) |
| 2470 | # |
| 2471 | # Cloud Run fully managed: not supported |
| 2472 | # |
| 2473 | # Cloud Run for Anthos: supported |
| 2474 | # |
| 2475 | # Path to access on the HTTP server. |
| 2476 | }, |
| 2477 | "failureThreshold": 42, # (Optional) |
| 2478 | # |
| 2479 | # Cloud Run fully managed: not supported |
| 2480 | # |
| 2481 | # Cloud Run for Anthos: supported |
| 2482 | # |
| 2483 | # Minimum consecutive failures for the probe to be considered failed after |
| 2484 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 2485 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 2486 | # |
| 2487 | # Cloud Run fully managed: not supported |
| 2488 | # |
| 2489 | # Cloud Run for Anthos: supported |
| 2490 | # |
| 2491 | # One and only one of the following should be specified. |
| 2492 | # Exec specifies the action to take. |
| 2493 | # |
| 2494 | # A field inlined from the Handler message. |
| 2495 | # |
| 2496 | # Cloud Run for Anthos: supported |
| 2497 | # |
| 2498 | # ExecAction describes a "run in container" action. |
| 2499 | "command": "A String", # (Optional) |
| 2500 | # |
| 2501 | # Cloud Run fully managed: not supported |
| 2502 | # |
| 2503 | # Cloud Run for Anthos: supported |
| 2504 | # |
| 2505 | # Command is the command line to execute inside the container, the working |
| 2506 | # directory for the command is root ('/') in the container's filesystem. The |
| 2507 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 2508 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 2509 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 2510 | # live/healthy and non-zero is unhealthy. |
| 2511 | }, |
| 2512 | "initialDelaySeconds": 42, # (Optional) |
| 2513 | # |
| 2514 | # Cloud Run fully managed: not supported |
| 2515 | # |
| 2516 | # Cloud Run for Anthos: supported |
| 2517 | # |
| 2518 | # Number of seconds after the container has started before liveness probes |
| 2519 | # are initiated. More info: |
| 2520 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 2521 | "timeoutSeconds": 42, # (Optional) |
| 2522 | # |
| 2523 | # Cloud Run fully managed: not supported |
| 2524 | # |
| 2525 | # Cloud Run for Anthos: supported |
| 2526 | # |
| 2527 | # Number of seconds after which the probe times out. |
| 2528 | # Defaults to 1 second. Minimum value is 1. |
| 2529 | # More info: |
| 2530 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 2531 | "successThreshold": 42, # (Optional) |
| 2532 | # |
| 2533 | # Cloud Run fully managed: not supported |
| 2534 | # |
| 2535 | # Cloud Run for Anthos: supported |
| 2536 | # |
| 2537 | # Minimum consecutive successes for the probe to be considered successful |
| 2538 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 2539 | # is 1. |
| 2540 | "periodSeconds": 42, # (Optional) |
| 2541 | # |
| 2542 | # Cloud Run fully managed: not supported |
| 2543 | # |
| 2544 | # Cloud Run for Anthos: supported |
| 2545 | # |
| 2546 | # How often (in seconds) to perform the probe. |
| 2547 | # Default to 10 seconds. Minimum value is 1. |
| 2548 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 2549 | # |
| 2550 | # Cloud Run fully managed: not supported |
| 2551 | # |
| 2552 | # Cloud Run for Anthos: supported |
| 2553 | # |
| 2554 | # TCPSocket specifies an action involving a TCP port. |
| 2555 | # TCP hooks not yet supported |
| 2556 | # |
| 2557 | # A field inlined from the Handler message. |
| 2558 | # |
| 2559 | # Cloud Run for Anthos: supported |
| 2560 | # |
| 2561 | # TCPSocketAction describes an action based on opening a socket |
| 2562 | "port": 42, # Cloud Run fully managed: not supported |
| 2563 | # |
| 2564 | # Cloud Run for Anthos: supported |
| 2565 | # |
| 2566 | # Number or name of the port to access on the container. |
| 2567 | # Number must be in the range 1 to 65535. |
| 2568 | # Name must be an IANA_SVC_NAME. |
| 2569 | # |
| 2570 | # This field is currently limited to integer types only because of proto's |
| 2571 | # inability to properly support the IntOrString golang type. |
| 2572 | "host": "A String", # (Optional) |
| 2573 | # |
| 2574 | # Cloud Run fully managed: not supported |
| 2575 | # |
| 2576 | # Cloud Run for Anthos: supported |
| 2577 | # |
| 2578 | # Optional: Host name to connect to, defaults to the pod IP. |
| 2579 | }, |
| 2580 | }, |
| 2581 | "imagePullPolicy": "A String", # (Optional) |
| 2582 | # |
| 2583 | # Cloud Run fully managed: not supported |
| 2584 | # |
| 2585 | # Cloud Run for Anthos: supported |
| 2586 | # |
| 2587 | # Image pull policy. |
| 2588 | # One of Always, Never, IfNotPresent. |
| 2589 | # Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. |
| 2590 | # More info: |
| 2591 | # https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 2592 | "terminationMessagePath": "A String", # (Optional) |
| 2593 | # |
| 2594 | # Cloud Run fully managed: not supported |
| 2595 | # |
| 2596 | # Cloud Run for Anthos: supported |
| 2597 | # |
| 2598 | # Path at which the file to which the container's termination |
| 2599 | # message will be written is mounted into the container's filesystem. Message |
| 2600 | # written is intended to be brief final status, such as an assertion failure |
| 2601 | # message. Will be truncated by the node if greater than 4096 bytes. The |
| 2602 | # total message length across all containers will be limited to 12kb. |
| 2603 | # Defaults to /dev/termination-log. |
| 2604 | "volumeMounts": [ # (Optional) |
| 2605 | # |
| 2606 | # Cloud Run fully managed: not supported |
| 2607 | # |
| 2608 | # Cloud Run for Anthos: supported |
| 2609 | # |
| 2610 | # Pod volumes to mount into the container's filesystem. |
| 2611 | { # Cloud Run fully managed: not supported |
| 2612 | # |
| 2613 | # Cloud Run for Anthos: supported |
| 2614 | # |
| 2615 | # VolumeMount describes a mounting of a Volume within a container. |
| 2616 | "mountPath": "A String", # Cloud Run fully managed: not supported |
| 2617 | # |
| 2618 | # Cloud Run for Anthos: supported |
| 2619 | # |
| 2620 | # Path within the container at which the volume should be mounted. Must |
| 2621 | # not contain ':'. |
| 2622 | "subPath": "A String", # (Optional) |
| 2623 | # |
| 2624 | # Cloud Run fully managed: not supported |
| 2625 | # |
| 2626 | # Cloud Run for Anthos: supported |
| 2627 | # |
| 2628 | # Path within the volume from which the container's volume should be mounted. |
| 2629 | # Defaults to "" (volume's root). |
| 2630 | "name": "A String", # Cloud Run fully managed: not supported |
| 2631 | # |
| 2632 | # Cloud Run for Anthos: supported |
| 2633 | # |
| 2634 | # This must match the Name of a Volume. |
| 2635 | "readOnly": True or False, # (Optional) |
| 2636 | # |
| 2637 | # Cloud Run fully managed: not supported |
| 2638 | # |
| 2639 | # Cloud Run for Anthos: supported |
| 2640 | # |
| 2641 | # Only true is accepted. |
| 2642 | # Defaults to true. |
| 2643 | }, |
| 2644 | ], |
| 2645 | "args": [ # (Optional) |
| 2646 | # |
| 2647 | # Cloud Run fully managed: supported |
| 2648 | # |
| 2649 | # Cloud Run for Anthos: supported |
| 2650 | # |
| 2651 | # Arguments to the entrypoint. |
| 2652 | # The docker image's CMD is used if this is not provided. |
| 2653 | # Variable references $(VAR_NAME) are expanded using the container's |
| 2654 | # environment. If a variable cannot be resolved, the reference in the input |
| 2655 | # string will be unchanged. The $(VAR_NAME) syntax can be escaped with a |
| 2656 | # double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, |
| 2657 | # regardless of whether the variable exists or not. |
| 2658 | # More info: |
| 2659 | # https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| 2660 | "A String", |
| 2661 | ], |
| 2662 | "workingDir": "A String", # (Optional) |
| 2663 | # |
| 2664 | # Cloud Run fully managed: not supported |
| 2665 | # |
| 2666 | # Cloud Run for Anthos: supported |
| 2667 | # |
| 2668 | # Container's working directory. |
| 2669 | # If not specified, the container runtime's default will be used, which |
| 2670 | # might be configured in the container image. |
| 2671 | "ports": [ # (Optional) |
| 2672 | # |
| 2673 | # List of ports to expose from the container. Only a single port can be |
| 2674 | # specified. The specified ports must be listening on all interfaces |
| 2675 | # (0.0.0.0) within the container to be accessible. |
| 2676 | # |
| 2677 | # If omitted, a port number will be chosen and passed to the container |
| 2678 | # through the PORT environment variable for the container to listen on. |
| 2679 | { # ContainerPort represents a network port in a single container. |
| 2680 | "containerPort": 42, # (Optional) |
| 2681 | # |
| 2682 | # Port number the container listens on. |
| 2683 | # This must be a valid port number, 0 < x < 65536. |
| 2684 | "protocol": "A String", # (Optional) |
| 2685 | # |
| 2686 | # Cloud Run fully managed: not supported |
| 2687 | # |
| 2688 | # Cloud Run for Anthos: supported |
| 2689 | # |
| 2690 | # Protocol for port. Must be "TCP". |
| 2691 | # Defaults to "TCP". |
| 2692 | "name": "A String", # (Optional) |
| 2693 | # |
| 2694 | # Cloud Run fully managed: not supported |
| 2695 | # |
| 2696 | # Cloud Run for Anthos: supported |
| 2697 | # |
| 2698 | # If specified, used to specify which protocol to use. |
| 2699 | # Allowed values are "http1" and "h2c". |
| 2700 | }, |
| 2701 | ], |
| 2702 | "image": "A String", # Cloud Run fully managed: only supports containers from Google Container |
| 2703 | # Registry |
| 2704 | # |
| 2705 | # Cloud Run for Anthos: supported |
| 2706 | # |
| 2707 | # URL of the Container image. |
| 2708 | # More info: https://kubernetes.io/docs/concepts/containers/images |
| 2709 | "envFrom": [ # (Optional) |
| 2710 | # |
| 2711 | # Cloud Run fully managed: not supported |
| 2712 | # |
| 2713 | # Cloud Run for Anthos: supported |
| 2714 | # |
| 2715 | # List of sources to populate environment variables in the container. |
| 2716 | # The keys defined within a source must be a C_IDENTIFIER. All invalid keys |
| 2717 | # will be reported as an event when the container is starting. When a key |
| 2718 | # exists in multiple sources, the value associated with the last source will |
| 2719 | # take precedence. Values defined by an Env with a duplicate key will take |
| 2720 | # precedence. Cannot be updated. |
| 2721 | { # Cloud Run fully managed: not supported |
| 2722 | # |
| 2723 | # Cloud Run for Anthos: supported |
| 2724 | # |
| 2725 | # EnvFromSource represents the source of a set of ConfigMaps |
| 2726 | "secretRef": { # Cloud Run fully managed: not supported # (Optional) |
| 2727 | # |
| 2728 | # Cloud Run fully managed: not supported |
| 2729 | # |
| 2730 | # Cloud Run for Anthos: supported |
| 2731 | # |
| 2732 | # The Secret to select from |
| 2733 | # |
| 2734 | # Cloud Run for Anthos: supported |
| 2735 | # |
| 2736 | # SecretEnvSource selects a Secret to populate the environment |
| 2737 | # variables with. |
| 2738 | # |
| 2739 | # The contents of the target Secret's Data field will represent the |
| 2740 | # key-value pairs as environment variables. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2741 | "name": "A String", # Cloud Run fully managed: not supported |
| 2742 | # |
| 2743 | # Cloud Run for Anthos: supported |
| 2744 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2745 | # The Secret to select from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2746 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 2747 | # directly into the message. Use the "name" field instead. |
| 2748 | # |
| 2749 | # Cloud Run for Anthos: supported |
| 2750 | # |
| 2751 | # LocalObjectReference contains enough information to let you locate the |
| 2752 | # referenced object inside the same namespace. |
| 2753 | "name": "A String", # (Optional) |
| 2754 | # |
| 2755 | # Cloud Run fully managed: not supported |
| 2756 | # |
| 2757 | # Cloud Run for Anthos: supported |
| 2758 | # |
| 2759 | # Name of the referent. |
| 2760 | # More info: |
| 2761 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 2762 | }, |
| 2763 | "optional": True or False, # (Optional) |
| 2764 | # |
| 2765 | # Cloud Run fully managed: not supported |
| 2766 | # |
| 2767 | # Cloud Run for Anthos: supported |
| 2768 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2769 | # Specify whether the Secret must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2770 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2771 | "prefix": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2772 | # |
| 2773 | # Cloud Run fully managed: not supported |
| 2774 | # |
| 2775 | # Cloud Run for Anthos: supported |
| 2776 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2777 | # An optional identifier to prepend to each key in the ConfigMap. Must be a |
| 2778 | # C_IDENTIFIER. |
| 2779 | "configMapRef": { # Cloud Run fully managed: not supported # (Optional) |
| 2780 | # |
| 2781 | # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2782 | # |
| 2783 | # Cloud Run for Anthos: supported |
| 2784 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2785 | # The ConfigMap to select from |
| 2786 | # |
| 2787 | # Cloud Run for Anthos: supported |
| 2788 | # |
| 2789 | # ConfigMapEnvSource selects a ConfigMap to populate the environment |
| 2790 | # variables with. |
| 2791 | # |
| 2792 | # The contents of the target ConfigMap's Data field will represent the |
| 2793 | # key-value pairs as environment variables. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2794 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 2795 | # directly into the message. Use the "name" field instead. |
| 2796 | # |
| 2797 | # Cloud Run for Anthos: supported |
| 2798 | # |
| 2799 | # LocalObjectReference contains enough information to let you locate the |
| 2800 | # referenced object inside the same namespace. |
| 2801 | "name": "A String", # (Optional) |
| 2802 | # |
| 2803 | # Cloud Run fully managed: not supported |
| 2804 | # |
| 2805 | # Cloud Run for Anthos: supported |
| 2806 | # |
| 2807 | # Name of the referent. |
| 2808 | # More info: |
| 2809 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 2810 | }, |
| 2811 | "optional": True or False, # (Optional) |
| 2812 | # |
| 2813 | # Cloud Run fully managed: not supported |
| 2814 | # |
| 2815 | # Cloud Run for Anthos: supported |
| 2816 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2817 | # Specify whether the ConfigMap must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2818 | "name": "A String", # Cloud Run fully managed: not supported |
| 2819 | # |
| 2820 | # Cloud Run for Anthos: supported |
| 2821 | # |
| 2822 | # The ConfigMap to select from. |
| 2823 | }, |
| 2824 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2825 | ], |
| 2826 | "name": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2827 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2828 | # Name of the container specified as a DNS_LABEL. |
| 2829 | "command": [ |
| 2830 | "A String", |
| 2831 | ], |
| 2832 | "terminationMessagePolicy": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2833 | # |
| 2834 | # Cloud Run fully managed: not supported |
| 2835 | # |
| 2836 | # Cloud Run for Anthos: supported |
| 2837 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2838 | # Indicate how the termination message should be populated. File will use the |
| 2839 | # contents of terminationMessagePath to populate the container status message |
| 2840 | # on both success and failure. FallbackToLogsOnError will use the last chunk |
| 2841 | # of container log output if the termination message file is empty and the |
| 2842 | # container exited with an error. The log output is limited to 2048 bytes or |
| 2843 | # 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 2844 | }, |
| 2845 | ], |
| 2846 | "volumes": [ |
| 2847 | { # Cloud Run fully managed: not supported |
| 2848 | # |
| 2849 | # Cloud Run for Anthos: supported |
| 2850 | # |
| 2851 | # Volume represents a named volume in a container. |
| 2852 | "configMap": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2853 | # |
| 2854 | # Cloud Run for Anthos: supported |
| 2855 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2856 | # Cloud Run for Anthos: supported |
| 2857 | # |
| 2858 | # Adapts a ConfigMap into a volume. |
| 2859 | # The contents of the target ConfigMap's Data field will be presented in a |
| 2860 | # volume as files using the keys in the Data field as the file names, unless |
| 2861 | # the items element is populated with specific mappings of keys to paths. |
| 2862 | "optional": True or False, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2863 | # |
| 2864 | # Cloud Run fully managed: not supported |
| 2865 | # |
| 2866 | # Cloud Run for Anthos: supported |
| 2867 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2868 | # Specify whether the Secret or its keys must be defined. |
| 2869 | "name": "A String", # Cloud Run fully managed: not supported |
| 2870 | # |
| 2871 | # Cloud Run for Anthos: supported |
| 2872 | # |
| 2873 | # Name of the config. |
| 2874 | "defaultMode": 42, # (Optional) |
| 2875 | # |
| 2876 | # Cloud Run fully managed: not supported |
| 2877 | # |
| 2878 | # Cloud Run for Anthos: supported |
| 2879 | # |
| 2880 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 2881 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 2882 | # this setting. This might be in conflict with other options that affect the |
| 2883 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 2884 | "items": [ # (Optional) |
| 2885 | # |
| 2886 | # Cloud Run fully managed: not supported |
| 2887 | # |
| 2888 | # Cloud Run for Anthos: supported |
| 2889 | # |
| 2890 | # If unspecified, each key-value pair in the Data field of the referenced |
| 2891 | # Secret will be projected into the volume as a file whose name is the |
| 2892 | # key and content is the value. If specified, the listed keys will be |
| 2893 | # projected into the specified paths, and unlisted keys will not be |
| 2894 | # present. If a key is specified which is not present in the Secret, |
| 2895 | # the volume setup will error unless it is marked optional. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2896 | { # Cloud Run fully managed: not supported |
| 2897 | # |
| 2898 | # Cloud Run for Anthos: supported |
| 2899 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2900 | # Maps a string key to a path within a volume. |
| 2901 | "key": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2902 | # |
| 2903 | # Cloud Run for Anthos: supported |
| 2904 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2905 | # The key to project. |
| 2906 | "path": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2907 | # |
| 2908 | # Cloud Run for Anthos: supported |
| 2909 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2910 | # The relative path of the file to map the key to. |
| 2911 | # May not be an absolute path. |
| 2912 | # May not contain the path element '..'. |
| 2913 | # May not start with the string '..'. |
| 2914 | "mode": 42, # (Optional) |
| 2915 | # |
| 2916 | # Cloud Run fully managed: not supported |
| 2917 | # |
| 2918 | # Cloud Run for Anthos: supported |
| 2919 | # |
| 2920 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 2921 | # specified, the volume defaultMode will be used. This might be in conflict |
| 2922 | # with other options that affect the file mode, like fsGroup, and the result |
| 2923 | # can be other mode bits set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2924 | }, |
| 2925 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2926 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2927 | "name": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2928 | # |
| 2929 | # Cloud Run for Anthos: supported |
| 2930 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2931 | # Volume's name. |
| 2932 | "secret": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2933 | # |
| 2934 | # Cloud Run for Anthos: supported |
| 2935 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2936 | # Cloud Run for Anthos: supported |
| 2937 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2938 | # The contents of the target Secret's Data field will be presented in a volume |
| 2939 | # as files using the keys in the Data field as the file names. |
| 2940 | "secretName": "A String", # Cloud Run fully managed: not supported |
| 2941 | # |
| 2942 | # Cloud Run for Anthos: supported |
| 2943 | # |
| 2944 | # Name of the secret in the container's namespace to use. |
| 2945 | "items": [ # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2946 | # |
| 2947 | # Cloud Run fully managed: not supported |
| 2948 | # |
| 2949 | # Cloud Run for Anthos: supported |
| 2950 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2951 | # If unspecified, each key-value pair in the Data field of the referenced |
| 2952 | # Secret will be projected into the volume as a file whose name is the |
| 2953 | # key and content is the value. If specified, the listed keys will be |
| 2954 | # projected into the specified paths, and unlisted keys will not be |
| 2955 | # present. If a key is specified which is not present in the Secret, |
| 2956 | # the volume setup will error unless it is marked optional. |
| 2957 | { # Cloud Run fully managed: not supported |
| 2958 | # |
| 2959 | # Cloud Run for Anthos: supported |
| 2960 | # |
| 2961 | # Maps a string key to a path within a volume. |
| 2962 | "key": "A String", # Cloud Run fully managed: not supported |
| 2963 | # |
| 2964 | # Cloud Run for Anthos: supported |
| 2965 | # |
| 2966 | # The key to project. |
| 2967 | "path": "A String", # Cloud Run fully managed: not supported |
| 2968 | # |
| 2969 | # Cloud Run for Anthos: supported |
| 2970 | # |
| 2971 | # The relative path of the file to map the key to. |
| 2972 | # May not be an absolute path. |
| 2973 | # May not contain the path element '..'. |
| 2974 | # May not start with the string '..'. |
| 2975 | "mode": 42, # (Optional) |
| 2976 | # |
| 2977 | # Cloud Run fully managed: not supported |
| 2978 | # |
| 2979 | # Cloud Run for Anthos: supported |
| 2980 | # |
| 2981 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 2982 | # specified, the volume defaultMode will be used. This might be in conflict |
| 2983 | # with other options that affect the file mode, like fsGroup, and the result |
| 2984 | # can be other mode bits set. |
| 2985 | }, |
| 2986 | ], |
| 2987 | "optional": True or False, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2988 | # |
| 2989 | # Cloud Run fully managed: not supported |
| 2990 | # |
| 2991 | # Cloud Run for Anthos: supported |
| 2992 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2993 | # Specify whether the Secret or its keys must be defined. |
| 2994 | "defaultMode": 42, # (Optional) |
| 2995 | # |
| 2996 | # Cloud Run fully managed: not supported |
| 2997 | # |
| 2998 | # Cloud Run for Anthos: supported |
| 2999 | # |
| 3000 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 3001 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 3002 | # this setting. This might be in conflict with other options that affect the |
| 3003 | # file mode, like fsGroup, and the result can be other mode bits set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3004 | }, |
| 3005 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3006 | ], |
| 3007 | }, |
| 3008 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Optional metadata for this Revision, including labels and annotations. Name |
| 3009 | # will be generated by the Configuration. |
| 3010 | # To set minimum instances for this revision, use the |
| 3011 | # "autoscaling.knative.dev/minScale" annotation key. |
| 3012 | # To set maximum instances for this revision, use the |
| 3013 | # "autoscaling.knative.dev/maxScale" annotation key. |
| 3014 | # To set Cloud SQL connections for the revision, use the |
| 3015 | # "run.googleapis.com/cloudsql-instances" annotation key. |
| 3016 | # persisted resources must have, which includes all objects users must create. |
| 3017 | "annotations": { # (Optional) |
| 3018 | # |
| 3019 | # Annotations is an unstructured key value map stored with a resource that |
| 3020 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 3021 | # are not queryable and should be preserved when modifying objects. More |
| 3022 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 3023 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3024 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3025 | "generateName": "A String", # (Optional) |
| 3026 | # |
| 3027 | # Cloud Run fully managed: not supported |
| 3028 | # |
| 3029 | # Cloud Run for Anthos: supported |
| 3030 | # |
| 3031 | # GenerateName is an optional prefix, used by the server, to generate a |
| 3032 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 3033 | # used, the name returned to the client will be different than the name |
| 3034 | # passed. This value will also be combined with a unique suffix. The provided |
| 3035 | # value has the same validation rules as the Name field, and may be truncated |
| 3036 | # by the length of the suffix required to make the value unique on the |
| 3037 | # server. |
| 3038 | # |
| 3039 | # If this field is specified and the generated name exists, the server will |
| 3040 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 3041 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 3042 | # time allotted, and the client should retry (optionally after the time |
| 3043 | # indicated in the Retry-After header). |
| 3044 | # |
| 3045 | # Applied only if Name is not specified. |
| 3046 | # More info: |
| 3047 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 3048 | # string generateName = 2; |
| 3049 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 3050 | # Is required when creating |
| 3051 | # resources, although some resources may allow a client to request the |
| 3052 | # generation of an appropriate name automatically. Name is primarily intended |
| 3053 | # for creation idempotence and configuration definition. Cannot be updated. |
| 3054 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 3055 | # +optional |
| 3056 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 3057 | # |
| 3058 | # Cloud Run fully managed: not supported |
| 3059 | # |
| 3060 | # Cloud Run for Anthos: supported |
| 3061 | # |
| 3062 | # Number of seconds allowed for this object to gracefully terminate before |
| 3063 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 3064 | # set. May only be shortened. Read-only. |
| 3065 | "clusterName": "A String", # (Optional) |
| 3066 | # |
| 3067 | # Cloud Run fully managed: not supported |
| 3068 | # |
| 3069 | # Cloud Run for Anthos: supported |
| 3070 | # |
| 3071 | # The name of the cluster which the object belongs to. |
| 3072 | # This is used to distinguish resources with same name and namespace in |
| 3073 | # different clusters. This field is not set anywhere right now and apiserver |
| 3074 | # is going to ignore it if set in create or update request. |
| 3075 | "finalizers": [ # (Optional) |
| 3076 | # |
| 3077 | # Cloud Run fully managed: not supported |
| 3078 | # |
| 3079 | # Cloud Run for Anthos: supported |
| 3080 | # |
| 3081 | # Must be empty before the object is deleted from the registry. Each entry |
| 3082 | # is an identifier for the responsible component that will remove the entry |
| 3083 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 3084 | # in this list can only be removed. |
| 3085 | # +patchStrategy=merge |
| 3086 | "A String", |
| 3087 | ], |
| 3088 | "deletionTimestamp": "A String", # (Optional) |
| 3089 | # |
| 3090 | # Cloud Run fully managed: not supported |
| 3091 | # |
| 3092 | # Cloud Run for Anthos: supported |
| 3093 | # |
| 3094 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 3095 | # deleted. This field is set by the server when a graceful deletion is |
| 3096 | # requested by the user, and is not directly settable by a client. The |
| 3097 | # resource is expected to be deleted (no longer visible from resource lists, |
| 3098 | # and not reachable by name) after the time in this field, once the |
| 3099 | # finalizers list is empty. As long as the finalizers list contains items, |
| 3100 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 3101 | # be unset or be set further into the future, although it may be shortened or |
| 3102 | # the resource may be deleted prior to this time. For example, a user may |
| 3103 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 3104 | # sending a graceful termination signal to the containers in the pod. After |
| 3105 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 3106 | # to the container and after cleanup, remove the pod from the API. In the |
| 3107 | # presence of network partitions, this object may still exist after this |
| 3108 | # timestamp, until an administrator or automated process can determine the |
| 3109 | # resource is fully terminated. |
| 3110 | # If not set, graceful deletion of the object has not been requested. |
| 3111 | # |
| 3112 | # Populated by the system when a graceful deletion is requested. |
| 3113 | # Read-only. |
| 3114 | # More info: |
| 3115 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 3116 | "ownerReferences": [ # (Optional) |
| 3117 | # |
| 3118 | # Cloud Run fully managed: not supported |
| 3119 | # |
| 3120 | # Cloud Run for Anthos: supported |
| 3121 | # |
| 3122 | # List of objects that own this object. If ALL objects in the list have |
| 3123 | # been deleted, this object will be garbage collected. |
| 3124 | { # OwnerReference contains enough information to let you identify an owning |
| 3125 | # object. Currently, an owning object must be in the same namespace, so there |
| 3126 | # is no namespace field. |
| 3127 | "controller": True or False, # If true, this reference points to the managing controller. |
| 3128 | # +optional |
| 3129 | "kind": "A String", # Kind of the referent. |
| 3130 | # More info: |
| 3131 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 3132 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 3133 | # the owner cannot be deleted from the key-value store until this |
| 3134 | # reference is removed. |
| 3135 | # Defaults to false. |
| 3136 | # To set this field, a user needs "delete" permission of the owner, |
| 3137 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 3138 | # +optional |
| 3139 | "apiVersion": "A String", # API version of the referent. |
| 3140 | "name": "A String", # Name of the referent. |
| 3141 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 3142 | "uid": "A String", # UID of the referent. |
| 3143 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 3144 | }, |
| 3145 | ], |
| 3146 | "creationTimestamp": "A String", # (Optional) |
| 3147 | # |
| 3148 | # CreationTimestamp is a timestamp representing the server time when this |
| 3149 | # object was created. It is not guaranteed to be set in happens-before order |
| 3150 | # across separate operations. Clients may not set this value. It is |
| 3151 | # represented in RFC3339 form and is in UTC. |
| 3152 | # |
| 3153 | # Populated by the system. |
| 3154 | # Read-only. |
| 3155 | # Null for lists. |
| 3156 | # More info: |
| 3157 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 3158 | "labels": { # (Optional) |
| 3159 | # |
| 3160 | # Map of string keys and values that can be used to organize and categorize |
| 3161 | # (scope and select) objects. May match selectors of replication controllers |
| 3162 | # and routes. |
| 3163 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 3164 | "a_key": "A String", |
| 3165 | }, |
| 3166 | "generation": 42, # (Optional) |
| 3167 | # |
| 3168 | # A sequence number representing a specific generation of the desired state. |
| 3169 | # Populated by the system. Read-only. |
| 3170 | "resourceVersion": "A String", # (Optional) |
| 3171 | # |
| 3172 | # An opaque value that represents the internal version of this object that |
| 3173 | # can be used by clients to determine when objects have changed. May be used |
| 3174 | # for optimistic concurrency, change detection, and the watch operation on a |
| 3175 | # resource or set of resources. Clients must treat these values as opaque and |
| 3176 | # passed unmodified back to the server. They may only be valid for a |
| 3177 | # particular resource or set of resources. |
| 3178 | # |
| 3179 | # Populated by the system. |
| 3180 | # Read-only. |
| 3181 | # Value must be treated as opaque by clients and . |
| 3182 | # More info: |
| 3183 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 3184 | "selfLink": "A String", # (Optional) |
| 3185 | # |
| 3186 | # SelfLink is a URL representing this object. |
| 3187 | # Populated by the system. |
| 3188 | # Read-only. |
| 3189 | # string selfLink = 4; |
| 3190 | "uid": "A String", # (Optional) |
| 3191 | # |
| 3192 | # UID is the unique in time and space value for this object. It is typically |
| 3193 | # generated by the server on successful creation of a resource and is not |
| 3194 | # allowed to change on PUT operations. |
| 3195 | # |
| 3196 | # Populated by the system. |
| 3197 | # Read-only. |
| 3198 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 3199 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 3200 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 3201 | # project ID or project number. |
| 3202 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3203 | }, |
| 3204 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3205 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3206 | </div> |
| 3207 | |
| 3208 | <div class="method"> |
| 3209 | <code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code> |
| 3210 | <pre>Delete a service. |
| 3211 | This will cause the Service to stop serving traffic and will delete the |
| 3212 | child entities like Routes, Configurations and Revisions. |
| 3213 | |
| 3214 | Args: |
| 3215 | name: string, The name of the service to delete. |
| 3216 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 3217 | or number. (required) |
| 3218 | apiVersion: string, Cloud Run currently ignores this parameter. |
| 3219 | propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores |
| 3220 | this setting, and deletes in the background. Please see |
| 3221 | kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for |
| 3222 | more information. |
| 3223 | kind: string, Cloud Run currently ignores this parameter. |
| 3224 | x__xgafv: string, V1 error format. |
| 3225 | Allowed values |
| 3226 | 1 - v1 error format |
| 3227 | 2 - v2 error format |
| 3228 | |
| 3229 | Returns: |
| 3230 | An object of the form: |
| 3231 | |
| 3232 | { # Status is a return value for calls that don't return other objects |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3233 | "details": { # StatusDetails is a set of additional properties that MAY be set by the # Extended data associated with the reason. Each reason may define its |
| 3234 | # own extended details. This field is optional and the data returned |
| 3235 | # is not guaranteed to conform to any schema except that defined by |
| 3236 | # the reason type. |
| 3237 | # +optional |
| 3238 | # server to provide additional information about a response. The Reason |
| 3239 | # field of a Status object defines what attributes will be set. Clients |
| 3240 | # must ignore fields that do not match the defined type of each attribute, |
| 3241 | # and should assume that any attribute may be empty, invalid, or under |
| 3242 | # defined. |
| 3243 | "name": "A String", # The name attribute of the resource associated with the status StatusReason |
| 3244 | # (when there is a single name which can be described). |
| 3245 | # +optional |
| 3246 | "uid": "A String", # UID of the resource. |
| 3247 | # (when there is a single resource which can be described). |
| 3248 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 3249 | # +optional |
| 3250 | "group": "A String", # The group attribute of the resource associated with the status |
| 3251 | # StatusReason. +optional |
| 3252 | "causes": [ # The Causes array includes more details associated with the StatusReason |
| 3253 | # failure. Not all StatusReasons may provide detailed causes. |
| 3254 | # +optional |
| 3255 | { # StatusCause provides more information about an api.Status failure, including |
| 3256 | # cases when multiple errors are encountered. |
| 3257 | "message": "A String", # A human-readable description of the cause of the error. This field may be |
| 3258 | # presented as-is to a reader. |
| 3259 | # +optional |
| 3260 | "reason": "A String", # A machine-readable description of the cause of the error. If this value is |
| 3261 | # empty there is no information available. |
| 3262 | # +optional |
| 3263 | "field": "A String", # The field of the resource that has caused this error, as named by its JSON |
| 3264 | # serialization. May include dot and postfix notation for nested attributes. |
| 3265 | # Arrays are zero-indexed. Fields may appear more than once in an array of |
| 3266 | # causes due to fields having multiple errors. |
| 3267 | # Optional. |
| 3268 | # |
| 3269 | # Examples: |
| 3270 | # "name" - the field "name" on the current resource |
| 3271 | # "items[0].name" - the field "name" on the first array entry in "items" |
| 3272 | # +optional |
| 3273 | }, |
| 3274 | ], |
| 3275 | "kind": "A String", # The kind attribute of the resource associated with the status StatusReason. |
| 3276 | # On some operations may differ from the requested resource Kind. |
| 3277 | # More info: |
| 3278 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 3279 | # +optional |
| 3280 | "retryAfterSeconds": 42, # If specified, the time in seconds before the operation should be retried. |
| 3281 | # Some errors may indicate the client must take an alternate action - for |
| 3282 | # those errors this field may indicate how long to wait before taking the |
| 3283 | # alternate action. +optional |
| 3284 | }, |
| 3285 | "reason": "A String", # A machine-readable description of why this operation is in the |
| 3286 | # "Failure" status. If this value is empty there |
| 3287 | # is no information available. A Reason clarifies an HTTP status |
| 3288 | # code but does not override it. |
| 3289 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3290 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Standard list metadata. |
| 3291 | # More info: |
| 3292 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 3293 | # +optional |
| 3294 | # lists and various status objects. A resource may have only one of |
| 3295 | # {ObjectMeta, ListMeta}. |
| 3296 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 3297 | # Populated by the system. |
| 3298 | # Read-only. |
| 3299 | # +optional |
| 3300 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 3301 | # can be used by clients to determine when objects have changed. Value must |
| 3302 | # be treated as opaque by clients and passed unmodified back to the server. |
| 3303 | # Populated by the system. |
| 3304 | # Read-only. |
| 3305 | # More info: |
| 3306 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 3307 | # +optional |
| 3308 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 3309 | # returned, and indicates that the server has more data available. The value |
| 3310 | # is opaque and may be used to issue another request to the endpoint that |
| 3311 | # served this list to retrieve the next set of available objects. Continuing |
| 3312 | # a list may not be possible if the server configuration has changed or more |
| 3313 | # than a few minutes have passed. The resourceVersion field returned when |
| 3314 | # using this continue value will be identical to the value in the first |
| 3315 | # response. |
| 3316 | }, |
| 3317 | "code": 42, # Suggested HTTP return code for this status, 0 if not set. |
| 3318 | # +optional |
| 3319 | "message": "A String", # A human-readable description of the status of this operation. |
| 3320 | # +optional |
| 3321 | "status": "A String", # Status of the operation. |
| 3322 | # One of: "Success" or "Failure". |
| 3323 | # More info: |
| 3324 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| 3325 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3326 | }</pre> |
| 3327 | </div> |
| 3328 | |
| 3329 | <div class="method"> |
| 3330 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 3331 | <pre>Get information about a service. |
| 3332 | |
| 3333 | Args: |
| 3334 | name: string, The name of the service to retrieve. |
| 3335 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 3336 | or number. (required) |
| 3337 | x__xgafv: string, V1 error format. |
| 3338 | Allowed values |
| 3339 | 1 - v1 error format |
| 3340 | 2 - v2 error format |
| 3341 | |
| 3342 | Returns: |
| 3343 | An object of the form: |
| 3344 | |
| 3345 | { # Service acts as a top-level container that manages a set of Routes and |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3346 | # Configurations which implement a network service. Service exists to provide a |
| 3347 | # singular abstraction which can be access controlled, reasoned about, and |
| 3348 | # which encapsulates software lifecycle decisions such as rollout policy and |
| 3349 | # team resource ownership. Service acts only as an orchestrator of the |
| 3350 | # underlying Routes and Configurations (much as a kubernetes Deployment |
| 3351 | # orchestrates ReplicaSets). |
| 3352 | # |
| 3353 | # The Service's controller will track the statuses of its owned Configuration |
| 3354 | # and Route, reflecting their statuses and conditions as its own. |
| 3355 | # |
| 3356 | # See also: |
| 3357 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#service |
| 3358 | "kind": "A String", # The kind of resource, in this case "Service". |
| 3359 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Service, including name, namespace, labels, |
| 3360 | # and annotations. |
| 3361 | # persisted resources must have, which includes all objects users must create. |
| 3362 | "annotations": { # (Optional) |
| 3363 | # |
| 3364 | # Annotations is an unstructured key value map stored with a resource that |
| 3365 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 3366 | # are not queryable and should be preserved when modifying objects. More |
| 3367 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 3368 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3369 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3370 | "generateName": "A String", # (Optional) |
| 3371 | # |
| 3372 | # Cloud Run fully managed: not supported |
| 3373 | # |
| 3374 | # Cloud Run for Anthos: supported |
| 3375 | # |
| 3376 | # GenerateName is an optional prefix, used by the server, to generate a |
| 3377 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 3378 | # used, the name returned to the client will be different than the name |
| 3379 | # passed. This value will also be combined with a unique suffix. The provided |
| 3380 | # value has the same validation rules as the Name field, and may be truncated |
| 3381 | # by the length of the suffix required to make the value unique on the |
| 3382 | # server. |
| 3383 | # |
| 3384 | # If this field is specified and the generated name exists, the server will |
| 3385 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 3386 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 3387 | # time allotted, and the client should retry (optionally after the time |
| 3388 | # indicated in the Retry-After header). |
| 3389 | # |
| 3390 | # Applied only if Name is not specified. |
| 3391 | # More info: |
| 3392 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 3393 | # string generateName = 2; |
| 3394 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 3395 | # Is required when creating |
| 3396 | # resources, although some resources may allow a client to request the |
| 3397 | # generation of an appropriate name automatically. Name is primarily intended |
| 3398 | # for creation idempotence and configuration definition. Cannot be updated. |
| 3399 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 3400 | # +optional |
| 3401 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 3402 | # |
| 3403 | # Cloud Run fully managed: not supported |
| 3404 | # |
| 3405 | # Cloud Run for Anthos: supported |
| 3406 | # |
| 3407 | # Number of seconds allowed for this object to gracefully terminate before |
| 3408 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 3409 | # set. May only be shortened. Read-only. |
| 3410 | "clusterName": "A String", # (Optional) |
| 3411 | # |
| 3412 | # Cloud Run fully managed: not supported |
| 3413 | # |
| 3414 | # Cloud Run for Anthos: supported |
| 3415 | # |
| 3416 | # The name of the cluster which the object belongs to. |
| 3417 | # This is used to distinguish resources with same name and namespace in |
| 3418 | # different clusters. This field is not set anywhere right now and apiserver |
| 3419 | # is going to ignore it if set in create or update request. |
| 3420 | "finalizers": [ # (Optional) |
| 3421 | # |
| 3422 | # Cloud Run fully managed: not supported |
| 3423 | # |
| 3424 | # Cloud Run for Anthos: supported |
| 3425 | # |
| 3426 | # Must be empty before the object is deleted from the registry. Each entry |
| 3427 | # is an identifier for the responsible component that will remove the entry |
| 3428 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 3429 | # in this list can only be removed. |
| 3430 | # +patchStrategy=merge |
| 3431 | "A String", |
| 3432 | ], |
| 3433 | "deletionTimestamp": "A String", # (Optional) |
| 3434 | # |
| 3435 | # Cloud Run fully managed: not supported |
| 3436 | # |
| 3437 | # Cloud Run for Anthos: supported |
| 3438 | # |
| 3439 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 3440 | # deleted. This field is set by the server when a graceful deletion is |
| 3441 | # requested by the user, and is not directly settable by a client. The |
| 3442 | # resource is expected to be deleted (no longer visible from resource lists, |
| 3443 | # and not reachable by name) after the time in this field, once the |
| 3444 | # finalizers list is empty. As long as the finalizers list contains items, |
| 3445 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 3446 | # be unset or be set further into the future, although it may be shortened or |
| 3447 | # the resource may be deleted prior to this time. For example, a user may |
| 3448 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 3449 | # sending a graceful termination signal to the containers in the pod. After |
| 3450 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 3451 | # to the container and after cleanup, remove the pod from the API. In the |
| 3452 | # presence of network partitions, this object may still exist after this |
| 3453 | # timestamp, until an administrator or automated process can determine the |
| 3454 | # resource is fully terminated. |
| 3455 | # If not set, graceful deletion of the object has not been requested. |
| 3456 | # |
| 3457 | # Populated by the system when a graceful deletion is requested. |
| 3458 | # Read-only. |
| 3459 | # More info: |
| 3460 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 3461 | "ownerReferences": [ # (Optional) |
| 3462 | # |
| 3463 | # Cloud Run fully managed: not supported |
| 3464 | # |
| 3465 | # Cloud Run for Anthos: supported |
| 3466 | # |
| 3467 | # List of objects that own this object. If ALL objects in the list have |
| 3468 | # been deleted, this object will be garbage collected. |
| 3469 | { # OwnerReference contains enough information to let you identify an owning |
| 3470 | # object. Currently, an owning object must be in the same namespace, so there |
| 3471 | # is no namespace field. |
| 3472 | "controller": True or False, # If true, this reference points to the managing controller. |
| 3473 | # +optional |
| 3474 | "kind": "A String", # Kind of the referent. |
| 3475 | # More info: |
| 3476 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 3477 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 3478 | # the owner cannot be deleted from the key-value store until this |
| 3479 | # reference is removed. |
| 3480 | # Defaults to false. |
| 3481 | # To set this field, a user needs "delete" permission of the owner, |
| 3482 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 3483 | # +optional |
| 3484 | "apiVersion": "A String", # API version of the referent. |
| 3485 | "name": "A String", # Name of the referent. |
| 3486 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 3487 | "uid": "A String", # UID of the referent. |
| 3488 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 3489 | }, |
| 3490 | ], |
| 3491 | "creationTimestamp": "A String", # (Optional) |
| 3492 | # |
| 3493 | # CreationTimestamp is a timestamp representing the server time when this |
| 3494 | # object was created. It is not guaranteed to be set in happens-before order |
| 3495 | # across separate operations. Clients may not set this value. It is |
| 3496 | # represented in RFC3339 form and is in UTC. |
| 3497 | # |
| 3498 | # Populated by the system. |
| 3499 | # Read-only. |
| 3500 | # Null for lists. |
| 3501 | # More info: |
| 3502 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 3503 | "labels": { # (Optional) |
| 3504 | # |
| 3505 | # Map of string keys and values that can be used to organize and categorize |
| 3506 | # (scope and select) objects. May match selectors of replication controllers |
| 3507 | # and routes. |
| 3508 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 3509 | "a_key": "A String", |
| 3510 | }, |
| 3511 | "generation": 42, # (Optional) |
| 3512 | # |
| 3513 | # A sequence number representing a specific generation of the desired state. |
| 3514 | # Populated by the system. Read-only. |
| 3515 | "resourceVersion": "A String", # (Optional) |
| 3516 | # |
| 3517 | # An opaque value that represents the internal version of this object that |
| 3518 | # can be used by clients to determine when objects have changed. May be used |
| 3519 | # for optimistic concurrency, change detection, and the watch operation on a |
| 3520 | # resource or set of resources. Clients must treat these values as opaque and |
| 3521 | # passed unmodified back to the server. They may only be valid for a |
| 3522 | # particular resource or set of resources. |
| 3523 | # |
| 3524 | # Populated by the system. |
| 3525 | # Read-only. |
| 3526 | # Value must be treated as opaque by clients and . |
| 3527 | # More info: |
| 3528 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 3529 | "selfLink": "A String", # (Optional) |
| 3530 | # |
| 3531 | # SelfLink is a URL representing this object. |
| 3532 | # Populated by the system. |
| 3533 | # Read-only. |
| 3534 | # string selfLink = 4; |
| 3535 | "uid": "A String", # (Optional) |
| 3536 | # |
| 3537 | # UID is the unique in time and space value for this object. It is typically |
| 3538 | # generated by the server on successful creation of a resource and is not |
| 3539 | # allowed to change on PUT operations. |
| 3540 | # |
| 3541 | # Populated by the system. |
| 3542 | # Read-only. |
| 3543 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 3544 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 3545 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 3546 | # project ID or project number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3547 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3548 | "status": { # The current state of the Service. Output only. # Status communicates the observed state of the Service (from the |
| 3549 | # controller). |
| 3550 | "latestCreatedRevisionName": "A String", # From ConfigurationStatus. |
| 3551 | # LatestCreatedRevisionName is the last revision that was created from this |
| 3552 | # Service's Configuration. It might not be ready yet, for that use |
| 3553 | # LatestReadyRevisionName. |
| 3554 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 3555 | # reconciliation processes that bring the "spec" inline with the observed |
| 3556 | # state of the world. |
| 3557 | # Service-specific conditions include: |
| 3558 | # * "ConfigurationsReady": true when the underlying Configuration is ready. |
| 3559 | # * "RoutesReady": true when the underlying Route is ready. |
| 3560 | # * "Ready": true when both the underlying Route and Configuration are |
| 3561 | # ready. |
| 3562 | { # Condition defines a generic condition for a Resource |
| 3563 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 3564 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 3565 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 3566 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 3567 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 3568 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 3569 | # See also: |
| 3570 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 3571 | # Types common to all resources include: |
| 3572 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3573 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3574 | ], |
| 3575 | "address": { # Information for connecting over HTTP(s). # From RouteStatus. |
| 3576 | # Similar to url, information on where the service is available on HTTP. |
| 3577 | "url": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3578 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3579 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 3580 | # was last processed by the controller. |
| 3581 | # |
| 3582 | # Clients polling for completed reconciliation should poll until |
| 3583 | # observedGeneration = metadata.generation and the Ready condition's status |
| 3584 | # is True or False. |
| 3585 | "url": "A String", # From RouteStatus. |
| 3586 | # URL holds the url that will distribute traffic over the provided traffic |
| 3587 | # targets. It generally has the form |
| 3588 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 3589 | "traffic": [ # From RouteStatus. |
| 3590 | # Traffic holds the configured traffic distribution. |
| 3591 | # These entries will always contain RevisionName references. |
| 3592 | # When ConfigurationName appears in the spec, this will hold the |
| 3593 | # LatestReadyRevisionName that we last observed. |
| 3594 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 3595 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 3596 | # traffic. This is mutually exclusive with ConfigurationName. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3597 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3598 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 3599 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 3600 | # ready Revision of the Configuration should be used for this traffic |
| 3601 | # target. When provided LatestRevision must be true if RevisionName is |
| 3602 | # empty; it must be false when RevisionName is non-empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3603 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3604 | # +optional |
| 3605 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 3606 | # this target exclusively. |
| 3607 | # |
| 3608 | # Not currently supported in Cloud Run. |
| 3609 | # +optional |
| 3610 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 3611 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 3612 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 3613 | # (e.g. basic auth, url path, etc. |
| 3614 | # |
| 3615 | # Not currently supported in Cloud Run. |
| 3616 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 3617 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 3618 | # of the referenced configuration changes, we will automatically migrate |
| 3619 | # traffic from the prior "latest ready" revision to the new one. This field |
| 3620 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 3621 | # with RevisionName. |
| 3622 | # |
| 3623 | # Cloud Run currently supports a single ConfigurationName. |
| 3624 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 3625 | # This defaults to zero if unspecified. |
| 3626 | # |
| 3627 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 3628 | # TrafficTarget entry. |
| 3629 | }, |
| 3630 | ], |
| 3631 | "latestReadyRevisionName": "A String", # From ConfigurationStatus. |
| 3632 | # LatestReadyRevisionName holds the name of the latest Revision stamped out |
| 3633 | # from this Service's Configuration that has had its "Ready" condition become |
| 3634 | # "True". |
| 3635 | }, |
| 3636 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 3637 | "spec": { # ServiceSpec holds the desired state of the Route (from the client), which # Spec holds the desired state of the Service (from the client). |
| 3638 | # is used to manipulate the underlying Route and Configuration(s). |
| 3639 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 3640 | # Revisions and Configurations. |
| 3641 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 3642 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 3643 | # traffic. This is mutually exclusive with ConfigurationName. |
| 3644 | # |
| 3645 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 3646 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 3647 | # ready Revision of the Configuration should be used for this traffic |
| 3648 | # target. When provided LatestRevision must be true if RevisionName is |
| 3649 | # empty; it must be false when RevisionName is non-empty. |
| 3650 | # |
| 3651 | # +optional |
| 3652 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 3653 | # this target exclusively. |
| 3654 | # |
| 3655 | # Not currently supported in Cloud Run. |
| 3656 | # +optional |
| 3657 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 3658 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 3659 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 3660 | # (e.g. basic auth, url path, etc. |
| 3661 | # |
| 3662 | # Not currently supported in Cloud Run. |
| 3663 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 3664 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 3665 | # of the referenced configuration changes, we will automatically migrate |
| 3666 | # traffic from the prior "latest ready" revision to the new one. This field |
| 3667 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 3668 | # with RevisionName. |
| 3669 | # |
| 3670 | # Cloud Run currently supports a single ConfigurationName. |
| 3671 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 3672 | # This defaults to zero if unspecified. |
| 3673 | # |
| 3674 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 3675 | # TrafficTarget entry. |
| 3676 | }, |
| 3677 | ], |
| 3678 | "template": { # RevisionTemplateSpec describes the data a revision should have when created # Template holds the latest specification for the Revision to |
| 3679 | # be stamped out. |
| 3680 | # from a template. Based on: |
| 3681 | # https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 |
| 3682 | "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). |
| 3683 | "containerConcurrency": 42, # (Optional) |
| 3684 | # |
| 3685 | # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) |
| 3686 | # requests per container instance of the Revision. |
| 3687 | # |
| 3688 | # Cloud Run fully managed: supported, defaults to 80 |
| 3689 | # |
| 3690 | # Cloud Run for Anthos: supported, defaults to 0, which means concurrency |
| 3691 | # to the application is not limited, and the system decides the |
| 3692 | # target concurrency for the autoscaler. |
| 3693 | "timeoutSeconds": 42, # TimeoutSeconds holds the max duration the instance is allowed for |
| 3694 | # responding to a request. |
| 3695 | # Not currently used by Cloud Run. |
| 3696 | "serviceAccountName": "A String", # Email address of the IAM service account associated with the revision |
| 3697 | # of the service. The service account represents the identity of the |
| 3698 | # running revision, and determines what permissions the revision has. If |
| 3699 | # not provided, the revision will use the project's default service account. |
| 3700 | "containers": [ # Containers holds the single container that defines the unit of execution |
| 3701 | # for this Revision. In the context of a Revision, we disallow a number of |
| 3702 | # fields on this Container, including: name and lifecycle. |
| 3703 | # In Cloud Run, only a single container may be provided. |
| 3704 | # The runtime contract is documented here: |
| 3705 | # https://github.com/knative/serving/blob/master/docs/runtime-contract.md |
| 3706 | { # A single application container. |
| 3707 | # This specifies both the container to run, the command to run in the container |
| 3708 | # and the arguments to supply to it. |
| 3709 | # Note that additional arguments may be supplied by the system to the container |
| 3710 | # at runtime. |
| 3711 | "securityContext": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3712 | # |
| 3713 | # Cloud Run fully managed: not supported |
| 3714 | # |
| 3715 | # Cloud Run for Anthos: supported |
| 3716 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3717 | # Security options the pod should run with. |
| 3718 | # More info: https://kubernetes.io/docs/concepts/policy/security-context/ |
| 3719 | # More info: |
| 3720 | # https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3721 | # |
| 3722 | # Cloud Run for Anthos: supported |
| 3723 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3724 | # SecurityContext holds security configuration that will be applied to a |
| 3725 | # container. Some fields are present in both SecurityContext and |
| 3726 | # PodSecurityContext. When both are set, the values in SecurityContext take |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3727 | # precedence. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3728 | "runAsUser": 42, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3729 | # |
| 3730 | # Cloud Run fully managed: not supported |
| 3731 | # |
| 3732 | # Cloud Run for Anthos: supported |
| 3733 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3734 | # The UID to run the entrypoint of the container process. |
| 3735 | # Defaults to user specified in image metadata if unspecified. |
| 3736 | # May also be set in PodSecurityContext. If set in both SecurityContext and |
| 3737 | # PodSecurityContext, the value specified in SecurityContext takes |
| 3738 | # precedence. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3739 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3740 | "livenessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3741 | # |
| 3742 | # Cloud Run fully managed: not supported |
| 3743 | # |
| 3744 | # Cloud Run for Anthos: supported |
| 3745 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3746 | # Periodic probe of container liveness. |
| 3747 | # Container will be restarted if the probe fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3748 | # More info: |
| 3749 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3750 | # |
| 3751 | # Cloud Run for Anthos: supported |
| 3752 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3753 | # Probe describes a health check to be performed against a container to |
| 3754 | # determine whether it is alive or ready to receive traffic. |
| 3755 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3756 | # |
| 3757 | # Cloud Run fully managed: not supported |
| 3758 | # |
| 3759 | # Cloud Run for Anthos: supported |
| 3760 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3761 | # HTTPGet specifies the http request to perform. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3762 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3763 | # A field inlined from the Handler message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3764 | # |
| 3765 | # Cloud Run for Anthos: supported |
| 3766 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3767 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 3768 | "host": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3769 | # |
| 3770 | # Cloud Run fully managed: not supported |
| 3771 | # |
| 3772 | # Cloud Run for Anthos: supported |
| 3773 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3774 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 3775 | # "Host" in httpHeaders instead. |
| 3776 | "scheme": "A String", # (Optional) |
| 3777 | # |
| 3778 | # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3779 | # |
| 3780 | # Cloud Run for Anthos: supported |
| 3781 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3782 | # Scheme to use for connecting to the host. |
| 3783 | # Defaults to HTTP. |
| 3784 | "httpHeaders": [ # (Optional) |
| 3785 | # |
| 3786 | # Cloud Run fully managed: not supported |
| 3787 | # |
| 3788 | # Cloud Run for Anthos: supported |
| 3789 | # |
| 3790 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 3791 | { # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3792 | # |
| 3793 | # Cloud Run for Anthos: supported |
| 3794 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3795 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 3796 | "name": "A String", # Cloud Run fully managed: not supported |
| 3797 | # |
| 3798 | # Cloud Run for Anthos: supported |
| 3799 | # |
| 3800 | # The header field name |
| 3801 | "value": "A String", # Cloud Run fully managed: not supported |
| 3802 | # |
| 3803 | # Cloud Run for Anthos: supported |
| 3804 | # |
| 3805 | # The header field value |
| 3806 | }, |
| 3807 | ], |
| 3808 | "path": "A String", # (Optional) |
| 3809 | # |
| 3810 | # Cloud Run fully managed: not supported |
| 3811 | # |
| 3812 | # Cloud Run for Anthos: supported |
| 3813 | # |
| 3814 | # Path to access on the HTTP server. |
| 3815 | }, |
| 3816 | "failureThreshold": 42, # (Optional) |
| 3817 | # |
| 3818 | # Cloud Run fully managed: not supported |
| 3819 | # |
| 3820 | # Cloud Run for Anthos: supported |
| 3821 | # |
| 3822 | # Minimum consecutive failures for the probe to be considered failed after |
| 3823 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 3824 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 3825 | # |
| 3826 | # Cloud Run fully managed: not supported |
| 3827 | # |
| 3828 | # Cloud Run for Anthos: supported |
| 3829 | # |
| 3830 | # One and only one of the following should be specified. |
| 3831 | # Exec specifies the action to take. |
| 3832 | # |
| 3833 | # A field inlined from the Handler message. |
| 3834 | # |
| 3835 | # Cloud Run for Anthos: supported |
| 3836 | # |
| 3837 | # ExecAction describes a "run in container" action. |
| 3838 | "command": "A String", # (Optional) |
| 3839 | # |
| 3840 | # Cloud Run fully managed: not supported |
| 3841 | # |
| 3842 | # Cloud Run for Anthos: supported |
| 3843 | # |
| 3844 | # Command is the command line to execute inside the container, the working |
| 3845 | # directory for the command is root ('/') in the container's filesystem. The |
| 3846 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 3847 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 3848 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 3849 | # live/healthy and non-zero is unhealthy. |
| 3850 | }, |
| 3851 | "initialDelaySeconds": 42, # (Optional) |
| 3852 | # |
| 3853 | # Cloud Run fully managed: not supported |
| 3854 | # |
| 3855 | # Cloud Run for Anthos: supported |
| 3856 | # |
| 3857 | # Number of seconds after the container has started before liveness probes |
| 3858 | # are initiated. More info: |
| 3859 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 3860 | "timeoutSeconds": 42, # (Optional) |
| 3861 | # |
| 3862 | # Cloud Run fully managed: not supported |
| 3863 | # |
| 3864 | # Cloud Run for Anthos: supported |
| 3865 | # |
| 3866 | # Number of seconds after which the probe times out. |
| 3867 | # Defaults to 1 second. Minimum value is 1. |
| 3868 | # More info: |
| 3869 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 3870 | "successThreshold": 42, # (Optional) |
| 3871 | # |
| 3872 | # Cloud Run fully managed: not supported |
| 3873 | # |
| 3874 | # Cloud Run for Anthos: supported |
| 3875 | # |
| 3876 | # Minimum consecutive successes for the probe to be considered successful |
| 3877 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 3878 | # is 1. |
| 3879 | "periodSeconds": 42, # (Optional) |
| 3880 | # |
| 3881 | # Cloud Run fully managed: not supported |
| 3882 | # |
| 3883 | # Cloud Run for Anthos: supported |
| 3884 | # |
| 3885 | # How often (in seconds) to perform the probe. |
| 3886 | # Default to 10 seconds. Minimum value is 1. |
| 3887 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 3888 | # |
| 3889 | # Cloud Run fully managed: not supported |
| 3890 | # |
| 3891 | # Cloud Run for Anthos: supported |
| 3892 | # |
| 3893 | # TCPSocket specifies an action involving a TCP port. |
| 3894 | # TCP hooks not yet supported |
| 3895 | # |
| 3896 | # A field inlined from the Handler message. |
| 3897 | # |
| 3898 | # Cloud Run for Anthos: supported |
| 3899 | # |
| 3900 | # TCPSocketAction describes an action based on opening a socket |
| 3901 | "port": 42, # Cloud Run fully managed: not supported |
| 3902 | # |
| 3903 | # Cloud Run for Anthos: supported |
| 3904 | # |
| 3905 | # Number or name of the port to access on the container. |
| 3906 | # Number must be in the range 1 to 65535. |
| 3907 | # Name must be an IANA_SVC_NAME. |
| 3908 | # |
| 3909 | # This field is currently limited to integer types only because of proto's |
| 3910 | # inability to properly support the IntOrString golang type. |
| 3911 | "host": "A String", # (Optional) |
| 3912 | # |
| 3913 | # Cloud Run fully managed: not supported |
| 3914 | # |
| 3915 | # Cloud Run for Anthos: supported |
| 3916 | # |
| 3917 | # Optional: Host name to connect to, defaults to the pod IP. |
| 3918 | }, |
| 3919 | }, |
| 3920 | "env": [ # (Optional) |
| 3921 | # |
| 3922 | # Cloud Run fully managed: supported |
| 3923 | # |
| 3924 | # Cloud Run for Anthos: supported |
| 3925 | # |
| 3926 | # List of environment variables to set in the container. |
| 3927 | { # EnvVar represents an environment variable present in a Container. |
| 3928 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| 3929 | "valueFrom": { # Cloud Run fully managed: not supported # (Optional) |
| 3930 | # |
| 3931 | # Cloud Run fully managed: not supported |
| 3932 | # |
| 3933 | # Cloud Run for Anthos: supported |
| 3934 | # |
| 3935 | # Source for the environment variable's value. Cannot be used if value is not |
| 3936 | # empty. |
| 3937 | # |
| 3938 | # Cloud Run for Anthos: supported |
| 3939 | # |
| 3940 | # EnvVarSource represents a source for the value of an EnvVar. |
| 3941 | "configMapKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 3942 | # |
| 3943 | # Cloud Run fully managed: not supported |
| 3944 | # |
| 3945 | # Cloud Run for Anthos: supported |
| 3946 | # |
| 3947 | # Selects a key of a ConfigMap. |
| 3948 | # |
| 3949 | # Cloud Run for Anthos: supported |
| 3950 | # |
| 3951 | # Selects a key from a ConfigMap. |
| 3952 | "optional": True or False, # (Optional) |
| 3953 | # |
| 3954 | # Cloud Run fully managed: not supported |
| 3955 | # |
| 3956 | # Cloud Run for Anthos: supported |
| 3957 | # |
| 3958 | # Specify whether the ConfigMap or its key must be defined |
| 3959 | "key": "A String", # Cloud Run fully managed: not supported |
| 3960 | # |
| 3961 | # Cloud Run for Anthos: supported |
| 3962 | # |
| 3963 | # The key to select. |
| 3964 | "name": "A String", # Cloud Run fully managed: not supported |
| 3965 | # |
| 3966 | # Cloud Run for Anthos: supported |
| 3967 | # |
| 3968 | # The ConfigMap to select from. |
| 3969 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 3970 | # directly into the message. Use the "name" field instead. |
| 3971 | # |
| 3972 | # Cloud Run for Anthos: supported |
| 3973 | # |
| 3974 | # LocalObjectReference contains enough information to let you locate the |
| 3975 | # referenced object inside the same namespace. |
| 3976 | "name": "A String", # (Optional) |
| 3977 | # |
| 3978 | # Cloud Run fully managed: not supported |
| 3979 | # |
| 3980 | # Cloud Run for Anthos: supported |
| 3981 | # |
| 3982 | # Name of the referent. |
| 3983 | # More info: |
| 3984 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 3985 | }, |
| 3986 | }, |
| 3987 | "secretKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 3988 | # |
| 3989 | # Cloud Run fully managed: not supported |
| 3990 | # |
| 3991 | # Cloud Run for Anthos: supported |
| 3992 | # |
| 3993 | # Selects a key of a secret in the pod's namespace |
| 3994 | # |
| 3995 | # Cloud Run for Anthos: supported |
| 3996 | # |
| 3997 | # SecretKeySelector selects a key of a Secret. |
| 3998 | "key": "A String", # Cloud Run fully managed: not supported |
| 3999 | # |
| 4000 | # Cloud Run for Anthos: supported |
| 4001 | # |
| 4002 | # The key of the secret to select from. Must be a valid secret key. |
| 4003 | "name": "A String", # Cloud Run fully managed: not supported |
| 4004 | # |
| 4005 | # Cloud Run for Anthos: supported |
| 4006 | # |
| 4007 | # The name of the secret in the pod's namespace to select from. |
| 4008 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 4009 | # directly into the message. Use the "name" field instead. |
| 4010 | # |
| 4011 | # Cloud Run for Anthos: supported |
| 4012 | # |
| 4013 | # LocalObjectReference contains enough information to let you locate the |
| 4014 | # referenced object inside the same namespace. |
| 4015 | "name": "A String", # (Optional) |
| 4016 | # |
| 4017 | # Cloud Run fully managed: not supported |
| 4018 | # |
| 4019 | # Cloud Run for Anthos: supported |
| 4020 | # |
| 4021 | # Name of the referent. |
| 4022 | # More info: |
| 4023 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 4024 | }, |
| 4025 | "optional": True or False, # (Optional) |
| 4026 | # |
| 4027 | # Cloud Run fully managed: not supported |
| 4028 | # |
| 4029 | # Cloud Run for Anthos: supported |
| 4030 | # |
| 4031 | # Specify whether the Secret or its key must be defined |
| 4032 | }, |
| 4033 | }, |
| 4034 | "value": "A String", # (Optional) |
| 4035 | # |
| 4036 | # Variable references $(VAR_NAME) are expanded |
| 4037 | # using the previous defined environment variables in the container and |
| 4038 | # any route environment variables. If a variable cannot be resolved, |
| 4039 | # the reference in the input string will be unchanged. The $(VAR_NAME) |
| 4040 | # syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped |
| 4041 | # references will never be expanded, regardless of whether the variable |
| 4042 | # exists or not. |
| 4043 | # Defaults to "". |
| 4044 | }, |
| 4045 | ], |
| 4046 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) |
| 4047 | # |
| 4048 | # Cloud Run fully managed: supported |
| 4049 | # |
| 4050 | # Cloud Run for Anthos: supported |
| 4051 | # |
| 4052 | # Compute Resources required by this container. |
| 4053 | # More info: |
| 4054 | # https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 4055 | "limits": { # (Optional) |
| 4056 | # |
| 4057 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 4058 | # supported value for CPU is '1'. |
| 4059 | # |
| 4060 | # Cloud Run for Anthos: supported |
| 4061 | # |
| 4062 | # Limits describes the maximum amount of compute resources allowed. |
| 4063 | # The values of the map is string form of the 'quantity' k8s type: |
| 4064 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 4065 | "a_key": "A String", |
| 4066 | }, |
| 4067 | "requests": { # (Optional) |
| 4068 | # |
| 4069 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 4070 | # supported value for CPU is '1'. |
| 4071 | # |
| 4072 | # Cloud Run for Anthos: supported |
| 4073 | # |
| 4074 | # Requests describes the minimum amount of compute resources required. |
| 4075 | # If Requests is omitted for a container, it defaults to Limits if that is |
| 4076 | # explicitly specified, otherwise to an implementation-defined value. |
| 4077 | # The values of the map is string form of the 'quantity' k8s type: |
| 4078 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 4079 | "a_key": "A String", |
| 4080 | }, |
| 4081 | }, |
| 4082 | "readinessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 4083 | # |
| 4084 | # Cloud Run fully managed: not supported |
| 4085 | # |
| 4086 | # Cloud Run for Anthos: supported |
| 4087 | # |
| 4088 | # Periodic probe of container service readiness. |
| 4089 | # Container will be removed from service endpoints if the probe fails. |
| 4090 | # More info: |
| 4091 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 4092 | # |
| 4093 | # Cloud Run for Anthos: supported |
| 4094 | # |
| 4095 | # Probe describes a health check to be performed against a container to |
| 4096 | # determine whether it is alive or ready to receive traffic. |
| 4097 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 4098 | # |
| 4099 | # Cloud Run fully managed: not supported |
| 4100 | # |
| 4101 | # Cloud Run for Anthos: supported |
| 4102 | # |
| 4103 | # HTTPGet specifies the http request to perform. |
| 4104 | # |
| 4105 | # A field inlined from the Handler message. |
| 4106 | # |
| 4107 | # Cloud Run for Anthos: supported |
| 4108 | # |
| 4109 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 4110 | "host": "A String", # (Optional) |
| 4111 | # |
| 4112 | # Cloud Run fully managed: not supported |
| 4113 | # |
| 4114 | # Cloud Run for Anthos: supported |
| 4115 | # |
| 4116 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 4117 | # "Host" in httpHeaders instead. |
| 4118 | "scheme": "A String", # (Optional) |
| 4119 | # |
| 4120 | # Cloud Run fully managed: not supported |
| 4121 | # |
| 4122 | # Cloud Run for Anthos: supported |
| 4123 | # |
| 4124 | # Scheme to use for connecting to the host. |
| 4125 | # Defaults to HTTP. |
| 4126 | "httpHeaders": [ # (Optional) |
| 4127 | # |
| 4128 | # Cloud Run fully managed: not supported |
| 4129 | # |
| 4130 | # Cloud Run for Anthos: supported |
| 4131 | # |
| 4132 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 4133 | { # Cloud Run fully managed: not supported |
| 4134 | # |
| 4135 | # Cloud Run for Anthos: supported |
| 4136 | # |
| 4137 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 4138 | "name": "A String", # Cloud Run fully managed: not supported |
| 4139 | # |
| 4140 | # Cloud Run for Anthos: supported |
| 4141 | # |
| 4142 | # The header field name |
| 4143 | "value": "A String", # Cloud Run fully managed: not supported |
| 4144 | # |
| 4145 | # Cloud Run for Anthos: supported |
| 4146 | # |
| 4147 | # The header field value |
| 4148 | }, |
| 4149 | ], |
| 4150 | "path": "A String", # (Optional) |
| 4151 | # |
| 4152 | # Cloud Run fully managed: not supported |
| 4153 | # |
| 4154 | # Cloud Run for Anthos: supported |
| 4155 | # |
| 4156 | # Path to access on the HTTP server. |
| 4157 | }, |
| 4158 | "failureThreshold": 42, # (Optional) |
| 4159 | # |
| 4160 | # Cloud Run fully managed: not supported |
| 4161 | # |
| 4162 | # Cloud Run for Anthos: supported |
| 4163 | # |
| 4164 | # Minimum consecutive failures for the probe to be considered failed after |
| 4165 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 4166 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 4167 | # |
| 4168 | # Cloud Run fully managed: not supported |
| 4169 | # |
| 4170 | # Cloud Run for Anthos: supported |
| 4171 | # |
| 4172 | # One and only one of the following should be specified. |
| 4173 | # Exec specifies the action to take. |
| 4174 | # |
| 4175 | # A field inlined from the Handler message. |
| 4176 | # |
| 4177 | # Cloud Run for Anthos: supported |
| 4178 | # |
| 4179 | # ExecAction describes a "run in container" action. |
| 4180 | "command": "A String", # (Optional) |
| 4181 | # |
| 4182 | # Cloud Run fully managed: not supported |
| 4183 | # |
| 4184 | # Cloud Run for Anthos: supported |
| 4185 | # |
| 4186 | # Command is the command line to execute inside the container, the working |
| 4187 | # directory for the command is root ('/') in the container's filesystem. The |
| 4188 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 4189 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 4190 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 4191 | # live/healthy and non-zero is unhealthy. |
| 4192 | }, |
| 4193 | "initialDelaySeconds": 42, # (Optional) |
| 4194 | # |
| 4195 | # Cloud Run fully managed: not supported |
| 4196 | # |
| 4197 | # Cloud Run for Anthos: supported |
| 4198 | # |
| 4199 | # Number of seconds after the container has started before liveness probes |
| 4200 | # are initiated. More info: |
| 4201 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 4202 | "timeoutSeconds": 42, # (Optional) |
| 4203 | # |
| 4204 | # Cloud Run fully managed: not supported |
| 4205 | # |
| 4206 | # Cloud Run for Anthos: supported |
| 4207 | # |
| 4208 | # Number of seconds after which the probe times out. |
| 4209 | # Defaults to 1 second. Minimum value is 1. |
| 4210 | # More info: |
| 4211 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 4212 | "successThreshold": 42, # (Optional) |
| 4213 | # |
| 4214 | # Cloud Run fully managed: not supported |
| 4215 | # |
| 4216 | # Cloud Run for Anthos: supported |
| 4217 | # |
| 4218 | # Minimum consecutive successes for the probe to be considered successful |
| 4219 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 4220 | # is 1. |
| 4221 | "periodSeconds": 42, # (Optional) |
| 4222 | # |
| 4223 | # Cloud Run fully managed: not supported |
| 4224 | # |
| 4225 | # Cloud Run for Anthos: supported |
| 4226 | # |
| 4227 | # How often (in seconds) to perform the probe. |
| 4228 | # Default to 10 seconds. Minimum value is 1. |
| 4229 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 4230 | # |
| 4231 | # Cloud Run fully managed: not supported |
| 4232 | # |
| 4233 | # Cloud Run for Anthos: supported |
| 4234 | # |
| 4235 | # TCPSocket specifies an action involving a TCP port. |
| 4236 | # TCP hooks not yet supported |
| 4237 | # |
| 4238 | # A field inlined from the Handler message. |
| 4239 | # |
| 4240 | # Cloud Run for Anthos: supported |
| 4241 | # |
| 4242 | # TCPSocketAction describes an action based on opening a socket |
| 4243 | "port": 42, # Cloud Run fully managed: not supported |
| 4244 | # |
| 4245 | # Cloud Run for Anthos: supported |
| 4246 | # |
| 4247 | # Number or name of the port to access on the container. |
| 4248 | # Number must be in the range 1 to 65535. |
| 4249 | # Name must be an IANA_SVC_NAME. |
| 4250 | # |
| 4251 | # This field is currently limited to integer types only because of proto's |
| 4252 | # inability to properly support the IntOrString golang type. |
| 4253 | "host": "A String", # (Optional) |
| 4254 | # |
| 4255 | # Cloud Run fully managed: not supported |
| 4256 | # |
| 4257 | # Cloud Run for Anthos: supported |
| 4258 | # |
| 4259 | # Optional: Host name to connect to, defaults to the pod IP. |
| 4260 | }, |
| 4261 | }, |
| 4262 | "imagePullPolicy": "A String", # (Optional) |
| 4263 | # |
| 4264 | # Cloud Run fully managed: not supported |
| 4265 | # |
| 4266 | # Cloud Run for Anthos: supported |
| 4267 | # |
| 4268 | # Image pull policy. |
| 4269 | # One of Always, Never, IfNotPresent. |
| 4270 | # Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. |
| 4271 | # More info: |
| 4272 | # https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 4273 | "terminationMessagePath": "A String", # (Optional) |
| 4274 | # |
| 4275 | # Cloud Run fully managed: not supported |
| 4276 | # |
| 4277 | # Cloud Run for Anthos: supported |
| 4278 | # |
| 4279 | # Path at which the file to which the container's termination |
| 4280 | # message will be written is mounted into the container's filesystem. Message |
| 4281 | # written is intended to be brief final status, such as an assertion failure |
| 4282 | # message. Will be truncated by the node if greater than 4096 bytes. The |
| 4283 | # total message length across all containers will be limited to 12kb. |
| 4284 | # Defaults to /dev/termination-log. |
| 4285 | "volumeMounts": [ # (Optional) |
| 4286 | # |
| 4287 | # Cloud Run fully managed: not supported |
| 4288 | # |
| 4289 | # Cloud Run for Anthos: supported |
| 4290 | # |
| 4291 | # Pod volumes to mount into the container's filesystem. |
| 4292 | { # Cloud Run fully managed: not supported |
| 4293 | # |
| 4294 | # Cloud Run for Anthos: supported |
| 4295 | # |
| 4296 | # VolumeMount describes a mounting of a Volume within a container. |
| 4297 | "mountPath": "A String", # Cloud Run fully managed: not supported |
| 4298 | # |
| 4299 | # Cloud Run for Anthos: supported |
| 4300 | # |
| 4301 | # Path within the container at which the volume should be mounted. Must |
| 4302 | # not contain ':'. |
| 4303 | "subPath": "A String", # (Optional) |
| 4304 | # |
| 4305 | # Cloud Run fully managed: not supported |
| 4306 | # |
| 4307 | # Cloud Run for Anthos: supported |
| 4308 | # |
| 4309 | # Path within the volume from which the container's volume should be mounted. |
| 4310 | # Defaults to "" (volume's root). |
| 4311 | "name": "A String", # Cloud Run fully managed: not supported |
| 4312 | # |
| 4313 | # Cloud Run for Anthos: supported |
| 4314 | # |
| 4315 | # This must match the Name of a Volume. |
| 4316 | "readOnly": True or False, # (Optional) |
| 4317 | # |
| 4318 | # Cloud Run fully managed: not supported |
| 4319 | # |
| 4320 | # Cloud Run for Anthos: supported |
| 4321 | # |
| 4322 | # Only true is accepted. |
| 4323 | # Defaults to true. |
| 4324 | }, |
| 4325 | ], |
| 4326 | "args": [ # (Optional) |
| 4327 | # |
| 4328 | # Cloud Run fully managed: supported |
| 4329 | # |
| 4330 | # Cloud Run for Anthos: supported |
| 4331 | # |
| 4332 | # Arguments to the entrypoint. |
| 4333 | # The docker image's CMD is used if this is not provided. |
| 4334 | # Variable references $(VAR_NAME) are expanded using the container's |
| 4335 | # environment. If a variable cannot be resolved, the reference in the input |
| 4336 | # string will be unchanged. The $(VAR_NAME) syntax can be escaped with a |
| 4337 | # double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, |
| 4338 | # regardless of whether the variable exists or not. |
| 4339 | # More info: |
| 4340 | # https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| 4341 | "A String", |
| 4342 | ], |
| 4343 | "workingDir": "A String", # (Optional) |
| 4344 | # |
| 4345 | # Cloud Run fully managed: not supported |
| 4346 | # |
| 4347 | # Cloud Run for Anthos: supported |
| 4348 | # |
| 4349 | # Container's working directory. |
| 4350 | # If not specified, the container runtime's default will be used, which |
| 4351 | # might be configured in the container image. |
| 4352 | "ports": [ # (Optional) |
| 4353 | # |
| 4354 | # List of ports to expose from the container. Only a single port can be |
| 4355 | # specified. The specified ports must be listening on all interfaces |
| 4356 | # (0.0.0.0) within the container to be accessible. |
| 4357 | # |
| 4358 | # If omitted, a port number will be chosen and passed to the container |
| 4359 | # through the PORT environment variable for the container to listen on. |
| 4360 | { # ContainerPort represents a network port in a single container. |
| 4361 | "containerPort": 42, # (Optional) |
| 4362 | # |
| 4363 | # Port number the container listens on. |
| 4364 | # This must be a valid port number, 0 < x < 65536. |
| 4365 | "protocol": "A String", # (Optional) |
| 4366 | # |
| 4367 | # Cloud Run fully managed: not supported |
| 4368 | # |
| 4369 | # Cloud Run for Anthos: supported |
| 4370 | # |
| 4371 | # Protocol for port. Must be "TCP". |
| 4372 | # Defaults to "TCP". |
| 4373 | "name": "A String", # (Optional) |
| 4374 | # |
| 4375 | # Cloud Run fully managed: not supported |
| 4376 | # |
| 4377 | # Cloud Run for Anthos: supported |
| 4378 | # |
| 4379 | # If specified, used to specify which protocol to use. |
| 4380 | # Allowed values are "http1" and "h2c". |
| 4381 | }, |
| 4382 | ], |
| 4383 | "image": "A String", # Cloud Run fully managed: only supports containers from Google Container |
| 4384 | # Registry |
| 4385 | # |
| 4386 | # Cloud Run for Anthos: supported |
| 4387 | # |
| 4388 | # URL of the Container image. |
| 4389 | # More info: https://kubernetes.io/docs/concepts/containers/images |
| 4390 | "envFrom": [ # (Optional) |
| 4391 | # |
| 4392 | # Cloud Run fully managed: not supported |
| 4393 | # |
| 4394 | # Cloud Run for Anthos: supported |
| 4395 | # |
| 4396 | # List of sources to populate environment variables in the container. |
| 4397 | # The keys defined within a source must be a C_IDENTIFIER. All invalid keys |
| 4398 | # will be reported as an event when the container is starting. When a key |
| 4399 | # exists in multiple sources, the value associated with the last source will |
| 4400 | # take precedence. Values defined by an Env with a duplicate key will take |
| 4401 | # precedence. Cannot be updated. |
| 4402 | { # Cloud Run fully managed: not supported |
| 4403 | # |
| 4404 | # Cloud Run for Anthos: supported |
| 4405 | # |
| 4406 | # EnvFromSource represents the source of a set of ConfigMaps |
| 4407 | "secretRef": { # Cloud Run fully managed: not supported # (Optional) |
| 4408 | # |
| 4409 | # Cloud Run fully managed: not supported |
| 4410 | # |
| 4411 | # Cloud Run for Anthos: supported |
| 4412 | # |
| 4413 | # The Secret to select from |
| 4414 | # |
| 4415 | # Cloud Run for Anthos: supported |
| 4416 | # |
| 4417 | # SecretEnvSource selects a Secret to populate the environment |
| 4418 | # variables with. |
| 4419 | # |
| 4420 | # The contents of the target Secret's Data field will represent the |
| 4421 | # key-value pairs as environment variables. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4422 | "name": "A String", # Cloud Run fully managed: not supported |
| 4423 | # |
| 4424 | # Cloud Run for Anthos: supported |
| 4425 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4426 | # The Secret to select from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4427 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 4428 | # directly into the message. Use the "name" field instead. |
| 4429 | # |
| 4430 | # Cloud Run for Anthos: supported |
| 4431 | # |
| 4432 | # LocalObjectReference contains enough information to let you locate the |
| 4433 | # referenced object inside the same namespace. |
| 4434 | "name": "A String", # (Optional) |
| 4435 | # |
| 4436 | # Cloud Run fully managed: not supported |
| 4437 | # |
| 4438 | # Cloud Run for Anthos: supported |
| 4439 | # |
| 4440 | # Name of the referent. |
| 4441 | # More info: |
| 4442 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 4443 | }, |
| 4444 | "optional": True or False, # (Optional) |
| 4445 | # |
| 4446 | # Cloud Run fully managed: not supported |
| 4447 | # |
| 4448 | # Cloud Run for Anthos: supported |
| 4449 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4450 | # Specify whether the Secret must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4451 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4452 | "prefix": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4453 | # |
| 4454 | # Cloud Run fully managed: not supported |
| 4455 | # |
| 4456 | # Cloud Run for Anthos: supported |
| 4457 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4458 | # An optional identifier to prepend to each key in the ConfigMap. Must be a |
| 4459 | # C_IDENTIFIER. |
| 4460 | "configMapRef": { # Cloud Run fully managed: not supported # (Optional) |
| 4461 | # |
| 4462 | # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4463 | # |
| 4464 | # Cloud Run for Anthos: supported |
| 4465 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4466 | # The ConfigMap to select from |
| 4467 | # |
| 4468 | # Cloud Run for Anthos: supported |
| 4469 | # |
| 4470 | # ConfigMapEnvSource selects a ConfigMap to populate the environment |
| 4471 | # variables with. |
| 4472 | # |
| 4473 | # The contents of the target ConfigMap's Data field will represent the |
| 4474 | # key-value pairs as environment variables. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4475 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 4476 | # directly into the message. Use the "name" field instead. |
| 4477 | # |
| 4478 | # Cloud Run for Anthos: supported |
| 4479 | # |
| 4480 | # LocalObjectReference contains enough information to let you locate the |
| 4481 | # referenced object inside the same namespace. |
| 4482 | "name": "A String", # (Optional) |
| 4483 | # |
| 4484 | # Cloud Run fully managed: not supported |
| 4485 | # |
| 4486 | # Cloud Run for Anthos: supported |
| 4487 | # |
| 4488 | # Name of the referent. |
| 4489 | # More info: |
| 4490 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 4491 | }, |
| 4492 | "optional": True or False, # (Optional) |
| 4493 | # |
| 4494 | # Cloud Run fully managed: not supported |
| 4495 | # |
| 4496 | # Cloud Run for Anthos: supported |
| 4497 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4498 | # Specify whether the ConfigMap must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4499 | "name": "A String", # Cloud Run fully managed: not supported |
| 4500 | # |
| 4501 | # Cloud Run for Anthos: supported |
| 4502 | # |
| 4503 | # The ConfigMap to select from. |
| 4504 | }, |
| 4505 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4506 | ], |
| 4507 | "name": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4508 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4509 | # Name of the container specified as a DNS_LABEL. |
| 4510 | "command": [ |
| 4511 | "A String", |
| 4512 | ], |
| 4513 | "terminationMessagePolicy": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4514 | # |
| 4515 | # Cloud Run fully managed: not supported |
| 4516 | # |
| 4517 | # Cloud Run for Anthos: supported |
| 4518 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4519 | # Indicate how the termination message should be populated. File will use the |
| 4520 | # contents of terminationMessagePath to populate the container status message |
| 4521 | # on both success and failure. FallbackToLogsOnError will use the last chunk |
| 4522 | # of container log output if the termination message file is empty and the |
| 4523 | # container exited with an error. The log output is limited to 2048 bytes or |
| 4524 | # 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 4525 | }, |
| 4526 | ], |
| 4527 | "volumes": [ |
| 4528 | { # Cloud Run fully managed: not supported |
| 4529 | # |
| 4530 | # Cloud Run for Anthos: supported |
| 4531 | # |
| 4532 | # Volume represents a named volume in a container. |
| 4533 | "configMap": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4534 | # |
| 4535 | # Cloud Run for Anthos: supported |
| 4536 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4537 | # Cloud Run for Anthos: supported |
| 4538 | # |
| 4539 | # Adapts a ConfigMap into a volume. |
| 4540 | # The contents of the target ConfigMap's Data field will be presented in a |
| 4541 | # volume as files using the keys in the Data field as the file names, unless |
| 4542 | # the items element is populated with specific mappings of keys to paths. |
| 4543 | "optional": True or False, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4544 | # |
| 4545 | # Cloud Run fully managed: not supported |
| 4546 | # |
| 4547 | # Cloud Run for Anthos: supported |
| 4548 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4549 | # Specify whether the Secret or its keys must be defined. |
| 4550 | "name": "A String", # Cloud Run fully managed: not supported |
| 4551 | # |
| 4552 | # Cloud Run for Anthos: supported |
| 4553 | # |
| 4554 | # Name of the config. |
| 4555 | "defaultMode": 42, # (Optional) |
| 4556 | # |
| 4557 | # Cloud Run fully managed: not supported |
| 4558 | # |
| 4559 | # Cloud Run for Anthos: supported |
| 4560 | # |
| 4561 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 4562 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 4563 | # this setting. This might be in conflict with other options that affect the |
| 4564 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 4565 | "items": [ # (Optional) |
| 4566 | # |
| 4567 | # Cloud Run fully managed: not supported |
| 4568 | # |
| 4569 | # Cloud Run for Anthos: supported |
| 4570 | # |
| 4571 | # If unspecified, each key-value pair in the Data field of the referenced |
| 4572 | # Secret will be projected into the volume as a file whose name is the |
| 4573 | # key and content is the value. If specified, the listed keys will be |
| 4574 | # projected into the specified paths, and unlisted keys will not be |
| 4575 | # present. If a key is specified which is not present in the Secret, |
| 4576 | # the volume setup will error unless it is marked optional. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4577 | { # Cloud Run fully managed: not supported |
| 4578 | # |
| 4579 | # Cloud Run for Anthos: supported |
| 4580 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4581 | # Maps a string key to a path within a volume. |
| 4582 | "key": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4583 | # |
| 4584 | # Cloud Run for Anthos: supported |
| 4585 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4586 | # The key to project. |
| 4587 | "path": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4588 | # |
| 4589 | # Cloud Run for Anthos: supported |
| 4590 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4591 | # The relative path of the file to map the key to. |
| 4592 | # May not be an absolute path. |
| 4593 | # May not contain the path element '..'. |
| 4594 | # May not start with the string '..'. |
| 4595 | "mode": 42, # (Optional) |
| 4596 | # |
| 4597 | # Cloud Run fully managed: not supported |
| 4598 | # |
| 4599 | # Cloud Run for Anthos: supported |
| 4600 | # |
| 4601 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 4602 | # specified, the volume defaultMode will be used. This might be in conflict |
| 4603 | # with other options that affect the file mode, like fsGroup, and the result |
| 4604 | # can be other mode bits set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4605 | }, |
| 4606 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4607 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4608 | "name": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4609 | # |
| 4610 | # Cloud Run for Anthos: supported |
| 4611 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4612 | # Volume's name. |
| 4613 | "secret": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4614 | # |
| 4615 | # Cloud Run for Anthos: supported |
| 4616 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4617 | # Cloud Run for Anthos: supported |
| 4618 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4619 | # The contents of the target Secret's Data field will be presented in a volume |
| 4620 | # as files using the keys in the Data field as the file names. |
| 4621 | "secretName": "A String", # Cloud Run fully managed: not supported |
| 4622 | # |
| 4623 | # Cloud Run for Anthos: supported |
| 4624 | # |
| 4625 | # Name of the secret in the container's namespace to use. |
| 4626 | "items": [ # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4627 | # |
| 4628 | # Cloud Run fully managed: not supported |
| 4629 | # |
| 4630 | # Cloud Run for Anthos: supported |
| 4631 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4632 | # If unspecified, each key-value pair in the Data field of the referenced |
| 4633 | # Secret will be projected into the volume as a file whose name is the |
| 4634 | # key and content is the value. If specified, the listed keys will be |
| 4635 | # projected into the specified paths, and unlisted keys will not be |
| 4636 | # present. If a key is specified which is not present in the Secret, |
| 4637 | # the volume setup will error unless it is marked optional. |
| 4638 | { # Cloud Run fully managed: not supported |
| 4639 | # |
| 4640 | # Cloud Run for Anthos: supported |
| 4641 | # |
| 4642 | # Maps a string key to a path within a volume. |
| 4643 | "key": "A String", # Cloud Run fully managed: not supported |
| 4644 | # |
| 4645 | # Cloud Run for Anthos: supported |
| 4646 | # |
| 4647 | # The key to project. |
| 4648 | "path": "A String", # Cloud Run fully managed: not supported |
| 4649 | # |
| 4650 | # Cloud Run for Anthos: supported |
| 4651 | # |
| 4652 | # The relative path of the file to map the key to. |
| 4653 | # May not be an absolute path. |
| 4654 | # May not contain the path element '..'. |
| 4655 | # May not start with the string '..'. |
| 4656 | "mode": 42, # (Optional) |
| 4657 | # |
| 4658 | # Cloud Run fully managed: not supported |
| 4659 | # |
| 4660 | # Cloud Run for Anthos: supported |
| 4661 | # |
| 4662 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 4663 | # specified, the volume defaultMode will be used. This might be in conflict |
| 4664 | # with other options that affect the file mode, like fsGroup, and the result |
| 4665 | # can be other mode bits set. |
| 4666 | }, |
| 4667 | ], |
| 4668 | "optional": True or False, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4669 | # |
| 4670 | # Cloud Run fully managed: not supported |
| 4671 | # |
| 4672 | # Cloud Run for Anthos: supported |
| 4673 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4674 | # Specify whether the Secret or its keys must be defined. |
| 4675 | "defaultMode": 42, # (Optional) |
| 4676 | # |
| 4677 | # Cloud Run fully managed: not supported |
| 4678 | # |
| 4679 | # Cloud Run for Anthos: supported |
| 4680 | # |
| 4681 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 4682 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 4683 | # this setting. This might be in conflict with other options that affect the |
| 4684 | # file mode, like fsGroup, and the result can be other mode bits set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4685 | }, |
| 4686 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4687 | ], |
| 4688 | }, |
| 4689 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Optional metadata for this Revision, including labels and annotations. Name |
| 4690 | # will be generated by the Configuration. |
| 4691 | # To set minimum instances for this revision, use the |
| 4692 | # "autoscaling.knative.dev/minScale" annotation key. |
| 4693 | # To set maximum instances for this revision, use the |
| 4694 | # "autoscaling.knative.dev/maxScale" annotation key. |
| 4695 | # To set Cloud SQL connections for the revision, use the |
| 4696 | # "run.googleapis.com/cloudsql-instances" annotation key. |
| 4697 | # persisted resources must have, which includes all objects users must create. |
| 4698 | "annotations": { # (Optional) |
| 4699 | # |
| 4700 | # Annotations is an unstructured key value map stored with a resource that |
| 4701 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 4702 | # are not queryable and should be preserved when modifying objects. More |
| 4703 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 4704 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4705 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4706 | "generateName": "A String", # (Optional) |
| 4707 | # |
| 4708 | # Cloud Run fully managed: not supported |
| 4709 | # |
| 4710 | # Cloud Run for Anthos: supported |
| 4711 | # |
| 4712 | # GenerateName is an optional prefix, used by the server, to generate a |
| 4713 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 4714 | # used, the name returned to the client will be different than the name |
| 4715 | # passed. This value will also be combined with a unique suffix. The provided |
| 4716 | # value has the same validation rules as the Name field, and may be truncated |
| 4717 | # by the length of the suffix required to make the value unique on the |
| 4718 | # server. |
| 4719 | # |
| 4720 | # If this field is specified and the generated name exists, the server will |
| 4721 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 4722 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 4723 | # time allotted, and the client should retry (optionally after the time |
| 4724 | # indicated in the Retry-After header). |
| 4725 | # |
| 4726 | # Applied only if Name is not specified. |
| 4727 | # More info: |
| 4728 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 4729 | # string generateName = 2; |
| 4730 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 4731 | # Is required when creating |
| 4732 | # resources, although some resources may allow a client to request the |
| 4733 | # generation of an appropriate name automatically. Name is primarily intended |
| 4734 | # for creation idempotence and configuration definition. Cannot be updated. |
| 4735 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 4736 | # +optional |
| 4737 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 4738 | # |
| 4739 | # Cloud Run fully managed: not supported |
| 4740 | # |
| 4741 | # Cloud Run for Anthos: supported |
| 4742 | # |
| 4743 | # Number of seconds allowed for this object to gracefully terminate before |
| 4744 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 4745 | # set. May only be shortened. Read-only. |
| 4746 | "clusterName": "A String", # (Optional) |
| 4747 | # |
| 4748 | # Cloud Run fully managed: not supported |
| 4749 | # |
| 4750 | # Cloud Run for Anthos: supported |
| 4751 | # |
| 4752 | # The name of the cluster which the object belongs to. |
| 4753 | # This is used to distinguish resources with same name and namespace in |
| 4754 | # different clusters. This field is not set anywhere right now and apiserver |
| 4755 | # is going to ignore it if set in create or update request. |
| 4756 | "finalizers": [ # (Optional) |
| 4757 | # |
| 4758 | # Cloud Run fully managed: not supported |
| 4759 | # |
| 4760 | # Cloud Run for Anthos: supported |
| 4761 | # |
| 4762 | # Must be empty before the object is deleted from the registry. Each entry |
| 4763 | # is an identifier for the responsible component that will remove the entry |
| 4764 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 4765 | # in this list can only be removed. |
| 4766 | # +patchStrategy=merge |
| 4767 | "A String", |
| 4768 | ], |
| 4769 | "deletionTimestamp": "A String", # (Optional) |
| 4770 | # |
| 4771 | # Cloud Run fully managed: not supported |
| 4772 | # |
| 4773 | # Cloud Run for Anthos: supported |
| 4774 | # |
| 4775 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 4776 | # deleted. This field is set by the server when a graceful deletion is |
| 4777 | # requested by the user, and is not directly settable by a client. The |
| 4778 | # resource is expected to be deleted (no longer visible from resource lists, |
| 4779 | # and not reachable by name) after the time in this field, once the |
| 4780 | # finalizers list is empty. As long as the finalizers list contains items, |
| 4781 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 4782 | # be unset or be set further into the future, although it may be shortened or |
| 4783 | # the resource may be deleted prior to this time. For example, a user may |
| 4784 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 4785 | # sending a graceful termination signal to the containers in the pod. After |
| 4786 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 4787 | # to the container and after cleanup, remove the pod from the API. In the |
| 4788 | # presence of network partitions, this object may still exist after this |
| 4789 | # timestamp, until an administrator or automated process can determine the |
| 4790 | # resource is fully terminated. |
| 4791 | # If not set, graceful deletion of the object has not been requested. |
| 4792 | # |
| 4793 | # Populated by the system when a graceful deletion is requested. |
| 4794 | # Read-only. |
| 4795 | # More info: |
| 4796 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 4797 | "ownerReferences": [ # (Optional) |
| 4798 | # |
| 4799 | # Cloud Run fully managed: not supported |
| 4800 | # |
| 4801 | # Cloud Run for Anthos: supported |
| 4802 | # |
| 4803 | # List of objects that own this object. If ALL objects in the list have |
| 4804 | # been deleted, this object will be garbage collected. |
| 4805 | { # OwnerReference contains enough information to let you identify an owning |
| 4806 | # object. Currently, an owning object must be in the same namespace, so there |
| 4807 | # is no namespace field. |
| 4808 | "controller": True or False, # If true, this reference points to the managing controller. |
| 4809 | # +optional |
| 4810 | "kind": "A String", # Kind of the referent. |
| 4811 | # More info: |
| 4812 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 4813 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 4814 | # the owner cannot be deleted from the key-value store until this |
| 4815 | # reference is removed. |
| 4816 | # Defaults to false. |
| 4817 | # To set this field, a user needs "delete" permission of the owner, |
| 4818 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 4819 | # +optional |
| 4820 | "apiVersion": "A String", # API version of the referent. |
| 4821 | "name": "A String", # Name of the referent. |
| 4822 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 4823 | "uid": "A String", # UID of the referent. |
| 4824 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 4825 | }, |
| 4826 | ], |
| 4827 | "creationTimestamp": "A String", # (Optional) |
| 4828 | # |
| 4829 | # CreationTimestamp is a timestamp representing the server time when this |
| 4830 | # object was created. It is not guaranteed to be set in happens-before order |
| 4831 | # across separate operations. Clients may not set this value. It is |
| 4832 | # represented in RFC3339 form and is in UTC. |
| 4833 | # |
| 4834 | # Populated by the system. |
| 4835 | # Read-only. |
| 4836 | # Null for lists. |
| 4837 | # More info: |
| 4838 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 4839 | "labels": { # (Optional) |
| 4840 | # |
| 4841 | # Map of string keys and values that can be used to organize and categorize |
| 4842 | # (scope and select) objects. May match selectors of replication controllers |
| 4843 | # and routes. |
| 4844 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 4845 | "a_key": "A String", |
| 4846 | }, |
| 4847 | "generation": 42, # (Optional) |
| 4848 | # |
| 4849 | # A sequence number representing a specific generation of the desired state. |
| 4850 | # Populated by the system. Read-only. |
| 4851 | "resourceVersion": "A String", # (Optional) |
| 4852 | # |
| 4853 | # An opaque value that represents the internal version of this object that |
| 4854 | # can be used by clients to determine when objects have changed. May be used |
| 4855 | # for optimistic concurrency, change detection, and the watch operation on a |
| 4856 | # resource or set of resources. Clients must treat these values as opaque and |
| 4857 | # passed unmodified back to the server. They may only be valid for a |
| 4858 | # particular resource or set of resources. |
| 4859 | # |
| 4860 | # Populated by the system. |
| 4861 | # Read-only. |
| 4862 | # Value must be treated as opaque by clients and . |
| 4863 | # More info: |
| 4864 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 4865 | "selfLink": "A String", # (Optional) |
| 4866 | # |
| 4867 | # SelfLink is a URL representing this object. |
| 4868 | # Populated by the system. |
| 4869 | # Read-only. |
| 4870 | # string selfLink = 4; |
| 4871 | "uid": "A String", # (Optional) |
| 4872 | # |
| 4873 | # UID is the unique in time and space value for this object. It is typically |
| 4874 | # generated by the server on successful creation of a resource and is not |
| 4875 | # allowed to change on PUT operations. |
| 4876 | # |
| 4877 | # Populated by the system. |
| 4878 | # Read-only. |
| 4879 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 4880 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 4881 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 4882 | # project ID or project number. |
| 4883 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4884 | }, |
| 4885 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4886 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4887 | </div> |
| 4888 | |
| 4889 | <div class="method"> |
| 4890 | <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| 4891 | <pre>Get the IAM Access Control policy currently in effect for the given |
| 4892 | Cloud Run service. This result does not include any inherited policies. |
| 4893 | |
| 4894 | Args: |
| 4895 | resource: string, REQUIRED: The resource for which the policy is being requested. |
| 4896 | See the operation documentation for the appropriate value for this field. (required) |
| 4897 | options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. |
| 4898 | |
| 4899 | Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| 4900 | rejected. |
| 4901 | |
| 4902 | Requests for policies with any conditional bindings must specify version 3. |
| 4903 | Policies without any conditional bindings may specify any valid value or |
| 4904 | leave the field unset. |
| 4905 | |
| 4906 | To learn which resources support conditions in their IAM policies, see the |
| 4907 | [IAM |
| 4908 | documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 4909 | x__xgafv: string, V1 error format. |
| 4910 | Allowed values |
| 4911 | 1 - v1 error format |
| 4912 | 2 - v2 error format |
| 4913 | |
| 4914 | Returns: |
| 4915 | An object of the form: |
| 4916 | |
| 4917 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 4918 | # controls for Google Cloud resources. |
| 4919 | # |
| 4920 | # |
| 4921 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 4922 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 4923 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 4924 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 4925 | # custom role. |
| 4926 | # |
| 4927 | # For some types of Google Cloud resources, a `binding` can also specify a |
| 4928 | # `condition`, which is a logical expression that allows access to a resource |
| 4929 | # only if the expression evaluates to `true`. A condition can add constraints |
| 4930 | # based on attributes of the request, the resource, or both. To learn which |
| 4931 | # resources support conditions in their IAM policies, see the |
| 4932 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 4933 | # |
| 4934 | # **JSON example:** |
| 4935 | # |
| 4936 | # { |
| 4937 | # "bindings": [ |
| 4938 | # { |
| 4939 | # "role": "roles/resourcemanager.organizationAdmin", |
| 4940 | # "members": [ |
| 4941 | # "user:mike@example.com", |
| 4942 | # "group:admins@example.com", |
| 4943 | # "domain:google.com", |
| 4944 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| 4945 | # ] |
| 4946 | # }, |
| 4947 | # { |
| 4948 | # "role": "roles/resourcemanager.organizationViewer", |
| 4949 | # "members": [ |
| 4950 | # "user:eve@example.com" |
| 4951 | # ], |
| 4952 | # "condition": { |
| 4953 | # "title": "expirable access", |
| 4954 | # "description": "Does not grant access after Sep 2020", |
| 4955 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| 4956 | # } |
| 4957 | # } |
| 4958 | # ], |
| 4959 | # "etag": "BwWWja0YfJA=", |
| 4960 | # "version": 3 |
| 4961 | # } |
| 4962 | # |
| 4963 | # **YAML example:** |
| 4964 | # |
| 4965 | # bindings: |
| 4966 | # - members: |
| 4967 | # - user:mike@example.com |
| 4968 | # - group:admins@example.com |
| 4969 | # - domain:google.com |
| 4970 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 4971 | # role: roles/resourcemanager.organizationAdmin |
| 4972 | # - members: |
| 4973 | # - user:eve@example.com |
| 4974 | # role: roles/resourcemanager.organizationViewer |
| 4975 | # condition: |
| 4976 | # title: expirable access |
| 4977 | # description: Does not grant access after Sep 2020 |
| 4978 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| 4979 | # - etag: BwWWja0YfJA= |
| 4980 | # - version: 3 |
| 4981 | # |
| 4982 | # For a description of IAM and its features, see the |
| 4983 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| 4984 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 4985 | # prevent simultaneous updates of a policy from overwriting each other. |
| 4986 | # It is strongly suggested that systems make use of the `etag` in the |
| 4987 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 4988 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 4989 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 4990 | # ensure that their change will be applied to the same version of the policy. |
| 4991 | # |
| 4992 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 4993 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 4994 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 4995 | # the conditions in the version `3` policy are lost. |
| 4996 | "version": 42, # Specifies the format of the policy. |
| 4997 | # |
| 4998 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 4999 | # are rejected. |
| 5000 | # |
| 5001 | # Any operation that affects conditional role bindings must specify version |
| 5002 | # `3`. This requirement applies to the following operations: |
| 5003 | # |
| 5004 | # * Getting a policy that includes a conditional role binding |
| 5005 | # * Adding a conditional role binding to a policy |
| 5006 | # * Changing a conditional role binding in a policy |
| 5007 | # * Removing any role binding, with or without a condition, from a policy |
| 5008 | # that includes conditions |
| 5009 | # |
| 5010 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 5011 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 5012 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 5013 | # the conditions in the version `3` policy are lost. |
| 5014 | # |
| 5015 | # If a policy does not include any conditions, operations on that policy may |
| 5016 | # specify any valid version or leave the field unset. |
| 5017 | # |
| 5018 | # To learn which resources support conditions in their IAM policies, see the |
| 5019 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 5020 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 5021 | { # Specifies the audit configuration for a service. |
| 5022 | # The configuration determines which permission types are logged, and what |
| 5023 | # identities, if any, are exempted from logging. |
| 5024 | # An AuditConfig must have one or more AuditLogConfigs. |
| 5025 | # |
| 5026 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 5027 | # the union of the two AuditConfigs is used for that service: the log_types |
| 5028 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 5029 | # AuditLogConfig are exempted. |
| 5030 | # |
| 5031 | # Example Policy with multiple AuditConfigs: |
| 5032 | # |
| 5033 | # { |
| 5034 | # "audit_configs": [ |
| 5035 | # { |
| 5036 | # "service": "allServices" |
| 5037 | # "audit_log_configs": [ |
| 5038 | # { |
| 5039 | # "log_type": "DATA_READ", |
| 5040 | # "exempted_members": [ |
| 5041 | # "user:jose@example.com" |
| 5042 | # ] |
| 5043 | # }, |
| 5044 | # { |
| 5045 | # "log_type": "DATA_WRITE", |
| 5046 | # }, |
| 5047 | # { |
| 5048 | # "log_type": "ADMIN_READ", |
| 5049 | # } |
| 5050 | # ] |
| 5051 | # }, |
| 5052 | # { |
| 5053 | # "service": "sampleservice.googleapis.com" |
| 5054 | # "audit_log_configs": [ |
| 5055 | # { |
| 5056 | # "log_type": "DATA_READ", |
| 5057 | # }, |
| 5058 | # { |
| 5059 | # "log_type": "DATA_WRITE", |
| 5060 | # "exempted_members": [ |
| 5061 | # "user:aliya@example.com" |
| 5062 | # ] |
| 5063 | # } |
| 5064 | # ] |
| 5065 | # } |
| 5066 | # ] |
| 5067 | # } |
| 5068 | # |
| 5069 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 5070 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 5071 | # aliya@example.com from DATA_WRITE logging. |
| 5072 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 5073 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 5074 | # `allServices` is a special value that covers all services. |
| 5075 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 5076 | { # Provides the configuration for logging a type of permissions. |
| 5077 | # Example: |
| 5078 | # |
| 5079 | # { |
| 5080 | # "audit_log_configs": [ |
| 5081 | # { |
| 5082 | # "log_type": "DATA_READ", |
| 5083 | # "exempted_members": [ |
| 5084 | # "user:jose@example.com" |
| 5085 | # ] |
| 5086 | # }, |
| 5087 | # { |
| 5088 | # "log_type": "DATA_WRITE", |
| 5089 | # } |
| 5090 | # ] |
| 5091 | # } |
| 5092 | # |
| 5093 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 5094 | # jose@example.com from DATA_READ logging. |
| 5095 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 5096 | # permission. |
| 5097 | # Follows the same format of Binding.members. |
| 5098 | "A String", |
| 5099 | ], |
| 5100 | "logType": "A String", # The log type that this config enables. |
| 5101 | }, |
| 5102 | ], |
| 5103 | }, |
| 5104 | ], |
| 5105 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| 5106 | # `condition` that determines how and when the `bindings` are applied. Each |
| 5107 | # of the `bindings` must contain at least one member. |
| 5108 | { # Associates `members` with a `role`. |
| 5109 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 5110 | # |
| 5111 | # If the condition evaluates to `true`, then this binding applies to the |
| 5112 | # current request. |
| 5113 | # |
| 5114 | # If the condition evaluates to `false`, then this binding does not apply to |
| 5115 | # the current request. However, a different role binding might grant the same |
| 5116 | # role to one or more of the members in this binding. |
| 5117 | # |
| 5118 | # To learn which resources support conditions in their IAM policies, see the |
| 5119 | # [IAM |
| 5120 | # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 5121 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 5122 | # are documented at https://github.com/google/cel-spec. |
| 5123 | # |
| 5124 | # Example (Comparison): |
| 5125 | # |
| 5126 | # title: "Summary size limit" |
| 5127 | # description: "Determines if a summary is less than 100 chars" |
| 5128 | # expression: "document.summary.size() < 100" |
| 5129 | # |
| 5130 | # Example (Equality): |
| 5131 | # |
| 5132 | # title: "Requestor is owner" |
| 5133 | # description: "Determines if requestor is the document owner" |
| 5134 | # expression: "document.owner == request.auth.claims.email" |
| 5135 | # |
| 5136 | # Example (Logic): |
| 5137 | # |
| 5138 | # title: "Public documents" |
| 5139 | # description: "Determine whether the document should be publicly visible" |
| 5140 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 5141 | # |
| 5142 | # Example (Data Manipulation): |
| 5143 | # |
| 5144 | # title: "Notification string" |
| 5145 | # description: "Create a notification string with a timestamp." |
| 5146 | # expression: "'New message received at ' + string(document.create_time)" |
| 5147 | # |
| 5148 | # The exact variables and functions that may be referenced within an expression |
| 5149 | # are determined by the service that evaluates it. See the service |
| 5150 | # documentation for additional information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5151 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 5152 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 5153 | # expression. |
| 5154 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 5155 | # reporting, e.g. a file name and a position in the file. |
| 5156 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 5157 | # describes the expression, e.g. when hovered over it in a UI. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5158 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 5159 | # syntax. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5160 | }, |
| 5161 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 5162 | # `members` can have the following values: |
| 5163 | # |
| 5164 | # * `allUsers`: A special identifier that represents anyone who is |
| 5165 | # on the internet; with or without a Google account. |
| 5166 | # |
| 5167 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 5168 | # who is authenticated with a Google account or a service account. |
| 5169 | # |
| 5170 | # * `user:{emailid}`: An email address that represents a specific Google |
| 5171 | # account. For example, `alice@example.com` . |
| 5172 | # |
| 5173 | # |
| 5174 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 5175 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 5176 | # |
| 5177 | # * `group:{emailid}`: An email address that represents a Google group. |
| 5178 | # For example, `admins@example.com`. |
| 5179 | # |
| 5180 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 5181 | # identifier) representing a user that has been recently deleted. For |
| 5182 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 5183 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 5184 | # retains the role in the binding. |
| 5185 | # |
| 5186 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 5187 | # unique identifier) representing a service account that has been recently |
| 5188 | # deleted. For example, |
| 5189 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 5190 | # If the service account is undeleted, this value reverts to |
| 5191 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 5192 | # role in the binding. |
| 5193 | # |
| 5194 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 5195 | # identifier) representing a Google group that has been recently |
| 5196 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 5197 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 5198 | # recovered group retains the role in the binding. |
| 5199 | # |
| 5200 | # |
| 5201 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 5202 | # users of that domain. For example, `google.com` or `example.com`. |
| 5203 | # |
| 5204 | "A String", |
| 5205 | ], |
| 5206 | "role": "A String", # Role that is assigned to `members`. |
| 5207 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 5208 | }, |
| 5209 | ], |
| 5210 | }</pre> |
| 5211 | </div> |
| 5212 | |
| 5213 | <div class="method"> |
| 5214 | <code class="details" id="list">list(parent, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, labelSelector=None, x__xgafv=None)</code> |
| 5215 | <pre>List services. |
| 5216 | |
| 5217 | Args: |
| 5218 | parent: string, The namespace from which the services should be listed. |
| 5219 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 5220 | or number. (required) |
| 5221 | resourceVersion: string, The baseline resource version from which the list or watch operation should |
| 5222 | start. Not currently used by Cloud Run. |
| 5223 | includeUninitialized: boolean, Not currently used by Cloud Run. |
| 5224 | fieldSelector: string, Allows to filter resources based on a specific value for a field name. |
| 5225 | Send this in a query string format. i.e. 'metadata.name%3Dlorem'. |
| 5226 | Not currently used by Cloud Run. |
| 5227 | continue: string, Optional encoded string to continue paging. |
| 5228 | limit: integer, The maximum number of records that should be returned. |
| 5229 | watch: boolean, Flag that indicates that the client expects to watch this resource as well. |
| 5230 | Not currently used by Cloud Run. |
| 5231 | labelSelector: string, Allows to filter resources based on a label. Supported operations are |
| 5232 | =, !=, exists, in, and notIn. |
| 5233 | x__xgafv: string, V1 error format. |
| 5234 | Allowed values |
| 5235 | 1 - v1 error format |
| 5236 | 2 - v2 error format |
| 5237 | |
| 5238 | Returns: |
| 5239 | An object of the form: |
| 5240 | |
| 5241 | { # A list of Service resources. |
| 5242 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 5243 | "kind": "A String", # The kind of this resource, in this case "ServiceList". |
| 5244 | "unreachable": [ # Locations that could not be reached. |
| 5245 | "A String", |
| 5246 | ], |
| 5247 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this Service list. |
| 5248 | # lists and various status objects. A resource may have only one of |
| 5249 | # {ObjectMeta, ListMeta}. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5250 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 5251 | # Populated by the system. |
| 5252 | # Read-only. |
| 5253 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5254 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 5255 | # can be used by clients to determine when objects have changed. Value must |
| 5256 | # be treated as opaque by clients and passed unmodified back to the server. |
| 5257 | # Populated by the system. |
| 5258 | # Read-only. |
| 5259 | # More info: |
| 5260 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 5261 | # +optional |
| 5262 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 5263 | # returned, and indicates that the server has more data available. The value |
| 5264 | # is opaque and may be used to issue another request to the endpoint that |
| 5265 | # served this list to retrieve the next set of available objects. Continuing |
| 5266 | # a list may not be possible if the server configuration has changed or more |
| 5267 | # than a few minutes have passed. The resourceVersion field returned when |
| 5268 | # using this continue value will be identical to the value in the first |
| 5269 | # response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5270 | }, |
| 5271 | "items": [ # List of Services. |
| 5272 | { # Service acts as a top-level container that manages a set of Routes and |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5273 | # Configurations which implement a network service. Service exists to provide a |
| 5274 | # singular abstraction which can be access controlled, reasoned about, and |
| 5275 | # which encapsulates software lifecycle decisions such as rollout policy and |
| 5276 | # team resource ownership. Service acts only as an orchestrator of the |
| 5277 | # underlying Routes and Configurations (much as a kubernetes Deployment |
| 5278 | # orchestrates ReplicaSets). |
| 5279 | # |
| 5280 | # The Service's controller will track the statuses of its owned Configuration |
| 5281 | # and Route, reflecting their statuses and conditions as its own. |
| 5282 | # |
| 5283 | # See also: |
| 5284 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#service |
| 5285 | "kind": "A String", # The kind of resource, in this case "Service". |
| 5286 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Service, including name, namespace, labels, |
| 5287 | # and annotations. |
| 5288 | # persisted resources must have, which includes all objects users must create. |
| 5289 | "annotations": { # (Optional) |
| 5290 | # |
| 5291 | # Annotations is an unstructured key value map stored with a resource that |
| 5292 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 5293 | # are not queryable and should be preserved when modifying objects. More |
| 5294 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 5295 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5296 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5297 | "generateName": "A String", # (Optional) |
| 5298 | # |
| 5299 | # Cloud Run fully managed: not supported |
| 5300 | # |
| 5301 | # Cloud Run for Anthos: supported |
| 5302 | # |
| 5303 | # GenerateName is an optional prefix, used by the server, to generate a |
| 5304 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 5305 | # used, the name returned to the client will be different than the name |
| 5306 | # passed. This value will also be combined with a unique suffix. The provided |
| 5307 | # value has the same validation rules as the Name field, and may be truncated |
| 5308 | # by the length of the suffix required to make the value unique on the |
| 5309 | # server. |
| 5310 | # |
| 5311 | # If this field is specified and the generated name exists, the server will |
| 5312 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 5313 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 5314 | # time allotted, and the client should retry (optionally after the time |
| 5315 | # indicated in the Retry-After header). |
| 5316 | # |
| 5317 | # Applied only if Name is not specified. |
| 5318 | # More info: |
| 5319 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 5320 | # string generateName = 2; |
| 5321 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 5322 | # Is required when creating |
| 5323 | # resources, although some resources may allow a client to request the |
| 5324 | # generation of an appropriate name automatically. Name is primarily intended |
| 5325 | # for creation idempotence and configuration definition. Cannot be updated. |
| 5326 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 5327 | # +optional |
| 5328 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 5329 | # |
| 5330 | # Cloud Run fully managed: not supported |
| 5331 | # |
| 5332 | # Cloud Run for Anthos: supported |
| 5333 | # |
| 5334 | # Number of seconds allowed for this object to gracefully terminate before |
| 5335 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 5336 | # set. May only be shortened. Read-only. |
| 5337 | "clusterName": "A String", # (Optional) |
| 5338 | # |
| 5339 | # Cloud Run fully managed: not supported |
| 5340 | # |
| 5341 | # Cloud Run for Anthos: supported |
| 5342 | # |
| 5343 | # The name of the cluster which the object belongs to. |
| 5344 | # This is used to distinguish resources with same name and namespace in |
| 5345 | # different clusters. This field is not set anywhere right now and apiserver |
| 5346 | # is going to ignore it if set in create or update request. |
| 5347 | "finalizers": [ # (Optional) |
| 5348 | # |
| 5349 | # Cloud Run fully managed: not supported |
| 5350 | # |
| 5351 | # Cloud Run for Anthos: supported |
| 5352 | # |
| 5353 | # Must be empty before the object is deleted from the registry. Each entry |
| 5354 | # is an identifier for the responsible component that will remove the entry |
| 5355 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 5356 | # in this list can only be removed. |
| 5357 | # +patchStrategy=merge |
| 5358 | "A String", |
| 5359 | ], |
| 5360 | "deletionTimestamp": "A String", # (Optional) |
| 5361 | # |
| 5362 | # Cloud Run fully managed: not supported |
| 5363 | # |
| 5364 | # Cloud Run for Anthos: supported |
| 5365 | # |
| 5366 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 5367 | # deleted. This field is set by the server when a graceful deletion is |
| 5368 | # requested by the user, and is not directly settable by a client. The |
| 5369 | # resource is expected to be deleted (no longer visible from resource lists, |
| 5370 | # and not reachable by name) after the time in this field, once the |
| 5371 | # finalizers list is empty. As long as the finalizers list contains items, |
| 5372 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 5373 | # be unset or be set further into the future, although it may be shortened or |
| 5374 | # the resource may be deleted prior to this time. For example, a user may |
| 5375 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 5376 | # sending a graceful termination signal to the containers in the pod. After |
| 5377 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 5378 | # to the container and after cleanup, remove the pod from the API. In the |
| 5379 | # presence of network partitions, this object may still exist after this |
| 5380 | # timestamp, until an administrator or automated process can determine the |
| 5381 | # resource is fully terminated. |
| 5382 | # If not set, graceful deletion of the object has not been requested. |
| 5383 | # |
| 5384 | # Populated by the system when a graceful deletion is requested. |
| 5385 | # Read-only. |
| 5386 | # More info: |
| 5387 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 5388 | "ownerReferences": [ # (Optional) |
| 5389 | # |
| 5390 | # Cloud Run fully managed: not supported |
| 5391 | # |
| 5392 | # Cloud Run for Anthos: supported |
| 5393 | # |
| 5394 | # List of objects that own this object. If ALL objects in the list have |
| 5395 | # been deleted, this object will be garbage collected. |
| 5396 | { # OwnerReference contains enough information to let you identify an owning |
| 5397 | # object. Currently, an owning object must be in the same namespace, so there |
| 5398 | # is no namespace field. |
| 5399 | "controller": True or False, # If true, this reference points to the managing controller. |
| 5400 | # +optional |
| 5401 | "kind": "A String", # Kind of the referent. |
| 5402 | # More info: |
| 5403 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 5404 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 5405 | # the owner cannot be deleted from the key-value store until this |
| 5406 | # reference is removed. |
| 5407 | # Defaults to false. |
| 5408 | # To set this field, a user needs "delete" permission of the owner, |
| 5409 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 5410 | # +optional |
| 5411 | "apiVersion": "A String", # API version of the referent. |
| 5412 | "name": "A String", # Name of the referent. |
| 5413 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 5414 | "uid": "A String", # UID of the referent. |
| 5415 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 5416 | }, |
| 5417 | ], |
| 5418 | "creationTimestamp": "A String", # (Optional) |
| 5419 | # |
| 5420 | # CreationTimestamp is a timestamp representing the server time when this |
| 5421 | # object was created. It is not guaranteed to be set in happens-before order |
| 5422 | # across separate operations. Clients may not set this value. It is |
| 5423 | # represented in RFC3339 form and is in UTC. |
| 5424 | # |
| 5425 | # Populated by the system. |
| 5426 | # Read-only. |
| 5427 | # Null for lists. |
| 5428 | # More info: |
| 5429 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 5430 | "labels": { # (Optional) |
| 5431 | # |
| 5432 | # Map of string keys and values that can be used to organize and categorize |
| 5433 | # (scope and select) objects. May match selectors of replication controllers |
| 5434 | # and routes. |
| 5435 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 5436 | "a_key": "A String", |
| 5437 | }, |
| 5438 | "generation": 42, # (Optional) |
| 5439 | # |
| 5440 | # A sequence number representing a specific generation of the desired state. |
| 5441 | # Populated by the system. Read-only. |
| 5442 | "resourceVersion": "A String", # (Optional) |
| 5443 | # |
| 5444 | # An opaque value that represents the internal version of this object that |
| 5445 | # can be used by clients to determine when objects have changed. May be used |
| 5446 | # for optimistic concurrency, change detection, and the watch operation on a |
| 5447 | # resource or set of resources. Clients must treat these values as opaque and |
| 5448 | # passed unmodified back to the server. They may only be valid for a |
| 5449 | # particular resource or set of resources. |
| 5450 | # |
| 5451 | # Populated by the system. |
| 5452 | # Read-only. |
| 5453 | # Value must be treated as opaque by clients and . |
| 5454 | # More info: |
| 5455 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 5456 | "selfLink": "A String", # (Optional) |
| 5457 | # |
| 5458 | # SelfLink is a URL representing this object. |
| 5459 | # Populated by the system. |
| 5460 | # Read-only. |
| 5461 | # string selfLink = 4; |
| 5462 | "uid": "A String", # (Optional) |
| 5463 | # |
| 5464 | # UID is the unique in time and space value for this object. It is typically |
| 5465 | # generated by the server on successful creation of a resource and is not |
| 5466 | # allowed to change on PUT operations. |
| 5467 | # |
| 5468 | # Populated by the system. |
| 5469 | # Read-only. |
| 5470 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 5471 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 5472 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 5473 | # project ID or project number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5474 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5475 | "status": { # The current state of the Service. Output only. # Status communicates the observed state of the Service (from the |
| 5476 | # controller). |
| 5477 | "latestCreatedRevisionName": "A String", # From ConfigurationStatus. |
| 5478 | # LatestCreatedRevisionName is the last revision that was created from this |
| 5479 | # Service's Configuration. It might not be ready yet, for that use |
| 5480 | # LatestReadyRevisionName. |
| 5481 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 5482 | # reconciliation processes that bring the "spec" inline with the observed |
| 5483 | # state of the world. |
| 5484 | # Service-specific conditions include: |
| 5485 | # * "ConfigurationsReady": true when the underlying Configuration is ready. |
| 5486 | # * "RoutesReady": true when the underlying Route is ready. |
| 5487 | # * "Ready": true when both the underlying Route and Configuration are |
| 5488 | # ready. |
| 5489 | { # Condition defines a generic condition for a Resource |
| 5490 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 5491 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 5492 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 5493 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 5494 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 5495 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 5496 | # See also: |
| 5497 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 5498 | # Types common to all resources include: |
| 5499 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5500 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5501 | ], |
| 5502 | "address": { # Information for connecting over HTTP(s). # From RouteStatus. |
| 5503 | # Similar to url, information on where the service is available on HTTP. |
| 5504 | "url": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5505 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5506 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 5507 | # was last processed by the controller. |
| 5508 | # |
| 5509 | # Clients polling for completed reconciliation should poll until |
| 5510 | # observedGeneration = metadata.generation and the Ready condition's status |
| 5511 | # is True or False. |
| 5512 | "url": "A String", # From RouteStatus. |
| 5513 | # URL holds the url that will distribute traffic over the provided traffic |
| 5514 | # targets. It generally has the form |
| 5515 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 5516 | "traffic": [ # From RouteStatus. |
| 5517 | # Traffic holds the configured traffic distribution. |
| 5518 | # These entries will always contain RevisionName references. |
| 5519 | # When ConfigurationName appears in the spec, this will hold the |
| 5520 | # LatestReadyRevisionName that we last observed. |
| 5521 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 5522 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 5523 | # traffic. This is mutually exclusive with ConfigurationName. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5524 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5525 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 5526 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 5527 | # ready Revision of the Configuration should be used for this traffic |
| 5528 | # target. When provided LatestRevision must be true if RevisionName is |
| 5529 | # empty; it must be false when RevisionName is non-empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5530 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5531 | # +optional |
| 5532 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 5533 | # this target exclusively. |
| 5534 | # |
| 5535 | # Not currently supported in Cloud Run. |
| 5536 | # +optional |
| 5537 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 5538 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 5539 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 5540 | # (e.g. basic auth, url path, etc. |
| 5541 | # |
| 5542 | # Not currently supported in Cloud Run. |
| 5543 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 5544 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 5545 | # of the referenced configuration changes, we will automatically migrate |
| 5546 | # traffic from the prior "latest ready" revision to the new one. This field |
| 5547 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 5548 | # with RevisionName. |
| 5549 | # |
| 5550 | # Cloud Run currently supports a single ConfigurationName. |
| 5551 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 5552 | # This defaults to zero if unspecified. |
| 5553 | # |
| 5554 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 5555 | # TrafficTarget entry. |
| 5556 | }, |
| 5557 | ], |
| 5558 | "latestReadyRevisionName": "A String", # From ConfigurationStatus. |
| 5559 | # LatestReadyRevisionName holds the name of the latest Revision stamped out |
| 5560 | # from this Service's Configuration that has had its "Ready" condition become |
| 5561 | # "True". |
| 5562 | }, |
| 5563 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 5564 | "spec": { # ServiceSpec holds the desired state of the Route (from the client), which # Spec holds the desired state of the Service (from the client). |
| 5565 | # is used to manipulate the underlying Route and Configuration(s). |
| 5566 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 5567 | # Revisions and Configurations. |
| 5568 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 5569 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 5570 | # traffic. This is mutually exclusive with ConfigurationName. |
| 5571 | # |
| 5572 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 5573 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 5574 | # ready Revision of the Configuration should be used for this traffic |
| 5575 | # target. When provided LatestRevision must be true if RevisionName is |
| 5576 | # empty; it must be false when RevisionName is non-empty. |
| 5577 | # |
| 5578 | # +optional |
| 5579 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 5580 | # this target exclusively. |
| 5581 | # |
| 5582 | # Not currently supported in Cloud Run. |
| 5583 | # +optional |
| 5584 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 5585 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 5586 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 5587 | # (e.g. basic auth, url path, etc. |
| 5588 | # |
| 5589 | # Not currently supported in Cloud Run. |
| 5590 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 5591 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 5592 | # of the referenced configuration changes, we will automatically migrate |
| 5593 | # traffic from the prior "latest ready" revision to the new one. This field |
| 5594 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 5595 | # with RevisionName. |
| 5596 | # |
| 5597 | # Cloud Run currently supports a single ConfigurationName. |
| 5598 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 5599 | # This defaults to zero if unspecified. |
| 5600 | # |
| 5601 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 5602 | # TrafficTarget entry. |
| 5603 | }, |
| 5604 | ], |
| 5605 | "template": { # RevisionTemplateSpec describes the data a revision should have when created # Template holds the latest specification for the Revision to |
| 5606 | # be stamped out. |
| 5607 | # from a template. Based on: |
| 5608 | # https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 |
| 5609 | "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). |
| 5610 | "containerConcurrency": 42, # (Optional) |
| 5611 | # |
| 5612 | # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) |
| 5613 | # requests per container instance of the Revision. |
| 5614 | # |
| 5615 | # Cloud Run fully managed: supported, defaults to 80 |
| 5616 | # |
| 5617 | # Cloud Run for Anthos: supported, defaults to 0, which means concurrency |
| 5618 | # to the application is not limited, and the system decides the |
| 5619 | # target concurrency for the autoscaler. |
| 5620 | "timeoutSeconds": 42, # TimeoutSeconds holds the max duration the instance is allowed for |
| 5621 | # responding to a request. |
| 5622 | # Not currently used by Cloud Run. |
| 5623 | "serviceAccountName": "A String", # Email address of the IAM service account associated with the revision |
| 5624 | # of the service. The service account represents the identity of the |
| 5625 | # running revision, and determines what permissions the revision has. If |
| 5626 | # not provided, the revision will use the project's default service account. |
| 5627 | "containers": [ # Containers holds the single container that defines the unit of execution |
| 5628 | # for this Revision. In the context of a Revision, we disallow a number of |
| 5629 | # fields on this Container, including: name and lifecycle. |
| 5630 | # In Cloud Run, only a single container may be provided. |
| 5631 | # The runtime contract is documented here: |
| 5632 | # https://github.com/knative/serving/blob/master/docs/runtime-contract.md |
| 5633 | { # A single application container. |
| 5634 | # This specifies both the container to run, the command to run in the container |
| 5635 | # and the arguments to supply to it. |
| 5636 | # Note that additional arguments may be supplied by the system to the container |
| 5637 | # at runtime. |
| 5638 | "securityContext": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5639 | # |
| 5640 | # Cloud Run fully managed: not supported |
| 5641 | # |
| 5642 | # Cloud Run for Anthos: supported |
| 5643 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5644 | # Security options the pod should run with. |
| 5645 | # More info: https://kubernetes.io/docs/concepts/policy/security-context/ |
| 5646 | # More info: |
| 5647 | # https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5648 | # |
| 5649 | # Cloud Run for Anthos: supported |
| 5650 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5651 | # SecurityContext holds security configuration that will be applied to a |
| 5652 | # container. Some fields are present in both SecurityContext and |
| 5653 | # PodSecurityContext. When both are set, the values in SecurityContext take |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5654 | # precedence. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5655 | "runAsUser": 42, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5656 | # |
| 5657 | # Cloud Run fully managed: not supported |
| 5658 | # |
| 5659 | # Cloud Run for Anthos: supported |
| 5660 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5661 | # The UID to run the entrypoint of the container process. |
| 5662 | # Defaults to user specified in image metadata if unspecified. |
| 5663 | # May also be set in PodSecurityContext. If set in both SecurityContext and |
| 5664 | # PodSecurityContext, the value specified in SecurityContext takes |
| 5665 | # precedence. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5666 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5667 | "livenessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5668 | # |
| 5669 | # Cloud Run fully managed: not supported |
| 5670 | # |
| 5671 | # Cloud Run for Anthos: supported |
| 5672 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5673 | # Periodic probe of container liveness. |
| 5674 | # Container will be restarted if the probe fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5675 | # More info: |
| 5676 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5677 | # |
| 5678 | # Cloud Run for Anthos: supported |
| 5679 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5680 | # Probe describes a health check to be performed against a container to |
| 5681 | # determine whether it is alive or ready to receive traffic. |
| 5682 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5683 | # |
| 5684 | # Cloud Run fully managed: not supported |
| 5685 | # |
| 5686 | # Cloud Run for Anthos: supported |
| 5687 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5688 | # HTTPGet specifies the http request to perform. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5689 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5690 | # A field inlined from the Handler message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5691 | # |
| 5692 | # Cloud Run for Anthos: supported |
| 5693 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5694 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 5695 | "host": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5696 | # |
| 5697 | # Cloud Run fully managed: not supported |
| 5698 | # |
| 5699 | # Cloud Run for Anthos: supported |
| 5700 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5701 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 5702 | # "Host" in httpHeaders instead. |
| 5703 | "scheme": "A String", # (Optional) |
| 5704 | # |
| 5705 | # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5706 | # |
| 5707 | # Cloud Run for Anthos: supported |
| 5708 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5709 | # Scheme to use for connecting to the host. |
| 5710 | # Defaults to HTTP. |
| 5711 | "httpHeaders": [ # (Optional) |
| 5712 | # |
| 5713 | # Cloud Run fully managed: not supported |
| 5714 | # |
| 5715 | # Cloud Run for Anthos: supported |
| 5716 | # |
| 5717 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 5718 | { # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5719 | # |
| 5720 | # Cloud Run for Anthos: supported |
| 5721 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5722 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 5723 | "name": "A String", # Cloud Run fully managed: not supported |
| 5724 | # |
| 5725 | # Cloud Run for Anthos: supported |
| 5726 | # |
| 5727 | # The header field name |
| 5728 | "value": "A String", # Cloud Run fully managed: not supported |
| 5729 | # |
| 5730 | # Cloud Run for Anthos: supported |
| 5731 | # |
| 5732 | # The header field value |
| 5733 | }, |
| 5734 | ], |
| 5735 | "path": "A String", # (Optional) |
| 5736 | # |
| 5737 | # Cloud Run fully managed: not supported |
| 5738 | # |
| 5739 | # Cloud Run for Anthos: supported |
| 5740 | # |
| 5741 | # Path to access on the HTTP server. |
| 5742 | }, |
| 5743 | "failureThreshold": 42, # (Optional) |
| 5744 | # |
| 5745 | # Cloud Run fully managed: not supported |
| 5746 | # |
| 5747 | # Cloud Run for Anthos: supported |
| 5748 | # |
| 5749 | # Minimum consecutive failures for the probe to be considered failed after |
| 5750 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 5751 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 5752 | # |
| 5753 | # Cloud Run fully managed: not supported |
| 5754 | # |
| 5755 | # Cloud Run for Anthos: supported |
| 5756 | # |
| 5757 | # One and only one of the following should be specified. |
| 5758 | # Exec specifies the action to take. |
| 5759 | # |
| 5760 | # A field inlined from the Handler message. |
| 5761 | # |
| 5762 | # Cloud Run for Anthos: supported |
| 5763 | # |
| 5764 | # ExecAction describes a "run in container" action. |
| 5765 | "command": "A String", # (Optional) |
| 5766 | # |
| 5767 | # Cloud Run fully managed: not supported |
| 5768 | # |
| 5769 | # Cloud Run for Anthos: supported |
| 5770 | # |
| 5771 | # Command is the command line to execute inside the container, the working |
| 5772 | # directory for the command is root ('/') in the container's filesystem. The |
| 5773 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 5774 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 5775 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 5776 | # live/healthy and non-zero is unhealthy. |
| 5777 | }, |
| 5778 | "initialDelaySeconds": 42, # (Optional) |
| 5779 | # |
| 5780 | # Cloud Run fully managed: not supported |
| 5781 | # |
| 5782 | # Cloud Run for Anthos: supported |
| 5783 | # |
| 5784 | # Number of seconds after the container has started before liveness probes |
| 5785 | # are initiated. More info: |
| 5786 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 5787 | "timeoutSeconds": 42, # (Optional) |
| 5788 | # |
| 5789 | # Cloud Run fully managed: not supported |
| 5790 | # |
| 5791 | # Cloud Run for Anthos: supported |
| 5792 | # |
| 5793 | # Number of seconds after which the probe times out. |
| 5794 | # Defaults to 1 second. Minimum value is 1. |
| 5795 | # More info: |
| 5796 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 5797 | "successThreshold": 42, # (Optional) |
| 5798 | # |
| 5799 | # Cloud Run fully managed: not supported |
| 5800 | # |
| 5801 | # Cloud Run for Anthos: supported |
| 5802 | # |
| 5803 | # Minimum consecutive successes for the probe to be considered successful |
| 5804 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 5805 | # is 1. |
| 5806 | "periodSeconds": 42, # (Optional) |
| 5807 | # |
| 5808 | # Cloud Run fully managed: not supported |
| 5809 | # |
| 5810 | # Cloud Run for Anthos: supported |
| 5811 | # |
| 5812 | # How often (in seconds) to perform the probe. |
| 5813 | # Default to 10 seconds. Minimum value is 1. |
| 5814 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 5815 | # |
| 5816 | # Cloud Run fully managed: not supported |
| 5817 | # |
| 5818 | # Cloud Run for Anthos: supported |
| 5819 | # |
| 5820 | # TCPSocket specifies an action involving a TCP port. |
| 5821 | # TCP hooks not yet supported |
| 5822 | # |
| 5823 | # A field inlined from the Handler message. |
| 5824 | # |
| 5825 | # Cloud Run for Anthos: supported |
| 5826 | # |
| 5827 | # TCPSocketAction describes an action based on opening a socket |
| 5828 | "port": 42, # Cloud Run fully managed: not supported |
| 5829 | # |
| 5830 | # Cloud Run for Anthos: supported |
| 5831 | # |
| 5832 | # Number or name of the port to access on the container. |
| 5833 | # Number must be in the range 1 to 65535. |
| 5834 | # Name must be an IANA_SVC_NAME. |
| 5835 | # |
| 5836 | # This field is currently limited to integer types only because of proto's |
| 5837 | # inability to properly support the IntOrString golang type. |
| 5838 | "host": "A String", # (Optional) |
| 5839 | # |
| 5840 | # Cloud Run fully managed: not supported |
| 5841 | # |
| 5842 | # Cloud Run for Anthos: supported |
| 5843 | # |
| 5844 | # Optional: Host name to connect to, defaults to the pod IP. |
| 5845 | }, |
| 5846 | }, |
| 5847 | "env": [ # (Optional) |
| 5848 | # |
| 5849 | # Cloud Run fully managed: supported |
| 5850 | # |
| 5851 | # Cloud Run for Anthos: supported |
| 5852 | # |
| 5853 | # List of environment variables to set in the container. |
| 5854 | { # EnvVar represents an environment variable present in a Container. |
| 5855 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| 5856 | "valueFrom": { # Cloud Run fully managed: not supported # (Optional) |
| 5857 | # |
| 5858 | # Cloud Run fully managed: not supported |
| 5859 | # |
| 5860 | # Cloud Run for Anthos: supported |
| 5861 | # |
| 5862 | # Source for the environment variable's value. Cannot be used if value is not |
| 5863 | # empty. |
| 5864 | # |
| 5865 | # Cloud Run for Anthos: supported |
| 5866 | # |
| 5867 | # EnvVarSource represents a source for the value of an EnvVar. |
| 5868 | "configMapKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 5869 | # |
| 5870 | # Cloud Run fully managed: not supported |
| 5871 | # |
| 5872 | # Cloud Run for Anthos: supported |
| 5873 | # |
| 5874 | # Selects a key of a ConfigMap. |
| 5875 | # |
| 5876 | # Cloud Run for Anthos: supported |
| 5877 | # |
| 5878 | # Selects a key from a ConfigMap. |
| 5879 | "optional": True or False, # (Optional) |
| 5880 | # |
| 5881 | # Cloud Run fully managed: not supported |
| 5882 | # |
| 5883 | # Cloud Run for Anthos: supported |
| 5884 | # |
| 5885 | # Specify whether the ConfigMap or its key must be defined |
| 5886 | "key": "A String", # Cloud Run fully managed: not supported |
| 5887 | # |
| 5888 | # Cloud Run for Anthos: supported |
| 5889 | # |
| 5890 | # The key to select. |
| 5891 | "name": "A String", # Cloud Run fully managed: not supported |
| 5892 | # |
| 5893 | # Cloud Run for Anthos: supported |
| 5894 | # |
| 5895 | # The ConfigMap to select from. |
| 5896 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 5897 | # directly into the message. Use the "name" field instead. |
| 5898 | # |
| 5899 | # Cloud Run for Anthos: supported |
| 5900 | # |
| 5901 | # LocalObjectReference contains enough information to let you locate the |
| 5902 | # referenced object inside the same namespace. |
| 5903 | "name": "A String", # (Optional) |
| 5904 | # |
| 5905 | # Cloud Run fully managed: not supported |
| 5906 | # |
| 5907 | # Cloud Run for Anthos: supported |
| 5908 | # |
| 5909 | # Name of the referent. |
| 5910 | # More info: |
| 5911 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 5912 | }, |
| 5913 | }, |
| 5914 | "secretKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 5915 | # |
| 5916 | # Cloud Run fully managed: not supported |
| 5917 | # |
| 5918 | # Cloud Run for Anthos: supported |
| 5919 | # |
| 5920 | # Selects a key of a secret in the pod's namespace |
| 5921 | # |
| 5922 | # Cloud Run for Anthos: supported |
| 5923 | # |
| 5924 | # SecretKeySelector selects a key of a Secret. |
| 5925 | "key": "A String", # Cloud Run fully managed: not supported |
| 5926 | # |
| 5927 | # Cloud Run for Anthos: supported |
| 5928 | # |
| 5929 | # The key of the secret to select from. Must be a valid secret key. |
| 5930 | "name": "A String", # Cloud Run fully managed: not supported |
| 5931 | # |
| 5932 | # Cloud Run for Anthos: supported |
| 5933 | # |
| 5934 | # The name of the secret in the pod's namespace to select from. |
| 5935 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 5936 | # directly into the message. Use the "name" field instead. |
| 5937 | # |
| 5938 | # Cloud Run for Anthos: supported |
| 5939 | # |
| 5940 | # LocalObjectReference contains enough information to let you locate the |
| 5941 | # referenced object inside the same namespace. |
| 5942 | "name": "A String", # (Optional) |
| 5943 | # |
| 5944 | # Cloud Run fully managed: not supported |
| 5945 | # |
| 5946 | # Cloud Run for Anthos: supported |
| 5947 | # |
| 5948 | # Name of the referent. |
| 5949 | # More info: |
| 5950 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 5951 | }, |
| 5952 | "optional": True or False, # (Optional) |
| 5953 | # |
| 5954 | # Cloud Run fully managed: not supported |
| 5955 | # |
| 5956 | # Cloud Run for Anthos: supported |
| 5957 | # |
| 5958 | # Specify whether the Secret or its key must be defined |
| 5959 | }, |
| 5960 | }, |
| 5961 | "value": "A String", # (Optional) |
| 5962 | # |
| 5963 | # Variable references $(VAR_NAME) are expanded |
| 5964 | # using the previous defined environment variables in the container and |
| 5965 | # any route environment variables. If a variable cannot be resolved, |
| 5966 | # the reference in the input string will be unchanged. The $(VAR_NAME) |
| 5967 | # syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped |
| 5968 | # references will never be expanded, regardless of whether the variable |
| 5969 | # exists or not. |
| 5970 | # Defaults to "". |
| 5971 | }, |
| 5972 | ], |
| 5973 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) |
| 5974 | # |
| 5975 | # Cloud Run fully managed: supported |
| 5976 | # |
| 5977 | # Cloud Run for Anthos: supported |
| 5978 | # |
| 5979 | # Compute Resources required by this container. |
| 5980 | # More info: |
| 5981 | # https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 5982 | "limits": { # (Optional) |
| 5983 | # |
| 5984 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 5985 | # supported value for CPU is '1'. |
| 5986 | # |
| 5987 | # Cloud Run for Anthos: supported |
| 5988 | # |
| 5989 | # Limits describes the maximum amount of compute resources allowed. |
| 5990 | # The values of the map is string form of the 'quantity' k8s type: |
| 5991 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 5992 | "a_key": "A String", |
| 5993 | }, |
| 5994 | "requests": { # (Optional) |
| 5995 | # |
| 5996 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 5997 | # supported value for CPU is '1'. |
| 5998 | # |
| 5999 | # Cloud Run for Anthos: supported |
| 6000 | # |
| 6001 | # Requests describes the minimum amount of compute resources required. |
| 6002 | # If Requests is omitted for a container, it defaults to Limits if that is |
| 6003 | # explicitly specified, otherwise to an implementation-defined value. |
| 6004 | # The values of the map is string form of the 'quantity' k8s type: |
| 6005 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 6006 | "a_key": "A String", |
| 6007 | }, |
| 6008 | }, |
| 6009 | "readinessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 6010 | # |
| 6011 | # Cloud Run fully managed: not supported |
| 6012 | # |
| 6013 | # Cloud Run for Anthos: supported |
| 6014 | # |
| 6015 | # Periodic probe of container service readiness. |
| 6016 | # Container will be removed from service endpoints if the probe fails. |
| 6017 | # More info: |
| 6018 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 6019 | # |
| 6020 | # Cloud Run for Anthos: supported |
| 6021 | # |
| 6022 | # Probe describes a health check to be performed against a container to |
| 6023 | # determine whether it is alive or ready to receive traffic. |
| 6024 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 6025 | # |
| 6026 | # Cloud Run fully managed: not supported |
| 6027 | # |
| 6028 | # Cloud Run for Anthos: supported |
| 6029 | # |
| 6030 | # HTTPGet specifies the http request to perform. |
| 6031 | # |
| 6032 | # A field inlined from the Handler message. |
| 6033 | # |
| 6034 | # Cloud Run for Anthos: supported |
| 6035 | # |
| 6036 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 6037 | "host": "A String", # (Optional) |
| 6038 | # |
| 6039 | # Cloud Run fully managed: not supported |
| 6040 | # |
| 6041 | # Cloud Run for Anthos: supported |
| 6042 | # |
| 6043 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 6044 | # "Host" in httpHeaders instead. |
| 6045 | "scheme": "A String", # (Optional) |
| 6046 | # |
| 6047 | # Cloud Run fully managed: not supported |
| 6048 | # |
| 6049 | # Cloud Run for Anthos: supported |
| 6050 | # |
| 6051 | # Scheme to use for connecting to the host. |
| 6052 | # Defaults to HTTP. |
| 6053 | "httpHeaders": [ # (Optional) |
| 6054 | # |
| 6055 | # Cloud Run fully managed: not supported |
| 6056 | # |
| 6057 | # Cloud Run for Anthos: supported |
| 6058 | # |
| 6059 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 6060 | { # Cloud Run fully managed: not supported |
| 6061 | # |
| 6062 | # Cloud Run for Anthos: supported |
| 6063 | # |
| 6064 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 6065 | "name": "A String", # Cloud Run fully managed: not supported |
| 6066 | # |
| 6067 | # Cloud Run for Anthos: supported |
| 6068 | # |
| 6069 | # The header field name |
| 6070 | "value": "A String", # Cloud Run fully managed: not supported |
| 6071 | # |
| 6072 | # Cloud Run for Anthos: supported |
| 6073 | # |
| 6074 | # The header field value |
| 6075 | }, |
| 6076 | ], |
| 6077 | "path": "A String", # (Optional) |
| 6078 | # |
| 6079 | # Cloud Run fully managed: not supported |
| 6080 | # |
| 6081 | # Cloud Run for Anthos: supported |
| 6082 | # |
| 6083 | # Path to access on the HTTP server. |
| 6084 | }, |
| 6085 | "failureThreshold": 42, # (Optional) |
| 6086 | # |
| 6087 | # Cloud Run fully managed: not supported |
| 6088 | # |
| 6089 | # Cloud Run for Anthos: supported |
| 6090 | # |
| 6091 | # Minimum consecutive failures for the probe to be considered failed after |
| 6092 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 6093 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 6094 | # |
| 6095 | # Cloud Run fully managed: not supported |
| 6096 | # |
| 6097 | # Cloud Run for Anthos: supported |
| 6098 | # |
| 6099 | # One and only one of the following should be specified. |
| 6100 | # Exec specifies the action to take. |
| 6101 | # |
| 6102 | # A field inlined from the Handler message. |
| 6103 | # |
| 6104 | # Cloud Run for Anthos: supported |
| 6105 | # |
| 6106 | # ExecAction describes a "run in container" action. |
| 6107 | "command": "A String", # (Optional) |
| 6108 | # |
| 6109 | # Cloud Run fully managed: not supported |
| 6110 | # |
| 6111 | # Cloud Run for Anthos: supported |
| 6112 | # |
| 6113 | # Command is the command line to execute inside the container, the working |
| 6114 | # directory for the command is root ('/') in the container's filesystem. The |
| 6115 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 6116 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 6117 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 6118 | # live/healthy and non-zero is unhealthy. |
| 6119 | }, |
| 6120 | "initialDelaySeconds": 42, # (Optional) |
| 6121 | # |
| 6122 | # Cloud Run fully managed: not supported |
| 6123 | # |
| 6124 | # Cloud Run for Anthos: supported |
| 6125 | # |
| 6126 | # Number of seconds after the container has started before liveness probes |
| 6127 | # are initiated. More info: |
| 6128 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 6129 | "timeoutSeconds": 42, # (Optional) |
| 6130 | # |
| 6131 | # Cloud Run fully managed: not supported |
| 6132 | # |
| 6133 | # Cloud Run for Anthos: supported |
| 6134 | # |
| 6135 | # Number of seconds after which the probe times out. |
| 6136 | # Defaults to 1 second. Minimum value is 1. |
| 6137 | # More info: |
| 6138 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 6139 | "successThreshold": 42, # (Optional) |
| 6140 | # |
| 6141 | # Cloud Run fully managed: not supported |
| 6142 | # |
| 6143 | # Cloud Run for Anthos: supported |
| 6144 | # |
| 6145 | # Minimum consecutive successes for the probe to be considered successful |
| 6146 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 6147 | # is 1. |
| 6148 | "periodSeconds": 42, # (Optional) |
| 6149 | # |
| 6150 | # Cloud Run fully managed: not supported |
| 6151 | # |
| 6152 | # Cloud Run for Anthos: supported |
| 6153 | # |
| 6154 | # How often (in seconds) to perform the probe. |
| 6155 | # Default to 10 seconds. Minimum value is 1. |
| 6156 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 6157 | # |
| 6158 | # Cloud Run fully managed: not supported |
| 6159 | # |
| 6160 | # Cloud Run for Anthos: supported |
| 6161 | # |
| 6162 | # TCPSocket specifies an action involving a TCP port. |
| 6163 | # TCP hooks not yet supported |
| 6164 | # |
| 6165 | # A field inlined from the Handler message. |
| 6166 | # |
| 6167 | # Cloud Run for Anthos: supported |
| 6168 | # |
| 6169 | # TCPSocketAction describes an action based on opening a socket |
| 6170 | "port": 42, # Cloud Run fully managed: not supported |
| 6171 | # |
| 6172 | # Cloud Run for Anthos: supported |
| 6173 | # |
| 6174 | # Number or name of the port to access on the container. |
| 6175 | # Number must be in the range 1 to 65535. |
| 6176 | # Name must be an IANA_SVC_NAME. |
| 6177 | # |
| 6178 | # This field is currently limited to integer types only because of proto's |
| 6179 | # inability to properly support the IntOrString golang type. |
| 6180 | "host": "A String", # (Optional) |
| 6181 | # |
| 6182 | # Cloud Run fully managed: not supported |
| 6183 | # |
| 6184 | # Cloud Run for Anthos: supported |
| 6185 | # |
| 6186 | # Optional: Host name to connect to, defaults to the pod IP. |
| 6187 | }, |
| 6188 | }, |
| 6189 | "imagePullPolicy": "A String", # (Optional) |
| 6190 | # |
| 6191 | # Cloud Run fully managed: not supported |
| 6192 | # |
| 6193 | # Cloud Run for Anthos: supported |
| 6194 | # |
| 6195 | # Image pull policy. |
| 6196 | # One of Always, Never, IfNotPresent. |
| 6197 | # Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. |
| 6198 | # More info: |
| 6199 | # https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 6200 | "terminationMessagePath": "A String", # (Optional) |
| 6201 | # |
| 6202 | # Cloud Run fully managed: not supported |
| 6203 | # |
| 6204 | # Cloud Run for Anthos: supported |
| 6205 | # |
| 6206 | # Path at which the file to which the container's termination |
| 6207 | # message will be written is mounted into the container's filesystem. Message |
| 6208 | # written is intended to be brief final status, such as an assertion failure |
| 6209 | # message. Will be truncated by the node if greater than 4096 bytes. The |
| 6210 | # total message length across all containers will be limited to 12kb. |
| 6211 | # Defaults to /dev/termination-log. |
| 6212 | "volumeMounts": [ # (Optional) |
| 6213 | # |
| 6214 | # Cloud Run fully managed: not supported |
| 6215 | # |
| 6216 | # Cloud Run for Anthos: supported |
| 6217 | # |
| 6218 | # Pod volumes to mount into the container's filesystem. |
| 6219 | { # Cloud Run fully managed: not supported |
| 6220 | # |
| 6221 | # Cloud Run for Anthos: supported |
| 6222 | # |
| 6223 | # VolumeMount describes a mounting of a Volume within a container. |
| 6224 | "mountPath": "A String", # Cloud Run fully managed: not supported |
| 6225 | # |
| 6226 | # Cloud Run for Anthos: supported |
| 6227 | # |
| 6228 | # Path within the container at which the volume should be mounted. Must |
| 6229 | # not contain ':'. |
| 6230 | "subPath": "A String", # (Optional) |
| 6231 | # |
| 6232 | # Cloud Run fully managed: not supported |
| 6233 | # |
| 6234 | # Cloud Run for Anthos: supported |
| 6235 | # |
| 6236 | # Path within the volume from which the container's volume should be mounted. |
| 6237 | # Defaults to "" (volume's root). |
| 6238 | "name": "A String", # Cloud Run fully managed: not supported |
| 6239 | # |
| 6240 | # Cloud Run for Anthos: supported |
| 6241 | # |
| 6242 | # This must match the Name of a Volume. |
| 6243 | "readOnly": True or False, # (Optional) |
| 6244 | # |
| 6245 | # Cloud Run fully managed: not supported |
| 6246 | # |
| 6247 | # Cloud Run for Anthos: supported |
| 6248 | # |
| 6249 | # Only true is accepted. |
| 6250 | # Defaults to true. |
| 6251 | }, |
| 6252 | ], |
| 6253 | "args": [ # (Optional) |
| 6254 | # |
| 6255 | # Cloud Run fully managed: supported |
| 6256 | # |
| 6257 | # Cloud Run for Anthos: supported |
| 6258 | # |
| 6259 | # Arguments to the entrypoint. |
| 6260 | # The docker image's CMD is used if this is not provided. |
| 6261 | # Variable references $(VAR_NAME) are expanded using the container's |
| 6262 | # environment. If a variable cannot be resolved, the reference in the input |
| 6263 | # string will be unchanged. The $(VAR_NAME) syntax can be escaped with a |
| 6264 | # double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, |
| 6265 | # regardless of whether the variable exists or not. |
| 6266 | # More info: |
| 6267 | # https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| 6268 | "A String", |
| 6269 | ], |
| 6270 | "workingDir": "A String", # (Optional) |
| 6271 | # |
| 6272 | # Cloud Run fully managed: not supported |
| 6273 | # |
| 6274 | # Cloud Run for Anthos: supported |
| 6275 | # |
| 6276 | # Container's working directory. |
| 6277 | # If not specified, the container runtime's default will be used, which |
| 6278 | # might be configured in the container image. |
| 6279 | "ports": [ # (Optional) |
| 6280 | # |
| 6281 | # List of ports to expose from the container. Only a single port can be |
| 6282 | # specified. The specified ports must be listening on all interfaces |
| 6283 | # (0.0.0.0) within the container to be accessible. |
| 6284 | # |
| 6285 | # If omitted, a port number will be chosen and passed to the container |
| 6286 | # through the PORT environment variable for the container to listen on. |
| 6287 | { # ContainerPort represents a network port in a single container. |
| 6288 | "containerPort": 42, # (Optional) |
| 6289 | # |
| 6290 | # Port number the container listens on. |
| 6291 | # This must be a valid port number, 0 < x < 65536. |
| 6292 | "protocol": "A String", # (Optional) |
| 6293 | # |
| 6294 | # Cloud Run fully managed: not supported |
| 6295 | # |
| 6296 | # Cloud Run for Anthos: supported |
| 6297 | # |
| 6298 | # Protocol for port. Must be "TCP". |
| 6299 | # Defaults to "TCP". |
| 6300 | "name": "A String", # (Optional) |
| 6301 | # |
| 6302 | # Cloud Run fully managed: not supported |
| 6303 | # |
| 6304 | # Cloud Run for Anthos: supported |
| 6305 | # |
| 6306 | # If specified, used to specify which protocol to use. |
| 6307 | # Allowed values are "http1" and "h2c". |
| 6308 | }, |
| 6309 | ], |
| 6310 | "image": "A String", # Cloud Run fully managed: only supports containers from Google Container |
| 6311 | # Registry |
| 6312 | # |
| 6313 | # Cloud Run for Anthos: supported |
| 6314 | # |
| 6315 | # URL of the Container image. |
| 6316 | # More info: https://kubernetes.io/docs/concepts/containers/images |
| 6317 | "envFrom": [ # (Optional) |
| 6318 | # |
| 6319 | # Cloud Run fully managed: not supported |
| 6320 | # |
| 6321 | # Cloud Run for Anthos: supported |
| 6322 | # |
| 6323 | # List of sources to populate environment variables in the container. |
| 6324 | # The keys defined within a source must be a C_IDENTIFIER. All invalid keys |
| 6325 | # will be reported as an event when the container is starting. When a key |
| 6326 | # exists in multiple sources, the value associated with the last source will |
| 6327 | # take precedence. Values defined by an Env with a duplicate key will take |
| 6328 | # precedence. Cannot be updated. |
| 6329 | { # Cloud Run fully managed: not supported |
| 6330 | # |
| 6331 | # Cloud Run for Anthos: supported |
| 6332 | # |
| 6333 | # EnvFromSource represents the source of a set of ConfigMaps |
| 6334 | "secretRef": { # Cloud Run fully managed: not supported # (Optional) |
| 6335 | # |
| 6336 | # Cloud Run fully managed: not supported |
| 6337 | # |
| 6338 | # Cloud Run for Anthos: supported |
| 6339 | # |
| 6340 | # The Secret to select from |
| 6341 | # |
| 6342 | # Cloud Run for Anthos: supported |
| 6343 | # |
| 6344 | # SecretEnvSource selects a Secret to populate the environment |
| 6345 | # variables with. |
| 6346 | # |
| 6347 | # The contents of the target Secret's Data field will represent the |
| 6348 | # key-value pairs as environment variables. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6349 | "name": "A String", # Cloud Run fully managed: not supported |
| 6350 | # |
| 6351 | # Cloud Run for Anthos: supported |
| 6352 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6353 | # The Secret to select from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6354 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 6355 | # directly into the message. Use the "name" field instead. |
| 6356 | # |
| 6357 | # Cloud Run for Anthos: supported |
| 6358 | # |
| 6359 | # LocalObjectReference contains enough information to let you locate the |
| 6360 | # referenced object inside the same namespace. |
| 6361 | "name": "A String", # (Optional) |
| 6362 | # |
| 6363 | # Cloud Run fully managed: not supported |
| 6364 | # |
| 6365 | # Cloud Run for Anthos: supported |
| 6366 | # |
| 6367 | # Name of the referent. |
| 6368 | # More info: |
| 6369 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 6370 | }, |
| 6371 | "optional": True or False, # (Optional) |
| 6372 | # |
| 6373 | # Cloud Run fully managed: not supported |
| 6374 | # |
| 6375 | # Cloud Run for Anthos: supported |
| 6376 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6377 | # Specify whether the Secret must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6378 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6379 | "prefix": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6380 | # |
| 6381 | # Cloud Run fully managed: not supported |
| 6382 | # |
| 6383 | # Cloud Run for Anthos: supported |
| 6384 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6385 | # An optional identifier to prepend to each key in the ConfigMap. Must be a |
| 6386 | # C_IDENTIFIER. |
| 6387 | "configMapRef": { # Cloud Run fully managed: not supported # (Optional) |
| 6388 | # |
| 6389 | # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6390 | # |
| 6391 | # Cloud Run for Anthos: supported |
| 6392 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6393 | # The ConfigMap to select from |
| 6394 | # |
| 6395 | # Cloud Run for Anthos: supported |
| 6396 | # |
| 6397 | # ConfigMapEnvSource selects a ConfigMap to populate the environment |
| 6398 | # variables with. |
| 6399 | # |
| 6400 | # The contents of the target ConfigMap's Data field will represent the |
| 6401 | # key-value pairs as environment variables. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6402 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 6403 | # directly into the message. Use the "name" field instead. |
| 6404 | # |
| 6405 | # Cloud Run for Anthos: supported |
| 6406 | # |
| 6407 | # LocalObjectReference contains enough information to let you locate the |
| 6408 | # referenced object inside the same namespace. |
| 6409 | "name": "A String", # (Optional) |
| 6410 | # |
| 6411 | # Cloud Run fully managed: not supported |
| 6412 | # |
| 6413 | # Cloud Run for Anthos: supported |
| 6414 | # |
| 6415 | # Name of the referent. |
| 6416 | # More info: |
| 6417 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 6418 | }, |
| 6419 | "optional": True or False, # (Optional) |
| 6420 | # |
| 6421 | # Cloud Run fully managed: not supported |
| 6422 | # |
| 6423 | # Cloud Run for Anthos: supported |
| 6424 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6425 | # Specify whether the ConfigMap must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6426 | "name": "A String", # Cloud Run fully managed: not supported |
| 6427 | # |
| 6428 | # Cloud Run for Anthos: supported |
| 6429 | # |
| 6430 | # The ConfigMap to select from. |
| 6431 | }, |
| 6432 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6433 | ], |
| 6434 | "name": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6435 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6436 | # Name of the container specified as a DNS_LABEL. |
| 6437 | "command": [ |
| 6438 | "A String", |
| 6439 | ], |
| 6440 | "terminationMessagePolicy": "A String", # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6441 | # |
| 6442 | # Cloud Run fully managed: not supported |
| 6443 | # |
| 6444 | # Cloud Run for Anthos: supported |
| 6445 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6446 | # Indicate how the termination message should be populated. File will use the |
| 6447 | # contents of terminationMessagePath to populate the container status message |
| 6448 | # on both success and failure. FallbackToLogsOnError will use the last chunk |
| 6449 | # of container log output if the termination message file is empty and the |
| 6450 | # container exited with an error. The log output is limited to 2048 bytes or |
| 6451 | # 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 6452 | }, |
| 6453 | ], |
| 6454 | "volumes": [ |
| 6455 | { # Cloud Run fully managed: not supported |
| 6456 | # |
| 6457 | # Cloud Run for Anthos: supported |
| 6458 | # |
| 6459 | # Volume represents a named volume in a container. |
| 6460 | "configMap": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6461 | # |
| 6462 | # Cloud Run for Anthos: supported |
| 6463 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6464 | # Cloud Run for Anthos: supported |
| 6465 | # |
| 6466 | # Adapts a ConfigMap into a volume. |
| 6467 | # The contents of the target ConfigMap's Data field will be presented in a |
| 6468 | # volume as files using the keys in the Data field as the file names, unless |
| 6469 | # the items element is populated with specific mappings of keys to paths. |
| 6470 | "optional": True or False, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6471 | # |
| 6472 | # Cloud Run fully managed: not supported |
| 6473 | # |
| 6474 | # Cloud Run for Anthos: supported |
| 6475 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6476 | # Specify whether the Secret or its keys must be defined. |
| 6477 | "name": "A String", # Cloud Run fully managed: not supported |
| 6478 | # |
| 6479 | # Cloud Run for Anthos: supported |
| 6480 | # |
| 6481 | # Name of the config. |
| 6482 | "defaultMode": 42, # (Optional) |
| 6483 | # |
| 6484 | # Cloud Run fully managed: not supported |
| 6485 | # |
| 6486 | # Cloud Run for Anthos: supported |
| 6487 | # |
| 6488 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 6489 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 6490 | # this setting. This might be in conflict with other options that affect the |
| 6491 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 6492 | "items": [ # (Optional) |
| 6493 | # |
| 6494 | # Cloud Run fully managed: not supported |
| 6495 | # |
| 6496 | # Cloud Run for Anthos: supported |
| 6497 | # |
| 6498 | # If unspecified, each key-value pair in the Data field of the referenced |
| 6499 | # Secret will be projected into the volume as a file whose name is the |
| 6500 | # key and content is the value. If specified, the listed keys will be |
| 6501 | # projected into the specified paths, and unlisted keys will not be |
| 6502 | # present. If a key is specified which is not present in the Secret, |
| 6503 | # the volume setup will error unless it is marked optional. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6504 | { # Cloud Run fully managed: not supported |
| 6505 | # |
| 6506 | # Cloud Run for Anthos: supported |
| 6507 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6508 | # Maps a string key to a path within a volume. |
| 6509 | "key": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6510 | # |
| 6511 | # Cloud Run for Anthos: supported |
| 6512 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6513 | # The key to project. |
| 6514 | "path": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6515 | # |
| 6516 | # Cloud Run for Anthos: supported |
| 6517 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6518 | # The relative path of the file to map the key to. |
| 6519 | # May not be an absolute path. |
| 6520 | # May not contain the path element '..'. |
| 6521 | # May not start with the string '..'. |
| 6522 | "mode": 42, # (Optional) |
| 6523 | # |
| 6524 | # Cloud Run fully managed: not supported |
| 6525 | # |
| 6526 | # Cloud Run for Anthos: supported |
| 6527 | # |
| 6528 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 6529 | # specified, the volume defaultMode will be used. This might be in conflict |
| 6530 | # with other options that affect the file mode, like fsGroup, and the result |
| 6531 | # can be other mode bits set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6532 | }, |
| 6533 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6534 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6535 | "name": "A String", # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6536 | # |
| 6537 | # Cloud Run for Anthos: supported |
| 6538 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6539 | # Volume's name. |
| 6540 | "secret": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6541 | # |
| 6542 | # Cloud Run for Anthos: supported |
| 6543 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6544 | # Cloud Run for Anthos: supported |
| 6545 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6546 | # The contents of the target Secret's Data field will be presented in a volume |
| 6547 | # as files using the keys in the Data field as the file names. |
| 6548 | "secretName": "A String", # Cloud Run fully managed: not supported |
| 6549 | # |
| 6550 | # Cloud Run for Anthos: supported |
| 6551 | # |
| 6552 | # Name of the secret in the container's namespace to use. |
| 6553 | "items": [ # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6554 | # |
| 6555 | # Cloud Run fully managed: not supported |
| 6556 | # |
| 6557 | # Cloud Run for Anthos: supported |
| 6558 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6559 | # If unspecified, each key-value pair in the Data field of the referenced |
| 6560 | # Secret will be projected into the volume as a file whose name is the |
| 6561 | # key and content is the value. If specified, the listed keys will be |
| 6562 | # projected into the specified paths, and unlisted keys will not be |
| 6563 | # present. If a key is specified which is not present in the Secret, |
| 6564 | # the volume setup will error unless it is marked optional. |
| 6565 | { # Cloud Run fully managed: not supported |
| 6566 | # |
| 6567 | # Cloud Run for Anthos: supported |
| 6568 | # |
| 6569 | # Maps a string key to a path within a volume. |
| 6570 | "key": "A String", # Cloud Run fully managed: not supported |
| 6571 | # |
| 6572 | # Cloud Run for Anthos: supported |
| 6573 | # |
| 6574 | # The key to project. |
| 6575 | "path": "A String", # Cloud Run fully managed: not supported |
| 6576 | # |
| 6577 | # Cloud Run for Anthos: supported |
| 6578 | # |
| 6579 | # The relative path of the file to map the key to. |
| 6580 | # May not be an absolute path. |
| 6581 | # May not contain the path element '..'. |
| 6582 | # May not start with the string '..'. |
| 6583 | "mode": 42, # (Optional) |
| 6584 | # |
| 6585 | # Cloud Run fully managed: not supported |
| 6586 | # |
| 6587 | # Cloud Run for Anthos: supported |
| 6588 | # |
| 6589 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 6590 | # specified, the volume defaultMode will be used. This might be in conflict |
| 6591 | # with other options that affect the file mode, like fsGroup, and the result |
| 6592 | # can be other mode bits set. |
| 6593 | }, |
| 6594 | ], |
| 6595 | "optional": True or False, # (Optional) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6596 | # |
| 6597 | # Cloud Run fully managed: not supported |
| 6598 | # |
| 6599 | # Cloud Run for Anthos: supported |
| 6600 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6601 | # Specify whether the Secret or its keys must be defined. |
| 6602 | "defaultMode": 42, # (Optional) |
| 6603 | # |
| 6604 | # Cloud Run fully managed: not supported |
| 6605 | # |
| 6606 | # Cloud Run for Anthos: supported |
| 6607 | # |
| 6608 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 6609 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 6610 | # this setting. This might be in conflict with other options that affect the |
| 6611 | # file mode, like fsGroup, and the result can be other mode bits set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6612 | }, |
| 6613 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6614 | ], |
| 6615 | }, |
| 6616 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Optional metadata for this Revision, including labels and annotations. Name |
| 6617 | # will be generated by the Configuration. |
| 6618 | # To set minimum instances for this revision, use the |
| 6619 | # "autoscaling.knative.dev/minScale" annotation key. |
| 6620 | # To set maximum instances for this revision, use the |
| 6621 | # "autoscaling.knative.dev/maxScale" annotation key. |
| 6622 | # To set Cloud SQL connections for the revision, use the |
| 6623 | # "run.googleapis.com/cloudsql-instances" annotation key. |
| 6624 | # persisted resources must have, which includes all objects users must create. |
| 6625 | "annotations": { # (Optional) |
| 6626 | # |
| 6627 | # Annotations is an unstructured key value map stored with a resource that |
| 6628 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 6629 | # are not queryable and should be preserved when modifying objects. More |
| 6630 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 6631 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6632 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6633 | "generateName": "A String", # (Optional) |
| 6634 | # |
| 6635 | # Cloud Run fully managed: not supported |
| 6636 | # |
| 6637 | # Cloud Run for Anthos: supported |
| 6638 | # |
| 6639 | # GenerateName is an optional prefix, used by the server, to generate a |
| 6640 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 6641 | # used, the name returned to the client will be different than the name |
| 6642 | # passed. This value will also be combined with a unique suffix. The provided |
| 6643 | # value has the same validation rules as the Name field, and may be truncated |
| 6644 | # by the length of the suffix required to make the value unique on the |
| 6645 | # server. |
| 6646 | # |
| 6647 | # If this field is specified and the generated name exists, the server will |
| 6648 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 6649 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 6650 | # time allotted, and the client should retry (optionally after the time |
| 6651 | # indicated in the Retry-After header). |
| 6652 | # |
| 6653 | # Applied only if Name is not specified. |
| 6654 | # More info: |
| 6655 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 6656 | # string generateName = 2; |
| 6657 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 6658 | # Is required when creating |
| 6659 | # resources, although some resources may allow a client to request the |
| 6660 | # generation of an appropriate name automatically. Name is primarily intended |
| 6661 | # for creation idempotence and configuration definition. Cannot be updated. |
| 6662 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 6663 | # +optional |
| 6664 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 6665 | # |
| 6666 | # Cloud Run fully managed: not supported |
| 6667 | # |
| 6668 | # Cloud Run for Anthos: supported |
| 6669 | # |
| 6670 | # Number of seconds allowed for this object to gracefully terminate before |
| 6671 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 6672 | # set. May only be shortened. Read-only. |
| 6673 | "clusterName": "A String", # (Optional) |
| 6674 | # |
| 6675 | # Cloud Run fully managed: not supported |
| 6676 | # |
| 6677 | # Cloud Run for Anthos: supported |
| 6678 | # |
| 6679 | # The name of the cluster which the object belongs to. |
| 6680 | # This is used to distinguish resources with same name and namespace in |
| 6681 | # different clusters. This field is not set anywhere right now and apiserver |
| 6682 | # is going to ignore it if set in create or update request. |
| 6683 | "finalizers": [ # (Optional) |
| 6684 | # |
| 6685 | # Cloud Run fully managed: not supported |
| 6686 | # |
| 6687 | # Cloud Run for Anthos: supported |
| 6688 | # |
| 6689 | # Must be empty before the object is deleted from the registry. Each entry |
| 6690 | # is an identifier for the responsible component that will remove the entry |
| 6691 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 6692 | # in this list can only be removed. |
| 6693 | # +patchStrategy=merge |
| 6694 | "A String", |
| 6695 | ], |
| 6696 | "deletionTimestamp": "A String", # (Optional) |
| 6697 | # |
| 6698 | # Cloud Run fully managed: not supported |
| 6699 | # |
| 6700 | # Cloud Run for Anthos: supported |
| 6701 | # |
| 6702 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 6703 | # deleted. This field is set by the server when a graceful deletion is |
| 6704 | # requested by the user, and is not directly settable by a client. The |
| 6705 | # resource is expected to be deleted (no longer visible from resource lists, |
| 6706 | # and not reachable by name) after the time in this field, once the |
| 6707 | # finalizers list is empty. As long as the finalizers list contains items, |
| 6708 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 6709 | # be unset or be set further into the future, although it may be shortened or |
| 6710 | # the resource may be deleted prior to this time. For example, a user may |
| 6711 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 6712 | # sending a graceful termination signal to the containers in the pod. After |
| 6713 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 6714 | # to the container and after cleanup, remove the pod from the API. In the |
| 6715 | # presence of network partitions, this object may still exist after this |
| 6716 | # timestamp, until an administrator or automated process can determine the |
| 6717 | # resource is fully terminated. |
| 6718 | # If not set, graceful deletion of the object has not been requested. |
| 6719 | # |
| 6720 | # Populated by the system when a graceful deletion is requested. |
| 6721 | # Read-only. |
| 6722 | # More info: |
| 6723 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 6724 | "ownerReferences": [ # (Optional) |
| 6725 | # |
| 6726 | # Cloud Run fully managed: not supported |
| 6727 | # |
| 6728 | # Cloud Run for Anthos: supported |
| 6729 | # |
| 6730 | # List of objects that own this object. If ALL objects in the list have |
| 6731 | # been deleted, this object will be garbage collected. |
| 6732 | { # OwnerReference contains enough information to let you identify an owning |
| 6733 | # object. Currently, an owning object must be in the same namespace, so there |
| 6734 | # is no namespace field. |
| 6735 | "controller": True or False, # If true, this reference points to the managing controller. |
| 6736 | # +optional |
| 6737 | "kind": "A String", # Kind of the referent. |
| 6738 | # More info: |
| 6739 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 6740 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 6741 | # the owner cannot be deleted from the key-value store until this |
| 6742 | # reference is removed. |
| 6743 | # Defaults to false. |
| 6744 | # To set this field, a user needs "delete" permission of the owner, |
| 6745 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 6746 | # +optional |
| 6747 | "apiVersion": "A String", # API version of the referent. |
| 6748 | "name": "A String", # Name of the referent. |
| 6749 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 6750 | "uid": "A String", # UID of the referent. |
| 6751 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 6752 | }, |
| 6753 | ], |
| 6754 | "creationTimestamp": "A String", # (Optional) |
| 6755 | # |
| 6756 | # CreationTimestamp is a timestamp representing the server time when this |
| 6757 | # object was created. It is not guaranteed to be set in happens-before order |
| 6758 | # across separate operations. Clients may not set this value. It is |
| 6759 | # represented in RFC3339 form and is in UTC. |
| 6760 | # |
| 6761 | # Populated by the system. |
| 6762 | # Read-only. |
| 6763 | # Null for lists. |
| 6764 | # More info: |
| 6765 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 6766 | "labels": { # (Optional) |
| 6767 | # |
| 6768 | # Map of string keys and values that can be used to organize and categorize |
| 6769 | # (scope and select) objects. May match selectors of replication controllers |
| 6770 | # and routes. |
| 6771 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 6772 | "a_key": "A String", |
| 6773 | }, |
| 6774 | "generation": 42, # (Optional) |
| 6775 | # |
| 6776 | # A sequence number representing a specific generation of the desired state. |
| 6777 | # Populated by the system. Read-only. |
| 6778 | "resourceVersion": "A String", # (Optional) |
| 6779 | # |
| 6780 | # An opaque value that represents the internal version of this object that |
| 6781 | # can be used by clients to determine when objects have changed. May be used |
| 6782 | # for optimistic concurrency, change detection, and the watch operation on a |
| 6783 | # resource or set of resources. Clients must treat these values as opaque and |
| 6784 | # passed unmodified back to the server. They may only be valid for a |
| 6785 | # particular resource or set of resources. |
| 6786 | # |
| 6787 | # Populated by the system. |
| 6788 | # Read-only. |
| 6789 | # Value must be treated as opaque by clients and . |
| 6790 | # More info: |
| 6791 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 6792 | "selfLink": "A String", # (Optional) |
| 6793 | # |
| 6794 | # SelfLink is a URL representing this object. |
| 6795 | # Populated by the system. |
| 6796 | # Read-only. |
| 6797 | # string selfLink = 4; |
| 6798 | "uid": "A String", # (Optional) |
| 6799 | # |
| 6800 | # UID is the unique in time and space value for this object. It is typically |
| 6801 | # generated by the server on successful creation of a resource and is not |
| 6802 | # allowed to change on PUT operations. |
| 6803 | # |
| 6804 | # Populated by the system. |
| 6805 | # Read-only. |
| 6806 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 6807 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 6808 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 6809 | # project ID or project number. |
| 6810 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6811 | }, |
| 6812 | }, |
| 6813 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6814 | ], |
| 6815 | }</pre> |
| 6816 | </div> |
| 6817 | |
| 6818 | <div class="method"> |
| 6819 | <code class="details" id="replaceService">replaceService(name, body=None, x__xgafv=None)</code> |
| 6820 | <pre>Replace a service. |
| 6821 | |
| 6822 | Only the spec and metadata labels and annotations are modifiable. After |
| 6823 | the Update request, Cloud Run will work to make the 'status' |
| 6824 | match the requested 'spec'. |
| 6825 | |
| 6826 | May provide metadata.resourceVersion to enforce update from last read for |
| 6827 | optimistic concurrency control. |
| 6828 | |
| 6829 | Args: |
| 6830 | name: string, The name of the service being replaced. |
| 6831 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 6832 | or number. (required) |
| 6833 | body: object, The request body. |
| 6834 | The object takes the form of: |
| 6835 | |
| 6836 | { # Service acts as a top-level container that manages a set of Routes and |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6837 | # Configurations which implement a network service. Service exists to provide a |
| 6838 | # singular abstraction which can be access controlled, reasoned about, and |
| 6839 | # which encapsulates software lifecycle decisions such as rollout policy and |
| 6840 | # team resource ownership. Service acts only as an orchestrator of the |
| 6841 | # underlying Routes and Configurations (much as a kubernetes Deployment |
| 6842 | # orchestrates ReplicaSets). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6843 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6844 | # The Service's controller will track the statuses of its owned Configuration |
| 6845 | # and Route, reflecting their statuses and conditions as its own. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6846 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 6847 | # See also: |
| 6848 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#service |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 6849 | "kind": "A String", # The kind of resource, in this case "Service". |
| 6850 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Service, including name, namespace, labels, |
| 6851 | # and annotations. |
| 6852 | # persisted resources must have, which includes all objects users must create. |
| 6853 | "annotations": { # (Optional) |
| 6854 | # |
| 6855 | # Annotations is an unstructured key value map stored with a resource that |
| 6856 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 6857 | # are not queryable and should be preserved when modifying objects. More |
| 6858 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 6859 | "a_key": "A String", |
| 6860 | }, |
| 6861 | "generateName": "A String", # (Optional) |
| 6862 | # |
| 6863 | # Cloud Run fully managed: not supported |
| 6864 | # |
| 6865 | # Cloud Run for Anthos: supported |
| 6866 | # |
| 6867 | # GenerateName is an optional prefix, used by the server, to generate a |
| 6868 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 6869 | # used, the name returned to the client will be different than the name |
| 6870 | # passed. This value will also be combined with a unique suffix. The provided |
| 6871 | # value has the same validation rules as the Name field, and may be truncated |
| 6872 | # by the length of the suffix required to make the value unique on the |
| 6873 | # server. |
| 6874 | # |
| 6875 | # If this field is specified and the generated name exists, the server will |
| 6876 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 6877 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 6878 | # time allotted, and the client should retry (optionally after the time |
| 6879 | # indicated in the Retry-After header). |
| 6880 | # |
| 6881 | # Applied only if Name is not specified. |
| 6882 | # More info: |
| 6883 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 6884 | # string generateName = 2; |
| 6885 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 6886 | # Is required when creating |
| 6887 | # resources, although some resources may allow a client to request the |
| 6888 | # generation of an appropriate name automatically. Name is primarily intended |
| 6889 | # for creation idempotence and configuration definition. Cannot be updated. |
| 6890 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 6891 | # +optional |
| 6892 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 6893 | # |
| 6894 | # Cloud Run fully managed: not supported |
| 6895 | # |
| 6896 | # Cloud Run for Anthos: supported |
| 6897 | # |
| 6898 | # Number of seconds allowed for this object to gracefully terminate before |
| 6899 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 6900 | # set. May only be shortened. Read-only. |
| 6901 | "clusterName": "A String", # (Optional) |
| 6902 | # |
| 6903 | # Cloud Run fully managed: not supported |
| 6904 | # |
| 6905 | # Cloud Run for Anthos: supported |
| 6906 | # |
| 6907 | # The name of the cluster which the object belongs to. |
| 6908 | # This is used to distinguish resources with same name and namespace in |
| 6909 | # different clusters. This field is not set anywhere right now and apiserver |
| 6910 | # is going to ignore it if set in create or update request. |
| 6911 | "finalizers": [ # (Optional) |
| 6912 | # |
| 6913 | # Cloud Run fully managed: not supported |
| 6914 | # |
| 6915 | # Cloud Run for Anthos: supported |
| 6916 | # |
| 6917 | # Must be empty before the object is deleted from the registry. Each entry |
| 6918 | # is an identifier for the responsible component that will remove the entry |
| 6919 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 6920 | # in this list can only be removed. |
| 6921 | # +patchStrategy=merge |
| 6922 | "A String", |
| 6923 | ], |
| 6924 | "deletionTimestamp": "A String", # (Optional) |
| 6925 | # |
| 6926 | # Cloud Run fully managed: not supported |
| 6927 | # |
| 6928 | # Cloud Run for Anthos: supported |
| 6929 | # |
| 6930 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 6931 | # deleted. This field is set by the server when a graceful deletion is |
| 6932 | # requested by the user, and is not directly settable by a client. The |
| 6933 | # resource is expected to be deleted (no longer visible from resource lists, |
| 6934 | # and not reachable by name) after the time in this field, once the |
| 6935 | # finalizers list is empty. As long as the finalizers list contains items, |
| 6936 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 6937 | # be unset or be set further into the future, although it may be shortened or |
| 6938 | # the resource may be deleted prior to this time. For example, a user may |
| 6939 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 6940 | # sending a graceful termination signal to the containers in the pod. After |
| 6941 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 6942 | # to the container and after cleanup, remove the pod from the API. In the |
| 6943 | # presence of network partitions, this object may still exist after this |
| 6944 | # timestamp, until an administrator or automated process can determine the |
| 6945 | # resource is fully terminated. |
| 6946 | # If not set, graceful deletion of the object has not been requested. |
| 6947 | # |
| 6948 | # Populated by the system when a graceful deletion is requested. |
| 6949 | # Read-only. |
| 6950 | # More info: |
| 6951 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 6952 | "ownerReferences": [ # (Optional) |
| 6953 | # |
| 6954 | # Cloud Run fully managed: not supported |
| 6955 | # |
| 6956 | # Cloud Run for Anthos: supported |
| 6957 | # |
| 6958 | # List of objects that own this object. If ALL objects in the list have |
| 6959 | # been deleted, this object will be garbage collected. |
| 6960 | { # OwnerReference contains enough information to let you identify an owning |
| 6961 | # object. Currently, an owning object must be in the same namespace, so there |
| 6962 | # is no namespace field. |
| 6963 | "controller": True or False, # If true, this reference points to the managing controller. |
| 6964 | # +optional |
| 6965 | "kind": "A String", # Kind of the referent. |
| 6966 | # More info: |
| 6967 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 6968 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 6969 | # the owner cannot be deleted from the key-value store until this |
| 6970 | # reference is removed. |
| 6971 | # Defaults to false. |
| 6972 | # To set this field, a user needs "delete" permission of the owner, |
| 6973 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 6974 | # +optional |
| 6975 | "apiVersion": "A String", # API version of the referent. |
| 6976 | "name": "A String", # Name of the referent. |
| 6977 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 6978 | "uid": "A String", # UID of the referent. |
| 6979 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 6980 | }, |
| 6981 | ], |
| 6982 | "creationTimestamp": "A String", # (Optional) |
| 6983 | # |
| 6984 | # CreationTimestamp is a timestamp representing the server time when this |
| 6985 | # object was created. It is not guaranteed to be set in happens-before order |
| 6986 | # across separate operations. Clients may not set this value. It is |
| 6987 | # represented in RFC3339 form and is in UTC. |
| 6988 | # |
| 6989 | # Populated by the system. |
| 6990 | # Read-only. |
| 6991 | # Null for lists. |
| 6992 | # More info: |
| 6993 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 6994 | "labels": { # (Optional) |
| 6995 | # |
| 6996 | # Map of string keys and values that can be used to organize and categorize |
| 6997 | # (scope and select) objects. May match selectors of replication controllers |
| 6998 | # and routes. |
| 6999 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 7000 | "a_key": "A String", |
| 7001 | }, |
| 7002 | "generation": 42, # (Optional) |
| 7003 | # |
| 7004 | # A sequence number representing a specific generation of the desired state. |
| 7005 | # Populated by the system. Read-only. |
| 7006 | "resourceVersion": "A String", # (Optional) |
| 7007 | # |
| 7008 | # An opaque value that represents the internal version of this object that |
| 7009 | # can be used by clients to determine when objects have changed. May be used |
| 7010 | # for optimistic concurrency, change detection, and the watch operation on a |
| 7011 | # resource or set of resources. Clients must treat these values as opaque and |
| 7012 | # passed unmodified back to the server. They may only be valid for a |
| 7013 | # particular resource or set of resources. |
| 7014 | # |
| 7015 | # Populated by the system. |
| 7016 | # Read-only. |
| 7017 | # Value must be treated as opaque by clients and . |
| 7018 | # More info: |
| 7019 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 7020 | "selfLink": "A String", # (Optional) |
| 7021 | # |
| 7022 | # SelfLink is a URL representing this object. |
| 7023 | # Populated by the system. |
| 7024 | # Read-only. |
| 7025 | # string selfLink = 4; |
| 7026 | "uid": "A String", # (Optional) |
| 7027 | # |
| 7028 | # UID is the unique in time and space value for this object. It is typically |
| 7029 | # generated by the server on successful creation of a resource and is not |
| 7030 | # allowed to change on PUT operations. |
| 7031 | # |
| 7032 | # Populated by the system. |
| 7033 | # Read-only. |
| 7034 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 7035 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 7036 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 7037 | # project ID or project number. |
| 7038 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7039 | "status": { # The current state of the Service. Output only. # Status communicates the observed state of the Service (from the |
| 7040 | # controller). |
| 7041 | "latestCreatedRevisionName": "A String", # From ConfigurationStatus. |
| 7042 | # LatestCreatedRevisionName is the last revision that was created from this |
| 7043 | # Service's Configuration. It might not be ready yet, for that use |
| 7044 | # LatestReadyRevisionName. |
| 7045 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 7046 | # reconciliation processes that bring the "spec" inline with the observed |
| 7047 | # state of the world. |
| 7048 | # Service-specific conditions include: |
| 7049 | # * "ConfigurationsReady": true when the underlying Configuration is ready. |
| 7050 | # * "RoutesReady": true when the underlying Route is ready. |
| 7051 | # * "Ready": true when both the underlying Route and Configuration are |
| 7052 | # ready. |
| 7053 | { # Condition defines a generic condition for a Resource |
| 7054 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 7055 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 7056 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 7057 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 7058 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 7059 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 7060 | # See also: |
| 7061 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 7062 | # Types common to all resources include: |
| 7063 | # * "Ready": True when the Resource is ready. |
| 7064 | }, |
| 7065 | ], |
| 7066 | "address": { # Information for connecting over HTTP(s). # From RouteStatus. |
| 7067 | # Similar to url, information on where the service is available on HTTP. |
| 7068 | "url": "A String", |
| 7069 | }, |
| 7070 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 7071 | # was last processed by the controller. |
| 7072 | # |
| 7073 | # Clients polling for completed reconciliation should poll until |
| 7074 | # observedGeneration = metadata.generation and the Ready condition's status |
| 7075 | # is True or False. |
| 7076 | "url": "A String", # From RouteStatus. |
| 7077 | # URL holds the url that will distribute traffic over the provided traffic |
| 7078 | # targets. It generally has the form |
| 7079 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 7080 | "traffic": [ # From RouteStatus. |
| 7081 | # Traffic holds the configured traffic distribution. |
| 7082 | # These entries will always contain RevisionName references. |
| 7083 | # When ConfigurationName appears in the spec, this will hold the |
| 7084 | # LatestReadyRevisionName that we last observed. |
| 7085 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7086 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 7087 | # traffic. This is mutually exclusive with ConfigurationName. |
| 7088 | # |
| 7089 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 7090 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 7091 | # ready Revision of the Configuration should be used for this traffic |
| 7092 | # target. When provided LatestRevision must be true if RevisionName is |
| 7093 | # empty; it must be false when RevisionName is non-empty. |
| 7094 | # |
| 7095 | # +optional |
| 7096 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 7097 | # this target exclusively. |
| 7098 | # |
| 7099 | # Not currently supported in Cloud Run. |
| 7100 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7101 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 7102 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 7103 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 7104 | # (e.g. basic auth, url path, etc. |
| 7105 | # |
| 7106 | # Not currently supported in Cloud Run. |
| 7107 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 7108 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 7109 | # of the referenced configuration changes, we will automatically migrate |
| 7110 | # traffic from the prior "latest ready" revision to the new one. This field |
| 7111 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 7112 | # with RevisionName. |
| 7113 | # |
| 7114 | # Cloud Run currently supports a single ConfigurationName. |
| 7115 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 7116 | # This defaults to zero if unspecified. |
| 7117 | # |
| 7118 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 7119 | # TrafficTarget entry. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7120 | }, |
| 7121 | ], |
| 7122 | "latestReadyRevisionName": "A String", # From ConfigurationStatus. |
| 7123 | # LatestReadyRevisionName holds the name of the latest Revision stamped out |
| 7124 | # from this Service's Configuration that has had its "Ready" condition become |
| 7125 | # "True". |
| 7126 | }, |
| 7127 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 7128 | "spec": { # ServiceSpec holds the desired state of the Route (from the client), which # Spec holds the desired state of the Service (from the client). |
| 7129 | # is used to manipulate the underlying Route and Configuration(s). |
| 7130 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 7131 | # Revisions and Configurations. |
| 7132 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7133 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 7134 | # traffic. This is mutually exclusive with ConfigurationName. |
| 7135 | # |
| 7136 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 7137 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 7138 | # ready Revision of the Configuration should be used for this traffic |
| 7139 | # target. When provided LatestRevision must be true if RevisionName is |
| 7140 | # empty; it must be false when RevisionName is non-empty. |
| 7141 | # |
| 7142 | # +optional |
| 7143 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 7144 | # this target exclusively. |
| 7145 | # |
| 7146 | # Not currently supported in Cloud Run. |
| 7147 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7148 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 7149 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 7150 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 7151 | # (e.g. basic auth, url path, etc. |
| 7152 | # |
| 7153 | # Not currently supported in Cloud Run. |
| 7154 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 7155 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 7156 | # of the referenced configuration changes, we will automatically migrate |
| 7157 | # traffic from the prior "latest ready" revision to the new one. This field |
| 7158 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 7159 | # with RevisionName. |
| 7160 | # |
| 7161 | # Cloud Run currently supports a single ConfigurationName. |
| 7162 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 7163 | # This defaults to zero if unspecified. |
| 7164 | # |
| 7165 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 7166 | # TrafficTarget entry. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7167 | }, |
| 7168 | ], |
| 7169 | "template": { # RevisionTemplateSpec describes the data a revision should have when created # Template holds the latest specification for the Revision to |
| 7170 | # be stamped out. |
| 7171 | # from a template. Based on: |
| 7172 | # https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7173 | "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7174 | "containerConcurrency": 42, # (Optional) |
| 7175 | # |
| 7176 | # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) |
| 7177 | # requests per container instance of the Revision. |
| 7178 | # |
| 7179 | # Cloud Run fully managed: supported, defaults to 80 |
| 7180 | # |
| 7181 | # Cloud Run for Anthos: supported, defaults to 0, which means concurrency |
| 7182 | # to the application is not limited, and the system decides the |
| 7183 | # target concurrency for the autoscaler. |
| 7184 | "timeoutSeconds": 42, # TimeoutSeconds holds the max duration the instance is allowed for |
| 7185 | # responding to a request. |
| 7186 | # Not currently used by Cloud Run. |
| 7187 | "serviceAccountName": "A String", # Email address of the IAM service account associated with the revision |
| 7188 | # of the service. The service account represents the identity of the |
| 7189 | # running revision, and determines what permissions the revision has. If |
| 7190 | # not provided, the revision will use the project's default service account. |
| 7191 | "containers": [ # Containers holds the single container that defines the unit of execution |
| 7192 | # for this Revision. In the context of a Revision, we disallow a number of |
| 7193 | # fields on this Container, including: name and lifecycle. |
| 7194 | # In Cloud Run, only a single container may be provided. |
| 7195 | # The runtime contract is documented here: |
| 7196 | # https://github.com/knative/serving/blob/master/docs/runtime-contract.md |
| 7197 | { # A single application container. |
| 7198 | # This specifies both the container to run, the command to run in the container |
| 7199 | # and the arguments to supply to it. |
| 7200 | # Note that additional arguments may be supplied by the system to the container |
| 7201 | # at runtime. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7202 | "securityContext": { # Cloud Run fully managed: not supported # (Optional) |
| 7203 | # |
| 7204 | # Cloud Run fully managed: not supported |
| 7205 | # |
| 7206 | # Cloud Run for Anthos: supported |
| 7207 | # |
| 7208 | # Security options the pod should run with. |
| 7209 | # More info: https://kubernetes.io/docs/concepts/policy/security-context/ |
| 7210 | # More info: |
| 7211 | # https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| 7212 | # |
| 7213 | # Cloud Run for Anthos: supported |
| 7214 | # |
| 7215 | # SecurityContext holds security configuration that will be applied to a |
| 7216 | # container. Some fields are present in both SecurityContext and |
| 7217 | # PodSecurityContext. When both are set, the values in SecurityContext take |
| 7218 | # precedence. |
| 7219 | "runAsUser": 42, # (Optional) |
| 7220 | # |
| 7221 | # Cloud Run fully managed: not supported |
| 7222 | # |
| 7223 | # Cloud Run for Anthos: supported |
| 7224 | # |
| 7225 | # The UID to run the entrypoint of the container process. |
| 7226 | # Defaults to user specified in image metadata if unspecified. |
| 7227 | # May also be set in PodSecurityContext. If set in both SecurityContext and |
| 7228 | # PodSecurityContext, the value specified in SecurityContext takes |
| 7229 | # precedence. |
| 7230 | }, |
| 7231 | "livenessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 7232 | # |
| 7233 | # Cloud Run fully managed: not supported |
| 7234 | # |
| 7235 | # Cloud Run for Anthos: supported |
| 7236 | # |
| 7237 | # Periodic probe of container liveness. |
| 7238 | # Container will be restarted if the probe fails. |
| 7239 | # More info: |
| 7240 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 7241 | # |
| 7242 | # Cloud Run for Anthos: supported |
| 7243 | # |
| 7244 | # Probe describes a health check to be performed against a container to |
| 7245 | # determine whether it is alive or ready to receive traffic. |
| 7246 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 7247 | # |
| 7248 | # Cloud Run fully managed: not supported |
| 7249 | # |
| 7250 | # Cloud Run for Anthos: supported |
| 7251 | # |
| 7252 | # HTTPGet specifies the http request to perform. |
| 7253 | # |
| 7254 | # A field inlined from the Handler message. |
| 7255 | # |
| 7256 | # Cloud Run for Anthos: supported |
| 7257 | # |
| 7258 | # HTTPGetAction describes an action based on HTTP Get requests. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7259 | "host": "A String", # (Optional) |
| 7260 | # |
| 7261 | # Cloud Run fully managed: not supported |
| 7262 | # |
| 7263 | # Cloud Run for Anthos: supported |
| 7264 | # |
| 7265 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 7266 | # "Host" in httpHeaders instead. |
| 7267 | "scheme": "A String", # (Optional) |
| 7268 | # |
| 7269 | # Cloud Run fully managed: not supported |
| 7270 | # |
| 7271 | # Cloud Run for Anthos: supported |
| 7272 | # |
| 7273 | # Scheme to use for connecting to the host. |
| 7274 | # Defaults to HTTP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7275 | "httpHeaders": [ # (Optional) |
| 7276 | # |
| 7277 | # Cloud Run fully managed: not supported |
| 7278 | # |
| 7279 | # Cloud Run for Anthos: supported |
| 7280 | # |
| 7281 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 7282 | { # Cloud Run fully managed: not supported |
| 7283 | # |
| 7284 | # Cloud Run for Anthos: supported |
| 7285 | # |
| 7286 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 7287 | "name": "A String", # Cloud Run fully managed: not supported |
| 7288 | # |
| 7289 | # Cloud Run for Anthos: supported |
| 7290 | # |
| 7291 | # The header field name |
| 7292 | "value": "A String", # Cloud Run fully managed: not supported |
| 7293 | # |
| 7294 | # Cloud Run for Anthos: supported |
| 7295 | # |
| 7296 | # The header field value |
| 7297 | }, |
| 7298 | ], |
| 7299 | "path": "A String", # (Optional) |
| 7300 | # |
| 7301 | # Cloud Run fully managed: not supported |
| 7302 | # |
| 7303 | # Cloud Run for Anthos: supported |
| 7304 | # |
| 7305 | # Path to access on the HTTP server. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7306 | }, |
| 7307 | "failureThreshold": 42, # (Optional) |
| 7308 | # |
| 7309 | # Cloud Run fully managed: not supported |
| 7310 | # |
| 7311 | # Cloud Run for Anthos: supported |
| 7312 | # |
| 7313 | # Minimum consecutive failures for the probe to be considered failed after |
| 7314 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 7315 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 7316 | # |
| 7317 | # Cloud Run fully managed: not supported |
| 7318 | # |
| 7319 | # Cloud Run for Anthos: supported |
| 7320 | # |
| 7321 | # One and only one of the following should be specified. |
| 7322 | # Exec specifies the action to take. |
| 7323 | # |
| 7324 | # A field inlined from the Handler message. |
| 7325 | # |
| 7326 | # Cloud Run for Anthos: supported |
| 7327 | # |
| 7328 | # ExecAction describes a "run in container" action. |
| 7329 | "command": "A String", # (Optional) |
| 7330 | # |
| 7331 | # Cloud Run fully managed: not supported |
| 7332 | # |
| 7333 | # Cloud Run for Anthos: supported |
| 7334 | # |
| 7335 | # Command is the command line to execute inside the container, the working |
| 7336 | # directory for the command is root ('/') in the container's filesystem. The |
| 7337 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 7338 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 7339 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 7340 | # live/healthy and non-zero is unhealthy. |
| 7341 | }, |
| 7342 | "initialDelaySeconds": 42, # (Optional) |
| 7343 | # |
| 7344 | # Cloud Run fully managed: not supported |
| 7345 | # |
| 7346 | # Cloud Run for Anthos: supported |
| 7347 | # |
| 7348 | # Number of seconds after the container has started before liveness probes |
| 7349 | # are initiated. More info: |
| 7350 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 7351 | "timeoutSeconds": 42, # (Optional) |
| 7352 | # |
| 7353 | # Cloud Run fully managed: not supported |
| 7354 | # |
| 7355 | # Cloud Run for Anthos: supported |
| 7356 | # |
| 7357 | # Number of seconds after which the probe times out. |
| 7358 | # Defaults to 1 second. Minimum value is 1. |
| 7359 | # More info: |
| 7360 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 7361 | "successThreshold": 42, # (Optional) |
| 7362 | # |
| 7363 | # Cloud Run fully managed: not supported |
| 7364 | # |
| 7365 | # Cloud Run for Anthos: supported |
| 7366 | # |
| 7367 | # Minimum consecutive successes for the probe to be considered successful |
| 7368 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 7369 | # is 1. |
| 7370 | "periodSeconds": 42, # (Optional) |
| 7371 | # |
| 7372 | # Cloud Run fully managed: not supported |
| 7373 | # |
| 7374 | # Cloud Run for Anthos: supported |
| 7375 | # |
| 7376 | # How often (in seconds) to perform the probe. |
| 7377 | # Default to 10 seconds. Minimum value is 1. |
| 7378 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 7379 | # |
| 7380 | # Cloud Run fully managed: not supported |
| 7381 | # |
| 7382 | # Cloud Run for Anthos: supported |
| 7383 | # |
| 7384 | # TCPSocket specifies an action involving a TCP port. |
| 7385 | # TCP hooks not yet supported |
| 7386 | # |
| 7387 | # A field inlined from the Handler message. |
| 7388 | # |
| 7389 | # Cloud Run for Anthos: supported |
| 7390 | # |
| 7391 | # TCPSocketAction describes an action based on opening a socket |
| 7392 | "port": 42, # Cloud Run fully managed: not supported |
| 7393 | # |
| 7394 | # Cloud Run for Anthos: supported |
| 7395 | # |
| 7396 | # Number or name of the port to access on the container. |
| 7397 | # Number must be in the range 1 to 65535. |
| 7398 | # Name must be an IANA_SVC_NAME. |
| 7399 | # |
| 7400 | # This field is currently limited to integer types only because of proto's |
| 7401 | # inability to properly support the IntOrString golang type. |
| 7402 | "host": "A String", # (Optional) |
| 7403 | # |
| 7404 | # Cloud Run fully managed: not supported |
| 7405 | # |
| 7406 | # Cloud Run for Anthos: supported |
| 7407 | # |
| 7408 | # Optional: Host name to connect to, defaults to the pod IP. |
| 7409 | }, |
| 7410 | }, |
| 7411 | "env": [ # (Optional) |
| 7412 | # |
| 7413 | # Cloud Run fully managed: supported |
| 7414 | # |
| 7415 | # Cloud Run for Anthos: supported |
| 7416 | # |
| 7417 | # List of environment variables to set in the container. |
| 7418 | { # EnvVar represents an environment variable present in a Container. |
| 7419 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| 7420 | "valueFrom": { # Cloud Run fully managed: not supported # (Optional) |
| 7421 | # |
| 7422 | # Cloud Run fully managed: not supported |
| 7423 | # |
| 7424 | # Cloud Run for Anthos: supported |
| 7425 | # |
| 7426 | # Source for the environment variable's value. Cannot be used if value is not |
| 7427 | # empty. |
| 7428 | # |
| 7429 | # Cloud Run for Anthos: supported |
| 7430 | # |
| 7431 | # EnvVarSource represents a source for the value of an EnvVar. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7432 | "configMapKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 7433 | # |
| 7434 | # Cloud Run fully managed: not supported |
| 7435 | # |
| 7436 | # Cloud Run for Anthos: supported |
| 7437 | # |
| 7438 | # Selects a key of a ConfigMap. |
| 7439 | # |
| 7440 | # Cloud Run for Anthos: supported |
| 7441 | # |
| 7442 | # Selects a key from a ConfigMap. |
| 7443 | "optional": True or False, # (Optional) |
| 7444 | # |
| 7445 | # Cloud Run fully managed: not supported |
| 7446 | # |
| 7447 | # Cloud Run for Anthos: supported |
| 7448 | # |
| 7449 | # Specify whether the ConfigMap or its key must be defined |
| 7450 | "key": "A String", # Cloud Run fully managed: not supported |
| 7451 | # |
| 7452 | # Cloud Run for Anthos: supported |
| 7453 | # |
| 7454 | # The key to select. |
| 7455 | "name": "A String", # Cloud Run fully managed: not supported |
| 7456 | # |
| 7457 | # Cloud Run for Anthos: supported |
| 7458 | # |
| 7459 | # The ConfigMap to select from. |
| 7460 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 7461 | # directly into the message. Use the "name" field instead. |
| 7462 | # |
| 7463 | # Cloud Run for Anthos: supported |
| 7464 | # |
| 7465 | # LocalObjectReference contains enough information to let you locate the |
| 7466 | # referenced object inside the same namespace. |
| 7467 | "name": "A String", # (Optional) |
| 7468 | # |
| 7469 | # Cloud Run fully managed: not supported |
| 7470 | # |
| 7471 | # Cloud Run for Anthos: supported |
| 7472 | # |
| 7473 | # Name of the referent. |
| 7474 | # More info: |
| 7475 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 7476 | }, |
| 7477 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7478 | "secretKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 7479 | # |
| 7480 | # Cloud Run fully managed: not supported |
| 7481 | # |
| 7482 | # Cloud Run for Anthos: supported |
| 7483 | # |
| 7484 | # Selects a key of a secret in the pod's namespace |
| 7485 | # |
| 7486 | # Cloud Run for Anthos: supported |
| 7487 | # |
| 7488 | # SecretKeySelector selects a key of a Secret. |
| 7489 | "key": "A String", # Cloud Run fully managed: not supported |
| 7490 | # |
| 7491 | # Cloud Run for Anthos: supported |
| 7492 | # |
| 7493 | # The key of the secret to select from. Must be a valid secret key. |
| 7494 | "name": "A String", # Cloud Run fully managed: not supported |
| 7495 | # |
| 7496 | # Cloud Run for Anthos: supported |
| 7497 | # |
| 7498 | # The name of the secret in the pod's namespace to select from. |
| 7499 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 7500 | # directly into the message. Use the "name" field instead. |
| 7501 | # |
| 7502 | # Cloud Run for Anthos: supported |
| 7503 | # |
| 7504 | # LocalObjectReference contains enough information to let you locate the |
| 7505 | # referenced object inside the same namespace. |
| 7506 | "name": "A String", # (Optional) |
| 7507 | # |
| 7508 | # Cloud Run fully managed: not supported |
| 7509 | # |
| 7510 | # Cloud Run for Anthos: supported |
| 7511 | # |
| 7512 | # Name of the referent. |
| 7513 | # More info: |
| 7514 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 7515 | }, |
| 7516 | "optional": True or False, # (Optional) |
| 7517 | # |
| 7518 | # Cloud Run fully managed: not supported |
| 7519 | # |
| 7520 | # Cloud Run for Anthos: supported |
| 7521 | # |
| 7522 | # Specify whether the Secret or its key must be defined |
| 7523 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7524 | }, |
| 7525 | "value": "A String", # (Optional) |
| 7526 | # |
| 7527 | # Variable references $(VAR_NAME) are expanded |
| 7528 | # using the previous defined environment variables in the container and |
| 7529 | # any route environment variables. If a variable cannot be resolved, |
| 7530 | # the reference in the input string will be unchanged. The $(VAR_NAME) |
| 7531 | # syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped |
| 7532 | # references will never be expanded, regardless of whether the variable |
| 7533 | # exists or not. |
| 7534 | # Defaults to "". |
| 7535 | }, |
| 7536 | ], |
| 7537 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) |
| 7538 | # |
| 7539 | # Cloud Run fully managed: supported |
| 7540 | # |
| 7541 | # Cloud Run for Anthos: supported |
| 7542 | # |
| 7543 | # Compute Resources required by this container. |
| 7544 | # More info: |
| 7545 | # https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 7546 | "limits": { # (Optional) |
| 7547 | # |
| 7548 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 7549 | # supported value for CPU is '1'. |
| 7550 | # |
| 7551 | # Cloud Run for Anthos: supported |
| 7552 | # |
| 7553 | # Limits describes the maximum amount of compute resources allowed. |
| 7554 | # The values of the map is string form of the 'quantity' k8s type: |
| 7555 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 7556 | "a_key": "A String", |
| 7557 | }, |
| 7558 | "requests": { # (Optional) |
| 7559 | # |
| 7560 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 7561 | # supported value for CPU is '1'. |
| 7562 | # |
| 7563 | # Cloud Run for Anthos: supported |
| 7564 | # |
| 7565 | # Requests describes the minimum amount of compute resources required. |
| 7566 | # If Requests is omitted for a container, it defaults to Limits if that is |
| 7567 | # explicitly specified, otherwise to an implementation-defined value. |
| 7568 | # The values of the map is string form of the 'quantity' k8s type: |
| 7569 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 7570 | "a_key": "A String", |
| 7571 | }, |
| 7572 | }, |
| 7573 | "readinessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 7574 | # |
| 7575 | # Cloud Run fully managed: not supported |
| 7576 | # |
| 7577 | # Cloud Run for Anthos: supported |
| 7578 | # |
| 7579 | # Periodic probe of container service readiness. |
| 7580 | # Container will be removed from service endpoints if the probe fails. |
| 7581 | # More info: |
| 7582 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 7583 | # |
| 7584 | # Cloud Run for Anthos: supported |
| 7585 | # |
| 7586 | # Probe describes a health check to be performed against a container to |
| 7587 | # determine whether it is alive or ready to receive traffic. |
| 7588 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 7589 | # |
| 7590 | # Cloud Run fully managed: not supported |
| 7591 | # |
| 7592 | # Cloud Run for Anthos: supported |
| 7593 | # |
| 7594 | # HTTPGet specifies the http request to perform. |
| 7595 | # |
| 7596 | # A field inlined from the Handler message. |
| 7597 | # |
| 7598 | # Cloud Run for Anthos: supported |
| 7599 | # |
| 7600 | # HTTPGetAction describes an action based on HTTP Get requests. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7601 | "host": "A String", # (Optional) |
| 7602 | # |
| 7603 | # Cloud Run fully managed: not supported |
| 7604 | # |
| 7605 | # Cloud Run for Anthos: supported |
| 7606 | # |
| 7607 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 7608 | # "Host" in httpHeaders instead. |
| 7609 | "scheme": "A String", # (Optional) |
| 7610 | # |
| 7611 | # Cloud Run fully managed: not supported |
| 7612 | # |
| 7613 | # Cloud Run for Anthos: supported |
| 7614 | # |
| 7615 | # Scheme to use for connecting to the host. |
| 7616 | # Defaults to HTTP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7617 | "httpHeaders": [ # (Optional) |
| 7618 | # |
| 7619 | # Cloud Run fully managed: not supported |
| 7620 | # |
| 7621 | # Cloud Run for Anthos: supported |
| 7622 | # |
| 7623 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 7624 | { # Cloud Run fully managed: not supported |
| 7625 | # |
| 7626 | # Cloud Run for Anthos: supported |
| 7627 | # |
| 7628 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 7629 | "name": "A String", # Cloud Run fully managed: not supported |
| 7630 | # |
| 7631 | # Cloud Run for Anthos: supported |
| 7632 | # |
| 7633 | # The header field name |
| 7634 | "value": "A String", # Cloud Run fully managed: not supported |
| 7635 | # |
| 7636 | # Cloud Run for Anthos: supported |
| 7637 | # |
| 7638 | # The header field value |
| 7639 | }, |
| 7640 | ], |
| 7641 | "path": "A String", # (Optional) |
| 7642 | # |
| 7643 | # Cloud Run fully managed: not supported |
| 7644 | # |
| 7645 | # Cloud Run for Anthos: supported |
| 7646 | # |
| 7647 | # Path to access on the HTTP server. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 7648 | }, |
| 7649 | "failureThreshold": 42, # (Optional) |
| 7650 | # |
| 7651 | # Cloud Run fully managed: not supported |
| 7652 | # |
| 7653 | # Cloud Run for Anthos: supported |
| 7654 | # |
| 7655 | # Minimum consecutive failures for the probe to be considered failed after |
| 7656 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 7657 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 7658 | # |
| 7659 | # Cloud Run fully managed: not supported |
| 7660 | # |
| 7661 | # Cloud Run for Anthos: supported |
| 7662 | # |
| 7663 | # One and only one of the following should be specified. |
| 7664 | # Exec specifies the action to take. |
| 7665 | # |
| 7666 | # A field inlined from the Handler message. |
| 7667 | # |
| 7668 | # Cloud Run for Anthos: supported |
| 7669 | # |
| 7670 | # ExecAction describes a "run in container" action. |
| 7671 | "command": "A String", # (Optional) |
| 7672 | # |
| 7673 | # Cloud Run fully managed: not supported |
| 7674 | # |
| 7675 | # Cloud Run for Anthos: supported |
| 7676 | # |
| 7677 | # Command is the command line to execute inside the container, the working |
| 7678 | # directory for the command is root ('/') in the container's filesystem. The |
| 7679 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 7680 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 7681 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 7682 | # live/healthy and non-zero is unhealthy. |
| 7683 | }, |
| 7684 | "initialDelaySeconds": 42, # (Optional) |
| 7685 | # |
| 7686 | # Cloud Run fully managed: not supported |
| 7687 | # |
| 7688 | # Cloud Run for Anthos: supported |
| 7689 | # |
| 7690 | # Number of seconds after the container has started before liveness probes |
| 7691 | # are initiated. More info: |
| 7692 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 7693 | "timeoutSeconds": 42, # (Optional) |
| 7694 | # |
| 7695 | # Cloud Run fully managed: not supported |
| 7696 | # |
| 7697 | # Cloud Run for Anthos: supported |
| 7698 | # |
| 7699 | # Number of seconds after which the probe times out. |
| 7700 | # Defaults to 1 second. Minimum value is 1. |
| 7701 | # More info: |
| 7702 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 7703 | "successThreshold": 42, # (Optional) |
| 7704 | # |
| 7705 | # Cloud Run fully managed: not supported |
| 7706 | # |
| 7707 | # Cloud Run for Anthos: supported |
| 7708 | # |
| 7709 | # Minimum consecutive successes for the probe to be considered successful |
| 7710 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 7711 | # is 1. |
| 7712 | "periodSeconds": 42, # (Optional) |
| 7713 | # |
| 7714 | # Cloud Run fully managed: not supported |
| 7715 | # |
| 7716 | # Cloud Run for Anthos: supported |
| 7717 | # |
| 7718 | # How often (in seconds) to perform the probe. |
| 7719 | # Default to 10 seconds. Minimum value is 1. |
| 7720 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 7721 | # |
| 7722 | # Cloud Run fully managed: not supported |
| 7723 | # |
| 7724 | # Cloud Run for Anthos: supported |
| 7725 | # |
| 7726 | # TCPSocket specifies an action involving a TCP port. |
| 7727 | # TCP hooks not yet supported |
| 7728 | # |
| 7729 | # A field inlined from the Handler message. |
| 7730 | # |
| 7731 | # Cloud Run for Anthos: supported |
| 7732 | # |
| 7733 | # TCPSocketAction describes an action based on opening a socket |
| 7734 | "port": 42, # Cloud Run fully managed: not supported |
| 7735 | # |
| 7736 | # Cloud Run for Anthos: supported |
| 7737 | # |
| 7738 | # Number or name of the port to access on the container. |
| 7739 | # Number must be in the range 1 to 65535. |
| 7740 | # Name must be an IANA_SVC_NAME. |
| 7741 | # |
| 7742 | # This field is currently limited to integer types only because of proto's |
| 7743 | # inability to properly support the IntOrString golang type. |
| 7744 | "host": "A String", # (Optional) |
| 7745 | # |
| 7746 | # Cloud Run fully managed: not supported |
| 7747 | # |
| 7748 | # Cloud Run for Anthos: supported |
| 7749 | # |
| 7750 | # Optional: Host name to connect to, defaults to the pod IP. |
| 7751 | }, |
| 7752 | }, |
| 7753 | "imagePullPolicy": "A String", # (Optional) |
| 7754 | # |
| 7755 | # Cloud Run fully managed: not supported |
| 7756 | # |
| 7757 | # Cloud Run for Anthos: supported |
| 7758 | # |
| 7759 | # Image pull policy. |
| 7760 | # One of Always, Never, IfNotPresent. |
| 7761 | # Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. |
| 7762 | # More info: |
| 7763 | # https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 7764 | "terminationMessagePath": "A String", # (Optional) |
| 7765 | # |
| 7766 | # Cloud Run fully managed: not supported |
| 7767 | # |
| 7768 | # Cloud Run for Anthos: supported |
| 7769 | # |
| 7770 | # Path at which the file to which the container's termination |
| 7771 | # message will be written is mounted into the container's filesystem. Message |
| 7772 | # written is intended to be brief final status, such as an assertion failure |
| 7773 | # message. Will be truncated by the node if greater than 4096 bytes. The |
| 7774 | # total message length across all containers will be limited to 12kb. |
| 7775 | # Defaults to /dev/termination-log. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 7776 | "volumeMounts": [ # (Optional) |
| 7777 | # |
| 7778 | # Cloud Run fully managed: not supported |
| 7779 | # |
| 7780 | # Cloud Run for Anthos: supported |
| 7781 | # |
| 7782 | # Pod volumes to mount into the container's filesystem. |
| 7783 | { # Cloud Run fully managed: not supported |
| 7784 | # |
| 7785 | # Cloud Run for Anthos: supported |
| 7786 | # |
| 7787 | # VolumeMount describes a mounting of a Volume within a container. |
| 7788 | "mountPath": "A String", # Cloud Run fully managed: not supported |
| 7789 | # |
| 7790 | # Cloud Run for Anthos: supported |
| 7791 | # |
| 7792 | # Path within the container at which the volume should be mounted. Must |
| 7793 | # not contain ':'. |
| 7794 | "subPath": "A String", # (Optional) |
| 7795 | # |
| 7796 | # Cloud Run fully managed: not supported |
| 7797 | # |
| 7798 | # Cloud Run for Anthos: supported |
| 7799 | # |
| 7800 | # Path within the volume from which the container's volume should be mounted. |
| 7801 | # Defaults to "" (volume's root). |
| 7802 | "name": "A String", # Cloud Run fully managed: not supported |
| 7803 | # |
| 7804 | # Cloud Run for Anthos: supported |
| 7805 | # |
| 7806 | # This must match the Name of a Volume. |
| 7807 | "readOnly": True or False, # (Optional) |
| 7808 | # |
| 7809 | # Cloud Run fully managed: not supported |
| 7810 | # |
| 7811 | # Cloud Run for Anthos: supported |
| 7812 | # |
| 7813 | # Only true is accepted. |
| 7814 | # Defaults to true. |
| 7815 | }, |
| 7816 | ], |
| 7817 | "args": [ # (Optional) |
| 7818 | # |
| 7819 | # Cloud Run fully managed: supported |
| 7820 | # |
| 7821 | # Cloud Run for Anthos: supported |
| 7822 | # |
| 7823 | # Arguments to the entrypoint. |
| 7824 | # The docker image's CMD is used if this is not provided. |
| 7825 | # Variable references $(VAR_NAME) are expanded using the container's |
| 7826 | # environment. If a variable cannot be resolved, the reference in the input |
| 7827 | # string will be unchanged. The $(VAR_NAME) syntax can be escaped with a |
| 7828 | # double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, |
| 7829 | # regardless of whether the variable exists or not. |
| 7830 | # More info: |
| 7831 | # https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| 7832 | "A String", |
| 7833 | ], |
| 7834 | "workingDir": "A String", # (Optional) |
| 7835 | # |
| 7836 | # Cloud Run fully managed: not supported |
| 7837 | # |
| 7838 | # Cloud Run for Anthos: supported |
| 7839 | # |
| 7840 | # Container's working directory. |
| 7841 | # If not specified, the container runtime's default will be used, which |
| 7842 | # might be configured in the container image. |
| 7843 | "ports": [ # (Optional) |
| 7844 | # |
| 7845 | # List of ports to expose from the container. Only a single port can be |
| 7846 | # specified. The specified ports must be listening on all interfaces |
| 7847 | # (0.0.0.0) within the container to be accessible. |
| 7848 | # |
| 7849 | # If omitted, a port number will be chosen and passed to the container |
| 7850 | # through the PORT environment variable for the container to listen on. |
| 7851 | { # ContainerPort represents a network port in a single container. |
| 7852 | "containerPort": 42, # (Optional) |
| 7853 | # |
| 7854 | # Port number the container listens on. |
| 7855 | # This must be a valid port number, 0 < x < 65536. |
| 7856 | "protocol": "A String", # (Optional) |
| 7857 | # |
| 7858 | # Cloud Run fully managed: not supported |
| 7859 | # |
| 7860 | # Cloud Run for Anthos: supported |
| 7861 | # |
| 7862 | # Protocol for port. Must be "TCP". |
| 7863 | # Defaults to "TCP". |
| 7864 | "name": "A String", # (Optional) |
| 7865 | # |
| 7866 | # Cloud Run fully managed: not supported |
| 7867 | # |
| 7868 | # Cloud Run for Anthos: supported |
| 7869 | # |
| 7870 | # If specified, used to specify which protocol to use. |
| 7871 | # Allowed values are "http1" and "h2c". |
| 7872 | }, |
| 7873 | ], |
| 7874 | "image": "A String", # Cloud Run fully managed: only supports containers from Google Container |
| 7875 | # Registry |
| 7876 | # |
| 7877 | # Cloud Run for Anthos: supported |
| 7878 | # |
| 7879 | # URL of the Container image. |
| 7880 | # More info: https://kubernetes.io/docs/concepts/containers/images |
| 7881 | "envFrom": [ # (Optional) |
| 7882 | # |
| 7883 | # Cloud Run fully managed: not supported |
| 7884 | # |
| 7885 | # Cloud Run for Anthos: supported |
| 7886 | # |
| 7887 | # List of sources to populate environment variables in the container. |
| 7888 | # The keys defined within a source must be a C_IDENTIFIER. All invalid keys |
| 7889 | # will be reported as an event when the container is starting. When a key |
| 7890 | # exists in multiple sources, the value associated with the last source will |
| 7891 | # take precedence. Values defined by an Env with a duplicate key will take |
| 7892 | # precedence. Cannot be updated. |
| 7893 | { # Cloud Run fully managed: not supported |
| 7894 | # |
| 7895 | # Cloud Run for Anthos: supported |
| 7896 | # |
| 7897 | # EnvFromSource represents the source of a set of ConfigMaps |
| 7898 | "secretRef": { # Cloud Run fully managed: not supported # (Optional) |
| 7899 | # |
| 7900 | # Cloud Run fully managed: not supported |
| 7901 | # |
| 7902 | # Cloud Run for Anthos: supported |
| 7903 | # |
| 7904 | # The Secret to select from |
| 7905 | # |
| 7906 | # Cloud Run for Anthos: supported |
| 7907 | # |
| 7908 | # SecretEnvSource selects a Secret to populate the environment |
| 7909 | # variables with. |
| 7910 | # |
| 7911 | # The contents of the target Secret's Data field will represent the |
| 7912 | # key-value pairs as environment variables. |
| 7913 | "name": "A String", # Cloud Run fully managed: not supported |
| 7914 | # |
| 7915 | # Cloud Run for Anthos: supported |
| 7916 | # |
| 7917 | # The Secret to select from. |
| 7918 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 7919 | # directly into the message. Use the "name" field instead. |
| 7920 | # |
| 7921 | # Cloud Run for Anthos: supported |
| 7922 | # |
| 7923 | # LocalObjectReference contains enough information to let you locate the |
| 7924 | # referenced object inside the same namespace. |
| 7925 | "name": "A String", # (Optional) |
| 7926 | # |
| 7927 | # Cloud Run fully managed: not supported |
| 7928 | # |
| 7929 | # Cloud Run for Anthos: supported |
| 7930 | # |
| 7931 | # Name of the referent. |
| 7932 | # More info: |
| 7933 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 7934 | }, |
| 7935 | "optional": True or False, # (Optional) |
| 7936 | # |
| 7937 | # Cloud Run fully managed: not supported |
| 7938 | # |
| 7939 | # Cloud Run for Anthos: supported |
| 7940 | # |
| 7941 | # Specify whether the Secret must be defined |
| 7942 | }, |
| 7943 | "prefix": "A String", # (Optional) |
| 7944 | # |
| 7945 | # Cloud Run fully managed: not supported |
| 7946 | # |
| 7947 | # Cloud Run for Anthos: supported |
| 7948 | # |
| 7949 | # An optional identifier to prepend to each key in the ConfigMap. Must be a |
| 7950 | # C_IDENTIFIER. |
| 7951 | "configMapRef": { # Cloud Run fully managed: not supported # (Optional) |
| 7952 | # |
| 7953 | # Cloud Run fully managed: not supported |
| 7954 | # |
| 7955 | # Cloud Run for Anthos: supported |
| 7956 | # |
| 7957 | # The ConfigMap to select from |
| 7958 | # |
| 7959 | # Cloud Run for Anthos: supported |
| 7960 | # |
| 7961 | # ConfigMapEnvSource selects a ConfigMap to populate the environment |
| 7962 | # variables with. |
| 7963 | # |
| 7964 | # The contents of the target ConfigMap's Data field will represent the |
| 7965 | # key-value pairs as environment variables. |
| 7966 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 7967 | # directly into the message. Use the "name" field instead. |
| 7968 | # |
| 7969 | # Cloud Run for Anthos: supported |
| 7970 | # |
| 7971 | # LocalObjectReference contains enough information to let you locate the |
| 7972 | # referenced object inside the same namespace. |
| 7973 | "name": "A String", # (Optional) |
| 7974 | # |
| 7975 | # Cloud Run fully managed: not supported |
| 7976 | # |
| 7977 | # Cloud Run for Anthos: supported |
| 7978 | # |
| 7979 | # Name of the referent. |
| 7980 | # More info: |
| 7981 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 7982 | }, |
| 7983 | "optional": True or False, # (Optional) |
| 7984 | # |
| 7985 | # Cloud Run fully managed: not supported |
| 7986 | # |
| 7987 | # Cloud Run for Anthos: supported |
| 7988 | # |
| 7989 | # Specify whether the ConfigMap must be defined |
| 7990 | "name": "A String", # Cloud Run fully managed: not supported |
| 7991 | # |
| 7992 | # Cloud Run for Anthos: supported |
| 7993 | # |
| 7994 | # The ConfigMap to select from. |
| 7995 | }, |
| 7996 | }, |
| 7997 | ], |
| 7998 | "name": "A String", # (Optional) |
| 7999 | # |
| 8000 | # Name of the container specified as a DNS_LABEL. |
| 8001 | "command": [ |
| 8002 | "A String", |
| 8003 | ], |
| 8004 | "terminationMessagePolicy": "A String", # (Optional) |
| 8005 | # |
| 8006 | # Cloud Run fully managed: not supported |
| 8007 | # |
| 8008 | # Cloud Run for Anthos: supported |
| 8009 | # |
| 8010 | # Indicate how the termination message should be populated. File will use the |
| 8011 | # contents of terminationMessagePath to populate the container status message |
| 8012 | # on both success and failure. FallbackToLogsOnError will use the last chunk |
| 8013 | # of container log output if the termination message file is empty and the |
| 8014 | # container exited with an error. The log output is limited to 2048 bytes or |
| 8015 | # 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 8016 | }, |
| 8017 | ], |
| 8018 | "volumes": [ |
| 8019 | { # Cloud Run fully managed: not supported |
| 8020 | # |
| 8021 | # Cloud Run for Anthos: supported |
| 8022 | # |
| 8023 | # Volume represents a named volume in a container. |
| 8024 | "configMap": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| 8025 | # |
| 8026 | # Cloud Run for Anthos: supported |
| 8027 | # |
| 8028 | # Cloud Run for Anthos: supported |
| 8029 | # |
| 8030 | # Adapts a ConfigMap into a volume. |
| 8031 | # The contents of the target ConfigMap's Data field will be presented in a |
| 8032 | # volume as files using the keys in the Data field as the file names, unless |
| 8033 | # the items element is populated with specific mappings of keys to paths. |
| 8034 | "optional": True or False, # (Optional) |
| 8035 | # |
| 8036 | # Cloud Run fully managed: not supported |
| 8037 | # |
| 8038 | # Cloud Run for Anthos: supported |
| 8039 | # |
| 8040 | # Specify whether the Secret or its keys must be defined. |
| 8041 | "name": "A String", # Cloud Run fully managed: not supported |
| 8042 | # |
| 8043 | # Cloud Run for Anthos: supported |
| 8044 | # |
| 8045 | # Name of the config. |
| 8046 | "defaultMode": 42, # (Optional) |
| 8047 | # |
| 8048 | # Cloud Run fully managed: not supported |
| 8049 | # |
| 8050 | # Cloud Run for Anthos: supported |
| 8051 | # |
| 8052 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 8053 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 8054 | # this setting. This might be in conflict with other options that affect the |
| 8055 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 8056 | "items": [ # (Optional) |
| 8057 | # |
| 8058 | # Cloud Run fully managed: not supported |
| 8059 | # |
| 8060 | # Cloud Run for Anthos: supported |
| 8061 | # |
| 8062 | # If unspecified, each key-value pair in the Data field of the referenced |
| 8063 | # Secret will be projected into the volume as a file whose name is the |
| 8064 | # key and content is the value. If specified, the listed keys will be |
| 8065 | # projected into the specified paths, and unlisted keys will not be |
| 8066 | # present. If a key is specified which is not present in the Secret, |
| 8067 | # the volume setup will error unless it is marked optional. |
| 8068 | { # Cloud Run fully managed: not supported |
| 8069 | # |
| 8070 | # Cloud Run for Anthos: supported |
| 8071 | # |
| 8072 | # Maps a string key to a path within a volume. |
| 8073 | "key": "A String", # Cloud Run fully managed: not supported |
| 8074 | # |
| 8075 | # Cloud Run for Anthos: supported |
| 8076 | # |
| 8077 | # The key to project. |
| 8078 | "path": "A String", # Cloud Run fully managed: not supported |
| 8079 | # |
| 8080 | # Cloud Run for Anthos: supported |
| 8081 | # |
| 8082 | # The relative path of the file to map the key to. |
| 8083 | # May not be an absolute path. |
| 8084 | # May not contain the path element '..'. |
| 8085 | # May not start with the string '..'. |
| 8086 | "mode": 42, # (Optional) |
| 8087 | # |
| 8088 | # Cloud Run fully managed: not supported |
| 8089 | # |
| 8090 | # Cloud Run for Anthos: supported |
| 8091 | # |
| 8092 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 8093 | # specified, the volume defaultMode will be used. This might be in conflict |
| 8094 | # with other options that affect the file mode, like fsGroup, and the result |
| 8095 | # can be other mode bits set. |
| 8096 | }, |
| 8097 | ], |
| 8098 | }, |
| 8099 | "name": "A String", # Cloud Run fully managed: not supported |
| 8100 | # |
| 8101 | # Cloud Run for Anthos: supported |
| 8102 | # |
| 8103 | # Volume's name. |
| 8104 | "secret": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| 8105 | # |
| 8106 | # Cloud Run for Anthos: supported |
| 8107 | # |
| 8108 | # Cloud Run for Anthos: supported |
| 8109 | # |
| 8110 | # The contents of the target Secret's Data field will be presented in a volume |
| 8111 | # as files using the keys in the Data field as the file names. |
| 8112 | "secretName": "A String", # Cloud Run fully managed: not supported |
| 8113 | # |
| 8114 | # Cloud Run for Anthos: supported |
| 8115 | # |
| 8116 | # Name of the secret in the container's namespace to use. |
| 8117 | "items": [ # (Optional) |
| 8118 | # |
| 8119 | # Cloud Run fully managed: not supported |
| 8120 | # |
| 8121 | # Cloud Run for Anthos: supported |
| 8122 | # |
| 8123 | # If unspecified, each key-value pair in the Data field of the referenced |
| 8124 | # Secret will be projected into the volume as a file whose name is the |
| 8125 | # key and content is the value. If specified, the listed keys will be |
| 8126 | # projected into the specified paths, and unlisted keys will not be |
| 8127 | # present. If a key is specified which is not present in the Secret, |
| 8128 | # the volume setup will error unless it is marked optional. |
| 8129 | { # Cloud Run fully managed: not supported |
| 8130 | # |
| 8131 | # Cloud Run for Anthos: supported |
| 8132 | # |
| 8133 | # Maps a string key to a path within a volume. |
| 8134 | "key": "A String", # Cloud Run fully managed: not supported |
| 8135 | # |
| 8136 | # Cloud Run for Anthos: supported |
| 8137 | # |
| 8138 | # The key to project. |
| 8139 | "path": "A String", # Cloud Run fully managed: not supported |
| 8140 | # |
| 8141 | # Cloud Run for Anthos: supported |
| 8142 | # |
| 8143 | # The relative path of the file to map the key to. |
| 8144 | # May not be an absolute path. |
| 8145 | # May not contain the path element '..'. |
| 8146 | # May not start with the string '..'. |
| 8147 | "mode": 42, # (Optional) |
| 8148 | # |
| 8149 | # Cloud Run fully managed: not supported |
| 8150 | # |
| 8151 | # Cloud Run for Anthos: supported |
| 8152 | # |
| 8153 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 8154 | # specified, the volume defaultMode will be used. This might be in conflict |
| 8155 | # with other options that affect the file mode, like fsGroup, and the result |
| 8156 | # can be other mode bits set. |
| 8157 | }, |
| 8158 | ], |
| 8159 | "optional": True or False, # (Optional) |
| 8160 | # |
| 8161 | # Cloud Run fully managed: not supported |
| 8162 | # |
| 8163 | # Cloud Run for Anthos: supported |
| 8164 | # |
| 8165 | # Specify whether the Secret or its keys must be defined. |
| 8166 | "defaultMode": 42, # (Optional) |
| 8167 | # |
| 8168 | # Cloud Run fully managed: not supported |
| 8169 | # |
| 8170 | # Cloud Run for Anthos: supported |
| 8171 | # |
| 8172 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 8173 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 8174 | # this setting. This might be in conflict with other options that affect the |
| 8175 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 8176 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8177 | }, |
| 8178 | ], |
| 8179 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8180 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Optional metadata for this Revision, including labels and annotations. Name |
| 8181 | # will be generated by the Configuration. |
| 8182 | # To set minimum instances for this revision, use the |
| 8183 | # "autoscaling.knative.dev/minScale" annotation key. |
| 8184 | # To set maximum instances for this revision, use the |
| 8185 | # "autoscaling.knative.dev/maxScale" annotation key. |
| 8186 | # To set Cloud SQL connections for the revision, use the |
| 8187 | # "run.googleapis.com/cloudsql-instances" annotation key. |
| 8188 | # persisted resources must have, which includes all objects users must create. |
| 8189 | "annotations": { # (Optional) |
| 8190 | # |
| 8191 | # Annotations is an unstructured key value map stored with a resource that |
| 8192 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 8193 | # are not queryable and should be preserved when modifying objects. More |
| 8194 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 8195 | "a_key": "A String", |
| 8196 | }, |
| 8197 | "generateName": "A String", # (Optional) |
| 8198 | # |
| 8199 | # Cloud Run fully managed: not supported |
| 8200 | # |
| 8201 | # Cloud Run for Anthos: supported |
| 8202 | # |
| 8203 | # GenerateName is an optional prefix, used by the server, to generate a |
| 8204 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 8205 | # used, the name returned to the client will be different than the name |
| 8206 | # passed. This value will also be combined with a unique suffix. The provided |
| 8207 | # value has the same validation rules as the Name field, and may be truncated |
| 8208 | # by the length of the suffix required to make the value unique on the |
| 8209 | # server. |
| 8210 | # |
| 8211 | # If this field is specified and the generated name exists, the server will |
| 8212 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 8213 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 8214 | # time allotted, and the client should retry (optionally after the time |
| 8215 | # indicated in the Retry-After header). |
| 8216 | # |
| 8217 | # Applied only if Name is not specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8218 | # More info: |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8219 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 8220 | # string generateName = 2; |
| 8221 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 8222 | # Is required when creating |
| 8223 | # resources, although some resources may allow a client to request the |
| 8224 | # generation of an appropriate name automatically. Name is primarily intended |
| 8225 | # for creation idempotence and configuration definition. Cannot be updated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8226 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8227 | # +optional |
| 8228 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 8229 | # |
| 8230 | # Cloud Run fully managed: not supported |
| 8231 | # |
| 8232 | # Cloud Run for Anthos: supported |
| 8233 | # |
| 8234 | # Number of seconds allowed for this object to gracefully terminate before |
| 8235 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 8236 | # set. May only be shortened. Read-only. |
| 8237 | "clusterName": "A String", # (Optional) |
| 8238 | # |
| 8239 | # Cloud Run fully managed: not supported |
| 8240 | # |
| 8241 | # Cloud Run for Anthos: supported |
| 8242 | # |
| 8243 | # The name of the cluster which the object belongs to. |
| 8244 | # This is used to distinguish resources with same name and namespace in |
| 8245 | # different clusters. This field is not set anywhere right now and apiserver |
| 8246 | # is going to ignore it if set in create or update request. |
| 8247 | "finalizers": [ # (Optional) |
| 8248 | # |
| 8249 | # Cloud Run fully managed: not supported |
| 8250 | # |
| 8251 | # Cloud Run for Anthos: supported |
| 8252 | # |
| 8253 | # Must be empty before the object is deleted from the registry. Each entry |
| 8254 | # is an identifier for the responsible component that will remove the entry |
| 8255 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 8256 | # in this list can only be removed. |
| 8257 | # +patchStrategy=merge |
| 8258 | "A String", |
| 8259 | ], |
| 8260 | "deletionTimestamp": "A String", # (Optional) |
| 8261 | # |
| 8262 | # Cloud Run fully managed: not supported |
| 8263 | # |
| 8264 | # Cloud Run for Anthos: supported |
| 8265 | # |
| 8266 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 8267 | # deleted. This field is set by the server when a graceful deletion is |
| 8268 | # requested by the user, and is not directly settable by a client. The |
| 8269 | # resource is expected to be deleted (no longer visible from resource lists, |
| 8270 | # and not reachable by name) after the time in this field, once the |
| 8271 | # finalizers list is empty. As long as the finalizers list contains items, |
| 8272 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 8273 | # be unset or be set further into the future, although it may be shortened or |
| 8274 | # the resource may be deleted prior to this time. For example, a user may |
| 8275 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 8276 | # sending a graceful termination signal to the containers in the pod. After |
| 8277 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 8278 | # to the container and after cleanup, remove the pod from the API. In the |
| 8279 | # presence of network partitions, this object may still exist after this |
| 8280 | # timestamp, until an administrator or automated process can determine the |
| 8281 | # resource is fully terminated. |
| 8282 | # If not set, graceful deletion of the object has not been requested. |
| 8283 | # |
| 8284 | # Populated by the system when a graceful deletion is requested. |
| 8285 | # Read-only. |
| 8286 | # More info: |
| 8287 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 8288 | "ownerReferences": [ # (Optional) |
| 8289 | # |
| 8290 | # Cloud Run fully managed: not supported |
| 8291 | # |
| 8292 | # Cloud Run for Anthos: supported |
| 8293 | # |
| 8294 | # List of objects that own this object. If ALL objects in the list have |
| 8295 | # been deleted, this object will be garbage collected. |
| 8296 | { # OwnerReference contains enough information to let you identify an owning |
| 8297 | # object. Currently, an owning object must be in the same namespace, so there |
| 8298 | # is no namespace field. |
| 8299 | "controller": True or False, # If true, this reference points to the managing controller. |
| 8300 | # +optional |
| 8301 | "kind": "A String", # Kind of the referent. |
| 8302 | # More info: |
| 8303 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 8304 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 8305 | # the owner cannot be deleted from the key-value store until this |
| 8306 | # reference is removed. |
| 8307 | # Defaults to false. |
| 8308 | # To set this field, a user needs "delete" permission of the owner, |
| 8309 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 8310 | # +optional |
| 8311 | "apiVersion": "A String", # API version of the referent. |
| 8312 | "name": "A String", # Name of the referent. |
| 8313 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 8314 | "uid": "A String", # UID of the referent. |
| 8315 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 8316 | }, |
| 8317 | ], |
| 8318 | "creationTimestamp": "A String", # (Optional) |
| 8319 | # |
| 8320 | # CreationTimestamp is a timestamp representing the server time when this |
| 8321 | # object was created. It is not guaranteed to be set in happens-before order |
| 8322 | # across separate operations. Clients may not set this value. It is |
| 8323 | # represented in RFC3339 form and is in UTC. |
| 8324 | # |
| 8325 | # Populated by the system. |
| 8326 | # Read-only. |
| 8327 | # Null for lists. |
| 8328 | # More info: |
| 8329 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 8330 | "labels": { # (Optional) |
| 8331 | # |
| 8332 | # Map of string keys and values that can be used to organize and categorize |
| 8333 | # (scope and select) objects. May match selectors of replication controllers |
| 8334 | # and routes. |
| 8335 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 8336 | "a_key": "A String", |
| 8337 | }, |
| 8338 | "generation": 42, # (Optional) |
| 8339 | # |
| 8340 | # A sequence number representing a specific generation of the desired state. |
| 8341 | # Populated by the system. Read-only. |
| 8342 | "resourceVersion": "A String", # (Optional) |
| 8343 | # |
| 8344 | # An opaque value that represents the internal version of this object that |
| 8345 | # can be used by clients to determine when objects have changed. May be used |
| 8346 | # for optimistic concurrency, change detection, and the watch operation on a |
| 8347 | # resource or set of resources. Clients must treat these values as opaque and |
| 8348 | # passed unmodified back to the server. They may only be valid for a |
| 8349 | # particular resource or set of resources. |
| 8350 | # |
| 8351 | # Populated by the system. |
| 8352 | # Read-only. |
| 8353 | # Value must be treated as opaque by clients and . |
| 8354 | # More info: |
| 8355 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 8356 | "selfLink": "A String", # (Optional) |
| 8357 | # |
| 8358 | # SelfLink is a URL representing this object. |
| 8359 | # Populated by the system. |
| 8360 | # Read-only. |
| 8361 | # string selfLink = 4; |
| 8362 | "uid": "A String", # (Optional) |
| 8363 | # |
| 8364 | # UID is the unique in time and space value for this object. It is typically |
| 8365 | # generated by the server on successful creation of a resource and is not |
| 8366 | # allowed to change on PUT operations. |
| 8367 | # |
| 8368 | # Populated by the system. |
| 8369 | # Read-only. |
| 8370 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 8371 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 8372 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 8373 | # project ID or project number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8374 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8375 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 8376 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 8377 | } |
| 8378 | |
| 8379 | x__xgafv: string, V1 error format. |
| 8380 | Allowed values |
| 8381 | 1 - v1 error format |
| 8382 | 2 - v2 error format |
| 8383 | |
| 8384 | Returns: |
| 8385 | An object of the form: |
| 8386 | |
| 8387 | { # Service acts as a top-level container that manages a set of Routes and |
| 8388 | # Configurations which implement a network service. Service exists to provide a |
| 8389 | # singular abstraction which can be access controlled, reasoned about, and |
| 8390 | # which encapsulates software lifecycle decisions such as rollout policy and |
| 8391 | # team resource ownership. Service acts only as an orchestrator of the |
| 8392 | # underlying Routes and Configurations (much as a kubernetes Deployment |
| 8393 | # orchestrates ReplicaSets). |
| 8394 | # |
| 8395 | # The Service's controller will track the statuses of its owned Configuration |
| 8396 | # and Route, reflecting their statuses and conditions as its own. |
| 8397 | # |
| 8398 | # See also: |
| 8399 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#service |
| 8400 | "kind": "A String", # The kind of resource, in this case "Service". |
| 8401 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Service, including name, namespace, labels, |
| 8402 | # and annotations. |
| 8403 | # persisted resources must have, which includes all objects users must create. |
| 8404 | "annotations": { # (Optional) |
| 8405 | # |
| 8406 | # Annotations is an unstructured key value map stored with a resource that |
| 8407 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 8408 | # are not queryable and should be preserved when modifying objects. More |
| 8409 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 8410 | "a_key": "A String", |
| 8411 | }, |
| 8412 | "generateName": "A String", # (Optional) |
| 8413 | # |
| 8414 | # Cloud Run fully managed: not supported |
| 8415 | # |
| 8416 | # Cloud Run for Anthos: supported |
| 8417 | # |
| 8418 | # GenerateName is an optional prefix, used by the server, to generate a |
| 8419 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 8420 | # used, the name returned to the client will be different than the name |
| 8421 | # passed. This value will also be combined with a unique suffix. The provided |
| 8422 | # value has the same validation rules as the Name field, and may be truncated |
| 8423 | # by the length of the suffix required to make the value unique on the |
| 8424 | # server. |
| 8425 | # |
| 8426 | # If this field is specified and the generated name exists, the server will |
| 8427 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 8428 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 8429 | # time allotted, and the client should retry (optionally after the time |
| 8430 | # indicated in the Retry-After header). |
| 8431 | # |
| 8432 | # Applied only if Name is not specified. |
| 8433 | # More info: |
| 8434 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 8435 | # string generateName = 2; |
| 8436 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 8437 | # Is required when creating |
| 8438 | # resources, although some resources may allow a client to request the |
| 8439 | # generation of an appropriate name automatically. Name is primarily intended |
| 8440 | # for creation idempotence and configuration definition. Cannot be updated. |
| 8441 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 8442 | # +optional |
| 8443 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 8444 | # |
| 8445 | # Cloud Run fully managed: not supported |
| 8446 | # |
| 8447 | # Cloud Run for Anthos: supported |
| 8448 | # |
| 8449 | # Number of seconds allowed for this object to gracefully terminate before |
| 8450 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 8451 | # set. May only be shortened. Read-only. |
| 8452 | "clusterName": "A String", # (Optional) |
| 8453 | # |
| 8454 | # Cloud Run fully managed: not supported |
| 8455 | # |
| 8456 | # Cloud Run for Anthos: supported |
| 8457 | # |
| 8458 | # The name of the cluster which the object belongs to. |
| 8459 | # This is used to distinguish resources with same name and namespace in |
| 8460 | # different clusters. This field is not set anywhere right now and apiserver |
| 8461 | # is going to ignore it if set in create or update request. |
| 8462 | "finalizers": [ # (Optional) |
| 8463 | # |
| 8464 | # Cloud Run fully managed: not supported |
| 8465 | # |
| 8466 | # Cloud Run for Anthos: supported |
| 8467 | # |
| 8468 | # Must be empty before the object is deleted from the registry. Each entry |
| 8469 | # is an identifier for the responsible component that will remove the entry |
| 8470 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 8471 | # in this list can only be removed. |
| 8472 | # +patchStrategy=merge |
| 8473 | "A String", |
| 8474 | ], |
| 8475 | "deletionTimestamp": "A String", # (Optional) |
| 8476 | # |
| 8477 | # Cloud Run fully managed: not supported |
| 8478 | # |
| 8479 | # Cloud Run for Anthos: supported |
| 8480 | # |
| 8481 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 8482 | # deleted. This field is set by the server when a graceful deletion is |
| 8483 | # requested by the user, and is not directly settable by a client. The |
| 8484 | # resource is expected to be deleted (no longer visible from resource lists, |
| 8485 | # and not reachable by name) after the time in this field, once the |
| 8486 | # finalizers list is empty. As long as the finalizers list contains items, |
| 8487 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 8488 | # be unset or be set further into the future, although it may be shortened or |
| 8489 | # the resource may be deleted prior to this time. For example, a user may |
| 8490 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 8491 | # sending a graceful termination signal to the containers in the pod. After |
| 8492 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 8493 | # to the container and after cleanup, remove the pod from the API. In the |
| 8494 | # presence of network partitions, this object may still exist after this |
| 8495 | # timestamp, until an administrator or automated process can determine the |
| 8496 | # resource is fully terminated. |
| 8497 | # If not set, graceful deletion of the object has not been requested. |
| 8498 | # |
| 8499 | # Populated by the system when a graceful deletion is requested. |
| 8500 | # Read-only. |
| 8501 | # More info: |
| 8502 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 8503 | "ownerReferences": [ # (Optional) |
| 8504 | # |
| 8505 | # Cloud Run fully managed: not supported |
| 8506 | # |
| 8507 | # Cloud Run for Anthos: supported |
| 8508 | # |
| 8509 | # List of objects that own this object. If ALL objects in the list have |
| 8510 | # been deleted, this object will be garbage collected. |
| 8511 | { # OwnerReference contains enough information to let you identify an owning |
| 8512 | # object. Currently, an owning object must be in the same namespace, so there |
| 8513 | # is no namespace field. |
| 8514 | "controller": True or False, # If true, this reference points to the managing controller. |
| 8515 | # +optional |
| 8516 | "kind": "A String", # Kind of the referent. |
| 8517 | # More info: |
| 8518 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 8519 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 8520 | # the owner cannot be deleted from the key-value store until this |
| 8521 | # reference is removed. |
| 8522 | # Defaults to false. |
| 8523 | # To set this field, a user needs "delete" permission of the owner, |
| 8524 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 8525 | # +optional |
| 8526 | "apiVersion": "A String", # API version of the referent. |
| 8527 | "name": "A String", # Name of the referent. |
| 8528 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 8529 | "uid": "A String", # UID of the referent. |
| 8530 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 8531 | }, |
| 8532 | ], |
| 8533 | "creationTimestamp": "A String", # (Optional) |
| 8534 | # |
| 8535 | # CreationTimestamp is a timestamp representing the server time when this |
| 8536 | # object was created. It is not guaranteed to be set in happens-before order |
| 8537 | # across separate operations. Clients may not set this value. It is |
| 8538 | # represented in RFC3339 form and is in UTC. |
| 8539 | # |
| 8540 | # Populated by the system. |
| 8541 | # Read-only. |
| 8542 | # Null for lists. |
| 8543 | # More info: |
| 8544 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 8545 | "labels": { # (Optional) |
| 8546 | # |
| 8547 | # Map of string keys and values that can be used to organize and categorize |
| 8548 | # (scope and select) objects. May match selectors of replication controllers |
| 8549 | # and routes. |
| 8550 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 8551 | "a_key": "A String", |
| 8552 | }, |
| 8553 | "generation": 42, # (Optional) |
| 8554 | # |
| 8555 | # A sequence number representing a specific generation of the desired state. |
| 8556 | # Populated by the system. Read-only. |
| 8557 | "resourceVersion": "A String", # (Optional) |
| 8558 | # |
| 8559 | # An opaque value that represents the internal version of this object that |
| 8560 | # can be used by clients to determine when objects have changed. May be used |
| 8561 | # for optimistic concurrency, change detection, and the watch operation on a |
| 8562 | # resource or set of resources. Clients must treat these values as opaque and |
| 8563 | # passed unmodified back to the server. They may only be valid for a |
| 8564 | # particular resource or set of resources. |
| 8565 | # |
| 8566 | # Populated by the system. |
| 8567 | # Read-only. |
| 8568 | # Value must be treated as opaque by clients and . |
| 8569 | # More info: |
| 8570 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 8571 | "selfLink": "A String", # (Optional) |
| 8572 | # |
| 8573 | # SelfLink is a URL representing this object. |
| 8574 | # Populated by the system. |
| 8575 | # Read-only. |
| 8576 | # string selfLink = 4; |
| 8577 | "uid": "A String", # (Optional) |
| 8578 | # |
| 8579 | # UID is the unique in time and space value for this object. It is typically |
| 8580 | # generated by the server on successful creation of a resource and is not |
| 8581 | # allowed to change on PUT operations. |
| 8582 | # |
| 8583 | # Populated by the system. |
| 8584 | # Read-only. |
| 8585 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 8586 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 8587 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 8588 | # project ID or project number. |
| 8589 | }, |
| 8590 | "status": { # The current state of the Service. Output only. # Status communicates the observed state of the Service (from the |
| 8591 | # controller). |
| 8592 | "latestCreatedRevisionName": "A String", # From ConfigurationStatus. |
| 8593 | # LatestCreatedRevisionName is the last revision that was created from this |
| 8594 | # Service's Configuration. It might not be ready yet, for that use |
| 8595 | # LatestReadyRevisionName. |
| 8596 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 8597 | # reconciliation processes that bring the "spec" inline with the observed |
| 8598 | # state of the world. |
| 8599 | # Service-specific conditions include: |
| 8600 | # * "ConfigurationsReady": true when the underlying Configuration is ready. |
| 8601 | # * "RoutesReady": true when the underlying Route is ready. |
| 8602 | # * "Ready": true when both the underlying Route and Configuration are |
| 8603 | # ready. |
| 8604 | { # Condition defines a generic condition for a Resource |
| 8605 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 8606 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 8607 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 8608 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 8609 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 8610 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 8611 | # See also: |
| 8612 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 8613 | # Types common to all resources include: |
| 8614 | # * "Ready": True when the Resource is ready. |
| 8615 | }, |
| 8616 | ], |
| 8617 | "address": { # Information for connecting over HTTP(s). # From RouteStatus. |
| 8618 | # Similar to url, information on where the service is available on HTTP. |
| 8619 | "url": "A String", |
| 8620 | }, |
| 8621 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 8622 | # was last processed by the controller. |
| 8623 | # |
| 8624 | # Clients polling for completed reconciliation should poll until |
| 8625 | # observedGeneration = metadata.generation and the Ready condition's status |
| 8626 | # is True or False. |
| 8627 | "url": "A String", # From RouteStatus. |
| 8628 | # URL holds the url that will distribute traffic over the provided traffic |
| 8629 | # targets. It generally has the form |
| 8630 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 8631 | "traffic": [ # From RouteStatus. |
| 8632 | # Traffic holds the configured traffic distribution. |
| 8633 | # These entries will always contain RevisionName references. |
| 8634 | # When ConfigurationName appears in the spec, this will hold the |
| 8635 | # LatestReadyRevisionName that we last observed. |
| 8636 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 8637 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 8638 | # traffic. This is mutually exclusive with ConfigurationName. |
| 8639 | # |
| 8640 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 8641 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 8642 | # ready Revision of the Configuration should be used for this traffic |
| 8643 | # target. When provided LatestRevision must be true if RevisionName is |
| 8644 | # empty; it must be false when RevisionName is non-empty. |
| 8645 | # |
| 8646 | # +optional |
| 8647 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 8648 | # this target exclusively. |
| 8649 | # |
| 8650 | # Not currently supported in Cloud Run. |
| 8651 | # +optional |
| 8652 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 8653 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 8654 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 8655 | # (e.g. basic auth, url path, etc. |
| 8656 | # |
| 8657 | # Not currently supported in Cloud Run. |
| 8658 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 8659 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 8660 | # of the referenced configuration changes, we will automatically migrate |
| 8661 | # traffic from the prior "latest ready" revision to the new one. This field |
| 8662 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 8663 | # with RevisionName. |
| 8664 | # |
| 8665 | # Cloud Run currently supports a single ConfigurationName. |
| 8666 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 8667 | # This defaults to zero if unspecified. |
| 8668 | # |
| 8669 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 8670 | # TrafficTarget entry. |
| 8671 | }, |
| 8672 | ], |
| 8673 | "latestReadyRevisionName": "A String", # From ConfigurationStatus. |
| 8674 | # LatestReadyRevisionName holds the name of the latest Revision stamped out |
| 8675 | # from this Service's Configuration that has had its "Ready" condition become |
| 8676 | # "True". |
| 8677 | }, |
| 8678 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 8679 | "spec": { # ServiceSpec holds the desired state of the Route (from the client), which # Spec holds the desired state of the Service (from the client). |
| 8680 | # is used to manipulate the underlying Route and Configuration(s). |
| 8681 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 8682 | # Revisions and Configurations. |
| 8683 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 8684 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 8685 | # traffic. This is mutually exclusive with ConfigurationName. |
| 8686 | # |
| 8687 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 8688 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 8689 | # ready Revision of the Configuration should be used for this traffic |
| 8690 | # target. When provided LatestRevision must be true if RevisionName is |
| 8691 | # empty; it must be false when RevisionName is non-empty. |
| 8692 | # |
| 8693 | # +optional |
| 8694 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 8695 | # this target exclusively. |
| 8696 | # |
| 8697 | # Not currently supported in Cloud Run. |
| 8698 | # +optional |
| 8699 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 8700 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 8701 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 8702 | # (e.g. basic auth, url path, etc. |
| 8703 | # |
| 8704 | # Not currently supported in Cloud Run. |
| 8705 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 8706 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 8707 | # of the referenced configuration changes, we will automatically migrate |
| 8708 | # traffic from the prior "latest ready" revision to the new one. This field |
| 8709 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 8710 | # with RevisionName. |
| 8711 | # |
| 8712 | # Cloud Run currently supports a single ConfigurationName. |
| 8713 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 8714 | # This defaults to zero if unspecified. |
| 8715 | # |
| 8716 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 8717 | # TrafficTarget entry. |
| 8718 | }, |
| 8719 | ], |
| 8720 | "template": { # RevisionTemplateSpec describes the data a revision should have when created # Template holds the latest specification for the Revision to |
| 8721 | # be stamped out. |
| 8722 | # from a template. Based on: |
| 8723 | # https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 |
| 8724 | "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). |
| 8725 | "containerConcurrency": 42, # (Optional) |
| 8726 | # |
| 8727 | # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) |
| 8728 | # requests per container instance of the Revision. |
| 8729 | # |
| 8730 | # Cloud Run fully managed: supported, defaults to 80 |
| 8731 | # |
| 8732 | # Cloud Run for Anthos: supported, defaults to 0, which means concurrency |
| 8733 | # to the application is not limited, and the system decides the |
| 8734 | # target concurrency for the autoscaler. |
| 8735 | "timeoutSeconds": 42, # TimeoutSeconds holds the max duration the instance is allowed for |
| 8736 | # responding to a request. |
| 8737 | # Not currently used by Cloud Run. |
| 8738 | "serviceAccountName": "A String", # Email address of the IAM service account associated with the revision |
| 8739 | # of the service. The service account represents the identity of the |
| 8740 | # running revision, and determines what permissions the revision has. If |
| 8741 | # not provided, the revision will use the project's default service account. |
| 8742 | "containers": [ # Containers holds the single container that defines the unit of execution |
| 8743 | # for this Revision. In the context of a Revision, we disallow a number of |
| 8744 | # fields on this Container, including: name and lifecycle. |
| 8745 | # In Cloud Run, only a single container may be provided. |
| 8746 | # The runtime contract is documented here: |
| 8747 | # https://github.com/knative/serving/blob/master/docs/runtime-contract.md |
| 8748 | { # A single application container. |
| 8749 | # This specifies both the container to run, the command to run in the container |
| 8750 | # and the arguments to supply to it. |
| 8751 | # Note that additional arguments may be supplied by the system to the container |
| 8752 | # at runtime. |
| 8753 | "securityContext": { # Cloud Run fully managed: not supported # (Optional) |
| 8754 | # |
| 8755 | # Cloud Run fully managed: not supported |
| 8756 | # |
| 8757 | # Cloud Run for Anthos: supported |
| 8758 | # |
| 8759 | # Security options the pod should run with. |
| 8760 | # More info: https://kubernetes.io/docs/concepts/policy/security-context/ |
| 8761 | # More info: |
| 8762 | # https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| 8763 | # |
| 8764 | # Cloud Run for Anthos: supported |
| 8765 | # |
| 8766 | # SecurityContext holds security configuration that will be applied to a |
| 8767 | # container. Some fields are present in both SecurityContext and |
| 8768 | # PodSecurityContext. When both are set, the values in SecurityContext take |
| 8769 | # precedence. |
| 8770 | "runAsUser": 42, # (Optional) |
| 8771 | # |
| 8772 | # Cloud Run fully managed: not supported |
| 8773 | # |
| 8774 | # Cloud Run for Anthos: supported |
| 8775 | # |
| 8776 | # The UID to run the entrypoint of the container process. |
| 8777 | # Defaults to user specified in image metadata if unspecified. |
| 8778 | # May also be set in PodSecurityContext. If set in both SecurityContext and |
| 8779 | # PodSecurityContext, the value specified in SecurityContext takes |
| 8780 | # precedence. |
| 8781 | }, |
| 8782 | "livenessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 8783 | # |
| 8784 | # Cloud Run fully managed: not supported |
| 8785 | # |
| 8786 | # Cloud Run for Anthos: supported |
| 8787 | # |
| 8788 | # Periodic probe of container liveness. |
| 8789 | # Container will be restarted if the probe fails. |
| 8790 | # More info: |
| 8791 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 8792 | # |
| 8793 | # Cloud Run for Anthos: supported |
| 8794 | # |
| 8795 | # Probe describes a health check to be performed against a container to |
| 8796 | # determine whether it is alive or ready to receive traffic. |
| 8797 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 8798 | # |
| 8799 | # Cloud Run fully managed: not supported |
| 8800 | # |
| 8801 | # Cloud Run for Anthos: supported |
| 8802 | # |
| 8803 | # HTTPGet specifies the http request to perform. |
| 8804 | # |
| 8805 | # A field inlined from the Handler message. |
| 8806 | # |
| 8807 | # Cloud Run for Anthos: supported |
| 8808 | # |
| 8809 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 8810 | "host": "A String", # (Optional) |
| 8811 | # |
| 8812 | # Cloud Run fully managed: not supported |
| 8813 | # |
| 8814 | # Cloud Run for Anthos: supported |
| 8815 | # |
| 8816 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 8817 | # "Host" in httpHeaders instead. |
| 8818 | "scheme": "A String", # (Optional) |
| 8819 | # |
| 8820 | # Cloud Run fully managed: not supported |
| 8821 | # |
| 8822 | # Cloud Run for Anthos: supported |
| 8823 | # |
| 8824 | # Scheme to use for connecting to the host. |
| 8825 | # Defaults to HTTP. |
| 8826 | "httpHeaders": [ # (Optional) |
| 8827 | # |
| 8828 | # Cloud Run fully managed: not supported |
| 8829 | # |
| 8830 | # Cloud Run for Anthos: supported |
| 8831 | # |
| 8832 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 8833 | { # Cloud Run fully managed: not supported |
| 8834 | # |
| 8835 | # Cloud Run for Anthos: supported |
| 8836 | # |
| 8837 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 8838 | "name": "A String", # Cloud Run fully managed: not supported |
| 8839 | # |
| 8840 | # Cloud Run for Anthos: supported |
| 8841 | # |
| 8842 | # The header field name |
| 8843 | "value": "A String", # Cloud Run fully managed: not supported |
| 8844 | # |
| 8845 | # Cloud Run for Anthos: supported |
| 8846 | # |
| 8847 | # The header field value |
| 8848 | }, |
| 8849 | ], |
| 8850 | "path": "A String", # (Optional) |
| 8851 | # |
| 8852 | # Cloud Run fully managed: not supported |
| 8853 | # |
| 8854 | # Cloud Run for Anthos: supported |
| 8855 | # |
| 8856 | # Path to access on the HTTP server. |
| 8857 | }, |
| 8858 | "failureThreshold": 42, # (Optional) |
| 8859 | # |
| 8860 | # Cloud Run fully managed: not supported |
| 8861 | # |
| 8862 | # Cloud Run for Anthos: supported |
| 8863 | # |
| 8864 | # Minimum consecutive failures for the probe to be considered failed after |
| 8865 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 8866 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 8867 | # |
| 8868 | # Cloud Run fully managed: not supported |
| 8869 | # |
| 8870 | # Cloud Run for Anthos: supported |
| 8871 | # |
| 8872 | # One and only one of the following should be specified. |
| 8873 | # Exec specifies the action to take. |
| 8874 | # |
| 8875 | # A field inlined from the Handler message. |
| 8876 | # |
| 8877 | # Cloud Run for Anthos: supported |
| 8878 | # |
| 8879 | # ExecAction describes a "run in container" action. |
| 8880 | "command": "A String", # (Optional) |
| 8881 | # |
| 8882 | # Cloud Run fully managed: not supported |
| 8883 | # |
| 8884 | # Cloud Run for Anthos: supported |
| 8885 | # |
| 8886 | # Command is the command line to execute inside the container, the working |
| 8887 | # directory for the command is root ('/') in the container's filesystem. The |
| 8888 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 8889 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 8890 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 8891 | # live/healthy and non-zero is unhealthy. |
| 8892 | }, |
| 8893 | "initialDelaySeconds": 42, # (Optional) |
| 8894 | # |
| 8895 | # Cloud Run fully managed: not supported |
| 8896 | # |
| 8897 | # Cloud Run for Anthos: supported |
| 8898 | # |
| 8899 | # Number of seconds after the container has started before liveness probes |
| 8900 | # are initiated. More info: |
| 8901 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 8902 | "timeoutSeconds": 42, # (Optional) |
| 8903 | # |
| 8904 | # Cloud Run fully managed: not supported |
| 8905 | # |
| 8906 | # Cloud Run for Anthos: supported |
| 8907 | # |
| 8908 | # Number of seconds after which the probe times out. |
| 8909 | # Defaults to 1 second. Minimum value is 1. |
| 8910 | # More info: |
| 8911 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 8912 | "successThreshold": 42, # (Optional) |
| 8913 | # |
| 8914 | # Cloud Run fully managed: not supported |
| 8915 | # |
| 8916 | # Cloud Run for Anthos: supported |
| 8917 | # |
| 8918 | # Minimum consecutive successes for the probe to be considered successful |
| 8919 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 8920 | # is 1. |
| 8921 | "periodSeconds": 42, # (Optional) |
| 8922 | # |
| 8923 | # Cloud Run fully managed: not supported |
| 8924 | # |
| 8925 | # Cloud Run for Anthos: supported |
| 8926 | # |
| 8927 | # How often (in seconds) to perform the probe. |
| 8928 | # Default to 10 seconds. Minimum value is 1. |
| 8929 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 8930 | # |
| 8931 | # Cloud Run fully managed: not supported |
| 8932 | # |
| 8933 | # Cloud Run for Anthos: supported |
| 8934 | # |
| 8935 | # TCPSocket specifies an action involving a TCP port. |
| 8936 | # TCP hooks not yet supported |
| 8937 | # |
| 8938 | # A field inlined from the Handler message. |
| 8939 | # |
| 8940 | # Cloud Run for Anthos: supported |
| 8941 | # |
| 8942 | # TCPSocketAction describes an action based on opening a socket |
| 8943 | "port": 42, # Cloud Run fully managed: not supported |
| 8944 | # |
| 8945 | # Cloud Run for Anthos: supported |
| 8946 | # |
| 8947 | # Number or name of the port to access on the container. |
| 8948 | # Number must be in the range 1 to 65535. |
| 8949 | # Name must be an IANA_SVC_NAME. |
| 8950 | # |
| 8951 | # This field is currently limited to integer types only because of proto's |
| 8952 | # inability to properly support the IntOrString golang type. |
| 8953 | "host": "A String", # (Optional) |
| 8954 | # |
| 8955 | # Cloud Run fully managed: not supported |
| 8956 | # |
| 8957 | # Cloud Run for Anthos: supported |
| 8958 | # |
| 8959 | # Optional: Host name to connect to, defaults to the pod IP. |
| 8960 | }, |
| 8961 | }, |
| 8962 | "env": [ # (Optional) |
| 8963 | # |
| 8964 | # Cloud Run fully managed: supported |
| 8965 | # |
| 8966 | # Cloud Run for Anthos: supported |
| 8967 | # |
| 8968 | # List of environment variables to set in the container. |
| 8969 | { # EnvVar represents an environment variable present in a Container. |
| 8970 | "name": "A String", # Name of the environment variable. Must be a C_IDENTIFIER. |
| 8971 | "valueFrom": { # Cloud Run fully managed: not supported # (Optional) |
| 8972 | # |
| 8973 | # Cloud Run fully managed: not supported |
| 8974 | # |
| 8975 | # Cloud Run for Anthos: supported |
| 8976 | # |
| 8977 | # Source for the environment variable's value. Cannot be used if value is not |
| 8978 | # empty. |
| 8979 | # |
| 8980 | # Cloud Run for Anthos: supported |
| 8981 | # |
| 8982 | # EnvVarSource represents a source for the value of an EnvVar. |
| 8983 | "configMapKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 8984 | # |
| 8985 | # Cloud Run fully managed: not supported |
| 8986 | # |
| 8987 | # Cloud Run for Anthos: supported |
| 8988 | # |
| 8989 | # Selects a key of a ConfigMap. |
| 8990 | # |
| 8991 | # Cloud Run for Anthos: supported |
| 8992 | # |
| 8993 | # Selects a key from a ConfigMap. |
| 8994 | "optional": True or False, # (Optional) |
| 8995 | # |
| 8996 | # Cloud Run fully managed: not supported |
| 8997 | # |
| 8998 | # Cloud Run for Anthos: supported |
| 8999 | # |
| 9000 | # Specify whether the ConfigMap or its key must be defined |
| 9001 | "key": "A String", # Cloud Run fully managed: not supported |
| 9002 | # |
| 9003 | # Cloud Run for Anthos: supported |
| 9004 | # |
| 9005 | # The key to select. |
| 9006 | "name": "A String", # Cloud Run fully managed: not supported |
| 9007 | # |
| 9008 | # Cloud Run for Anthos: supported |
| 9009 | # |
| 9010 | # The ConfigMap to select from. |
| 9011 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 9012 | # directly into the message. Use the "name" field instead. |
| 9013 | # |
| 9014 | # Cloud Run for Anthos: supported |
| 9015 | # |
| 9016 | # LocalObjectReference contains enough information to let you locate the |
| 9017 | # referenced object inside the same namespace. |
| 9018 | "name": "A String", # (Optional) |
| 9019 | # |
| 9020 | # Cloud Run fully managed: not supported |
| 9021 | # |
| 9022 | # Cloud Run for Anthos: supported |
| 9023 | # |
| 9024 | # Name of the referent. |
| 9025 | # More info: |
| 9026 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 9027 | }, |
| 9028 | }, |
| 9029 | "secretKeyRef": { # Cloud Run fully managed: not supported # (Optional) |
| 9030 | # |
| 9031 | # Cloud Run fully managed: not supported |
| 9032 | # |
| 9033 | # Cloud Run for Anthos: supported |
| 9034 | # |
| 9035 | # Selects a key of a secret in the pod's namespace |
| 9036 | # |
| 9037 | # Cloud Run for Anthos: supported |
| 9038 | # |
| 9039 | # SecretKeySelector selects a key of a Secret. |
| 9040 | "key": "A String", # Cloud Run fully managed: not supported |
| 9041 | # |
| 9042 | # Cloud Run for Anthos: supported |
| 9043 | # |
| 9044 | # The key of the secret to select from. Must be a valid secret key. |
| 9045 | "name": "A String", # Cloud Run fully managed: not supported |
| 9046 | # |
| 9047 | # Cloud Run for Anthos: supported |
| 9048 | # |
| 9049 | # The name of the secret in the pod's namespace to select from. |
| 9050 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 9051 | # directly into the message. Use the "name" field instead. |
| 9052 | # |
| 9053 | # Cloud Run for Anthos: supported |
| 9054 | # |
| 9055 | # LocalObjectReference contains enough information to let you locate the |
| 9056 | # referenced object inside the same namespace. |
| 9057 | "name": "A String", # (Optional) |
| 9058 | # |
| 9059 | # Cloud Run fully managed: not supported |
| 9060 | # |
| 9061 | # Cloud Run for Anthos: supported |
| 9062 | # |
| 9063 | # Name of the referent. |
| 9064 | # More info: |
| 9065 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 9066 | }, |
| 9067 | "optional": True or False, # (Optional) |
| 9068 | # |
| 9069 | # Cloud Run fully managed: not supported |
| 9070 | # |
| 9071 | # Cloud Run for Anthos: supported |
| 9072 | # |
| 9073 | # Specify whether the Secret or its key must be defined |
| 9074 | }, |
| 9075 | }, |
| 9076 | "value": "A String", # (Optional) |
| 9077 | # |
| 9078 | # Variable references $(VAR_NAME) are expanded |
| 9079 | # using the previous defined environment variables in the container and |
| 9080 | # any route environment variables. If a variable cannot be resolved, |
| 9081 | # the reference in the input string will be unchanged. The $(VAR_NAME) |
| 9082 | # syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped |
| 9083 | # references will never be expanded, regardless of whether the variable |
| 9084 | # exists or not. |
| 9085 | # Defaults to "". |
| 9086 | }, |
| 9087 | ], |
| 9088 | "resources": { # ResourceRequirements describes the compute resource requirements. # (Optional) |
| 9089 | # |
| 9090 | # Cloud Run fully managed: supported |
| 9091 | # |
| 9092 | # Cloud Run for Anthos: supported |
| 9093 | # |
| 9094 | # Compute Resources required by this container. |
| 9095 | # More info: |
| 9096 | # https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
| 9097 | "limits": { # (Optional) |
| 9098 | # |
| 9099 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 9100 | # supported value for CPU is '1'. |
| 9101 | # |
| 9102 | # Cloud Run for Anthos: supported |
| 9103 | # |
| 9104 | # Limits describes the maximum amount of compute resources allowed. |
| 9105 | # The values of the map is string form of the 'quantity' k8s type: |
| 9106 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 9107 | "a_key": "A String", |
| 9108 | }, |
| 9109 | "requests": { # (Optional) |
| 9110 | # |
| 9111 | # Cloud Run fully managed: Only memory and CPU are supported. Note: The only |
| 9112 | # supported value for CPU is '1'. |
| 9113 | # |
| 9114 | # Cloud Run for Anthos: supported |
| 9115 | # |
| 9116 | # Requests describes the minimum amount of compute resources required. |
| 9117 | # If Requests is omitted for a container, it defaults to Limits if that is |
| 9118 | # explicitly specified, otherwise to an implementation-defined value. |
| 9119 | # The values of the map is string form of the 'quantity' k8s type: |
| 9120 | # https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
| 9121 | "a_key": "A String", |
| 9122 | }, |
| 9123 | }, |
| 9124 | "readinessProbe": { # Cloud Run fully managed: not supported # (Optional) |
| 9125 | # |
| 9126 | # Cloud Run fully managed: not supported |
| 9127 | # |
| 9128 | # Cloud Run for Anthos: supported |
| 9129 | # |
| 9130 | # Periodic probe of container service readiness. |
| 9131 | # Container will be removed from service endpoints if the probe fails. |
| 9132 | # More info: |
| 9133 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 9134 | # |
| 9135 | # Cloud Run for Anthos: supported |
| 9136 | # |
| 9137 | # Probe describes a health check to be performed against a container to |
| 9138 | # determine whether it is alive or ready to receive traffic. |
| 9139 | "httpGet": { # Cloud Run fully managed: not supported # (Optional) |
| 9140 | # |
| 9141 | # Cloud Run fully managed: not supported |
| 9142 | # |
| 9143 | # Cloud Run for Anthos: supported |
| 9144 | # |
| 9145 | # HTTPGet specifies the http request to perform. |
| 9146 | # |
| 9147 | # A field inlined from the Handler message. |
| 9148 | # |
| 9149 | # Cloud Run for Anthos: supported |
| 9150 | # |
| 9151 | # HTTPGetAction describes an action based on HTTP Get requests. |
| 9152 | "host": "A String", # (Optional) |
| 9153 | # |
| 9154 | # Cloud Run fully managed: not supported |
| 9155 | # |
| 9156 | # Cloud Run for Anthos: supported |
| 9157 | # |
| 9158 | # Host name to connect to, defaults to the pod IP. You probably want to set |
| 9159 | # "Host" in httpHeaders instead. |
| 9160 | "scheme": "A String", # (Optional) |
| 9161 | # |
| 9162 | # Cloud Run fully managed: not supported |
| 9163 | # |
| 9164 | # Cloud Run for Anthos: supported |
| 9165 | # |
| 9166 | # Scheme to use for connecting to the host. |
| 9167 | # Defaults to HTTP. |
| 9168 | "httpHeaders": [ # (Optional) |
| 9169 | # |
| 9170 | # Cloud Run fully managed: not supported |
| 9171 | # |
| 9172 | # Cloud Run for Anthos: supported |
| 9173 | # |
| 9174 | # Custom headers to set in the request. HTTP allows repeated headers. |
| 9175 | { # Cloud Run fully managed: not supported |
| 9176 | # |
| 9177 | # Cloud Run for Anthos: supported |
| 9178 | # |
| 9179 | # HTTPHeader describes a custom header to be used in HTTP probes |
| 9180 | "name": "A String", # Cloud Run fully managed: not supported |
| 9181 | # |
| 9182 | # Cloud Run for Anthos: supported |
| 9183 | # |
| 9184 | # The header field name |
| 9185 | "value": "A String", # Cloud Run fully managed: not supported |
| 9186 | # |
| 9187 | # Cloud Run for Anthos: supported |
| 9188 | # |
| 9189 | # The header field value |
| 9190 | }, |
| 9191 | ], |
| 9192 | "path": "A String", # (Optional) |
| 9193 | # |
| 9194 | # Cloud Run fully managed: not supported |
| 9195 | # |
| 9196 | # Cloud Run for Anthos: supported |
| 9197 | # |
| 9198 | # Path to access on the HTTP server. |
| 9199 | }, |
| 9200 | "failureThreshold": 42, # (Optional) |
| 9201 | # |
| 9202 | # Cloud Run fully managed: not supported |
| 9203 | # |
| 9204 | # Cloud Run for Anthos: supported |
| 9205 | # |
| 9206 | # Minimum consecutive failures for the probe to be considered failed after |
| 9207 | # having succeeded. Defaults to 3. Minimum value is 1. |
| 9208 | "exec": { # Cloud Run fully managed: not supported # (Optional) |
| 9209 | # |
| 9210 | # Cloud Run fully managed: not supported |
| 9211 | # |
| 9212 | # Cloud Run for Anthos: supported |
| 9213 | # |
| 9214 | # One and only one of the following should be specified. |
| 9215 | # Exec specifies the action to take. |
| 9216 | # |
| 9217 | # A field inlined from the Handler message. |
| 9218 | # |
| 9219 | # Cloud Run for Anthos: supported |
| 9220 | # |
| 9221 | # ExecAction describes a "run in container" action. |
| 9222 | "command": "A String", # (Optional) |
| 9223 | # |
| 9224 | # Cloud Run fully managed: not supported |
| 9225 | # |
| 9226 | # Cloud Run for Anthos: supported |
| 9227 | # |
| 9228 | # Command is the command line to execute inside the container, the working |
| 9229 | # directory for the command is root ('/') in the container's filesystem. The |
| 9230 | # command is simply exec'd, it is not run inside a shell, so traditional |
| 9231 | # shell instructions ('|', etc) won't work. To use a shell, you need to |
| 9232 | # explicitly call out to that shell. Exit status of 0 is treated as |
| 9233 | # live/healthy and non-zero is unhealthy. |
| 9234 | }, |
| 9235 | "initialDelaySeconds": 42, # (Optional) |
| 9236 | # |
| 9237 | # Cloud Run fully managed: not supported |
| 9238 | # |
| 9239 | # Cloud Run for Anthos: supported |
| 9240 | # |
| 9241 | # Number of seconds after the container has started before liveness probes |
| 9242 | # are initiated. More info: |
| 9243 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 9244 | "timeoutSeconds": 42, # (Optional) |
| 9245 | # |
| 9246 | # Cloud Run fully managed: not supported |
| 9247 | # |
| 9248 | # Cloud Run for Anthos: supported |
| 9249 | # |
| 9250 | # Number of seconds after which the probe times out. |
| 9251 | # Defaults to 1 second. Minimum value is 1. |
| 9252 | # More info: |
| 9253 | # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
| 9254 | "successThreshold": 42, # (Optional) |
| 9255 | # |
| 9256 | # Cloud Run fully managed: not supported |
| 9257 | # |
| 9258 | # Cloud Run for Anthos: supported |
| 9259 | # |
| 9260 | # Minimum consecutive successes for the probe to be considered successful |
| 9261 | # after having failed. Defaults to 1. Must be 1 for liveness. Minimum value |
| 9262 | # is 1. |
| 9263 | "periodSeconds": 42, # (Optional) |
| 9264 | # |
| 9265 | # Cloud Run fully managed: not supported |
| 9266 | # |
| 9267 | # Cloud Run for Anthos: supported |
| 9268 | # |
| 9269 | # How often (in seconds) to perform the probe. |
| 9270 | # Default to 10 seconds. Minimum value is 1. |
| 9271 | "tcpSocket": { # Cloud Run fully managed: not supported # (Optional) |
| 9272 | # |
| 9273 | # Cloud Run fully managed: not supported |
| 9274 | # |
| 9275 | # Cloud Run for Anthos: supported |
| 9276 | # |
| 9277 | # TCPSocket specifies an action involving a TCP port. |
| 9278 | # TCP hooks not yet supported |
| 9279 | # |
| 9280 | # A field inlined from the Handler message. |
| 9281 | # |
| 9282 | # Cloud Run for Anthos: supported |
| 9283 | # |
| 9284 | # TCPSocketAction describes an action based on opening a socket |
| 9285 | "port": 42, # Cloud Run fully managed: not supported |
| 9286 | # |
| 9287 | # Cloud Run for Anthos: supported |
| 9288 | # |
| 9289 | # Number or name of the port to access on the container. |
| 9290 | # Number must be in the range 1 to 65535. |
| 9291 | # Name must be an IANA_SVC_NAME. |
| 9292 | # |
| 9293 | # This field is currently limited to integer types only because of proto's |
| 9294 | # inability to properly support the IntOrString golang type. |
| 9295 | "host": "A String", # (Optional) |
| 9296 | # |
| 9297 | # Cloud Run fully managed: not supported |
| 9298 | # |
| 9299 | # Cloud Run for Anthos: supported |
| 9300 | # |
| 9301 | # Optional: Host name to connect to, defaults to the pod IP. |
| 9302 | }, |
| 9303 | }, |
| 9304 | "imagePullPolicy": "A String", # (Optional) |
| 9305 | # |
| 9306 | # Cloud Run fully managed: not supported |
| 9307 | # |
| 9308 | # Cloud Run for Anthos: supported |
| 9309 | # |
| 9310 | # Image pull policy. |
| 9311 | # One of Always, Never, IfNotPresent. |
| 9312 | # Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. |
| 9313 | # More info: |
| 9314 | # https://kubernetes.io/docs/concepts/containers/images#updating-images |
| 9315 | "terminationMessagePath": "A String", # (Optional) |
| 9316 | # |
| 9317 | # Cloud Run fully managed: not supported |
| 9318 | # |
| 9319 | # Cloud Run for Anthos: supported |
| 9320 | # |
| 9321 | # Path at which the file to which the container's termination |
| 9322 | # message will be written is mounted into the container's filesystem. Message |
| 9323 | # written is intended to be brief final status, such as an assertion failure |
| 9324 | # message. Will be truncated by the node if greater than 4096 bytes. The |
| 9325 | # total message length across all containers will be limited to 12kb. |
| 9326 | # Defaults to /dev/termination-log. |
| 9327 | "volumeMounts": [ # (Optional) |
| 9328 | # |
| 9329 | # Cloud Run fully managed: not supported |
| 9330 | # |
| 9331 | # Cloud Run for Anthos: supported |
| 9332 | # |
| 9333 | # Pod volumes to mount into the container's filesystem. |
| 9334 | { # Cloud Run fully managed: not supported |
| 9335 | # |
| 9336 | # Cloud Run for Anthos: supported |
| 9337 | # |
| 9338 | # VolumeMount describes a mounting of a Volume within a container. |
| 9339 | "mountPath": "A String", # Cloud Run fully managed: not supported |
| 9340 | # |
| 9341 | # Cloud Run for Anthos: supported |
| 9342 | # |
| 9343 | # Path within the container at which the volume should be mounted. Must |
| 9344 | # not contain ':'. |
| 9345 | "subPath": "A String", # (Optional) |
| 9346 | # |
| 9347 | # Cloud Run fully managed: not supported |
| 9348 | # |
| 9349 | # Cloud Run for Anthos: supported |
| 9350 | # |
| 9351 | # Path within the volume from which the container's volume should be mounted. |
| 9352 | # Defaults to "" (volume's root). |
| 9353 | "name": "A String", # Cloud Run fully managed: not supported |
| 9354 | # |
| 9355 | # Cloud Run for Anthos: supported |
| 9356 | # |
| 9357 | # This must match the Name of a Volume. |
| 9358 | "readOnly": True or False, # (Optional) |
| 9359 | # |
| 9360 | # Cloud Run fully managed: not supported |
| 9361 | # |
| 9362 | # Cloud Run for Anthos: supported |
| 9363 | # |
| 9364 | # Only true is accepted. |
| 9365 | # Defaults to true. |
| 9366 | }, |
| 9367 | ], |
| 9368 | "args": [ # (Optional) |
| 9369 | # |
| 9370 | # Cloud Run fully managed: supported |
| 9371 | # |
| 9372 | # Cloud Run for Anthos: supported |
| 9373 | # |
| 9374 | # Arguments to the entrypoint. |
| 9375 | # The docker image's CMD is used if this is not provided. |
| 9376 | # Variable references $(VAR_NAME) are expanded using the container's |
| 9377 | # environment. If a variable cannot be resolved, the reference in the input |
| 9378 | # string will be unchanged. The $(VAR_NAME) syntax can be escaped with a |
| 9379 | # double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, |
| 9380 | # regardless of whether the variable exists or not. |
| 9381 | # More info: |
| 9382 | # https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| 9383 | "A String", |
| 9384 | ], |
| 9385 | "workingDir": "A String", # (Optional) |
| 9386 | # |
| 9387 | # Cloud Run fully managed: not supported |
| 9388 | # |
| 9389 | # Cloud Run for Anthos: supported |
| 9390 | # |
| 9391 | # Container's working directory. |
| 9392 | # If not specified, the container runtime's default will be used, which |
| 9393 | # might be configured in the container image. |
| 9394 | "ports": [ # (Optional) |
| 9395 | # |
| 9396 | # List of ports to expose from the container. Only a single port can be |
| 9397 | # specified. The specified ports must be listening on all interfaces |
| 9398 | # (0.0.0.0) within the container to be accessible. |
| 9399 | # |
| 9400 | # If omitted, a port number will be chosen and passed to the container |
| 9401 | # through the PORT environment variable for the container to listen on. |
| 9402 | { # ContainerPort represents a network port in a single container. |
| 9403 | "containerPort": 42, # (Optional) |
| 9404 | # |
| 9405 | # Port number the container listens on. |
| 9406 | # This must be a valid port number, 0 < x < 65536. |
| 9407 | "protocol": "A String", # (Optional) |
| 9408 | # |
| 9409 | # Cloud Run fully managed: not supported |
| 9410 | # |
| 9411 | # Cloud Run for Anthos: supported |
| 9412 | # |
| 9413 | # Protocol for port. Must be "TCP". |
| 9414 | # Defaults to "TCP". |
| 9415 | "name": "A String", # (Optional) |
| 9416 | # |
| 9417 | # Cloud Run fully managed: not supported |
| 9418 | # |
| 9419 | # Cloud Run for Anthos: supported |
| 9420 | # |
| 9421 | # If specified, used to specify which protocol to use. |
| 9422 | # Allowed values are "http1" and "h2c". |
| 9423 | }, |
| 9424 | ], |
| 9425 | "image": "A String", # Cloud Run fully managed: only supports containers from Google Container |
| 9426 | # Registry |
| 9427 | # |
| 9428 | # Cloud Run for Anthos: supported |
| 9429 | # |
| 9430 | # URL of the Container image. |
| 9431 | # More info: https://kubernetes.io/docs/concepts/containers/images |
| 9432 | "envFrom": [ # (Optional) |
| 9433 | # |
| 9434 | # Cloud Run fully managed: not supported |
| 9435 | # |
| 9436 | # Cloud Run for Anthos: supported |
| 9437 | # |
| 9438 | # List of sources to populate environment variables in the container. |
| 9439 | # The keys defined within a source must be a C_IDENTIFIER. All invalid keys |
| 9440 | # will be reported as an event when the container is starting. When a key |
| 9441 | # exists in multiple sources, the value associated with the last source will |
| 9442 | # take precedence. Values defined by an Env with a duplicate key will take |
| 9443 | # precedence. Cannot be updated. |
| 9444 | { # Cloud Run fully managed: not supported |
| 9445 | # |
| 9446 | # Cloud Run for Anthos: supported |
| 9447 | # |
| 9448 | # EnvFromSource represents the source of a set of ConfigMaps |
| 9449 | "secretRef": { # Cloud Run fully managed: not supported # (Optional) |
| 9450 | # |
| 9451 | # Cloud Run fully managed: not supported |
| 9452 | # |
| 9453 | # Cloud Run for Anthos: supported |
| 9454 | # |
| 9455 | # The Secret to select from |
| 9456 | # |
| 9457 | # Cloud Run for Anthos: supported |
| 9458 | # |
| 9459 | # SecretEnvSource selects a Secret to populate the environment |
| 9460 | # variables with. |
| 9461 | # |
| 9462 | # The contents of the target Secret's Data field will represent the |
| 9463 | # key-value pairs as environment variables. |
| 9464 | "name": "A String", # Cloud Run fully managed: not supported |
| 9465 | # |
| 9466 | # Cloud Run for Anthos: supported |
| 9467 | # |
| 9468 | # The Secret to select from. |
| 9469 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 9470 | # directly into the message. Use the "name" field instead. |
| 9471 | # |
| 9472 | # Cloud Run for Anthos: supported |
| 9473 | # |
| 9474 | # LocalObjectReference contains enough information to let you locate the |
| 9475 | # referenced object inside the same namespace. |
| 9476 | "name": "A String", # (Optional) |
| 9477 | # |
| 9478 | # Cloud Run fully managed: not supported |
| 9479 | # |
| 9480 | # Cloud Run for Anthos: supported |
| 9481 | # |
| 9482 | # Name of the referent. |
| 9483 | # More info: |
| 9484 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 9485 | }, |
| 9486 | "optional": True or False, # (Optional) |
| 9487 | # |
| 9488 | # Cloud Run fully managed: not supported |
| 9489 | # |
| 9490 | # Cloud Run for Anthos: supported |
| 9491 | # |
| 9492 | # Specify whether the Secret must be defined |
| 9493 | }, |
| 9494 | "prefix": "A String", # (Optional) |
| 9495 | # |
| 9496 | # Cloud Run fully managed: not supported |
| 9497 | # |
| 9498 | # Cloud Run for Anthos: supported |
| 9499 | # |
| 9500 | # An optional identifier to prepend to each key in the ConfigMap. Must be a |
| 9501 | # C_IDENTIFIER. |
| 9502 | "configMapRef": { # Cloud Run fully managed: not supported # (Optional) |
| 9503 | # |
| 9504 | # Cloud Run fully managed: not supported |
| 9505 | # |
| 9506 | # Cloud Run for Anthos: supported |
| 9507 | # |
| 9508 | # The ConfigMap to select from |
| 9509 | # |
| 9510 | # Cloud Run for Anthos: supported |
| 9511 | # |
| 9512 | # ConfigMapEnvSource selects a ConfigMap to populate the environment |
| 9513 | # variables with. |
| 9514 | # |
| 9515 | # The contents of the target ConfigMap's Data field will represent the |
| 9516 | # key-value pairs as environment variables. |
| 9517 | "localObjectReference": { # Cloud Run fully managed: not supported # This field should not be used directly as it is meant to be inlined |
| 9518 | # directly into the message. Use the "name" field instead. |
| 9519 | # |
| 9520 | # Cloud Run for Anthos: supported |
| 9521 | # |
| 9522 | # LocalObjectReference contains enough information to let you locate the |
| 9523 | # referenced object inside the same namespace. |
| 9524 | "name": "A String", # (Optional) |
| 9525 | # |
| 9526 | # Cloud Run fully managed: not supported |
| 9527 | # |
| 9528 | # Cloud Run for Anthos: supported |
| 9529 | # |
| 9530 | # Name of the referent. |
| 9531 | # More info: |
| 9532 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 9533 | }, |
| 9534 | "optional": True or False, # (Optional) |
| 9535 | # |
| 9536 | # Cloud Run fully managed: not supported |
| 9537 | # |
| 9538 | # Cloud Run for Anthos: supported |
| 9539 | # |
| 9540 | # Specify whether the ConfigMap must be defined |
| 9541 | "name": "A String", # Cloud Run fully managed: not supported |
| 9542 | # |
| 9543 | # Cloud Run for Anthos: supported |
| 9544 | # |
| 9545 | # The ConfigMap to select from. |
| 9546 | }, |
| 9547 | }, |
| 9548 | ], |
| 9549 | "name": "A String", # (Optional) |
| 9550 | # |
| 9551 | # Name of the container specified as a DNS_LABEL. |
| 9552 | "command": [ |
| 9553 | "A String", |
| 9554 | ], |
| 9555 | "terminationMessagePolicy": "A String", # (Optional) |
| 9556 | # |
| 9557 | # Cloud Run fully managed: not supported |
| 9558 | # |
| 9559 | # Cloud Run for Anthos: supported |
| 9560 | # |
| 9561 | # Indicate how the termination message should be populated. File will use the |
| 9562 | # contents of terminationMessagePath to populate the container status message |
| 9563 | # on both success and failure. FallbackToLogsOnError will use the last chunk |
| 9564 | # of container log output if the termination message file is empty and the |
| 9565 | # container exited with an error. The log output is limited to 2048 bytes or |
| 9566 | # 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
| 9567 | }, |
| 9568 | ], |
| 9569 | "volumes": [ |
| 9570 | { # Cloud Run fully managed: not supported |
| 9571 | # |
| 9572 | # Cloud Run for Anthos: supported |
| 9573 | # |
| 9574 | # Volume represents a named volume in a container. |
| 9575 | "configMap": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| 9576 | # |
| 9577 | # Cloud Run for Anthos: supported |
| 9578 | # |
| 9579 | # Cloud Run for Anthos: supported |
| 9580 | # |
| 9581 | # Adapts a ConfigMap into a volume. |
| 9582 | # The contents of the target ConfigMap's Data field will be presented in a |
| 9583 | # volume as files using the keys in the Data field as the file names, unless |
| 9584 | # the items element is populated with specific mappings of keys to paths. |
| 9585 | "optional": True or False, # (Optional) |
| 9586 | # |
| 9587 | # Cloud Run fully managed: not supported |
| 9588 | # |
| 9589 | # Cloud Run for Anthos: supported |
| 9590 | # |
| 9591 | # Specify whether the Secret or its keys must be defined. |
| 9592 | "name": "A String", # Cloud Run fully managed: not supported |
| 9593 | # |
| 9594 | # Cloud Run for Anthos: supported |
| 9595 | # |
| 9596 | # Name of the config. |
| 9597 | "defaultMode": 42, # (Optional) |
| 9598 | # |
| 9599 | # Cloud Run fully managed: not supported |
| 9600 | # |
| 9601 | # Cloud Run for Anthos: supported |
| 9602 | # |
| 9603 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 9604 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 9605 | # this setting. This might be in conflict with other options that affect the |
| 9606 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 9607 | "items": [ # (Optional) |
| 9608 | # |
| 9609 | # Cloud Run fully managed: not supported |
| 9610 | # |
| 9611 | # Cloud Run for Anthos: supported |
| 9612 | # |
| 9613 | # If unspecified, each key-value pair in the Data field of the referenced |
| 9614 | # Secret will be projected into the volume as a file whose name is the |
| 9615 | # key and content is the value. If specified, the listed keys will be |
| 9616 | # projected into the specified paths, and unlisted keys will not be |
| 9617 | # present. If a key is specified which is not present in the Secret, |
| 9618 | # the volume setup will error unless it is marked optional. |
| 9619 | { # Cloud Run fully managed: not supported |
| 9620 | # |
| 9621 | # Cloud Run for Anthos: supported |
| 9622 | # |
| 9623 | # Maps a string key to a path within a volume. |
| 9624 | "key": "A String", # Cloud Run fully managed: not supported |
| 9625 | # |
| 9626 | # Cloud Run for Anthos: supported |
| 9627 | # |
| 9628 | # The key to project. |
| 9629 | "path": "A String", # Cloud Run fully managed: not supported |
| 9630 | # |
| 9631 | # Cloud Run for Anthos: supported |
| 9632 | # |
| 9633 | # The relative path of the file to map the key to. |
| 9634 | # May not be an absolute path. |
| 9635 | # May not contain the path element '..'. |
| 9636 | # May not start with the string '..'. |
| 9637 | "mode": 42, # (Optional) |
| 9638 | # |
| 9639 | # Cloud Run fully managed: not supported |
| 9640 | # |
| 9641 | # Cloud Run for Anthos: supported |
| 9642 | # |
| 9643 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 9644 | # specified, the volume defaultMode will be used. This might be in conflict |
| 9645 | # with other options that affect the file mode, like fsGroup, and the result |
| 9646 | # can be other mode bits set. |
| 9647 | }, |
| 9648 | ], |
| 9649 | }, |
| 9650 | "name": "A String", # Cloud Run fully managed: not supported |
| 9651 | # |
| 9652 | # Cloud Run for Anthos: supported |
| 9653 | # |
| 9654 | # Volume's name. |
| 9655 | "secret": { # Cloud Run fully managed: not supported # Cloud Run fully managed: not supported |
| 9656 | # |
| 9657 | # Cloud Run for Anthos: supported |
| 9658 | # |
| 9659 | # Cloud Run for Anthos: supported |
| 9660 | # |
| 9661 | # The contents of the target Secret's Data field will be presented in a volume |
| 9662 | # as files using the keys in the Data field as the file names. |
| 9663 | "secretName": "A String", # Cloud Run fully managed: not supported |
| 9664 | # |
| 9665 | # Cloud Run for Anthos: supported |
| 9666 | # |
| 9667 | # Name of the secret in the container's namespace to use. |
| 9668 | "items": [ # (Optional) |
| 9669 | # |
| 9670 | # Cloud Run fully managed: not supported |
| 9671 | # |
| 9672 | # Cloud Run for Anthos: supported |
| 9673 | # |
| 9674 | # If unspecified, each key-value pair in the Data field of the referenced |
| 9675 | # Secret will be projected into the volume as a file whose name is the |
| 9676 | # key and content is the value. If specified, the listed keys will be |
| 9677 | # projected into the specified paths, and unlisted keys will not be |
| 9678 | # present. If a key is specified which is not present in the Secret, |
| 9679 | # the volume setup will error unless it is marked optional. |
| 9680 | { # Cloud Run fully managed: not supported |
| 9681 | # |
| 9682 | # Cloud Run for Anthos: supported |
| 9683 | # |
| 9684 | # Maps a string key to a path within a volume. |
| 9685 | "key": "A String", # Cloud Run fully managed: not supported |
| 9686 | # |
| 9687 | # Cloud Run for Anthos: supported |
| 9688 | # |
| 9689 | # The key to project. |
| 9690 | "path": "A String", # Cloud Run fully managed: not supported |
| 9691 | # |
| 9692 | # Cloud Run for Anthos: supported |
| 9693 | # |
| 9694 | # The relative path of the file to map the key to. |
| 9695 | # May not be an absolute path. |
| 9696 | # May not contain the path element '..'. |
| 9697 | # May not start with the string '..'. |
| 9698 | "mode": 42, # (Optional) |
| 9699 | # |
| 9700 | # Cloud Run fully managed: not supported |
| 9701 | # |
| 9702 | # Cloud Run for Anthos: supported |
| 9703 | # |
| 9704 | # Mode bits to use on this file, must be a value between 0 and 0777. If not |
| 9705 | # specified, the volume defaultMode will be used. This might be in conflict |
| 9706 | # with other options that affect the file mode, like fsGroup, and the result |
| 9707 | # can be other mode bits set. |
| 9708 | }, |
| 9709 | ], |
| 9710 | "optional": True or False, # (Optional) |
| 9711 | # |
| 9712 | # Cloud Run fully managed: not supported |
| 9713 | # |
| 9714 | # Cloud Run for Anthos: supported |
| 9715 | # |
| 9716 | # Specify whether the Secret or its keys must be defined. |
| 9717 | "defaultMode": 42, # (Optional) |
| 9718 | # |
| 9719 | # Cloud Run fully managed: not supported |
| 9720 | # |
| 9721 | # Cloud Run for Anthos: supported |
| 9722 | # |
| 9723 | # Mode bits to use on created files by default. Must be a value between 0 and |
| 9724 | # 0777. Defaults to 0644. Directories within the path are not affected by |
| 9725 | # this setting. This might be in conflict with other options that affect the |
| 9726 | # file mode, like fsGroup, and the result can be other mode bits set. |
| 9727 | }, |
| 9728 | }, |
| 9729 | ], |
| 9730 | }, |
| 9731 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Optional metadata for this Revision, including labels and annotations. Name |
| 9732 | # will be generated by the Configuration. |
| 9733 | # To set minimum instances for this revision, use the |
| 9734 | # "autoscaling.knative.dev/minScale" annotation key. |
| 9735 | # To set maximum instances for this revision, use the |
| 9736 | # "autoscaling.knative.dev/maxScale" annotation key. |
| 9737 | # To set Cloud SQL connections for the revision, use the |
| 9738 | # "run.googleapis.com/cloudsql-instances" annotation key. |
| 9739 | # persisted resources must have, which includes all objects users must create. |
| 9740 | "annotations": { # (Optional) |
| 9741 | # |
| 9742 | # Annotations is an unstructured key value map stored with a resource that |
| 9743 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 9744 | # are not queryable and should be preserved when modifying objects. More |
| 9745 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 9746 | "a_key": "A String", |
| 9747 | }, |
| 9748 | "generateName": "A String", # (Optional) |
| 9749 | # |
| 9750 | # Cloud Run fully managed: not supported |
| 9751 | # |
| 9752 | # Cloud Run for Anthos: supported |
| 9753 | # |
| 9754 | # GenerateName is an optional prefix, used by the server, to generate a |
| 9755 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 9756 | # used, the name returned to the client will be different than the name |
| 9757 | # passed. This value will also be combined with a unique suffix. The provided |
| 9758 | # value has the same validation rules as the Name field, and may be truncated |
| 9759 | # by the length of the suffix required to make the value unique on the |
| 9760 | # server. |
| 9761 | # |
| 9762 | # If this field is specified and the generated name exists, the server will |
| 9763 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 9764 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 9765 | # time allotted, and the client should retry (optionally after the time |
| 9766 | # indicated in the Retry-After header). |
| 9767 | # |
| 9768 | # Applied only if Name is not specified. |
| 9769 | # More info: |
| 9770 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 9771 | # string generateName = 2; |
| 9772 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 9773 | # Is required when creating |
| 9774 | # resources, although some resources may allow a client to request the |
| 9775 | # generation of an appropriate name automatically. Name is primarily intended |
| 9776 | # for creation idempotence and configuration definition. Cannot be updated. |
| 9777 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 9778 | # +optional |
| 9779 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 9780 | # |
| 9781 | # Cloud Run fully managed: not supported |
| 9782 | # |
| 9783 | # Cloud Run for Anthos: supported |
| 9784 | # |
| 9785 | # Number of seconds allowed for this object to gracefully terminate before |
| 9786 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 9787 | # set. May only be shortened. Read-only. |
| 9788 | "clusterName": "A String", # (Optional) |
| 9789 | # |
| 9790 | # Cloud Run fully managed: not supported |
| 9791 | # |
| 9792 | # Cloud Run for Anthos: supported |
| 9793 | # |
| 9794 | # The name of the cluster which the object belongs to. |
| 9795 | # This is used to distinguish resources with same name and namespace in |
| 9796 | # different clusters. This field is not set anywhere right now and apiserver |
| 9797 | # is going to ignore it if set in create or update request. |
| 9798 | "finalizers": [ # (Optional) |
| 9799 | # |
| 9800 | # Cloud Run fully managed: not supported |
| 9801 | # |
| 9802 | # Cloud Run for Anthos: supported |
| 9803 | # |
| 9804 | # Must be empty before the object is deleted from the registry. Each entry |
| 9805 | # is an identifier for the responsible component that will remove the entry |
| 9806 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 9807 | # in this list can only be removed. |
| 9808 | # +patchStrategy=merge |
| 9809 | "A String", |
| 9810 | ], |
| 9811 | "deletionTimestamp": "A String", # (Optional) |
| 9812 | # |
| 9813 | # Cloud Run fully managed: not supported |
| 9814 | # |
| 9815 | # Cloud Run for Anthos: supported |
| 9816 | # |
| 9817 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 9818 | # deleted. This field is set by the server when a graceful deletion is |
| 9819 | # requested by the user, and is not directly settable by a client. The |
| 9820 | # resource is expected to be deleted (no longer visible from resource lists, |
| 9821 | # and not reachable by name) after the time in this field, once the |
| 9822 | # finalizers list is empty. As long as the finalizers list contains items, |
| 9823 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 9824 | # be unset or be set further into the future, although it may be shortened or |
| 9825 | # the resource may be deleted prior to this time. For example, a user may |
| 9826 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 9827 | # sending a graceful termination signal to the containers in the pod. After |
| 9828 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 9829 | # to the container and after cleanup, remove the pod from the API. In the |
| 9830 | # presence of network partitions, this object may still exist after this |
| 9831 | # timestamp, until an administrator or automated process can determine the |
| 9832 | # resource is fully terminated. |
| 9833 | # If not set, graceful deletion of the object has not been requested. |
| 9834 | # |
| 9835 | # Populated by the system when a graceful deletion is requested. |
| 9836 | # Read-only. |
| 9837 | # More info: |
| 9838 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 9839 | "ownerReferences": [ # (Optional) |
| 9840 | # |
| 9841 | # Cloud Run fully managed: not supported |
| 9842 | # |
| 9843 | # Cloud Run for Anthos: supported |
| 9844 | # |
| 9845 | # List of objects that own this object. If ALL objects in the list have |
| 9846 | # been deleted, this object will be garbage collected. |
| 9847 | { # OwnerReference contains enough information to let you identify an owning |
| 9848 | # object. Currently, an owning object must be in the same namespace, so there |
| 9849 | # is no namespace field. |
| 9850 | "controller": True or False, # If true, this reference points to the managing controller. |
| 9851 | # +optional |
| 9852 | "kind": "A String", # Kind of the referent. |
| 9853 | # More info: |
| 9854 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 9855 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 9856 | # the owner cannot be deleted from the key-value store until this |
| 9857 | # reference is removed. |
| 9858 | # Defaults to false. |
| 9859 | # To set this field, a user needs "delete" permission of the owner, |
| 9860 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 9861 | # +optional |
| 9862 | "apiVersion": "A String", # API version of the referent. |
| 9863 | "name": "A String", # Name of the referent. |
| 9864 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 9865 | "uid": "A String", # UID of the referent. |
| 9866 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 9867 | }, |
| 9868 | ], |
| 9869 | "creationTimestamp": "A String", # (Optional) |
| 9870 | # |
| 9871 | # CreationTimestamp is a timestamp representing the server time when this |
| 9872 | # object was created. It is not guaranteed to be set in happens-before order |
| 9873 | # across separate operations. Clients may not set this value. It is |
| 9874 | # represented in RFC3339 form and is in UTC. |
| 9875 | # |
| 9876 | # Populated by the system. |
| 9877 | # Read-only. |
| 9878 | # Null for lists. |
| 9879 | # More info: |
| 9880 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 9881 | "labels": { # (Optional) |
| 9882 | # |
| 9883 | # Map of string keys and values that can be used to organize and categorize |
| 9884 | # (scope and select) objects. May match selectors of replication controllers |
| 9885 | # and routes. |
| 9886 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 9887 | "a_key": "A String", |
| 9888 | }, |
| 9889 | "generation": 42, # (Optional) |
| 9890 | # |
| 9891 | # A sequence number representing a specific generation of the desired state. |
| 9892 | # Populated by the system. Read-only. |
| 9893 | "resourceVersion": "A String", # (Optional) |
| 9894 | # |
| 9895 | # An opaque value that represents the internal version of this object that |
| 9896 | # can be used by clients to determine when objects have changed. May be used |
| 9897 | # for optimistic concurrency, change detection, and the watch operation on a |
| 9898 | # resource or set of resources. Clients must treat these values as opaque and |
| 9899 | # passed unmodified back to the server. They may only be valid for a |
| 9900 | # particular resource or set of resources. |
| 9901 | # |
| 9902 | # Populated by the system. |
| 9903 | # Read-only. |
| 9904 | # Value must be treated as opaque by clients and . |
| 9905 | # More info: |
| 9906 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 9907 | "selfLink": "A String", # (Optional) |
| 9908 | # |
| 9909 | # SelfLink is a URL representing this object. |
| 9910 | # Populated by the system. |
| 9911 | # Read-only. |
| 9912 | # string selfLink = 4; |
| 9913 | "uid": "A String", # (Optional) |
| 9914 | # |
| 9915 | # UID is the unique in time and space value for this object. It is typically |
| 9916 | # generated by the server on successful creation of a resource and is not |
| 9917 | # allowed to change on PUT operations. |
| 9918 | # |
| 9919 | # Populated by the system. |
| 9920 | # Read-only. |
| 9921 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 9922 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 9923 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 9924 | # project ID or project number. |
| 9925 | }, |
| 9926 | }, |
| 9927 | }, |
| 9928 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 9929 | </div> |
| 9930 | |
| 9931 | <div class="method"> |
| 9932 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| 9933 | <pre>Sets the IAM Access control policy for the specified Service. Overwrites |
| 9934 | any existing policy. |
| 9935 | |
| 9936 | Args: |
| 9937 | resource: string, REQUIRED: The resource for which the policy is being specified. |
| 9938 | See the operation documentation for the appropriate value for this field. (required) |
| 9939 | body: object, The request body. |
| 9940 | The object takes the form of: |
| 9941 | |
| 9942 | { # Request message for `SetIamPolicy` method. |
| 9943 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| 9944 | # the policy is limited to a few 10s of KB. An empty policy is a |
| 9945 | # valid policy but certain Cloud Platform services (such as Projects) |
| 9946 | # might reject them. |
| 9947 | # controls for Google Cloud resources. |
| 9948 | # |
| 9949 | # |
| 9950 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 9951 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 9952 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 9953 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 9954 | # custom role. |
| 9955 | # |
| 9956 | # For some types of Google Cloud resources, a `binding` can also specify a |
| 9957 | # `condition`, which is a logical expression that allows access to a resource |
| 9958 | # only if the expression evaluates to `true`. A condition can add constraints |
| 9959 | # based on attributes of the request, the resource, or both. To learn which |
| 9960 | # resources support conditions in their IAM policies, see the |
| 9961 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 9962 | # |
| 9963 | # **JSON example:** |
| 9964 | # |
| 9965 | # { |
| 9966 | # "bindings": [ |
| 9967 | # { |
| 9968 | # "role": "roles/resourcemanager.organizationAdmin", |
| 9969 | # "members": [ |
| 9970 | # "user:mike@example.com", |
| 9971 | # "group:admins@example.com", |
| 9972 | # "domain:google.com", |
| 9973 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| 9974 | # ] |
| 9975 | # }, |
| 9976 | # { |
| 9977 | # "role": "roles/resourcemanager.organizationViewer", |
| 9978 | # "members": [ |
| 9979 | # "user:eve@example.com" |
| 9980 | # ], |
| 9981 | # "condition": { |
| 9982 | # "title": "expirable access", |
| 9983 | # "description": "Does not grant access after Sep 2020", |
| 9984 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| 9985 | # } |
| 9986 | # } |
| 9987 | # ], |
| 9988 | # "etag": "BwWWja0YfJA=", |
| 9989 | # "version": 3 |
| 9990 | # } |
| 9991 | # |
| 9992 | # **YAML example:** |
| 9993 | # |
| 9994 | # bindings: |
| 9995 | # - members: |
| 9996 | # - user:mike@example.com |
| 9997 | # - group:admins@example.com |
| 9998 | # - domain:google.com |
| 9999 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 10000 | # role: roles/resourcemanager.organizationAdmin |
| 10001 | # - members: |
| 10002 | # - user:eve@example.com |
| 10003 | # role: roles/resourcemanager.organizationViewer |
| 10004 | # condition: |
| 10005 | # title: expirable access |
| 10006 | # description: Does not grant access after Sep 2020 |
| 10007 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| 10008 | # - etag: BwWWja0YfJA= |
| 10009 | # - version: 3 |
| 10010 | # |
| 10011 | # For a description of IAM and its features, see the |
| 10012 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| 10013 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 10014 | # prevent simultaneous updates of a policy from overwriting each other. |
| 10015 | # It is strongly suggested that systems make use of the `etag` in the |
| 10016 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 10017 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 10018 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 10019 | # ensure that their change will be applied to the same version of the policy. |
| 10020 | # |
| 10021 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 10022 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 10023 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 10024 | # the conditions in the version `3` policy are lost. |
| 10025 | "version": 42, # Specifies the format of the policy. |
| 10026 | # |
| 10027 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 10028 | # are rejected. |
| 10029 | # |
| 10030 | # Any operation that affects conditional role bindings must specify version |
| 10031 | # `3`. This requirement applies to the following operations: |
| 10032 | # |
| 10033 | # * Getting a policy that includes a conditional role binding |
| 10034 | # * Adding a conditional role binding to a policy |
| 10035 | # * Changing a conditional role binding in a policy |
| 10036 | # * Removing any role binding, with or without a condition, from a policy |
| 10037 | # that includes conditions |
| 10038 | # |
| 10039 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 10040 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 10041 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 10042 | # the conditions in the version `3` policy are lost. |
| 10043 | # |
| 10044 | # If a policy does not include any conditions, operations on that policy may |
| 10045 | # specify any valid version or leave the field unset. |
| 10046 | # |
| 10047 | # To learn which resources support conditions in their IAM policies, see the |
| 10048 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 10049 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 10050 | { # Specifies the audit configuration for a service. |
| 10051 | # The configuration determines which permission types are logged, and what |
| 10052 | # identities, if any, are exempted from logging. |
| 10053 | # An AuditConfig must have one or more AuditLogConfigs. |
| 10054 | # |
| 10055 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 10056 | # the union of the two AuditConfigs is used for that service: the log_types |
| 10057 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 10058 | # AuditLogConfig are exempted. |
| 10059 | # |
| 10060 | # Example Policy with multiple AuditConfigs: |
| 10061 | # |
| 10062 | # { |
| 10063 | # "audit_configs": [ |
| 10064 | # { |
| 10065 | # "service": "allServices" |
| 10066 | # "audit_log_configs": [ |
| 10067 | # { |
| 10068 | # "log_type": "DATA_READ", |
| 10069 | # "exempted_members": [ |
| 10070 | # "user:jose@example.com" |
| 10071 | # ] |
| 10072 | # }, |
| 10073 | # { |
| 10074 | # "log_type": "DATA_WRITE", |
| 10075 | # }, |
| 10076 | # { |
| 10077 | # "log_type": "ADMIN_READ", |
| 10078 | # } |
| 10079 | # ] |
| 10080 | # }, |
| 10081 | # { |
| 10082 | # "service": "sampleservice.googleapis.com" |
| 10083 | # "audit_log_configs": [ |
| 10084 | # { |
| 10085 | # "log_type": "DATA_READ", |
| 10086 | # }, |
| 10087 | # { |
| 10088 | # "log_type": "DATA_WRITE", |
| 10089 | # "exempted_members": [ |
| 10090 | # "user:aliya@example.com" |
| 10091 | # ] |
| 10092 | # } |
| 10093 | # ] |
| 10094 | # } |
| 10095 | # ] |
| 10096 | # } |
| 10097 | # |
| 10098 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 10099 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 10100 | # aliya@example.com from DATA_WRITE logging. |
| 10101 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 10102 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 10103 | # `allServices` is a special value that covers all services. |
| 10104 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 10105 | { # Provides the configuration for logging a type of permissions. |
| 10106 | # Example: |
| 10107 | # |
| 10108 | # { |
| 10109 | # "audit_log_configs": [ |
| 10110 | # { |
| 10111 | # "log_type": "DATA_READ", |
| 10112 | # "exempted_members": [ |
| 10113 | # "user:jose@example.com" |
| 10114 | # ] |
| 10115 | # }, |
| 10116 | # { |
| 10117 | # "log_type": "DATA_WRITE", |
| 10118 | # } |
| 10119 | # ] |
| 10120 | # } |
| 10121 | # |
| 10122 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 10123 | # jose@example.com from DATA_READ logging. |
| 10124 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 10125 | # permission. |
| 10126 | # Follows the same format of Binding.members. |
| 10127 | "A String", |
| 10128 | ], |
| 10129 | "logType": "A String", # The log type that this config enables. |
| 10130 | }, |
| 10131 | ], |
| 10132 | }, |
| 10133 | ], |
| 10134 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| 10135 | # `condition` that determines how and when the `bindings` are applied. Each |
| 10136 | # of the `bindings` must contain at least one member. |
| 10137 | { # Associates `members` with a `role`. |
| 10138 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 10139 | # |
| 10140 | # If the condition evaluates to `true`, then this binding applies to the |
| 10141 | # current request. |
| 10142 | # |
| 10143 | # If the condition evaluates to `false`, then this binding does not apply to |
| 10144 | # the current request. However, a different role binding might grant the same |
| 10145 | # role to one or more of the members in this binding. |
| 10146 | # |
| 10147 | # To learn which resources support conditions in their IAM policies, see the |
| 10148 | # [IAM |
| 10149 | # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 10150 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 10151 | # are documented at https://github.com/google/cel-spec. |
| 10152 | # |
| 10153 | # Example (Comparison): |
| 10154 | # |
| 10155 | # title: "Summary size limit" |
| 10156 | # description: "Determines if a summary is less than 100 chars" |
| 10157 | # expression: "document.summary.size() < 100" |
| 10158 | # |
| 10159 | # Example (Equality): |
| 10160 | # |
| 10161 | # title: "Requestor is owner" |
| 10162 | # description: "Determines if requestor is the document owner" |
| 10163 | # expression: "document.owner == request.auth.claims.email" |
| 10164 | # |
| 10165 | # Example (Logic): |
| 10166 | # |
| 10167 | # title: "Public documents" |
| 10168 | # description: "Determine whether the document should be publicly visible" |
| 10169 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 10170 | # |
| 10171 | # Example (Data Manipulation): |
| 10172 | # |
| 10173 | # title: "Notification string" |
| 10174 | # description: "Create a notification string with a timestamp." |
| 10175 | # expression: "'New message received at ' + string(document.create_time)" |
| 10176 | # |
| 10177 | # The exact variables and functions that may be referenced within an expression |
| 10178 | # are determined by the service that evaluates it. See the service |
| 10179 | # documentation for additional information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10180 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 10181 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 10182 | # expression. |
| 10183 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 10184 | # reporting, e.g. a file name and a position in the file. |
| 10185 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 10186 | # describes the expression, e.g. when hovered over it in a UI. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 10187 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 10188 | # syntax. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10189 | }, |
| 10190 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 10191 | # `members` can have the following values: |
| 10192 | # |
| 10193 | # * `allUsers`: A special identifier that represents anyone who is |
| 10194 | # on the internet; with or without a Google account. |
| 10195 | # |
| 10196 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 10197 | # who is authenticated with a Google account or a service account. |
| 10198 | # |
| 10199 | # * `user:{emailid}`: An email address that represents a specific Google |
| 10200 | # account. For example, `alice@example.com` . |
| 10201 | # |
| 10202 | # |
| 10203 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 10204 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 10205 | # |
| 10206 | # * `group:{emailid}`: An email address that represents a Google group. |
| 10207 | # For example, `admins@example.com`. |
| 10208 | # |
| 10209 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 10210 | # identifier) representing a user that has been recently deleted. For |
| 10211 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 10212 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 10213 | # retains the role in the binding. |
| 10214 | # |
| 10215 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 10216 | # unique identifier) representing a service account that has been recently |
| 10217 | # deleted. For example, |
| 10218 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 10219 | # If the service account is undeleted, this value reverts to |
| 10220 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 10221 | # role in the binding. |
| 10222 | # |
| 10223 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 10224 | # identifier) representing a Google group that has been recently |
| 10225 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 10226 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 10227 | # recovered group retains the role in the binding. |
| 10228 | # |
| 10229 | # |
| 10230 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 10231 | # users of that domain. For example, `google.com` or `example.com`. |
| 10232 | # |
| 10233 | "A String", |
| 10234 | ], |
| 10235 | "role": "A String", # Role that is assigned to `members`. |
| 10236 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 10237 | }, |
| 10238 | ], |
| 10239 | }, |
| 10240 | "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only |
| 10241 | # the fields in the mask will be modified. If no mask is provided, the |
| 10242 | # following default mask is used: |
| 10243 | # |
| 10244 | # `paths: "bindings, etag"` |
| 10245 | } |
| 10246 | |
| 10247 | x__xgafv: string, V1 error format. |
| 10248 | Allowed values |
| 10249 | 1 - v1 error format |
| 10250 | 2 - v2 error format |
| 10251 | |
| 10252 | Returns: |
| 10253 | An object of the form: |
| 10254 | |
| 10255 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 10256 | # controls for Google Cloud resources. |
| 10257 | # |
| 10258 | # |
| 10259 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 10260 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 10261 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 10262 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 10263 | # custom role. |
| 10264 | # |
| 10265 | # For some types of Google Cloud resources, a `binding` can also specify a |
| 10266 | # `condition`, which is a logical expression that allows access to a resource |
| 10267 | # only if the expression evaluates to `true`. A condition can add constraints |
| 10268 | # based on attributes of the request, the resource, or both. To learn which |
| 10269 | # resources support conditions in their IAM policies, see the |
| 10270 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 10271 | # |
| 10272 | # **JSON example:** |
| 10273 | # |
| 10274 | # { |
| 10275 | # "bindings": [ |
| 10276 | # { |
| 10277 | # "role": "roles/resourcemanager.organizationAdmin", |
| 10278 | # "members": [ |
| 10279 | # "user:mike@example.com", |
| 10280 | # "group:admins@example.com", |
| 10281 | # "domain:google.com", |
| 10282 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| 10283 | # ] |
| 10284 | # }, |
| 10285 | # { |
| 10286 | # "role": "roles/resourcemanager.organizationViewer", |
| 10287 | # "members": [ |
| 10288 | # "user:eve@example.com" |
| 10289 | # ], |
| 10290 | # "condition": { |
| 10291 | # "title": "expirable access", |
| 10292 | # "description": "Does not grant access after Sep 2020", |
| 10293 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| 10294 | # } |
| 10295 | # } |
| 10296 | # ], |
| 10297 | # "etag": "BwWWja0YfJA=", |
| 10298 | # "version": 3 |
| 10299 | # } |
| 10300 | # |
| 10301 | # **YAML example:** |
| 10302 | # |
| 10303 | # bindings: |
| 10304 | # - members: |
| 10305 | # - user:mike@example.com |
| 10306 | # - group:admins@example.com |
| 10307 | # - domain:google.com |
| 10308 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 10309 | # role: roles/resourcemanager.organizationAdmin |
| 10310 | # - members: |
| 10311 | # - user:eve@example.com |
| 10312 | # role: roles/resourcemanager.organizationViewer |
| 10313 | # condition: |
| 10314 | # title: expirable access |
| 10315 | # description: Does not grant access after Sep 2020 |
| 10316 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| 10317 | # - etag: BwWWja0YfJA= |
| 10318 | # - version: 3 |
| 10319 | # |
| 10320 | # For a description of IAM and its features, see the |
| 10321 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| 10322 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 10323 | # prevent simultaneous updates of a policy from overwriting each other. |
| 10324 | # It is strongly suggested that systems make use of the `etag` in the |
| 10325 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 10326 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 10327 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 10328 | # ensure that their change will be applied to the same version of the policy. |
| 10329 | # |
| 10330 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 10331 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 10332 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 10333 | # the conditions in the version `3` policy are lost. |
| 10334 | "version": 42, # Specifies the format of the policy. |
| 10335 | # |
| 10336 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 10337 | # are rejected. |
| 10338 | # |
| 10339 | # Any operation that affects conditional role bindings must specify version |
| 10340 | # `3`. This requirement applies to the following operations: |
| 10341 | # |
| 10342 | # * Getting a policy that includes a conditional role binding |
| 10343 | # * Adding a conditional role binding to a policy |
| 10344 | # * Changing a conditional role binding in a policy |
| 10345 | # * Removing any role binding, with or without a condition, from a policy |
| 10346 | # that includes conditions |
| 10347 | # |
| 10348 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 10349 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 10350 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 10351 | # the conditions in the version `3` policy are lost. |
| 10352 | # |
| 10353 | # If a policy does not include any conditions, operations on that policy may |
| 10354 | # specify any valid version or leave the field unset. |
| 10355 | # |
| 10356 | # To learn which resources support conditions in their IAM policies, see the |
| 10357 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 10358 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 10359 | { # Specifies the audit configuration for a service. |
| 10360 | # The configuration determines which permission types are logged, and what |
| 10361 | # identities, if any, are exempted from logging. |
| 10362 | # An AuditConfig must have one or more AuditLogConfigs. |
| 10363 | # |
| 10364 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 10365 | # the union of the two AuditConfigs is used for that service: the log_types |
| 10366 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 10367 | # AuditLogConfig are exempted. |
| 10368 | # |
| 10369 | # Example Policy with multiple AuditConfigs: |
| 10370 | # |
| 10371 | # { |
| 10372 | # "audit_configs": [ |
| 10373 | # { |
| 10374 | # "service": "allServices" |
| 10375 | # "audit_log_configs": [ |
| 10376 | # { |
| 10377 | # "log_type": "DATA_READ", |
| 10378 | # "exempted_members": [ |
| 10379 | # "user:jose@example.com" |
| 10380 | # ] |
| 10381 | # }, |
| 10382 | # { |
| 10383 | # "log_type": "DATA_WRITE", |
| 10384 | # }, |
| 10385 | # { |
| 10386 | # "log_type": "ADMIN_READ", |
| 10387 | # } |
| 10388 | # ] |
| 10389 | # }, |
| 10390 | # { |
| 10391 | # "service": "sampleservice.googleapis.com" |
| 10392 | # "audit_log_configs": [ |
| 10393 | # { |
| 10394 | # "log_type": "DATA_READ", |
| 10395 | # }, |
| 10396 | # { |
| 10397 | # "log_type": "DATA_WRITE", |
| 10398 | # "exempted_members": [ |
| 10399 | # "user:aliya@example.com" |
| 10400 | # ] |
| 10401 | # } |
| 10402 | # ] |
| 10403 | # } |
| 10404 | # ] |
| 10405 | # } |
| 10406 | # |
| 10407 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 10408 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 10409 | # aliya@example.com from DATA_WRITE logging. |
| 10410 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 10411 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 10412 | # `allServices` is a special value that covers all services. |
| 10413 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 10414 | { # Provides the configuration for logging a type of permissions. |
| 10415 | # Example: |
| 10416 | # |
| 10417 | # { |
| 10418 | # "audit_log_configs": [ |
| 10419 | # { |
| 10420 | # "log_type": "DATA_READ", |
| 10421 | # "exempted_members": [ |
| 10422 | # "user:jose@example.com" |
| 10423 | # ] |
| 10424 | # }, |
| 10425 | # { |
| 10426 | # "log_type": "DATA_WRITE", |
| 10427 | # } |
| 10428 | # ] |
| 10429 | # } |
| 10430 | # |
| 10431 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 10432 | # jose@example.com from DATA_READ logging. |
| 10433 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 10434 | # permission. |
| 10435 | # Follows the same format of Binding.members. |
| 10436 | "A String", |
| 10437 | ], |
| 10438 | "logType": "A String", # The log type that this config enables. |
| 10439 | }, |
| 10440 | ], |
| 10441 | }, |
| 10442 | ], |
| 10443 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| 10444 | # `condition` that determines how and when the `bindings` are applied. Each |
| 10445 | # of the `bindings` must contain at least one member. |
| 10446 | { # Associates `members` with a `role`. |
| 10447 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 10448 | # |
| 10449 | # If the condition evaluates to `true`, then this binding applies to the |
| 10450 | # current request. |
| 10451 | # |
| 10452 | # If the condition evaluates to `false`, then this binding does not apply to |
| 10453 | # the current request. However, a different role binding might grant the same |
| 10454 | # role to one or more of the members in this binding. |
| 10455 | # |
| 10456 | # To learn which resources support conditions in their IAM policies, see the |
| 10457 | # [IAM |
| 10458 | # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 10459 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 10460 | # are documented at https://github.com/google/cel-spec. |
| 10461 | # |
| 10462 | # Example (Comparison): |
| 10463 | # |
| 10464 | # title: "Summary size limit" |
| 10465 | # description: "Determines if a summary is less than 100 chars" |
| 10466 | # expression: "document.summary.size() < 100" |
| 10467 | # |
| 10468 | # Example (Equality): |
| 10469 | # |
| 10470 | # title: "Requestor is owner" |
| 10471 | # description: "Determines if requestor is the document owner" |
| 10472 | # expression: "document.owner == request.auth.claims.email" |
| 10473 | # |
| 10474 | # Example (Logic): |
| 10475 | # |
| 10476 | # title: "Public documents" |
| 10477 | # description: "Determine whether the document should be publicly visible" |
| 10478 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 10479 | # |
| 10480 | # Example (Data Manipulation): |
| 10481 | # |
| 10482 | # title: "Notification string" |
| 10483 | # description: "Create a notification string with a timestamp." |
| 10484 | # expression: "'New message received at ' + string(document.create_time)" |
| 10485 | # |
| 10486 | # The exact variables and functions that may be referenced within an expression |
| 10487 | # are determined by the service that evaluates it. See the service |
| 10488 | # documentation for additional information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10489 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 10490 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 10491 | # expression. |
| 10492 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 10493 | # reporting, e.g. a file name and a position in the file. |
| 10494 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 10495 | # describes the expression, e.g. when hovered over it in a UI. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 10496 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 10497 | # syntax. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 10498 | }, |
| 10499 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 10500 | # `members` can have the following values: |
| 10501 | # |
| 10502 | # * `allUsers`: A special identifier that represents anyone who is |
| 10503 | # on the internet; with or without a Google account. |
| 10504 | # |
| 10505 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 10506 | # who is authenticated with a Google account or a service account. |
| 10507 | # |
| 10508 | # * `user:{emailid}`: An email address that represents a specific Google |
| 10509 | # account. For example, `alice@example.com` . |
| 10510 | # |
| 10511 | # |
| 10512 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 10513 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 10514 | # |
| 10515 | # * `group:{emailid}`: An email address that represents a Google group. |
| 10516 | # For example, `admins@example.com`. |
| 10517 | # |
| 10518 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 10519 | # identifier) representing a user that has been recently deleted. For |
| 10520 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 10521 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 10522 | # retains the role in the binding. |
| 10523 | # |
| 10524 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 10525 | # unique identifier) representing a service account that has been recently |
| 10526 | # deleted. For example, |
| 10527 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 10528 | # If the service account is undeleted, this value reverts to |
| 10529 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 10530 | # role in the binding. |
| 10531 | # |
| 10532 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 10533 | # identifier) representing a Google group that has been recently |
| 10534 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 10535 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 10536 | # recovered group retains the role in the binding. |
| 10537 | # |
| 10538 | # |
| 10539 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 10540 | # users of that domain. For example, `google.com` or `example.com`. |
| 10541 | # |
| 10542 | "A String", |
| 10543 | ], |
| 10544 | "role": "A String", # Role that is assigned to `members`. |
| 10545 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 10546 | }, |
| 10547 | ], |
| 10548 | }</pre> |
| 10549 | </div> |
| 10550 | |
| 10551 | <div class="method"> |
| 10552 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| 10553 | <pre>Returns permissions that a caller has on the specified Project. |
| 10554 | |
| 10555 | There are no permissions required for making this API call. |
| 10556 | |
| 10557 | Args: |
| 10558 | resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| 10559 | See the operation documentation for the appropriate value for this field. (required) |
| 10560 | body: object, The request body. |
| 10561 | The object takes the form of: |
| 10562 | |
| 10563 | { # Request message for `TestIamPermissions` method. |
| 10564 | "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| 10565 | # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| 10566 | # information see |
| 10567 | # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| 10568 | "A String", |
| 10569 | ], |
| 10570 | } |
| 10571 | |
| 10572 | x__xgafv: string, V1 error format. |
| 10573 | Allowed values |
| 10574 | 1 - v1 error format |
| 10575 | 2 - v2 error format |
| 10576 | |
| 10577 | Returns: |
| 10578 | An object of the form: |
| 10579 | |
| 10580 | { # Response message for `TestIamPermissions` method. |
| 10581 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| 10582 | # allowed. |
| 10583 | "A String", |
| 10584 | ], |
| 10585 | }</pre> |
| 10586 | </div> |
| 10587 | |
| 10588 | </body></html> |