You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: bundle/internal/docs/docs.md
+26-21Lines changed: 26 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
2
2
## artifacts
3
+
3
4
Defines the attributes to build an artifact
4
5
5
6
@@ -46,9 +47,9 @@ Each item has the following attributes:
46
47
47
48
48
49
## bundle
50
+
49
51
The attributes of the bundle. See [_](/dev-tools/bundles/settings.md#bundle)
50
52
51
-
#### Attributes
52
53
53
54
54
55
.. list-table::
@@ -88,9 +89,9 @@ The attributes of the bundle. See [_](/dev-tools/bundles/settings.md#bundle)
88
89
89
90
90
91
### bundle.deployment
92
+
91
93
The definition of the bundle deployment
92
94
93
-
#### Attributes
94
95
95
96
96
97
.. list-table::
@@ -110,9 +111,9 @@ The definition of the bundle deployment
110
111
111
112
112
113
### bundle.deployment.lock
114
+
113
115
The deployment lock attributes.
114
116
115
-
#### Attributes
116
117
117
118
118
119
.. list-table::
@@ -132,9 +133,9 @@ The deployment lock attributes.
132
133
133
134
134
135
### bundle.git
136
+
135
137
The Git version control details that are associated with your bundle.
136
138
137
-
#### Attributes
138
139
139
140
140
141
.. list-table::
@@ -154,9 +155,9 @@ The Git version control details that are associated with your bundle.
154
155
155
156
156
157
## experimental
158
+
157
159
Defines attributes for experimental features.
158
160
159
-
#### Attributes
160
161
161
162
162
163
.. list-table::
@@ -184,9 +185,9 @@ Defines attributes for experimental features.
184
185
185
186
186
187
### experimental.pydabs
188
+
187
189
The PyDABs configuration.
188
190
189
-
#### Attributes
190
191
191
192
192
193
.. list-table::
@@ -210,10 +211,12 @@ The PyDABs configuration.
210
211
211
212
212
213
## include
214
+
213
215
Specifies a list of path globs that contain configuration files to include within the bundle. See [_](/dev-tools/bundles/settings.md#include)
214
216
215
217
216
218
## permissions
219
+
217
220
Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle. See [_](/dev-tools/bundles/settings.md#permissions) and [_](/dev-tools/bundles/permissions.md).
218
221
219
222
Each item of `permissions` has the following attributes:
@@ -244,9 +247,9 @@ Each item of `permissions` has the following attributes:
244
247
245
248
246
249
## presets
250
+
247
251
Defines bundle deployment presets. See [_](/dev-tools/bundles/deployment-modes.md#presets).
248
252
249
-
#### Attributes
250
253
251
254
252
255
.. list-table::
@@ -282,9 +285,9 @@ Defines bundle deployment presets. See [_](/dev-tools/bundles/deployment-modes.m
282
285
283
286
284
287
## resources
288
+
285
289
Specifies information about the Databricks resources used by the bundle. See [_](/dev-tools/bundles/resources.md).
286
290
287
-
#### Attributes
288
291
289
292
290
293
.. list-table::
@@ -340,9 +343,9 @@ Specifies information about the Databricks resources used by the bundle. See [_]
340
343
341
344
342
345
## run_as
346
+
343
347
The identity to use to run the bundle.
344
348
345
-
#### Attributes
346
349
347
350
348
351
.. list-table::
@@ -362,9 +365,9 @@ The identity to use to run the bundle.
362
365
363
366
364
367
## sync
368
+
365
369
The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/)
366
370
367
-
#### Attributes
368
371
369
372
370
373
.. list-table::
@@ -388,6 +391,7 @@ The files and file paths to include or exclude in the bundle. See [_](/dev-tools
388
391
389
392
390
393
## targets
394
+
391
395
Defines deployment targets for the bundle.
392
396
393
397
@@ -470,9 +474,9 @@ Each item has the following attributes:
470
474
471
475
472
476
### targets.bundle
477
+
473
478
The name of the bundle when deploying to this target.
474
479
475
-
#### Attributes
476
480
477
481
478
482
.. list-table::
@@ -512,9 +516,9 @@ The name of the bundle when deploying to this target.
512
516
513
517
514
518
### targets.bundle.deployment
519
+
515
520
The definition of the bundle deployment
516
521
517
-
#### Attributes
518
522
519
523
520
524
.. list-table::
@@ -534,9 +538,9 @@ The definition of the bundle deployment
534
538
535
539
536
540
### targets.bundle.deployment.lock
541
+
537
542
The deployment lock attributes.
538
543
539
-
#### Attributes
540
544
541
545
542
546
.. list-table::
@@ -556,9 +560,9 @@ The deployment lock attributes.
556
560
557
561
558
562
### targets.bundle.git
563
+
559
564
The Git version control details that are associated with your bundle.
560
565
561
-
#### Attributes
562
566
563
567
564
568
.. list-table::
@@ -578,9 +582,9 @@ The Git version control details that are associated with your bundle.
578
582
579
583
580
584
### targets.git
585
+
581
586
The Git version control settings for the target.
582
587
583
-
#### Attributes
584
588
585
589
586
590
.. list-table::
@@ -600,9 +604,9 @@ The Git version control settings for the target.
600
604
601
605
602
606
### targets.presets
607
+
603
608
The deployment presets for the target.
604
609
605
-
#### Attributes
606
610
607
611
608
612
.. list-table::
@@ -638,9 +642,9 @@ The deployment presets for the target.
638
642
639
643
640
644
### targets.resources
645
+
641
646
The resource definitions for the target.
642
647
643
-
#### Attributes
644
648
645
649
646
650
.. list-table::
@@ -696,9 +700,9 @@ The resource definitions for the target.
696
700
697
701
698
702
### targets.sync
703
+
699
704
The local paths to sync to the target workspace when a bundle is run or deployed.
700
705
701
-
#### Attributes
702
706
703
707
704
708
.. list-table::
@@ -722,9 +726,9 @@ The local paths to sync to the target workspace when a bundle is run or deployed
722
726
723
727
724
728
### targets.workspace
729
+
725
730
The Databricks workspace for the target.
726
731
727
-
#### Attributes
728
732
729
733
730
734
.. list-table::
@@ -800,6 +804,7 @@ The Databricks workspace for the target.
800
804
801
805
802
806
## variables
807
+
803
808
A Map that defines the custom variables for the bundle, where each key is the name of the variable, and the value is a Map that defines the variable.
804
809
805
810
@@ -842,9 +847,9 @@ Each item has the following attributes:
842
847
843
848
844
849
### variables.lookup
850
+
845
851
The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.
846
852
847
-
#### Attributes
848
853
849
854
850
855
.. list-table::
@@ -904,9 +909,9 @@ The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, m
0 commit comments