-
Notifications
You must be signed in to change notification settings - Fork 215
/
appengine_v1alpha1_appengineflexibleappversion.yaml
713 lines (706 loc) · 34.5 KB
/
appengine_v1alpha1_appengineflexibleappversion.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
cnrm.cloud.google.com/version: 1.122.0
creationTimestamp: null
labels:
cnrm.cloud.google.com/managed-by-kcc: "true"
cnrm.cloud.google.com/stability-level: alpha
cnrm.cloud.google.com/system: "true"
cnrm.cloud.google.com/tf2crd: "true"
name: appengineflexibleappversions.appengine.cnrm.cloud.google.com
spec:
group: appengine.cnrm.cloud.google.com
names:
categories:
- gcp
kind: AppEngineFlexibleAppVersion
plural: appengineflexibleappversions
shortNames:
- gcpappengineflexibleappversion
- gcpappengineflexibleappversions
singular: appengineflexibleappversion
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
- description: When 'True', the most recent reconcile of the resource succeeded
jsonPath: .status.conditions[?(@.type=='Ready')].status
name: Ready
type: string
- description: The reason for the value in 'Ready'
jsonPath: .status.conditions[?(@.type=='Ready')].reason
name: Status
type: string
- description: The last transition time for the value in 'Status'
jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
name: Status Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
properties:
apiVersion:
description: 'apiVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
type: string
kind:
description: 'kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
properties:
apiConfig:
description: Serving configuration for Google Cloud Endpoints.
properties:
authFailAction:
description: 'Action to take when users access resources that
require authentication. Default value: "AUTH_FAIL_ACTION_REDIRECT"
Possible values: ["AUTH_FAIL_ACTION_REDIRECT", "AUTH_FAIL_ACTION_UNAUTHORIZED"].'
type: string
login:
description: 'Level of login required to access this resource.
Default value: "LOGIN_OPTIONAL" Possible values: ["LOGIN_OPTIONAL",
"LOGIN_ADMIN", "LOGIN_REQUIRED"].'
type: string
script:
description: Path to the script from the application root directory.
type: string
securityLevel:
description: 'Security (HTTPS) enforcement for this URL. Possible
values: ["SECURE_DEFAULT", "SECURE_NEVER", "SECURE_OPTIONAL",
"SECURE_ALWAYS"].'
type: string
url:
description: URL to serve the endpoint at.
type: string
required:
- script
type: object
automaticScaling:
description: Automatic scaling is based on request rate, response
latencies, and other application metrics.
properties:
coolDownPeriod:
description: |-
The time period that the Autoscaler should wait before it starts collecting information from a new instance.
This prevents the autoscaler from collecting information when the instance is initializing,
during which the collected usage would not be reliable. Default: 120s.
type: string
cpuUtilization:
description: Target scaling by CPU usage.
properties:
aggregationWindowLength:
description: Period of time over which CPU utilization is
calculated.
type: string
targetUtilization:
description: Target CPU utilization ratio to maintain when
scaling. Must be between 0 and 1.
type: number
required:
- targetUtilization
type: object
diskUtilization:
description: Target scaling by disk usage.
properties:
targetReadBytesPerSecond:
description: Target bytes read per second.
type: integer
targetReadOpsPerSecond:
description: Target ops read per seconds.
type: integer
targetWriteBytesPerSecond:
description: Target bytes written per second.
type: integer
targetWriteOpsPerSecond:
description: Target ops written per second.
type: integer
type: object
maxConcurrentRequests:
description: |-
Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.
Defaults to a runtime-specific value.
type: integer
maxIdleInstances:
description: Maximum number of idle instances that should be maintained
for this version.
type: integer
maxPendingLatency:
description: Maximum amount of time that a request should wait
in the pending queue before starting a new instance to handle
it.
type: string
maxTotalInstances:
description: 'Maximum number of instances that should be started
to handle requests for this version. Default: 20.'
type: integer
minIdleInstances:
description: Minimum number of idle instances that should be maintained
for this version. Only applicable for the default version of
a service.
type: integer
minPendingLatency:
description: Minimum amount of time a request should wait in the
pending queue before starting a new instance to handle it.
type: string
minTotalInstances:
description: 'Minimum number of running instances that should
be maintained for this version. Default: 2.'
type: integer
networkUtilization:
description: Target scaling by network usage.
properties:
targetReceivedBytesPerSecond:
description: Target bytes received per second.
type: integer
targetReceivedPacketsPerSecond:
description: Target packets received per second.
type: integer
targetSentBytesPerSecond:
description: Target bytes sent per second.
type: integer
targetSentPacketsPerSecond:
description: Target packets sent per second.
type: integer
type: object
requestUtilization:
description: Target scaling by request utilization.
properties:
targetConcurrentRequests:
description: Target number of concurrent requests.
type: number
targetRequestCountPerSecond:
description: Target requests per second.
type: string
type: object
required:
- cpuUtilization
type: object
betaSettings:
additionalProperties:
type: string
description: Metadata settings that are supplied to this version to
enable beta runtime features.
type: object
defaultExpiration:
description: |-
Duration that static files should be cached by web proxies and browsers.
Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
type: string
deleteServiceOnDestroy:
description: If set to 'true', the service will be deleted if it is
the last version.
type: boolean
deployment:
description: Code and application artifacts that make up this version.
properties:
cloudBuildOptions:
description: Options for the build operations performed as a part
of the version deployment. Only applicable when creating a version
using source code directly.
properties:
appYamlPath:
description: Path to the yaml file used in deployment, used
to determine runtime configuration details.
type: string
cloudBuildTimeout:
description: |-
The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
type: string
required:
- appYamlPath
type: object
container:
description: The Docker image for the container that runs the
version.
properties:
image:
description: |-
URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest.
Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest".
type: string
required:
- image
type: object
files:
description: |-
Manifest of the files stored in Google Cloud Storage that are included as part of this version.
All files must be readable using the credentials supplied with this call.
items:
properties:
name:
type: string
sha1Sum:
description: SHA1 checksum of the file.
type: string
sourceUrl:
description: Source URL.
type: string
required:
- name
- sourceUrl
type: object
type: array
zip:
description: Zip File.
properties:
filesCount:
description: files count.
type: integer
sourceUrl:
description: Source URL.
type: string
required:
- sourceUrl
type: object
type: object
endpointsApiService:
description: Code and application artifacts that make up this version.
properties:
configId:
description: |-
Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".
By default, the rollout strategy for Endpoints is "FIXED". This means that Endpoints starts up with a particular configuration ID.
When a new configuration is rolled out, Endpoints must be given the new configuration ID. The configId field is used to give the configuration ID
and is required in this case.
Endpoints also has a rollout strategy called "MANAGED". When using this, Endpoints fetches the latest configuration and does not need
the configuration ID. In this case, configId must be omitted.
type: string
disableTraceSampling:
description: Enable or disable trace sampling. By default, this
is set to false for enabled.
type: boolean
name:
description: |-
Endpoints service name which is the name of the "service" resource in the Service Management API.
For example "myapi.endpoints.myproject.cloud.goog".
type: string
rolloutStrategy:
description: 'Endpoints rollout strategy. If FIXED, configId must
be specified. If MANAGED, configId must be omitted. Default
value: "FIXED" Possible values: ["FIXED", "MANAGED"].'
type: string
required:
- name
type: object
entrypoint:
description: The entrypoint for the application.
properties:
shell:
description: The format should be a shell command that can be
fed to bash -c.
type: string
required:
- shell
type: object
envVariables:
additionalProperties:
type: string
type: object
handlers:
description: |-
An ordered list of URL-matching patterns that should be applied to incoming requests.
The first matching URL handles the request and other request handlers are not attempted.
items:
properties:
authFailAction:
description: 'Actions to take when the user is not logged in.
Possible values: ["AUTH_FAIL_ACTION_REDIRECT", "AUTH_FAIL_ACTION_UNAUTHORIZED"].'
type: string
login:
description: 'Methods to restrict access to a URL based on login
status. Possible values: ["LOGIN_OPTIONAL", "LOGIN_ADMIN",
"LOGIN_REQUIRED"].'
type: string
redirectHttpResponseCode:
description: '30x code to use when performing redirects for
the secure field. Possible values: ["REDIRECT_HTTP_RESPONSE_CODE_301",
"REDIRECT_HTTP_RESPONSE_CODE_302", "REDIRECT_HTTP_RESPONSE_CODE_303",
"REDIRECT_HTTP_RESPONSE_CODE_307"].'
type: string
script:
description: |-
Executes a script to handle the requests that match this URL pattern.
Only the auto value is supported for Node.js in the App Engine standard environment, for example "script:" "auto".
properties:
scriptPath:
description: Path to the script from the application root
directory.
type: string
required:
- scriptPath
type: object
securityLevel:
description: 'Security (HTTPS) enforcement for this URL. Possible
values: ["SECURE_DEFAULT", "SECURE_NEVER", "SECURE_OPTIONAL",
"SECURE_ALWAYS"].'
type: string
staticFiles:
description: |-
Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files.
Static file handlers describe which files in the application directory are static files, and which URLs serve them.
properties:
applicationReadable:
description: |-
Whether files should also be uploaded as code data. By default, files declared in static file handlers are
uploaded as static data and are only served to end users; they cannot be read by the application. If enabled,
uploads are charged against both your code and static data storage resource quotas.
type: boolean
expiration:
description: |-
Time a static file served by this handler should be cached by web proxies and browsers.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example "3.5s".
Default is '0s'.
type: string
httpHeaders:
additionalProperties:
type: string
description: |-
HTTP headers to use for all responses from these URLs.
An object containing a list of "key:value" value pairs.".
type: object
mimeType:
description: |-
MIME type used to serve all files served by this handler.
Defaults to file-specific MIME types, which are derived from each file's filename extension.
type: string
path:
description: |-
Path to the static files matched by the URL pattern, from the application root directory.
The path can refer to text matched in groupings in the URL pattern.
type: string
requireMatchingFile:
description: Whether this handler should match the request
if the file referenced by the handler does not exist.
type: boolean
uploadPathRegex:
description: Regular expression that matches the file paths
for all files that should be referenced by this handler.
type: string
type: object
urlRegex:
description: |-
URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings.
All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
type: string
type: object
type: array
inboundServices:
description: 'A list of the types of messages that this application
is able to receive. Possible values: ["INBOUND_SERVICE_MAIL", "INBOUND_SERVICE_MAIL_BOUNCE",
"INBOUND_SERVICE_XMPP_ERROR", "INBOUND_SERVICE_XMPP_MESSAGE", "INBOUND_SERVICE_XMPP_SUBSCRIBE",
"INBOUND_SERVICE_XMPP_PRESENCE", "INBOUND_SERVICE_CHANNEL_PRESENCE",
"INBOUND_SERVICE_WARMUP"].'
items:
type: string
type: array
instanceClass:
description: |-
Instance class that is used to run this version. Valid values are
AutomaticScaling: F1, F2, F4, F4_1G
ManualScaling: B1, B2, B4, B8, B4_1G
Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
type: string
livenessCheck:
description: Health checking configuration for VM instances. Unhealthy
instances are killed and replaced with new instances.
properties:
checkInterval:
description: Interval between health checks.
type: string
failureThreshold:
description: 'Number of consecutive failed checks required before
considering the VM unhealthy. Default: 4.'
type: number
host:
description: 'Host header to send when performing a HTTP Readiness
check. Example: "myapp.appspot.com".'
type: string
initialDelay:
description: 'The initial delay before starting to execute the
checks. Default: "300s".'
type: string
path:
description: The request path.
type: string
successThreshold:
description: 'Number of consecutive successful checks required
before considering the VM healthy. Default: 2.'
type: number
timeout:
description: 'Time before the check is considered failed. Default:
"4s".'
type: string
required:
- path
type: object
manualScaling:
description: A service with manual scaling runs continuously, allowing
you to perform complex initialization and rely on the state of its
memory over time.
properties:
instances:
description: |-
Number of instances to assign to the service at the start.
**Note:** When managing the number of instances at runtime through the App Engine Admin API or the (now deprecated) Python 2
Modules API set_num_instances() you must use 'lifecycle.ignore_changes = ["manual_scaling"[0].instances]' to prevent drift detection.
type: integer
required:
- instances
type: object
network:
description: Extra network settings.
properties:
forwardedPorts:
description: List of ports, or port pairs, to forward from the
virtual machine to the application container.
items:
type: string
type: array
instanceTag:
description: Tag to apply to the instance during creation.
type: string
name:
description: Google Compute Engine network where the virtual machines
are created. Specify the short name, not the resource path.
type: string
sessionAffinity:
description: Enable session affinity.
type: boolean
subnetwork:
description: |-
Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.
If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetworkName) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetworkName must be specified and the IP address is created from the IPCidrRange of the subnetwork.
If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
type: string
required:
- name
type: object
nobuildFilesRegex:
description: Files that match this pattern will not be built into
this version. Only applicable for Go runtimes.
type: string
noopOnDestroy:
description: If set to 'true', the application version will not be
deleted.
type: boolean
project:
description: Immutable.
type: string
readinessCheck:
description: Configures readiness health checking for instances. Unhealthy
instances are not put into the backend traffic rotation.
properties:
appStartTimeout:
description: |-
A maximum time limit on application initialization, measured from moment the application successfully
replies to a healthcheck until it is ready to serve traffic. Default: "300s".
type: string
checkInterval:
description: 'Interval between health checks. Default: "5s".'
type: string
failureThreshold:
description: 'Number of consecutive failed checks required before
removing traffic. Default: 2.'
type: number
host:
description: 'Host header to send when performing a HTTP Readiness
check. Example: "myapp.appspot.com".'
type: string
path:
description: The request path.
type: string
successThreshold:
description: 'Number of consecutive successful checks required
before receiving traffic. Default: 2.'
type: number
timeout:
description: 'Time before the check is considered failed. Default:
"4s".'
type: string
required:
- path
type: object
resourceID:
description: Immutable. Optional. The versionId of the resource. Used
for creation and acquisition. When unset, the value of `metadata.name`
is used as the default.
type: string
resources:
description: Machine resources for a version.
properties:
cpu:
description: Number of CPU cores needed.
type: integer
diskGb:
description: Disk size (GB) needed.
type: integer
memoryGb:
description: Memory (GB) needed.
type: number
volumes:
description: List of ports, or port pairs, to forward from the
virtual machine to the application container.
items:
properties:
name:
description: Unique name for the volume.
type: string
sizeGb:
description: Volume size in gigabytes.
type: integer
volumeType:
description: Underlying volume type, e.g. 'tmpfs'.
type: string
required:
- name
- sizeGb
- volumeType
type: object
type: array
type: object
runtime:
description: Desired runtime. Example python27.
type: string
runtimeApiVersion:
description: |-
The version of the API in the given runtime environment.
Please see the app.yaml reference for valid values at 'https://cloud.google.com/appengine/docs/standard/<language>/config/appref'\
Substitute '<language>' with 'python', 'java', 'php', 'ruby', 'go' or 'nodejs'.
type: string
runtimeChannel:
description: The channel of the runtime to use. Only available for
some runtimes.
type: string
runtimeMainExecutablePath:
description: The path or name of the app's main executable.
type: string
serviceAccount:
description: |-
The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as
default if this field is neither provided in app.yaml file nor through CLI flag.
type: string
serviceRef:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `name` field of an `AppEngineService`
resource.'
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
servingStatus:
description: 'Current serving status of this version. Only the versions
with a SERVING status create instances and can be billed. Default
value: "SERVING" Possible values: ["SERVING", "STOPPED"].'
type: string
vpcAccessConnector:
description: Enables VPC connectivity for standard apps.
properties:
name:
description: Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
type: string
required:
- name
type: object
required:
- livenessCheck
- readinessCheck
- runtime
- serviceRef
type: object
status:
properties:
conditions:
description: Conditions represent the latest available observation
of the resource's current state.
items:
properties:
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
type: string
message:
description: Human-readable message indicating details about
last transition.
type: string
reason:
description: Unique, one-word, CamelCase reason for the condition's
last transition.
type: string
status:
description: Status is the status of the condition. Can be True,
False, Unknown.
type: string
type:
description: Type is the type of the condition.
type: string
type: object
type: array
name:
description: Full path to the Version resource in the API. Example,
"v1".
type: string
observedGeneration:
description: ObservedGeneration is the generation of the resource
that was most recently observed by the Config Connector controller.
If this is equal to metadata.generation, then that means that the
current reported status reflects the most recent desired state of
the resource.
type: integer
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []