@sap/cds-dk 6.3.2 → 6.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -7
- package/bin/cds.js +2 -0
- package/bin/compile/index.js +2 -1
- package/bin/deploy/index.js +5 -3
- package/bin/deploy/to-sqlite.js +17 -15
- package/bin/help.js +7 -4
- package/bin/init.js +1 -1
- package/bin/login.js +3 -4
- package/bin/migrate.js +33 -0
- package/bin/pull.js +4 -4
- package/bin/push.js +1 -1
- package/bin/subscribe.js +58 -66
- package/bin/unsubscribe.js +67 -0
- package/bin/watch.js +4 -3
- package/lib/bind/bindingUtil.js +2 -0
- package/lib/bind/cfKeyProvider.js +5 -1
- package/lib/client/activate.js +3 -3
- package/lib/client/auth_manager.js +2 -2
- package/lib/client/base_command.js +7 -6
- package/lib/client/extend.js +2 -2
- package/lib/client/helper/errors.js +8 -2
- package/lib/client/helper/logging.js +13 -11
- package/lib/client/params.js +3 -0
- package/lib/client/pull.js +1 -1
- package/lib/client/push.js +4 -4
- package/lib/client/settings_manager.js +13 -6
- package/lib/client/subscription.js +81 -0
- package/lib/compile/to-xsuaa.js +25 -19
- package/lib/import/odata/metadataconverter/MetadataConverter.js +3 -3
- package/lib/import/odata/v2parser.js +37 -24
- package/lib/import/odata/v4parser.js +111 -37
- package/lib/init/constants.js +1 -1
- package/lib/init/index.js +2 -2
- package/lib/init/template/_merging/registry-mta.js +0 -3
- package/lib/init/template/approuter/files/approuter-configmap.yaml +10 -0
- package/lib/init/template/approuter/files/approuter-mtxs-configmap.yaml +15 -0
- package/lib/init/template/approuter/files/chart.yaml +4 -0
- package/lib/init/template/approuter/files/package.json +1 -1
- package/lib/init/template/approuter/files/values.yaml.hbs +31 -0
- package/lib/init/template/approuter/index.js +60 -12
- package/lib/init/template/auditlog/index.js +16 -8
- package/lib/init/template/cf-manifest/index.js +3 -3
- package/lib/init/template/connectivity/index.js +19 -10
- package/lib/init/template/destinations/index.js +23 -7
- package/lib/init/template/enterprise-messaging/files/cds.package.json +1 -2
- package/lib/init/template/enterprise-messaging/files/cds.profile.package.json.hbs +1 -2
- package/lib/init/template/enterprise-messaging/files/cdsrc.json +1 -2
- package/lib/init/template/enterprise-messaging/files/cdsrc.json.hbs +1 -2
- package/lib/init/template/enterprise-messaging/files/event-mesh.json.hbs +31 -0
- package/lib/init/template/enterprise-messaging/files/mta.yaml.hbs +1 -0
- package/lib/init/template/enterprise-messaging/index.js +26 -13
- package/lib/init/template/extensibility/index.js +19 -10
- package/lib/init/template/hana/files/mta.yaml.hbs +0 -4
- package/lib/init/template/hana/index.js +58 -22
- package/lib/init/template/helm/chart/templates/NOTES.txt +4 -3
- package/lib/init/template/helm/chart/templates/_deployment_helpers.tpl +25 -2
- package/lib/init/template/helm/chart/values.root.schema.json +5 -0
- package/lib/init/template/helm/chart/values.schema.json +27 -0
- package/lib/init/template/helm/files/values.yaml.hbs +1 -1
- package/lib/init/template/helm/index.js +25 -23
- package/lib/init/template/helm/subchart/templates/_helpers.tpl +29 -0
- package/lib/init/template/helm/subchart/templates/api-rule.yaml +5 -5
- package/lib/init/template/helm/subchart/templates/deployment.yaml +12 -9
- package/lib/init/template/helm/subchart/values.md +258 -88
- package/lib/init/template/helm/subchart/values.schema.json +96 -13
- package/lib/init/template/helm/subchart/values.yaml +6 -2
- package/lib/init/template/html5-repo/index.js +28 -11
- package/lib/init/template/java/index.js +5 -5
- package/lib/init/template/kibana-logging/index.js +5 -4
- package/lib/init/template/mta/index.js +2 -2
- package/lib/init/template/mtx/index.js +1 -1
- package/lib/init/template/multitenancy/files/chart.yaml +4 -0
- package/lib/init/template/multitenancy/files/java/mtxs-configmap.yaml +20 -0
- package/lib/init/template/multitenancy/files/java/package.json +6 -9
- package/lib/init/template/multitenancy/files/mtxs-configmap.yaml +15 -0
- package/lib/init/template/multitenancy/files/saas-registry.yaml +17 -19
- package/lib/init/template/multitenancy/files/values.yaml.hbs +47 -0
- package/lib/init/template/multitenancy/files/xs-security.json.hbs +0 -7
- package/lib/init/template/multitenancy/index.js +83 -37
- package/lib/init/template/nodejs/files/.eslintrc +26 -0
- package/lib/init/template/nodejs/files/package.json.hbs +0 -28
- package/lib/init/template/nodejs/index.js +7 -10
- package/lib/init/template/pipeline/index.js +4 -4
- package/lib/init/template/samples/index.js +5 -5
- package/lib/init/template/templateBase.js +1 -4
- package/lib/init/template/toggles/index.js +5 -5
- package/lib/init/template/xsuaa/files/values.yaml.hbs +21 -0
- package/lib/init/template/xsuaa/index.js +34 -24
- package/lib/init/util/md5Tracking.js +113 -0
- package/lib/init/util/merge.js +19 -2
- package/lib/init/util/projectReader.js +15 -12
- package/npm-shrinkwrap.json +211 -686
- package/package.json +3 -3
|
@@ -5,25 +5,27 @@
|
|
|
5
5
|
| **Type** | `object` |
|
|
6
6
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
7
7
|
|
|
8
|
-
| Property | Pattern | Type | Deprecated
|
|
9
|
-
| -------------------------------------------- | ------- | --------------- |
|
|
10
|
-
| - [global](#global ) | No | object | No
|
|
11
|
-
| - [nameOverride](#nameOverride ) | No | string | No
|
|
12
|
-
| - [fullnameOverride](#fullnameOverride ) | No | string | No
|
|
13
|
-
| - [replicaCount](#replicaCount ) | No | integer | No
|
|
14
|
-
| - [port](#port ) | No | integer | No
|
|
15
|
-
| - [serviceAccountName](#serviceAccountName ) | No | string | No
|
|
16
|
-
| + [image](#image ) | No | object | No
|
|
17
|
-
| - [imagePullSecret](#imagePullSecret ) | No | object | No
|
|
18
|
-
| - [additionalVolumes](#additionalVolumes ) | No | array of object | No
|
|
19
|
-
| - [ha](#ha ) | No | object | No
|
|
20
|
-
| + [resources](#resources ) | No | object | No
|
|
21
|
-
| - [health_check](#health_check ) | No | object |
|
|
22
|
-
| - [
|
|
23
|
-
| - [
|
|
24
|
-
| - [
|
|
25
|
-
| - [
|
|
26
|
-
| - [
|
|
8
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
9
|
+
| -------------------------------------------- | ------- | --------------- | ---------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
10
|
+
| - [global](#global ) | No | object | No | - | Helm global values |
|
|
11
|
+
| - [nameOverride](#nameOverride ) | No | string | No | - | Chart name override |
|
|
12
|
+
| - [fullnameOverride](#fullnameOverride ) | No | string | No | - | Override for the \`.fullname\` helper function. |
|
|
13
|
+
| - [replicaCount](#replicaCount ) | No | integer | No | - | Replica count |
|
|
14
|
+
| - [port](#port ) | No | integer | No | - | Port |
|
|
15
|
+
| - [serviceAccountName](#serviceAccountName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Service Account name |
|
|
16
|
+
| + [image](#image ) | No | object | No | - | Image configuration |
|
|
17
|
+
| - [imagePullSecret](#imagePullSecret ) | No | object | No | - | Image Pull Secret configuration |
|
|
18
|
+
| - [additionalVolumes](#additionalVolumes ) | No | array of object | No | - | Additional Pod volumes |
|
|
19
|
+
| - [ha](#ha ) | No | object | No | - | High Availability configuration |
|
|
20
|
+
| + [resources](#resources ) | No | object | No | - | Pod resources configuration |
|
|
21
|
+
| - [health_check](#health_check ) | No | object |  | - | Health-check configuration |
|
|
22
|
+
| - [health](#health ) | No | object | No | - | Health-check configuration |
|
|
23
|
+
| - [startupTimeout](#startupTimeout ) | No | integer | No | - | Initial timeout in seconds, during which the app must start giving the response to the liveness-probe. |
|
|
24
|
+
| - [env](#env ) | No | Combination | No | - | Key-value map of environment variables, which should be added to the Pod spec. |
|
|
25
|
+
| - [envSecretNames](#envSecretNames ) | No | array |  | - | [Deprecated] Use \`envFrom\` instead |
|
|
26
|
+
| - [envFrom](#envFrom ) | No | array of object | No | - | List of sources to populate environment variables in the pod. |
|
|
27
|
+
| - [expose](#expose ) | No | object | No | - | - |
|
|
28
|
+
| - [bindings](#bindings ) | No | object | No | - | Service Binding configuration |
|
|
27
29
|
|
|
28
30
|
## <a name="global"></a>1.  Property `global`
|
|
29
31
|
|
|
@@ -498,15 +500,18 @@ Must be one of:
|
|
|
498
500
|
|
|
499
501
|
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
500
502
|
|
|
501
|
-
## <a name="health_check"></a>12.  Property `health_check
|
|
503
|
+
## <a name="health_check"></a>12. ~~ Property `health_check`~~
|
|
502
504
|
|
|
503
505
|
**Title:** Health-check configuration
|
|
504
506
|
|
|
505
507
|
| | |
|
|
506
508
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
507
509
|
| **Type** | `object` |
|
|
510
|
+
| **Deprecated** |  |
|
|
508
511
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
509
512
|
|
|
513
|
+
**Description:** [Deprecated] Use health instead
|
|
514
|
+
|
|
510
515
|
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
511
516
|
| --------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ |
|
|
512
517
|
| - [liveness](#health_check_liveness ) | No | object | No | - | Liveness-probe configuration. |
|
|
@@ -527,10 +532,9 @@ Must be one of:
|
|
|
527
532
|
|
|
528
533
|
#### <a name="health_check_liveness_path"></a>12.1.1.  Property `path`
|
|
529
534
|
|
|
530
|
-
|
|
|
531
|
-
|
|
|
532
|
-
| **Type**
|
|
533
|
-
| **Default** | `"/healthz"` |
|
|
535
|
+
| | |
|
|
536
|
+
| -------- | -------- |
|
|
537
|
+
| **Type** | `string` |
|
|
534
538
|
|
|
535
539
|
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
536
540
|
|
|
@@ -549,14 +553,71 @@ Must be one of:
|
|
|
549
553
|
|
|
550
554
|
#### <a name="health_check_readiness_path"></a>12.2.1.  Property `path`
|
|
551
555
|
|
|
556
|
+
| | |
|
|
557
|
+
| -------- | -------- |
|
|
558
|
+
| **Type** | `string` |
|
|
559
|
+
|
|
560
|
+
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
561
|
+
|
|
562
|
+
## <a name="health"></a>13.  Property `health`
|
|
563
|
+
|
|
564
|
+
**Title:** Health-check configuration
|
|
565
|
+
|
|
566
|
+
| | |
|
|
567
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
568
|
+
| **Type** | `object` |
|
|
569
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
570
|
+
|
|
571
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
572
|
+
| --------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ |
|
|
573
|
+
| - [liveness](#health_liveness ) | No | object | No | - | Liveness-probe configuration. |
|
|
574
|
+
| - [readiness](#health_readiness ) | No | object | No | - | Readiness-probe configuration. |
|
|
575
|
+
|
|
576
|
+
### <a name="health_liveness"></a>13.1.  Property `liveness`
|
|
577
|
+
|
|
578
|
+
| | |
|
|
579
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
580
|
+
| **Type** | `object` |
|
|
581
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
582
|
+
|
|
583
|
+
**Description:** Liveness-probe configuration.
|
|
584
|
+
|
|
585
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
586
|
+
| -------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------- |
|
|
587
|
+
| - [path](#health_liveness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform liveness-probe calls. |
|
|
588
|
+
|
|
589
|
+
#### <a name="health_liveness_path"></a>13.1.1.  Property `path`
|
|
590
|
+
|
|
552
591
|
| | |
|
|
553
592
|
| ----------- | ------------ |
|
|
554
593
|
| **Type** | `string` |
|
|
555
594
|
| **Default** | `"/healthz"` |
|
|
556
595
|
|
|
557
|
-
**Description:** HTTP path used by Kubernetes, to perform
|
|
596
|
+
**Description:** HTTP path used by Kubernetes, to perform liveness-probe calls.
|
|
597
|
+
|
|
598
|
+
### <a name="health_readiness"></a>13.2.  Property `readiness`
|
|
599
|
+
|
|
600
|
+
| | |
|
|
601
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
602
|
+
| **Type** | `object` |
|
|
603
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
604
|
+
|
|
605
|
+
**Description:** Readiness-probe configuration.
|
|
606
|
+
|
|
607
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
608
|
+
| --------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------- |
|
|
609
|
+
| - [path](#health_readiness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform readiness-probe calls. |
|
|
610
|
+
|
|
611
|
+
#### <a name="health_readiness_path"></a>13.2.1.  Property `path`
|
|
612
|
+
|
|
613
|
+
| | |
|
|
614
|
+
| ----------- | ------------ |
|
|
615
|
+
| **Type** | `string` |
|
|
616
|
+
| **Default** | `"/healthz"` |
|
|
617
|
+
|
|
618
|
+
**Description:** HTTP path used by Kubernetes, to perform readiness-probe calls.
|
|
558
619
|
|
|
559
|
-
## <a name="startupTimeout"></a>
|
|
620
|
+
## <a name="startupTimeout"></a>14.  Property `startupTimeout`
|
|
560
621
|
|
|
561
622
|
| | |
|
|
562
623
|
| ----------- | --------- |
|
|
@@ -569,7 +630,7 @@ Must be one of:
|
|
|
569
630
|
| ------------ | ------ |
|
|
570
631
|
| **Minimum** | ≥ 1 |
|
|
571
632
|
|
|
572
|
-
## <a name="env"></a>
|
|
633
|
+
## <a name="env"></a>15.  Property `env`
|
|
573
634
|
|
|
574
635
|
| | |
|
|
575
636
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -584,7 +645,7 @@ Must be one of:
|
|
|
584
645
|
| [item 0](#env_anyOf_i0) |
|
|
585
646
|
| [item 1](#env_anyOf_i1) |
|
|
586
647
|
|
|
587
|
-
### <a name="env_anyOf_i0"></a>
|
|
648
|
+
### <a name="env_anyOf_i0"></a>15.1. Property `None`
|
|
588
649
|
|
|
589
650
|
| | |
|
|
590
651
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -596,7 +657,7 @@ Must be one of:
|
|
|
596
657
|
| --------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
597
658
|
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#env_anyOf_i0_pattern1 ) | Yes | Combination | No | - | - |
|
|
598
659
|
|
|
599
|
-
#### <a name="env_anyOf_i0_pattern1"></a>
|
|
660
|
+
#### <a name="env_anyOf_i0_pattern1"></a>15.1.1. Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
600
661
|
> All properties whose name matches the regular expression
|
|
601
662
|
```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` ([Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24))
|
|
602
663
|
must respect the following conditions
|
|
@@ -611,7 +672,7 @@ must respect the following conditions
|
|
|
611
672
|
| [item 0](#env_anyOf_i0_pattern1_anyOf_i0) |
|
|
612
673
|
| [item 1](#env_anyOf_i0_pattern1_anyOf_i1) |
|
|
613
674
|
|
|
614
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i0"></a>
|
|
675
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i0"></a>15.1.1.1. Property `None`
|
|
615
676
|
|
|
616
677
|
| | |
|
|
617
678
|
| -------- | ------------------- |
|
|
@@ -619,7 +680,7 @@ must respect the following conditions
|
|
|
619
680
|
|
|
620
681
|
**Description:** Plain value of an environment variable.
|
|
621
682
|
|
|
622
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1"></a>
|
|
683
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1"></a>15.1.1.2. Property `None`
|
|
623
684
|
|
|
624
685
|
| | |
|
|
625
686
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -635,7 +696,7 @@ must respect the following conditions
|
|
|
635
696
|
| - [resourceFieldRef](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
636
697
|
| - [fieldRef](#env_anyOf_i0_pattern1_anyOf_i1_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
637
698
|
|
|
638
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef"></a>
|
|
699
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef"></a>15.1.1.2.1. Property `configMapKeyRef`
|
|
639
700
|
|
|
640
701
|
| | |
|
|
641
702
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -649,7 +710,7 @@ must respect the following conditions
|
|
|
649
710
|
| - [name](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a ConfigMap. |
|
|
650
711
|
| - [key](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
651
712
|
|
|
652
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_name"></a>
|
|
713
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_name"></a>15.1.1.2.1.1. Property `name`
|
|
653
714
|
|
|
654
715
|
| | |
|
|
655
716
|
| ---------------------- | ------------------------------------ |
|
|
@@ -658,7 +719,7 @@ must respect the following conditions
|
|
|
658
719
|
|
|
659
720
|
**Description:** Name of a ConfigMap.
|
|
660
721
|
|
|
661
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_key"></a>
|
|
722
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_key"></a>15.1.1.2.1.2. Property `key`
|
|
662
723
|
|
|
663
724
|
| | |
|
|
664
725
|
| -------- | -------- |
|
|
@@ -666,7 +727,7 @@ must respect the following conditions
|
|
|
666
727
|
|
|
667
728
|
**Description:** Key in that ConfigMap, which value will be used.
|
|
668
729
|
|
|
669
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef"></a>
|
|
730
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef"></a>15.1.1.2.2. Property `secretKeyRef`
|
|
670
731
|
|
|
671
732
|
| | |
|
|
672
733
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -680,7 +741,7 @@ must respect the following conditions
|
|
|
680
741
|
| - [name](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
681
742
|
| - [key](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
682
743
|
|
|
683
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_name"></a>
|
|
744
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_name"></a>15.1.1.2.2.1. Property `name`
|
|
684
745
|
|
|
685
746
|
| | |
|
|
686
747
|
| ---------------------- | ------------------------------------ |
|
|
@@ -689,7 +750,7 @@ must respect the following conditions
|
|
|
689
750
|
|
|
690
751
|
**Description:** Name of a Secret.
|
|
691
752
|
|
|
692
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_key"></a>
|
|
753
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_key"></a>15.1.1.2.2.2. Property `key`
|
|
693
754
|
|
|
694
755
|
| | |
|
|
695
756
|
| -------- | -------- |
|
|
@@ -697,7 +758,7 @@ must respect the following conditions
|
|
|
697
758
|
|
|
698
759
|
**Description:** Key in that Secret, which value will be used.
|
|
699
760
|
|
|
700
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef"></a>
|
|
761
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef"></a>15.1.1.2.3. Property `resourceFieldRef`
|
|
701
762
|
|
|
702
763
|
| | |
|
|
703
764
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -711,7 +772,7 @@ must respect the following conditions
|
|
|
711
772
|
| - [containerName](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
712
773
|
| - [resource](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_resource ) | No | string | No | - | Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
713
774
|
|
|
714
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_containerName"></a>
|
|
775
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_containerName"></a>15.1.1.2.3.1. Property `containerName`
|
|
715
776
|
|
|
716
777
|
| | |
|
|
717
778
|
| ---------------------- | ------------------------------------ |
|
|
@@ -720,7 +781,7 @@ must respect the following conditions
|
|
|
720
781
|
|
|
721
782
|
**Description:** Name of a Container.
|
|
722
783
|
|
|
723
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_resource"></a>
|
|
784
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_resource"></a>15.1.1.2.3.2. Property `resource`
|
|
724
785
|
|
|
725
786
|
| | |
|
|
726
787
|
| -------- | -------- |
|
|
@@ -728,7 +789,7 @@ must respect the following conditions
|
|
|
728
789
|
|
|
729
790
|
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
730
791
|
|
|
731
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef"></a>
|
|
792
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef"></a>15.1.1.2.4. Property `fieldRef`
|
|
732
793
|
|
|
733
794
|
| | |
|
|
734
795
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -741,7 +802,7 @@ must respect the following conditions
|
|
|
741
802
|
| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
742
803
|
| - [fieldPath](#env_anyOf_i0_pattern1_anyOf_i1_fieldRef_fieldPath ) | No | string | No | - | Supports metadata.name, metadata.namespace, \`metadata.labels['<KEY>']\`, \`metadata.annotations['<KEY>']\`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
|
|
743
804
|
|
|
744
|
-
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef_fieldPath"></a>
|
|
805
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef_fieldPath"></a>15.1.1.2.4.1. Property `fieldPath`
|
|
745
806
|
|
|
746
807
|
| | |
|
|
747
808
|
| -------- | -------- |
|
|
@@ -749,7 +810,7 @@ must respect the following conditions
|
|
|
749
810
|
|
|
750
811
|
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
751
812
|
|
|
752
|
-
### <a name="env_anyOf_i1"></a>
|
|
813
|
+
### <a name="env_anyOf_i1"></a>15.2. Property `None`
|
|
753
814
|
|
|
754
815
|
| | |
|
|
755
816
|
| -------- | ----------------- |
|
|
@@ -759,7 +820,7 @@ must respect the following conditions
|
|
|
759
820
|
| ----------------------------------- | ----------- |
|
|
760
821
|
| [item 1 items](#env_anyOf_i1_items) | - |
|
|
761
822
|
|
|
762
|
-
#### <a name="autogenerated_heading_3"></a>
|
|
823
|
+
#### <a name="autogenerated_heading_3"></a>15.2.1. items
|
|
763
824
|
|
|
764
825
|
| | |
|
|
765
826
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -775,7 +836,7 @@ must respect the following conditions
|
|
|
775
836
|
| - [resourceFieldRef](#env_anyOf_i1_items_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
776
837
|
| - [fieldRef](#env_anyOf_i1_items_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
777
838
|
|
|
778
|
-
##### <a name="env_anyOf_i1_items_name"></a>
|
|
839
|
+
##### <a name="env_anyOf_i1_items_name"></a>15.2.1.1. Property `name`
|
|
779
840
|
|
|
780
841
|
| | |
|
|
781
842
|
| -------- | -------- |
|
|
@@ -785,13 +846,13 @@ must respect the following conditions
|
|
|
785
846
|
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
786
847
|
| **Must match regular expression** | ```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` [Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24) |
|
|
787
848
|
|
|
788
|
-
##### <a name="env_anyOf_i1_items_value"></a>
|
|
849
|
+
##### <a name="env_anyOf_i1_items_value"></a>15.2.1.2. Property `value`
|
|
789
850
|
|
|
790
851
|
| | |
|
|
791
852
|
| -------- | ------------------- |
|
|
792
853
|
| **Type** | `string or integer` |
|
|
793
854
|
|
|
794
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef"></a>
|
|
855
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef"></a>15.2.1.3. Property `configMapKeyRef`
|
|
795
856
|
|
|
796
857
|
| | |
|
|
797
858
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -805,7 +866,7 @@ must respect the following conditions
|
|
|
805
866
|
| - [name](#env_anyOf_i1_items_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a ConfigMap. |
|
|
806
867
|
| - [key](#env_anyOf_i1_items_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
807
868
|
|
|
808
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef_name"></a>
|
|
869
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_name"></a>15.2.1.3.1. Property `name`
|
|
809
870
|
|
|
810
871
|
| | |
|
|
811
872
|
| ---------------------- | ------------------------------------ |
|
|
@@ -814,7 +875,7 @@ must respect the following conditions
|
|
|
814
875
|
|
|
815
876
|
**Description:** Name of a ConfigMap.
|
|
816
877
|
|
|
817
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef_key"></a>
|
|
878
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_key"></a>15.2.1.3.2. Property `key`
|
|
818
879
|
|
|
819
880
|
| | |
|
|
820
881
|
| -------- | -------- |
|
|
@@ -822,7 +883,7 @@ must respect the following conditions
|
|
|
822
883
|
|
|
823
884
|
**Description:** Key in that ConfigMap, which value will be used.
|
|
824
885
|
|
|
825
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef"></a>
|
|
886
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef"></a>15.2.1.4. Property `secretKeyRef`
|
|
826
887
|
|
|
827
888
|
| | |
|
|
828
889
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -836,7 +897,7 @@ must respect the following conditions
|
|
|
836
897
|
| - [name](#env_anyOf_i1_items_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
837
898
|
| - [key](#env_anyOf_i1_items_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
838
899
|
|
|
839
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef_name"></a>
|
|
900
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_name"></a>15.2.1.4.1. Property `name`
|
|
840
901
|
|
|
841
902
|
| | |
|
|
842
903
|
| ---------------------- | ------------------------------------ |
|
|
@@ -845,7 +906,7 @@ must respect the following conditions
|
|
|
845
906
|
|
|
846
907
|
**Description:** Name of a Secret.
|
|
847
908
|
|
|
848
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef_key"></a>
|
|
909
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_key"></a>15.2.1.4.2. Property `key`
|
|
849
910
|
|
|
850
911
|
| | |
|
|
851
912
|
| -------- | -------- |
|
|
@@ -853,7 +914,7 @@ must respect the following conditions
|
|
|
853
914
|
|
|
854
915
|
**Description:** Key in that Secret, which value will be used.
|
|
855
916
|
|
|
856
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef"></a>
|
|
917
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef"></a>15.2.1.5. Property `resourceFieldRef`
|
|
857
918
|
|
|
858
919
|
| | |
|
|
859
920
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -867,7 +928,7 @@ must respect the following conditions
|
|
|
867
928
|
| - [containerName](#env_anyOf_i1_items_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
868
929
|
| - [resource](#env_anyOf_i1_items_resourceFieldRef_resource ) | No | string | No | - | Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
869
930
|
|
|
870
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef_containerName"></a>
|
|
931
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_containerName"></a>15.2.1.5.1. Property `containerName`
|
|
871
932
|
|
|
872
933
|
| | |
|
|
873
934
|
| ---------------------- | ------------------------------------ |
|
|
@@ -876,7 +937,7 @@ must respect the following conditions
|
|
|
876
937
|
|
|
877
938
|
**Description:** Name of a Container.
|
|
878
939
|
|
|
879
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef_resource"></a>
|
|
940
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_resource"></a>15.2.1.5.2. Property `resource`
|
|
880
941
|
|
|
881
942
|
| | |
|
|
882
943
|
| -------- | -------- |
|
|
@@ -884,7 +945,7 @@ must respect the following conditions
|
|
|
884
945
|
|
|
885
946
|
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
886
947
|
|
|
887
|
-
##### <a name="env_anyOf_i1_items_fieldRef"></a>
|
|
948
|
+
##### <a name="env_anyOf_i1_items_fieldRef"></a>15.2.1.6. Property `fieldRef`
|
|
888
949
|
|
|
889
950
|
| | |
|
|
890
951
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -897,7 +958,7 @@ must respect the following conditions
|
|
|
897
958
|
| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
898
959
|
| - [fieldPath](#env_anyOf_i1_items_fieldRef_fieldPath ) | No | string | No | - | Supports metadata.name, metadata.namespace, \`metadata.labels['<KEY>']\`, \`metadata.annotations['<KEY>']\`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
|
|
899
960
|
|
|
900
|
-
##### <a name="env_anyOf_i1_items_fieldRef_fieldPath"></a>
|
|
961
|
+
##### <a name="env_anyOf_i1_items_fieldRef_fieldPath"></a>15.2.1.6.1. Property `fieldPath`
|
|
901
962
|
|
|
902
963
|
| | |
|
|
903
964
|
| -------- | -------- |
|
|
@@ -905,27 +966,136 @@ must respect the following conditions
|
|
|
905
966
|
|
|
906
967
|
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
907
968
|
|
|
908
|
-
## <a name="envSecretNames"></a>
|
|
969
|
+
## <a name="envSecretNames"></a>16. ~~ Property `envSecretNames`~~
|
|
909
970
|
|
|
910
|
-
|
|
|
911
|
-
|
|
|
912
|
-
| **Type**
|
|
913
|
-
| **
|
|
971
|
+
| | |
|
|
972
|
+
| -------------- | ---------------------------------------------------------- |
|
|
973
|
+
| **Type** | `array` |
|
|
974
|
+
| **Deprecated** |  |
|
|
914
975
|
|
|
915
|
-
**Description:**
|
|
976
|
+
**Description:** [Deprecated] Use `envFrom` instead
|
|
916
977
|
|
|
917
978
|
| Each item of this array must be | Description |
|
|
918
979
|
| --------------------------------------- | ----------- |
|
|
919
980
|
| [KubernetesName](#envSecretNames_items) | - |
|
|
920
981
|
|
|
921
|
-
### <a name="autogenerated_heading_4"></a>
|
|
982
|
+
### <a name="autogenerated_heading_4"></a>16.1. items
|
|
922
983
|
|
|
923
984
|
| | |
|
|
924
985
|
| ---------------------- | ------------------------------------ |
|
|
925
986
|
| **Type** | `string` |
|
|
926
987
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
927
988
|
|
|
928
|
-
## <a name="
|
|
989
|
+
## <a name="envFrom"></a>17.  Property `envFrom`
|
|
990
|
+
|
|
991
|
+
| | |
|
|
992
|
+
| ----------- | ----------------- |
|
|
993
|
+
| **Type** | `array of object` |
|
|
994
|
+
| **Default** | `[]` |
|
|
995
|
+
|
|
996
|
+
**Description:** List of sources to populate environment variables in the pod.
|
|
997
|
+
|
|
998
|
+
| Each item of this array must be | Description |
|
|
999
|
+
| ------------------------------- | ----------- |
|
|
1000
|
+
| [envFrom items](#envFrom_items) | - |
|
|
1001
|
+
|
|
1002
|
+
### <a name="autogenerated_heading_5"></a>17.1. items
|
|
1003
|
+
|
|
1004
|
+
| | |
|
|
1005
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1006
|
+
| **Type** | `combining` |
|
|
1007
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1008
|
+
|
|
1009
|
+
| One of(Option) |
|
|
1010
|
+
| --------------------------------- |
|
|
1011
|
+
| [item 0](#envFrom_items_oneOf_i0) |
|
|
1012
|
+
| [item 1](#envFrom_items_oneOf_i1) |
|
|
1013
|
+
|
|
1014
|
+
#### <a name="envFrom_items_oneOf_i0"></a>17.1.1. Property `None`
|
|
1015
|
+
|
|
1016
|
+
| | |
|
|
1017
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1018
|
+
| **Type** | `object` |
|
|
1019
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1020
|
+
|
|
1021
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1022
|
+
| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------- |
|
|
1023
|
+
| + [configMapRef](#envFrom_items_oneOf_i0_configMapRef ) | No | object | No | - | The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. |
|
|
1024
|
+
|
|
1025
|
+
##### <a name="envFrom_items_oneOf_i0_configMapRef"></a>17.1.1.1. Property `configMapRef`
|
|
1026
|
+
|
|
1027
|
+
| | |
|
|
1028
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1029
|
+
| **Type** | `object` |
|
|
1030
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1031
|
+
|
|
1032
|
+
**Description:** The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
|
|
1033
|
+
|
|
1034
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1035
|
+
| ---------------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------- |
|
|
1036
|
+
| + [name](#envFrom_items_oneOf_i0_configMapRef_name ) | No | string | No | - | Name of a ConfigMap. |
|
|
1037
|
+
| - [tpl](#envFrom_items_oneOf_i0_configMapRef_tpl ) | No | boolean | No | - | Flag which tells whether the name is a template string or not. |
|
|
1038
|
+
|
|
1039
|
+
##### <a name="envFrom_items_oneOf_i0_configMapRef_name"></a>17.1.1.1.1. Property `name`
|
|
1040
|
+
|
|
1041
|
+
| | |
|
|
1042
|
+
| -------- | -------- |
|
|
1043
|
+
| **Type** | `string` |
|
|
1044
|
+
|
|
1045
|
+
**Description:** Name of a ConfigMap.
|
|
1046
|
+
|
|
1047
|
+
##### <a name="envFrom_items_oneOf_i0_configMapRef_tpl"></a>17.1.1.1.2. Property `tpl`
|
|
1048
|
+
|
|
1049
|
+
| | |
|
|
1050
|
+
| ----------- | --------- |
|
|
1051
|
+
| **Type** | `boolean` |
|
|
1052
|
+
| **Default** | `false` |
|
|
1053
|
+
|
|
1054
|
+
**Description:** Flag which tells whether the name is a template string or not.
|
|
1055
|
+
|
|
1056
|
+
#### <a name="envFrom_items_oneOf_i1"></a>17.1.2. Property `None`
|
|
1057
|
+
|
|
1058
|
+
| | |
|
|
1059
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1060
|
+
| **Type** | `object` |
|
|
1061
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1062
|
+
|
|
1063
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1064
|
+
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- |
|
|
1065
|
+
| + [secretRef](#envFrom_items_oneOf_i1_secretRef ) | No | object | No | - | The contents of the target Secret's Data field will represent the key-value pairs as environment variables. |
|
|
1066
|
+
|
|
1067
|
+
##### <a name="envFrom_items_oneOf_i1_secretRef"></a>17.1.2.1. Property `secretRef`
|
|
1068
|
+
|
|
1069
|
+
| | |
|
|
1070
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1071
|
+
| **Type** | `object` |
|
|
1072
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1073
|
+
|
|
1074
|
+
**Description:** The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
|
|
1075
|
+
|
|
1076
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1077
|
+
| ------------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------- |
|
|
1078
|
+
| + [name](#envFrom_items_oneOf_i1_secretRef_name ) | No | string | No | - | Name of a Secret. |
|
|
1079
|
+
| - [tpl](#envFrom_items_oneOf_i1_secretRef_tpl ) | No | boolean | No | - | Flag which tells whether the name is a template string or not. |
|
|
1080
|
+
|
|
1081
|
+
##### <a name="envFrom_items_oneOf_i1_secretRef_name"></a>17.1.2.1.1. Property `name`
|
|
1082
|
+
|
|
1083
|
+
| | |
|
|
1084
|
+
| -------- | -------- |
|
|
1085
|
+
| **Type** | `string` |
|
|
1086
|
+
|
|
1087
|
+
**Description:** Name of a Secret.
|
|
1088
|
+
|
|
1089
|
+
##### <a name="envFrom_items_oneOf_i1_secretRef_tpl"></a>17.1.2.1.2. Property `tpl`
|
|
1090
|
+
|
|
1091
|
+
| | |
|
|
1092
|
+
| ----------- | --------- |
|
|
1093
|
+
| **Type** | `boolean` |
|
|
1094
|
+
| **Default** | `false` |
|
|
1095
|
+
|
|
1096
|
+
**Description:** Flag which tells whether the name is a template string or not.
|
|
1097
|
+
|
|
1098
|
+
## <a name="expose"></a>18.  Property `expose`
|
|
929
1099
|
|
|
930
1100
|
| | |
|
|
931
1101
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -937,7 +1107,7 @@ must respect the following conditions
|
|
|
937
1107
|
| - [host](#expose_host ) | No | string | No | - | Specifies the service's dns name for inbound external traffic. If it doesn't contain a dot, the default cluster domain will be appended. |
|
|
938
1108
|
| - [enabled](#expose_enabled ) | No | boolean | No | - | Expose the application to the internet. |
|
|
939
1109
|
|
|
940
|
-
### <a name="expose_host"></a>
|
|
1110
|
+
### <a name="expose_host"></a>18.1.  Property `host`
|
|
941
1111
|
|
|
942
1112
|
| | |
|
|
943
1113
|
| -------- | -------- |
|
|
@@ -945,7 +1115,7 @@ must respect the following conditions
|
|
|
945
1115
|
|
|
946
1116
|
**Description:** Specifies the service's dns name for inbound external traffic. If it doesn't contain a dot, the default cluster domain will be appended.
|
|
947
1117
|
|
|
948
|
-
### <a name="expose_enabled"></a>
|
|
1118
|
+
### <a name="expose_enabled"></a>18.2.  Property `enabled`
|
|
949
1119
|
|
|
950
1120
|
| | |
|
|
951
1121
|
| ----------- | --------- |
|
|
@@ -954,7 +1124,7 @@ must respect the following conditions
|
|
|
954
1124
|
|
|
955
1125
|
**Description:** Expose the application to the internet.
|
|
956
1126
|
|
|
957
|
-
## <a name="bindings"></a>
|
|
1127
|
+
## <a name="bindings"></a>19.  Property `bindings`
|
|
958
1128
|
|
|
959
1129
|
**Title:** Service Binding configuration
|
|
960
1130
|
|
|
@@ -967,7 +1137,7 @@ must respect the following conditions
|
|
|
967
1137
|
| ----------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
968
1138
|
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#bindings_pattern1 ) | Yes | Combination | No | - | - |
|
|
969
1139
|
|
|
970
|
-
### <a name="bindings_pattern1"></a>
|
|
1140
|
+
### <a name="bindings_pattern1"></a>19.1.  Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
971
1141
|
> All properties whose name matches the regular expression
|
|
972
1142
|
```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` ([Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24))
|
|
973
1143
|
must respect the following conditions
|
|
@@ -982,7 +1152,7 @@ must respect the following conditions
|
|
|
982
1152
|
| [item 0](#bindings_pattern1_anyOf_i0) |
|
|
983
1153
|
| [item 1](#bindings_pattern1_anyOf_i1) |
|
|
984
1154
|
|
|
985
|
-
#### <a name="bindings_pattern1_anyOf_i0"></a>
|
|
1155
|
+
#### <a name="bindings_pattern1_anyOf_i0"></a>19.1.1. Property `None`
|
|
986
1156
|
|
|
987
1157
|
| | |
|
|
988
1158
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -993,7 +1163,7 @@ must respect the following conditions
|
|
|
993
1163
|
| ------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
994
1164
|
| + [fromSecret](#bindings_pattern1_anyOf_i0_fromSecret ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kubernetes Service Binding spec https://github.tools.sap/Kubernetes-Service-Bindings/doc/ |
|
|
995
1165
|
|
|
996
|
-
##### <a name="bindings_pattern1_anyOf_i0_fromSecret"></a>
|
|
1166
|
+
##### <a name="bindings_pattern1_anyOf_i0_fromSecret"></a>19.1.1.1. Property `fromSecret`
|
|
997
1167
|
|
|
998
1168
|
| | |
|
|
999
1169
|
| ---------------------- | ------------------------------------ |
|
|
@@ -1002,7 +1172,7 @@ must respect the following conditions
|
|
|
1002
1172
|
|
|
1003
1173
|
**Description:** Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kubernetes Service Binding spec https://github.tools.sap/Kubernetes-Service-Bindings/doc/
|
|
1004
1174
|
|
|
1005
|
-
#### <a name="bindings_pattern1_anyOf_i1"></a>
|
|
1175
|
+
#### <a name="bindings_pattern1_anyOf_i1"></a>19.1.2. Property `None`
|
|
1006
1176
|
|
|
1007
1177
|
| | |
|
|
1008
1178
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1019,7 +1189,7 @@ must respect the following conditions
|
|
|
1019
1189
|
| - [parametersFrom](#bindings_pattern1_anyOf_i1_parametersFrom ) | No | array | No | - | List of sources to populate parameters. |
|
|
1020
1190
|
| - [credentialsRotationPolicy](#bindings_pattern1_anyOf_i1_credentialsRotationPolicy ) | No | object | No | - | Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1 |
|
|
1021
1191
|
|
|
1022
|
-
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceName"></a>
|
|
1192
|
+
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceName"></a>19.1.2.1. Property `serviceInstanceName`
|
|
1023
1193
|
|
|
1024
1194
|
| | |
|
|
1025
1195
|
| ---------------------- | ------------------------------------ |
|
|
@@ -1028,7 +1198,7 @@ must respect the following conditions
|
|
|
1028
1198
|
|
|
1029
1199
|
**Description:** Name of a BTP Operator Service Instance, created by the `service-instance` Helm chart. Can't be used with the `serviceInstanceFullname` option.
|
|
1030
1200
|
|
|
1031
|
-
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceFullname"></a>
|
|
1201
|
+
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceFullname"></a>19.1.2.2. Property `serviceInstanceFullname`
|
|
1032
1202
|
|
|
1033
1203
|
| | |
|
|
1034
1204
|
| ---------------------- | ------------------------------------ |
|
|
@@ -1037,7 +1207,7 @@ must respect the following conditions
|
|
|
1037
1207
|
|
|
1038
1208
|
**Description:** Full name of a BTP Operator Service Instance. Can't be used with the `serviceInstanceName` option.
|
|
1039
1209
|
|
|
1040
|
-
##### <a name="bindings_pattern1_anyOf_i1_externalName"></a>
|
|
1210
|
+
##### <a name="bindings_pattern1_anyOf_i1_externalName"></a>19.1.2.3. Property `externalName`
|
|
1041
1211
|
|
|
1042
1212
|
| | |
|
|
1043
1213
|
| -------- | -------- |
|
|
@@ -1045,7 +1215,7 @@ must respect the following conditions
|
|
|
1045
1215
|
|
|
1046
1216
|
**Description:** The name for the service binding in SAP BTP
|
|
1047
1217
|
|
|
1048
|
-
##### <a name="bindings_pattern1_anyOf_i1_secretName"></a>
|
|
1218
|
+
##### <a name="bindings_pattern1_anyOf_i1_secretName"></a>19.1.2.4. Property `secretName`
|
|
1049
1219
|
|
|
1050
1220
|
| | |
|
|
1051
1221
|
| ---------------------- | ------------------------------------ |
|
|
@@ -1054,7 +1224,7 @@ must respect the following conditions
|
|
|
1054
1224
|
|
|
1055
1225
|
**Description:** The name of the secret where the credentials are stored.
|
|
1056
1226
|
|
|
1057
|
-
##### <a name="bindings_pattern1_anyOf_i1_parameters"></a>
|
|
1227
|
+
##### <a name="bindings_pattern1_anyOf_i1_parameters"></a>19.1.2.5. Property `parameters`
|
|
1058
1228
|
|
|
1059
1229
|
| | |
|
|
1060
1230
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1063,7 +1233,7 @@ must respect the following conditions
|
|
|
1063
1233
|
|
|
1064
1234
|
**Description:** Some services support the provisioning of additional configuration parameters during the bind request. For the list of supported parameters, check the documentation of the particular service offering.
|
|
1065
1235
|
|
|
1066
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom"></a>
|
|
1236
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom"></a>19.1.2.6. Property `parametersFrom`
|
|
1067
1237
|
|
|
1068
1238
|
| | |
|
|
1069
1239
|
| -------- | ------- |
|
|
@@ -1075,7 +1245,7 @@ must respect the following conditions
|
|
|
1075
1245
|
| ------------------------------------------------------------------------ | ----------- |
|
|
1076
1246
|
| [parametersFrom items](#bindings_pattern1_anyOf_i1_parametersFrom_items) | - |
|
|
1077
1247
|
|
|
1078
|
-
##### <a name="
|
|
1248
|
+
##### <a name="autogenerated_heading_6"></a>19.1.2.6.1. items
|
|
1079
1249
|
|
|
1080
1250
|
| | |
|
|
1081
1251
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1087,7 +1257,7 @@ must respect the following conditions
|
|
|
1087
1257
|
| [item 0](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0) |
|
|
1088
1258
|
| [item 1](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1) |
|
|
1089
1259
|
|
|
1090
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0"></a>
|
|
1260
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0"></a>19.1.2.6.1.1. Property `None`
|
|
1091
1261
|
|
|
1092
1262
|
| | |
|
|
1093
1263
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1100,7 +1270,7 @@ must respect the following conditions
|
|
|
1100
1270
|
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1101
1271
|
| - [secretKeyRef](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef ) | No | object | No | - | - |
|
|
1102
1272
|
|
|
1103
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef"></a>
|
|
1273
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef"></a>19.1.2.6.1.1.1. Property `secretKeyRef`
|
|
1104
1274
|
|
|
1105
1275
|
| | |
|
|
1106
1276
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1112,7 +1282,7 @@ must respect the following conditions
|
|
|
1112
1282
|
| + [name](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
1113
1283
|
| + [key](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker. |
|
|
1114
1284
|
|
|
1115
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name"></a>
|
|
1285
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name"></a>19.1.2.6.1.1.1.1. Property `name`
|
|
1116
1286
|
|
|
1117
1287
|
| | |
|
|
1118
1288
|
| ---------------------- | ------------------------------------ |
|
|
@@ -1121,7 +1291,7 @@ must respect the following conditions
|
|
|
1121
1291
|
|
|
1122
1292
|
**Description:** Name of a Secret.
|
|
1123
1293
|
|
|
1124
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key"></a>
|
|
1294
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key"></a>19.1.2.6.1.1.1.2. Property `key`
|
|
1125
1295
|
|
|
1126
1296
|
| | |
|
|
1127
1297
|
| -------- | -------- |
|
|
@@ -1129,7 +1299,7 @@ must respect the following conditions
|
|
|
1129
1299
|
|
|
1130
1300
|
**Description:** Key in that Secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker.
|
|
1131
1301
|
|
|
1132
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1"></a>
|
|
1302
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1"></a>19.1.2.6.1.2. Property `None`
|
|
1133
1303
|
|
|
1134
1304
|
| | |
|
|
1135
1305
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1142,7 +1312,7 @@ must respect the following conditions
|
|
|
1142
1312
|
| ----------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1143
1313
|
| - [configMapKeyRef](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef ) | No | object | No | - | - |
|
|
1144
1314
|
|
|
1145
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef"></a>
|
|
1315
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef"></a>19.1.2.6.1.2.1. Property `configMapKeyRef`
|
|
1146
1316
|
|
|
1147
1317
|
| | |
|
|
1148
1318
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1154,7 +1324,7 @@ must respect the following conditions
|
|
|
1154
1324
|
| + [name](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Config Map |
|
|
1155
1325
|
| + [key](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key ) | No | string | No | - | Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker. |
|
|
1156
1326
|
|
|
1157
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name"></a>
|
|
1327
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name"></a>19.1.2.6.1.2.1.1. Property `name`
|
|
1158
1328
|
|
|
1159
1329
|
| | |
|
|
1160
1330
|
| ---------------------- | ------------------------------------ |
|
|
@@ -1163,7 +1333,7 @@ must respect the following conditions
|
|
|
1163
1333
|
|
|
1164
1334
|
**Description:** Name of a Config Map
|
|
1165
1335
|
|
|
1166
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key"></a>
|
|
1336
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key"></a>19.1.2.6.1.2.1.2. Property `key`
|
|
1167
1337
|
|
|
1168
1338
|
| | |
|
|
1169
1339
|
| -------- | -------- |
|
|
@@ -1171,7 +1341,7 @@ must respect the following conditions
|
|
|
1171
1341
|
|
|
1172
1342
|
**Description:** Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker.
|
|
1173
1343
|
|
|
1174
|
-
##### <a name="bindings_pattern1_anyOf_i1_credentialsRotationPolicy"></a>
|
|
1344
|
+
##### <a name="bindings_pattern1_anyOf_i1_credentialsRotationPolicy"></a>19.1.2.7. Property `credentialsRotationPolicy`
|
|
1175
1345
|
|
|
1176
1346
|
| | |
|
|
1177
1347
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|