forked from RedHatInsights/clowder
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdeploy-mutate.yml
7524 lines (7523 loc) · 440 KB
/
deploy-mutate.yml
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
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: v1
kind: Template
metadata:
name: clowder
objects:
- apiVersion: v1
kind: Namespace
metadata:
labels:
control-plane: controller-manager
name: clowder-system
- apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.8.0
creationTimestamp: null
name: clowdapps.cloud.redhat.com
spec:
group: cloud.redhat.com
names:
kind: ClowdApp
listKind: ClowdAppList
plural: clowdapps
shortNames:
- app
singular: clowdapp
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.deployments.readyDeployments
name: Ready
type: integer
- jsonPath: .status.deployments.managedDeployments
name: Managed
type: integer
- jsonPath: .spec.envName
name: EnvName
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: ClowdApp is the Schema for the clowdapps API
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: A ClowdApp specification.
properties:
cyndi:
description: Configures 'cyndi' database syndication for this app.
When the app's ClowdEnvironment has the kafka provider set to
(*_operator_*) mode, Clowder will configure a CyndiPipeline for
this app in the environment's kafka-connect namespace. When the
kafka provider is in (*_app-interface_*) mode, Clowder will check
to ensure that a CyndiPipeline resource exists for the application
in the environment's kafka-connect namespace. For all other kafka
provider modes, this configuration option has no effect.
properties:
appName:
maxLength: 64
minLength: 1
pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*'
type: string
enabled:
type: boolean
insightsOnly:
type: boolean
type: object
database:
description: The database specification defines a single database,
the configuration of which will be made available to all the pods
in the ClowdApp.
properties:
dbResourceSize:
description: T-shirt size, one of small, medium, large
enum:
- small
- medium
- large
type: string
dbVolumeSize:
description: T-shirt size, one of small, medium, large
enum:
- small
- medium
- large
type: string
name:
description: Defines the Name of the database to be created.
This will be used as the name of the logical database inside
the database server in (*_local_*) mode and the name of the
secret to be used for Database configuration in (*_app-interface_*)
mode.
type: string
sharedDbAppName:
description: Defines the Name of the app to share a database
from
type: string
version:
description: Defines the Version of the PostGreSQL database,
defaults to 12.
enum:
- 10
- 12
- 13
format: int32
type: integer
type: object
dependencies:
description: A list of dependencies in the form of the name of the
ClowdApps that are required to be present for this ClowdApp to
function.
items:
type: string
type: array
deployments:
description: A list of deployments
items:
description: Deployment defines a service running inside a ClowdApp
and will output a deployment resource. Only one container per
pod is allowed and this is defined in the PodSpec attribute.
properties:
autoScaler:
description: AutoScaler defines the configuration for the
Keda auto scaler
properties:
advanced:
description: AdvancedConfig specifies advance scaling
options
properties:
horizontalPodAutoscalerConfig:
description: HorizontalPodAutoscalerConfig specifies
horizontal scale config
properties:
behavior:
description: HorizontalPodAutoscalerBehavior configures
the scaling behavior of the target in both Up
and Down directions (scaleUp and scaleDown fields
respectively).
properties:
scaleDown:
description: scaleDown is scaling policy for
scaling Down. If not set, the default value
is to allow to scale down to minReplicas
pods, with a 300 second stabilization window
(i.e., the highest recommendation for the
last 300sec is used).
properties:
policies:
description: policies is a list of potential
scaling polices which can be used during
scaling. At least one policy must be
specified, otherwise the HPAScalingRules
will be discarded as invalid
items:
description: HPAScalingPolicy is a single
policy which must hold true for a
specified past interval.
properties:
periodSeconds:
description: PeriodSeconds specifies
the window of time for which the
policy should hold true. PeriodSeconds
must be greater than zero and
less than or equal to 1800 (30
min).
format: int32
type: integer
type:
description: Type is used to specify
the scaling policy.
type: string
value:
description: Value contains the
amount of change which is permitted
by the policy. It must be greater
than zero
format: int32
type: integer
required:
- periodSeconds
- type
- value
type: object
type: array
selectPolicy:
description: selectPolicy is used to specify
which policy should be used. If not
set, the default value MaxPolicySelect
is used.
type: string
stabilizationWindowSeconds:
description: 'StabilizationWindowSeconds
is the number of seconds for which past
recommendations should be considered
while scaling up or scaling down. StabilizationWindowSeconds
must be greater than or equal to zero
and less than or equal to 3600 (one
hour). If not set, use the default values:
- For scale up: 0 (i.e. no stabilization
is done). - For scale down: 300 (i.e.
the stabilization window is 300 seconds
long).'
format: int32
type: integer
type: object
scaleUp:
description: 'scaleUp is scaling policy for
scaling Up. If not set, the default value
is the higher of: * increase no more than
4 pods per 60 seconds * double the number
of pods per 60 seconds No stabilization
is used.'
properties:
policies:
description: policies is a list of potential
scaling polices which can be used during
scaling. At least one policy must be
specified, otherwise the HPAScalingRules
will be discarded as invalid
items:
description: HPAScalingPolicy is a single
policy which must hold true for a
specified past interval.
properties:
periodSeconds:
description: PeriodSeconds specifies
the window of time for which the
policy should hold true. PeriodSeconds
must be greater than zero and
less than or equal to 1800 (30
min).
format: int32
type: integer
type:
description: Type is used to specify
the scaling policy.
type: string
value:
description: Value contains the
amount of change which is permitted
by the policy. It must be greater
than zero
format: int32
type: integer
required:
- periodSeconds
- type
- value
type: object
type: array
selectPolicy:
description: selectPolicy is used to specify
which policy should be used. If not
set, the default value MaxPolicySelect
is used.
type: string
stabilizationWindowSeconds:
description: 'StabilizationWindowSeconds
is the number of seconds for which past
recommendations should be considered
while scaling up or scaling down. StabilizationWindowSeconds
must be greater than or equal to zero
and less than or equal to 3600 (one
hour). If not set, use the default values:
- For scale up: 0 (i.e. no stabilization
is done). - For scale down: 300 (i.e.
the stabilization window is 300 seconds
long).'
format: int32
type: integer
type: object
type: object
name:
type: string
type: object
restoreToOriginalReplicaCount:
type: boolean
type: object
cooldownPeriod:
description: CooldownPeriod is the interval (in seconds)
to wait after the last trigger reported active before
scaling the deployment down. Default is 5 minutes (300
seconds).
format: int32
type: integer
externalHPA:
description: ExternalHPA allows replicas on deployments
to be controlled by another resource, but will not be
allowed to fall under the minReplicas as set in the
ClowdApp.
type: boolean
fallback:
description: Fallback is the spec for fallback options
properties:
failureThreshold:
format: int32
type: integer
replicas:
format: int32
type: integer
required:
- failureThreshold
- replicas
type: object
maxReplicaCount:
description: MaxReplicaCount is the maximum number of
replicas the scaler will scale the deployment to. Default
is 10.
format: int32
type: integer
minReplicaCount:
description: MinReplicaCount is the minimum number of
replicas the scaler will scale the deployment to.
format: int32
type: integer
pollingInterval:
description: PollingInterval is the interval (in seconds)
to check each trigger on. Default is 30 seconds.
format: int32
type: integer
triggers:
items:
description: ScaleTriggers reference the scaler that
will be used
properties:
authenticationRef:
description: ScaledObjectAuthRef points to the TriggerAuthentication
or ClusterTriggerAuthentication object that is
used to authenticate the scaler with the environment
properties:
kind:
description: Kind of the resource being referred
to. Defaults to TriggerAuthentication.
type: string
name:
type: string
required:
- name
type: object
metadata:
additionalProperties:
type: string
type: object
metricType:
description: MetricTargetType specifies the type
of metric being targeted, and should be either
"Value", "AverageValue", or "Utilization"
type: string
name:
type: string
type:
type: string
required:
- metadata
- type
type: object
type: array
type: object
autoScalerSimple:
description: SimpleAutoScaler defines a simple HPA with scaling
for RAM and CPU by value and utilization thresholds, along
with replica count limits
properties:
cpu:
description: SimpleAutoScalerMetric defines a metric of
either a value or utilization
properties:
scaleAtUtilization:
format: int32
type: integer
scaleAtValue:
type: string
type: object
ram:
description: SimpleAutoScalerMetric defines a metric of
either a value or utilization
properties:
scaleAtUtilization:
format: int32
type: integer
scaleAtValue:
type: string
type: object
replicas:
description: SimpleAutoScalerReplicas defines the minimum
and maximum replica counts for the auto scaler
properties:
max:
format: int32
type: integer
min:
format: int32
type: integer
required:
- max
- min
type: object
required:
- replicas
type: object
deploymentStrategy:
description: DeploymentStrategy allows the deployment strategy
to be set only if the deployment has no public service enabled
properties:
privateStrategy:
description: PrivateStrategy allows a deployment that
only uses a private port to set the deployment strategy
one of Recreate or Rolling, default for a private service
is Recreate. This is to enable a quicker roll out for
services that do not have public facing endpoints.
type: string
type: object
k8sAccessLevel:
description: K8sAccessLevel defines the level of access for
this deployment
enum:
- default
- view
- ''
- edit
type: string
metadata:
properties:
annotations:
additionalProperties:
type: string
type: object
type: object
minReplicas:
description: 'Deprecated: Use Replicas instead If Replicas
is not set and MinReplicas is set, then MinReplicas will
be used'
format: int32
type: integer
name:
description: Name defines the identifier of a Pod inside the
ClowdApp. This name will be used along side the name of
the ClowdApp itself to form a <app>-<pod> pattern which
will be used for all other created resources and also for
some labels. It must be unique within a ClowdApp.
type: string
podSpec:
description: PodSpec defines a container running inside a
ClowdApp.
properties:
args:
description: A list of args to be passed to the pod container.
items:
type: string
type: array
command:
description: The command that will be invoked inside the
pod at startup.
items:
type: string
type: array
env:
description: A list of environment variables in k8s defined
format.
items:
description: EnvVar represents an environment variable
present in a Container.
properties:
name:
description: Name of the environment variable. Must
be a C_IDENTIFIER.
type: string
value:
description: 'Variable references $(VAR_NAME) are
expanded using the previously defined environment
variables in the container and any service environment
variables. If a variable cannot be resolved, the
reference in the input string will be unchanged.
Double $$ are reduced to a single $, which allows
for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless
of whether the variable exists or not. Defaults
to "".'
type: string
valueFrom:
description: Source for the environment variable's
value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
properties:
key:
description: The key to select.
type: string
name:
description: 'Name of the referent. More
info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion,
kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
or its key must be defined
type: boolean
required:
- key
type: object
fieldRef:
description: 'Selects a field of the pod: supports
metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`,
`metadata.annotations[''<KEY>'']`, spec.nodeName,
spec.serviceAccountName, status.hostIP, status.podIP,
status.podIPs.'
properties:
apiVersion:
description: Version of the schema the FieldPath
is written in terms of, defaults to "v1".
type: string
fieldPath:
description: Path of the field to select
in the specified API version.
type: string
required:
- fieldPath
type: object
resourceFieldRef:
description: 'Selects a resource of the container:
only resources limits and requests (limits.cpu,
limits.memory, limits.ephemeral-storage, requests.cpu,
requests.memory and requests.ephemeral-storage)
are currently supported.'
properties:
containerName:
description: 'Container name: required for
volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
description: Specifies the output format
of the exposed resources, defaults to
"1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
description: 'Required: resource to select'
type: string
required:
- resource
type: object
secretKeyRef:
description: Selects a key of a secret in the
pod's namespace
properties:
key:
description: The key of the secret to select
from. Must be a valid secret key.
type: string
name:
description: 'Name of the referent. More
info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion,
kind, uid?'
type: string
optional:
description: Specify whether the Secret
or its key must be defined
type: boolean
required:
- key
type: object
type: object
required:
- name
type: object
type: array
image:
description: Image refers to the container image used
to create the pod.
type: string
initContainers:
description: A list of init containers used to perform
at-startup operations.
items:
description: InitContainer is a struct defining a k8s
init container. This will be deployed along with the
parent pod and is used to carry out one time initialization
procedures.
properties:
args:
description: A list of args to be passed to the
init container.
items:
type: string
type: array
command:
description: A list of commands to run inside the
parent Pod.
items:
type: string
type: array
env:
description: A list of environment variables used
only by the initContainer.
items:
description: EnvVar represents an environment
variable present in a Container.
properties:
name:
description: Name of the environment variable.
Must be a C_IDENTIFIER.
type: string
value:
description: 'Variable references $(VAR_NAME)
are expanded using the previously defined
environment variables in the container and
any service environment variables. If a
variable cannot be resolved, the reference
in the input string will be unchanged. Double
$$ are reduced to a single $, which allows
for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal
"$(VAR_NAME)". Escaped references will never
be expanded, regardless of whether the variable
exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
properties:
key:
description: The key to select.
type: string
name:
description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion,
kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
or its key must be defined
type: boolean
required:
- key
type: object
fieldRef:
description: 'Selects a field of the pod:
supports metadata.name, metadata.namespace,
`metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`,
spec.nodeName, spec.serviceAccountName,
status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
the FieldPath is written in terms
of, defaults to "v1".
type: string
fieldPath:
description: Path of the field to
select in the specified API version.
type: string
required:
- fieldPath
type: object
resourceFieldRef:
description: 'Selects a resource of the
container: only resources limits and
requests (limits.cpu, limits.memory,
limits.ephemeral-storage, requests.cpu,
requests.memory and requests.ephemeral-storage)
are currently supported.'
properties:
containerName:
description: 'Container name: required
for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
description: Specifies the output
format of the exposed resources,
defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
description: 'Required: resource to
select'
type: string
required:
- resource
type: object
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
properties:
key:
description: The key of the secret
to select from. Must be a valid
secret key.
type: string
name:
description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion,
kind, uid?'
type: string
optional:
description: Specify whether the Secret
or its key must be defined
type: boolean
required:
- key
type: object
type: object
required:
- name
type: object
type: array
image:
description: Image refers to the container image
used to create the init container (if different
from the primary pod image).
type: string
inheritEnv:
description: If true, inheirts the environment variables
from the parent pod. specification
type: boolean
name:
description: Name gives an identifier in the situation
where multiple init containers exist
type: string
type: object
type: array
livenessProbe:
description: A pass-through of a Liveness Probe specification
in standard k8s format. If omitted, a standard probe
will be setup point to the webPort defined in the ClowdEnvironment
and a path of /healthz. Ignored if Web is set to false.
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
inside the container, the working directory
for the command is root ('/') in the container's
filesystem. The command is simply exec'd, it
is not run inside a shell, so traditional shell
instructions ('|', etc) won't work. To use a
shell, you need to explicitly call out to that
shell. Exit status of 0 is treated as live/healthy
and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
description: Minimum consecutive failures for the
probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
description: GRPC specifies an action involving a
GRPC port. This is a beta field and requires enabling
GRPCContainerProbe feature gate.
properties:
port:
description: Port number of the gRPC service.
Number must be in the range 1 to 65535.
format: int32
type: integer
service:
description: "Service is the name of the service\
\ to place in the gRPC HealthCheckRequest (see\
\ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\
\ \n If this is not specified, the default behavior\
\ is defined by gRPC."
type: string
required:
- port
type: object
httpGet:
description: HTTPGet specifies the http request to
perform.
properties:
host:
description: Host name to connect to, defaults
to the pod IP. You probably want to set "Host"
in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
HTTP allows repeated headers.
items:
description: HTTPHeader describes a custom header
to be used in HTTP probes
properties:
name:
description: The header field name
type: string
value:
description: The header field value
type: string
required:
- name
- value
type: object
type: array
path:
description: Path to access on the HTTP server.
type: string
port:
anyOf:
- type: integer
- type: string
description: Name or number of the port to access
on the container. Number must be in the range
1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the
host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
description: 'Number of seconds after the container
has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
description: How often (in seconds) to perform the
probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
description: Minimum consecutive successes for the
probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup.
Minimum value is 1.
format: int32
type: integer
tcpSocket:
description: TCPSocket specifies an action involving
a TCP port.
properties:
host:
description: 'Optional: Host name to connect to,
defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
description: Number or name of the port to access
on the container. Number must be in the range
1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
description: Optional duration in seconds the pod
needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after
the processes running in the pod are sent a termination
signal and the time when the processes are forcibly
halted with a kill signal. Set this value longer
than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds
will be used. Otherwise, this value overrides the
value provided by the pod spec. Value must be non-negative
integer. The value zero indicates stop immediately
via the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod
feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
is used if unset.
format: int64
type: integer
timeoutSeconds:
description: 'Number of seconds after which the probe
times out. Defaults to 1 second. Minimum value is
1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
machinePool:
description: MachinePool allows the pod to be scheduled
to a particular machine pool.
type: string
metadata:
description: Allows for defining custom PodSpec metadata,
such as annotations
properties:
annotations:
additionalProperties:
type: string
type: object
type: object
readinessProbe:
description: A pass-through of a Readiness Probe specification
in standard k8s format. If omitted, a standard probe
will be setup point to the webPort defined in the ClowdEnvironment
and a path of /healthz. Ignored if Web is set to false.
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
inside the container, the working directory
for the command is root ('/') in the container's
filesystem. The command is simply exec'd, it
is not run inside a shell, so traditional shell
instructions ('|', etc) won't work. To use a
shell, you need to explicitly call out to that
shell. Exit status of 0 is treated as live/healthy
and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
description: Minimum consecutive failures for the
probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
description: GRPC specifies an action involving a
GRPC port. This is a beta field and requires enabling
GRPCContainerProbe feature gate.
properties:
port:
description: Port number of the gRPC service.
Number must be in the range 1 to 65535.
format: int32
type: integer
service:
description: "Service is the name of the service\
\ to place in the gRPC HealthCheckRequest (see\
\ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\
\ \n If this is not specified, the default behavior\
\ is defined by gRPC."
type: string
required:
- port
type: object
httpGet:
description: HTTPGet specifies the http request to
perform.
properties:
host:
description: Host name to connect to, defaults
to the pod IP. You probably want to set "Host"
in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
HTTP allows repeated headers.
items:
description: HTTPHeader describes a custom header
to be used in HTTP probes
properties:
name:
description: The header field name
type: string
value:
description: The header field value
type: string
required:
- name
- value
type: object
type: array
path:
description: Path to access on the HTTP server.
type: string
port: