forked from devfile/devworkspace-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdevworkspaceoperatorconfigs.controller.devfile.io.CustomResourceDefinition.yaml
More file actions
5145 lines (4982 loc) · 316 KB
/
devworkspaceoperatorconfigs.controller.devfile.io.CustomResourceDefinition.yaml
File metadata and controls
5145 lines (4982 loc) · 316 KB
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: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.18.0
labels:
app.kubernetes.io/name: devworkspace-controller
app.kubernetes.io/part-of: devworkspace-operator
name: devworkspaceoperatorconfigs.controller.devfile.io
spec:
group: controller.devfile.io
names:
kind: DevWorkspaceOperatorConfig
listKind: DevWorkspaceOperatorConfigList
plural: devworkspaceoperatorconfigs
shortNames:
- dwoc
singular: devworkspaceoperatorconfig
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: DevWorkspaceOperatorConfig is the Schema for the devworkspaceoperatorconfigs
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
config:
description: |-
OperatorConfiguration defines configuration options for the DevWorkspace
Operator.
properties:
enableExperimentalFeatures:
description: |-
EnableExperimentalFeatures turns on in-development features of the controller.
This option should generally not be enabled, as any capabilites are subject
to removal without notice.
type: boolean
routing:
description: Routing defines configuration options related to DevWorkspace
networking
properties:
clusterHostSuffix:
description: |-
ClusterHostSuffix is the hostname suffix to be used for DevWorkspace endpoints.
On OpenShift, the DevWorkspace Operator will attempt to determine the appropriate
value automatically. Must be specified on Kubernetes.
type: string
defaultRoutingClass:
description: |-
DefaultRoutingClass specifies the routingClass to be used when a DevWorkspace
specifies an empty `.spec.routingClass`. Supported routingClasses can be defined
in other controllers. If not specified, the default value of "basic" is used.
type: string
proxyConfig:
description: |-
ProxyConfig defines the proxy settings that should be used for all DevWorkspaces.
These values are propagated to workspace containers as environment variables.
On OpenShift, the operator automatically reads values from the "cluster" proxies.config.openshift.io
object and this value only needs to be set to override those defaults. Values for httpProxy
and httpsProxy override the cluster configuration directly. Entries for noProxy are merged
with the noProxy values in the cluster configuration. To ignore automatically read values from the cluster,
set values in fields to the empty string ("")
Changes to the proxy configuration are detected by the DevWorkspace Operator and propagated to
DevWorkspaces. However, changing the proxy configuration for the DevWorkspace Operator itself
requires restarting the controller deployment.
properties:
httpProxy:
description: |-
HttpProxy is the URL of the proxy for HTTP requests, in the format http://USERNAME:PASSWORD@SERVER:PORT/. To ignore
automatically detected proxy settings for the cluster, set this field to an empty string ("")
type: string
httpsProxy:
description: |-
HttpsProxy is the URL of the proxy for HTTPS requests, in the format http://USERNAME:PASSWORD@SERVER:PORT/. To ignore
automatically detected proxy settings for the cluster, set this field to an empty string ("")
type: string
noProxy:
description: |-
NoProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. Ignored
when HttpProxy and HttpsProxy are unset. To ignore automatically detected proxy settings for the cluster, set this
field to an empty string ("")
type: string
type: object
tlsCertificateConfigmapRef:
description: |-
TLSCertificateConfigmapRef defines the name and namespace of the configmap with a certificate to inject into the
HTTP client.
properties:
name:
description: Name is the name of the configmap
type: string
namespace:
description: Namespace is the namespace of the configmap
type: string
required:
- name
- namespace
type: object
type: object
webhook:
description: |-
Webhook defines configuration options for the DevWorkspace Webhook Server.
Note: In order for changes made to the webhook configuration to take effect:
- The changes must be made in the global DevWorkspaceOperatorConfig, which has the
name 'devworkspace-operator-config' and exists in the same namespace where the
DevWorkspaceOperator is deployed.
- The devworkspace-controller-manager pod must be terminated and recreated for the
DevWorkspace Webhook Server deployment to be updated.
properties:
nodeSelector:
additionalProperties:
type: string
description: |-
NodeSelector defines the map of Kubernetes nodeSelectors to apply to the DevWorkspace Webhook
Server pod(s).
No NodeSelectors are added by default.
type: object
replicas:
default: 2
description: |-
Replicas defines the number of desired DevWorkspace Webhook Server pods.
Defaults to 2.
format: int32
minimum: 1
type: integer
tolerations:
description: |-
Tolerations defines the array of Kubernetes pod tolerations to apply to the DevWorkspace Webhook
Server pod(s).
No Tolerations are added by default.
items:
description: |-
The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.
properties:
effect:
description: |-
Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
type: string
key:
description: |-
Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.
type: string
operator:
description: |-
Operator represents a key's relationship to the value.
Valid operators are Exists and Equal. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category.
type: string
tolerationSeconds:
description: |-
TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
description: |-
Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
type: string
type: object
type: array
type: object
workspace:
description: |-
Workspace defines configuration options related to how DevWorkspaces are
managed
properties:
backupCronJob:
description: BackupCronJobConfig defines configuration options
for a cron job that automatically backs up workspace PVCs.
properties:
backoffLimit:
default: 1
description: |-
BackoffLimit specifies the number of retries before marking a backup job as failed.
Defaults to 1 if not specified.
format: int32
minimum: 0
type: integer
enable:
description: |-
Enable determines whether backup CronJobs should be created for workspace PVCs.
Defaults to false if not specified.
type: boolean
oras:
description: |-
OrasConfig defines additional configuration options for the oras CLI used to
push and pull backup images.
properties:
extraArgs:
description: ExtraArgs are additional arguments passed
to the oras CLI
type: string
type: object
registry:
description: RegistryConfig defines the registry configuration
where backup images are stored.
properties:
authSecret:
description: |-
AuthSecret is the name of a Kubernetes secret of
type kubernetes.io/dockerconfigjson.
The secret is expected to be in the same namespace the workspace is running in.
If secret is not found in the workspace namespace, the operator will look for the secret
in the namespace where the operator is running in.
as the DevWorkspaceOperatorCongfig.
The secret must contain "controller.devfile.io/watch-secret=true" label so that it can be
recognized by the operator.
type: string
path:
description: |-
A registry where backup images are stored. Images are stored
in {path}/${DEVWORKSPACE_NAMESPACE}/${DEVWORKSPACE_NAME}:latest
type: string
required:
- path
type: object
schedule:
default: 0 1 * * *
description: |-
Schedule specifies the cron schedule for the backup cron job.
For example, "0 1 * * *" runs daily at 1 AM.
type: string
required:
- registry
type: object
cleanupCronJob:
description: CleanupCronJobConfig defines configuration options
for a cron job that automatically cleans up stale DevWorkspaces.
properties:
dryRun:
description: |-
DryRun determines whether the cleanup cron job should be run in dry-run mode.
If set to true, the cron job will not delete any DevWorkspaces, but will log the DevWorkspaces that would have been deleted.
Defaults to false if not specified.
type: boolean
enable:
description: |-
Enable determines whether the cleanup cron job is enabled.
Defaults to false if not specified.
type: boolean
retainTime:
default: 2592000
description: |-
RetainTime specifies the minimum time (in seconds) since a DevWorkspace was last started before it is considered stale and eligible for cleanup.
For example, a value of 2592000 (30 days) would mean that any DevWorkspace that has not been started in the last 30 days will be deleted.
Defaults to 2592000 seconds (30 days) if not specified.
format: int32
minimum: 0
type: integer
schedule:
default: 0 0 1 * *
description: Schedule specifies the cron schedule for the
cleanup cron job.
type: string
type: object
cleanupOnStop:
description: |-
CleanupOnStop governs how the Operator handles stopped DevWorkspaces. If set to
true, additional resources associated with a DevWorkspace (e.g. services, deployments,
configmaps, etc.) will be removed from the cluster when a DevWorkspace has
.spec.started = false. If set to false, resources will be scaled down (e.g. deployments
but the objects will be left on the cluster). The default value is false.
type: boolean
containerResourceCaps:
description: |-
ContainerResourceCaps defines the maximum resource requirements enforced for workspace
containers. If a container specifies limits or requests that exceed these values, they
will be capped at the maximum. Note: Caps only apply when resources are already specified
on a container. For containers without resource specifications, use DefaultContainerResources
instead. These resource caps do not apply to initContainers or the projectClone container.
properties:
claims:
description: |-
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This field depends on the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: |-
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
type: string
request:
description: |-
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
type: object
containerSecurityContext:
description: |-
ContainerSecurityContext overrides the default ContainerSecurityContext used for all
workspace-related containers created by the DevWorkspace Operator. If set, defined
values are merged into the default configuration
properties:
allowPrivilegeEscalation:
description: |-
AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
type: boolean
appArmorProfile:
description: |-
appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
description: |-
localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".
type: string
type:
description: |-
type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
type: string
required:
- type
type: object
capabilities:
description: |-
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
description: Capability represent POSIX capabilities
type
type: string
type: array
x-kubernetes-list-type: atomic
drop:
description: Removed capabilities
items:
description: Capability represent POSIX capabilities
type
type: string
type: array
x-kubernetes-list-type: atomic
type: object
privileged:
description: |-
Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
description: |-
procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
description: |-
Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
description: |-
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
description: |-
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
description: |-
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
description: |-
The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that applies
to the container.
type: string
role:
description: Role is a SELinux role label that applies
to the container.
type: string
type:
description: Type is a SELinux type label that applies
to the container.
type: string
user:
description: User is a SELinux user label that applies
to the container.
type: string
type: object
seccompProfile:
description: |-
The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
description: |-
localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.
type: string
type:
description: |-
type indicates which kind of seccomp profile will be applied.
Valid options are:
Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.
type: string
required:
- type
type: object
windowsOptions:
description: |-
The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
description: |-
GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name of the
GMSA credential spec to use.
type: string
hostProcess:
description: |-
HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
description: |-
The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
defaultContainerResources:
description: |-
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
container components that do not define limits or requests. In order to not set a field by default,
the value "0" should be used. By default, the memory limit is 128Mi and the memory request is 64Mi.
No CPU limit or request is added by default.
properties:
claims:
description: |-
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This field depends on the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: |-
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
type: string
request:
description: |-
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
type: object
defaultStorageSize:
description: |-
DefaultStorageSize defines an optional struct with fields to specify the sizes of Persistent Volume Claims for storage
classes used by DevWorkspaces.
properties:
common:
anyOf:
- type: integer
- type: string
description: |-
The default Persistent Volume Claim size for the "common" storage class.
Note that the "async" storage class also uses the PVC size set for the "common" storage class.
If not specified, the "common" and "async" Persistent Volume Claim sizes are set to 10Gi
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
perWorkspace:
anyOf:
- type: integer
- type: string
description: |-
The default Persistent Volume Claim size for the "per-workspace" storage class.
If not specified, the "per-workspace" Persistent Volume Claim size is set to 10Gi
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
defaultTemplate:
description: |-
DefaultTemplate defines an optional DevWorkspace Spec Template which gets applied to the workspace
if the workspace's Template Spec Components are not defined. The DefaultTemplate will overwrite the existing
Template Spec, with the exception of Projects (if any are defined).
properties:
attributes:
description: Map of implementation-dependant free-form YAML
attributes.
type: object
x-kubernetes-preserve-unknown-fields: true
commands:
description: Predefined, ready-to-use, devworkspace-related
commands
items:
properties:
apply:
description: |-
Command that consists in applying a given component definition,
typically bound to a devworkspace event.
For example, when an `apply` command is bound to a `preStart` event,
and references a `container` component, it will start the container as a
K8S initContainer in the devworkspace POD, unless the component has its
`dedicatedPod` field set to `true`.
When no `apply` command exist for a given component,
it is assumed the component will be applied at devworkspace start
by default, unless `deployByDefault` for that component is set to false.
properties:
component:
description: Describes component that will be applied
type: string
group:
description: Defines the group this command is part
of
properties:
isDefault:
description: Identifies the default command
for a given group kind
type: boolean
kind:
description: Kind of group the command is part
of
enum:
- build
- run
- test
- debug
- deploy
type: string
required:
- kind
type: object
label:
description: |-
Optional label that provides a label for this command
to be used in Editor UI menus for example
type: string
required:
- component
type: object
attributes:
description: Map of implementation-dependant free-form
YAML attributes.
type: object
x-kubernetes-preserve-unknown-fields: true
commandType:
description: Type of devworkspace command
enum:
- Exec
- Apply
- Composite
- Custom
type: string
composite:
description: |-
Composite command that allows executing several sub-commands
either sequentially or concurrently
properties:
commands:
description: The commands that comprise this composite
command
items:
type: string
type: array
group:
description: Defines the group this command is part
of
properties:
isDefault:
description: Identifies the default command
for a given group kind
type: boolean
kind:
description: Kind of group the command is part
of
enum:
- build
- run
- test
- debug
- deploy
type: string
required:
- kind
type: object
label:
description: |-
Optional label that provides a label for this command
to be used in Editor UI menus for example
type: string
parallel:
description: Indicates if the sub-commands should
be executed concurrently
type: boolean
type: object
custom:
description: |-
Custom command whose logic is implementation-dependant
and should be provided by the user
possibly through some dedicated plugin
properties:
commandClass:
description: |-
Class of command that the associated implementation component
should use to process this command with the appropriate logic
type: string
embeddedResource:
description: |-
Additional free-form configuration for this custom command
that the implementation component will know how to use
type: object
x-kubernetes-embedded-resource: true
x-kubernetes-preserve-unknown-fields: true
group:
description: Defines the group this command is part
of
properties:
isDefault:
description: Identifies the default command
for a given group kind
type: boolean
kind:
description: Kind of group the command is part
of
enum:
- build
- run
- test
- debug
- deploy
type: string
required:
- kind
type: object
label:
description: |-
Optional label that provides a label for this command
to be used in Editor UI menus for example
type: string
required:
- commandClass
- embeddedResource
type: object
exec:
description: CLI Command executed in an existing component
container
properties:
commandLine:
description: |-
The actual command-line string
Special variables that can be used:
- `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.
- `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.
type: string
component:
description: Describes component to which given
action relates
type: string
env:
description: |-
Optional list of environment variables that have to be set
before running the command
items:
properties:
name:
type: string
value:
type: string
required:
- name
- value
type: object
type: array
group:
description: Defines the group this command is part
of
properties:
isDefault:
description: Identifies the default command
for a given group kind
type: boolean
kind:
description: Kind of group the command is part
of
enum:
- build
- run
- test
- debug
- deploy
type: string
required:
- kind
type: object
hotReloadCapable:
description: |-
Specify whether the command is restarted or not when the source code changes.
If set to `true` the command won't be restarted.
A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted.
A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again.
This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`.
Default value is `false`
type: boolean
label:
description: |-
Optional label that provides a label for this command
to be used in Editor UI menus for example
type: string
workingDir:
description: |-
Working directory where the command should be executed
Special variables that can be used:
- `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.
- `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.
type: string
required:
- commandLine
- component
type: object
id:
description: |-
Mandatory identifier that allows referencing
this command in composite commands, from
a parent, or in events.
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
required:
- id
type: object
type: array
components:
description: |-
List of the devworkspace components, such as editor and plugins,
user-provided containers, or other types of components
items:
properties:
attributes:
description: Map of implementation-dependant free-form
YAML attributes.
type: object
x-kubernetes-preserve-unknown-fields: true
componentType:
description: Type of component
enum:
- Container
- Kubernetes
- Openshift
- Volume
- Image
- Plugin
- Custom
type: string
container:
description: Allows adding and configuring devworkspace-related
containers
properties:
annotation:
description: Annotations that should be added to
specific resources for this container
properties:
deployment:
additionalProperties:
type: string
description: Annotations to be added to deployment
type: object
service:
additionalProperties:
type: string
description: Annotations to be added to service
type: object
type: object
args:
description: |-
The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.
Defaults to an empty array, meaning use whatever is defined in the image.
items:
type: string
type: array
command:
description: |-
The command to run in the dockerimage component instead of the default one provided in the image.
Defaults to an empty array, meaning use whatever is defined in the image.
items:
type: string
type: array
cpuLimit:
type: string
cpuRequest:
type: string
dedicatedPod:
description: |-
Specify if a container should run in its own separated pod,
instead of running as part of the main development environment pod.
Default value is `false`
type: boolean
endpoints:
items:
properties:
annotation:
additionalProperties:
type: string
description: Annotations to be added to Kubernetes
Ingress or Openshift Route
type: object
attributes:
description: |-
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",
type: object
x-kubernetes-preserve-unknown-fields: true
exposure:
default: public
description: |-
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through
a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD,
typically by K8S services, to be consumed by other elements running
on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible
inside the main devworkspace POD, on a local address.
Default value is `public`
enum:
- public
- internal
- none
type: string
name:
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$