/
werf_yaml.yml
812 lines (810 loc) · 43.7 KB
/
werf_yaml.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
sections:
- id: meta-section
description:
en: Meta section
ru: Секция мета-информации
directives:
- name: project
value: "string"
description:
en: Unique project name
ru: Уникальное имя проекта приложения
detailsAnchor:
en: "#project-name"
ru: "#имя-проекта"
required: true
- name: configVersion
value: "int"
description:
en: Config syntax version. It should always be 1 for now
ru: Версия конфигурации. На данный момент поддерживается единственная версия 1
required: true
- name: deploy
description:
en: Settings for deployment
ru: Настройки выката
detailsAnchor:
en: "#deploy"
ru: "#выкат"
collapsible: true
isCollapsedByDefault: false
directives:
- name: helmChartDir
value: "string"
description:
en: Path to the helm chart directory of the project
ru: Путь до директории helm чарта проекта
default: ".helm"
detailsAnchor:
en: "#helm-chart-dir"
ru: "#директория-helm-chart"
- name: helmRelease
value: "string"
description:
en: Release name template
ru: Шаблон имени релиза
default: "[[ project ]]-[[ env ]]"
detailsAnchor:
en: "#release-name"
ru: "#имя-релиза"
- name: helmReleaseSlug
value: "bool"
description:
en: Release name slugification
ru: Слагификация имени релиза
default: true
- name: namespace
value: "string"
description:
en: Kubernetes namespace template
ru: Шаблон Kubernetes namespace
default: "[[ project ]]-[[ env ]]"
detailsAnchor:
en: "#kubernetes-namespace"
ru: "#namespace-в-kubernetes"
- name: namespaceSlug
value: "bool"
description:
en: Kubernetes namespace slugification
ru: Слагификация Kubernetes namespace
default: true
detailsAnchor:
en: "#kubernetes-namespace"
ru: "#namespace-в-kubernetes"
- name: cleanup
description:
en: Settings for cleaning up irrelevant images
ru: Настройка удаления неактульных образов
detailsAnchor:
en: "#cleanup"
ru: "#очистка"
collapsible: true
isCollapsedByDefault: false
directives:
- name: disableKubernetesBasedPolicy
value: "bool"
description:
en: Disable a cleanup policy that allows not to remove images deployed in Kubernetes from the container registry
ru: Отключить политику очистки, которая позволяет не удалять запущенные в Kubernetes образы из container registry
- name: disableGitHistoryBasedPolicy
value: "bool"
description:
en: Disable a cleanup policy that allows not to remove images taking into account user-defined policies by the Git history (keepPolicies)
ru: Отключить политику очистки, которая позволяет не удалять образы с учётом пользовательских политик по истории Git (keepPolicies)
- name: disableBuiltWithinLastNHoursPolicy
value: "bool"
description:
en: Disable a cleanup policy that allows not to remove images built in last hours (keepImagesBuiltWithinLastNHours)
ru: Отключить политику очистки, которая позволяет не удалять образы, собранные в рамках заданного периода времени (keepImagesBuiltWithinLastNHours)
- name: keepImagesBuiltWithinLastNHours
value: "uint"
description:
en: The minimum number of hours that must elapse since the image is built
ru: Минимальное количество часов, которое должно пройти с момента сборки образа
default: "2"
- name: keepPolicies
description:
en: Set of policies to select relevant images using the Git history
ru: Набор политик для выборки актуальных образов, используя историю Git
detailsAnchor:
en: "#configuring-cleanup-policies"
ru: "#конфигурация-политик-очистки"
directiveList:
- name: references
description:
en: References to perform scanning on
ru: Набор references, который будет использоваться при сканировании
directives:
- name: branch
value: "string || /REGEXP/"
description:
en: One or more git origin branches
ru: Множество git origin веток
- name: tag
value: "string || /REGEXP/"
description:
en: One or more git origin tags
ru: Множество git origin тегов
- name: limit
description:
en: The set of rules to limit references on the basis of the date when the git tag was created or the activity in the git branch
ru: Набор правил, по которым можно ограничить описанное множество references, основываясь на времени создания git-тега или активности в git-ветке
directives:
- name: last
value: "int"
description:
en: To select n last references last n references from those defined in the branch or tag
ru: Выборка последних n references из определённого в branch/tag множества
default: "-1"
- name: in
value: "duration string"
description:
en: To select git tags that were created during the specified period or git branches that were active during the period
ru: Выборка git-тегов, которые были созданы в указанный период, или git-веток с активностью в рамках периода. Также для определённого множества branch/tag
- name: operator
value: "And || Or"
default: And
description:
en: Check both conditions or any of them
ru: Определяет какие references будут результатом политики, те которые удовлетворяют оба условия или любое из них
- name: imagesPerReference
description:
en: The limit on the number of images for each reference contained in the set
ru: Лимит искомых образов для каждого reference из множества
directives:
- name: last
value: "int"
description:
en: The number of images to search for each reference
ru: Количество искомых образов для каждого reference
default: "-1"
- name: in
value: "duration string"
description:
en: The time frame in which werf searches for images
ru: Период, в рамках которого необходимо выполнять поиск образов
- name: operator
value: "And || Or"
default: And
description:
en: Check both conditions or any of them
ru: Определяет какие образы сохранятся после применения политики, те которые удовлетворяют оба условия или любое из них
- name: gitWorktree
description:
en: Configure how werf handles git worktree of the project
ru: Настройки связанные с работой werf с рабочей директорией git проекта
detailsAnchor:
en: "#git-worktree"
ru: "#git-worktree"
collapsible: true
isCollapsedByDefault: false
directives:
- name: forceShallowClone
value: "bool"
description:
en: Force werf to use shallow clone despite restrictions
ru: Принудительно позволить werf использовать shallow clone несмотря на ограничения данного подхода
default: false
detailsAnchor:
en: "#git-worktree"
ru: "#git-worktree"
- name: allowUnshallow
value: "bool"
description:
en: Allow werf to automatically convert project shallow git clone to full one during build process when needed
ru: Разрешить процессу werf автоматически преобразовать shallow clone проекта в полный clone в процессе сборки по необходимости
default: true
- name: allowFetchOriginBranchesAndTags
value: "bool"
description:
en: Allow werf to synchronize git branches and tags with remote origin during cleanup process when needed
ru: Разрешить процессу werf автоматически скачать новые ветки и теги из origin в процессе cleanup по необходимости
default: true
detailsAnchor:
en: "#git-worktree"
ru: "#git-worktree"
- id: dockerfile-image-section
description:
en: "Dockerfile image section: optional, define as many image sections as you need"
ru: "Секция Dockerfile image: может использоваться произвольное количество секций"
directives:
- &dockerfile-image-section-image
name: image
value: "string || [ string, ... ] || ~"
description:
en: One or more unique names for image
ru: Одно или несколько уникальных имён для образа
detailsAnchor:
en: "#image-section"
ru: "#секция-image"
required: true
- name: dockerfile
value: "string"
description:
en: Dockerfile path relative to the context PATH
ru: Путь к Dockerfile относительно директории контекста
- name: context
value: "string"
description:
en: Build context PATH inside project directory
ru: Путь к контексту внутри папки проекта
- name: contextAddFiles
value: "[ string, ... ]"
description:
en: Untracked files and directories for adding to build context. The paths must be relative to context PATH
ru: Добавление нехранящихся в git файлов и директорий в сборочный контекст. Пути должны быть относительно директории контекста
detailsAnchor:
all: "#contextaddfiles"
- name: target
value: "string"
description:
en: Specific Dockerfile stage (last one by default, see docker build --target option)
ru: Конкретная стадия Dockerfile (по умолчанию — последняя, подобно docker build --target)
- name: args
value: "{ name string: value string, ... }"
description:
en: Variables for ARG dockerfile instructions (see docker build --build-arg option)
ru: Переменные для ARG Dockerfile-инструкций (подобно docker build --build-arg)
- name: addHost
value: "[ string, ... ]"
description:
en: Custom host-to-IP mapping (host:ip) (see docker build --add-host option)
ru: Установить связь host-to-IP (host:ip) (подобно docker build --add-host)
- name: network
value: "string"
description:
en: The networking mode for the RUN instructions during build (see docker build --network option)
ru: Сетевой режим для инструкций RUN во время сборки (подобно docker build --network)
- name: ssh
value: "string"
description:
en: SSH agent socket or keys to the build (only if BuildKit enabled) (see docker build --ssh option)
ru: Сокет агента SSH или ключи для сборки определённых слоёв (только если используется BuildKit) (подобно docker build --ssh)
- name: dependencies
description:
en: "Dependencies images for current image"
ru: "Образы-зависимости для текущего образа"
#detailsArticle:
#all: "/advanced/building_images_with_stapel/import_directive.html"
collapsible: true
isCollapsedByDefault: false
directiveList:
- name: image
value: "string"
description:
en: "Dependency image name, which should be built before building current image"
ru: "Имя зависимого образа, который должен быть собран до сборки текущего образа"
- name: imports
description:
en: "Define target build args to import image information into current image (optional)"
ru: "Определить аргументы для импорта информации о зависимом образе в текущий образ используя Dockerfile build-args (опционально)"
collapsible: false
isCollapsedByDefault: false
directiveList:
- name: type
value: "string"
description:
en: "Type of image info: ImageName, ImageID, ImageRepo or ImageTag"
ru: "Тип импортируемой информации об образе: ImageName, ImageID, ImageRepo или ImageTag"
- name: targetBuildArg
value: "string"
description:
en: "Name of build argument which will contain specified type of information about image"
ru: "Имя аргумента (Dockerfile build-args), который будет содержать указанный тип информации об образе"
- id: stapel-section
description:
en: "Stapel image/artifact section: optional, define as many image sections as you need"
ru: "Секция Stapel image/artifact: может использоваться произвольное количество секций"
isCollapsedByDefault: false
directives:
- << : *dockerfile-image-section-image
- name: artifact
value: "string"
description:
en: The unique name for artifact
ru: Уникальное имя артефакта
detailsArticle:
all: "/advanced/building_images_with_stapel/artifacts.html"
- name: from
value: "string"
description:
en: "The name of a base image"
ru: Имя и тег базового образа
detailsArticle:
all: "/advanced/building_images_with_stapel/base_image.html#from-fromlatest"
- name: fromLatest
value: "bool"
description:
en: "To use actual base image without caching"
ru: Использование актуального базового образа (без кеширования)
detailsArticle:
all: "/advanced/building_images_with_stapel/base_image.html#from-fromlatest"
- name: fromImage
value: "string"
description:
en: "To use image as base image by image name"
ru: "Использование образа из werf.yaml в качестве базового"
detailsArticle:
en: "/advanced/building_images_with_stapel/base_image.html#fromimage-and-fromartifact"
ru: "/advanced/building_images_with_stapel/base_image.html#fromimage-и-fromartifact"
- name: fromArtifact
value: "string"
description:
en: "To use artifact as base image by artifact name"
ru: "Использование образа артефакта из werf.yaml в качестве базового"
detailsArticle:
en: "/advanced/building_images_with_stapel/base_image.html#fromimage-and-fromartifact"
ru: "/advanced/building_images_with_stapel/base_image.html#fromimage-и-fromartifact"
- name: fromCacheVersion
value: "string"
description:
en: "Cache version"
ru: "Версия кеша"
detailsArticle:
all: "/advanced/building_images_with_stapel/base_image.html#fromcacheversion"
- name: git
description:
en: "Set of directives to add source files from git repositories (both the project repository and any other)"
ru: "Набор директив для добавления исходных файлов из git-репозиториев (как репозитория проекта, так и любого другого)"
detailsArticle:
all: "/advanced/building_images_with_stapel/git_directive.html"
collapsible: true
isCollapsedByDefault: false
directiveList:
- name: url
value: "string"
description:
en: "The address of the remote repository"
ru: "Адрес git-репозитория"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#working-with-remote-repositories"
ru: "/advanced/building_images_with_stapel/git_directive.html#работа-с-удаленными-репозиториями"
- name: branch
value: "string"
description:
en: "The branch name"
ru: "Имя ветки"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#syntax-of-a-git-mapping"
ru: "/advanced/building_images_with_stapel/git_directive.html#синтаксис"
- name: commit
value: "string"
description:
en: "The commit"
ru: "Коммит"
- name: tag
value: "string"
description:
en: "The tag name"
ru: "Имя тега"
- name: add
value: "string"
description:
en: "A source path in a repository"
ru: "Исходный путь в репозитории"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#copying-directories"
ru: "/advanced/building_images_with_stapel/git_directive.html#копирование-директорий"
- name: to
value: "string"
description:
en: "A destination path in image"
ru: "Путь назначения в образе"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#copying-directories"
ru: "/advanced/building_images_with_stapel/git_directive.html#копирование-директорий"
- name: owner
value: "string"
description:
en: "The name or UID of the owner"
ru: "Имя или UID владельца"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#changing-the-owner"
ru: "/advanced/building_images_with_stapel/git_directive.html#изменение-владельца"
- name: group
value: "string"
description:
en: "The name or GID of the owner’s group"
ru: "Имя или GID группы"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#changing-the-owner"
ru: "/advanced/building_images_with_stapel/git_directive.html#изменение-владельца"
- name: includePaths
value: "[ glob, ... ]"
description:
en: "Globs for including"
ru: "Глобы добавления"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#using-filters"
ru: "/advanced/building_images_with_stapel/git_directive.html#использование-фильтров"
- name: excludePaths
value: "[ glob, ... ]"
description:
en: "Globs for excluding"
ru: "Глобы исключения"
detailsArticle:
en: "/advanced/building_images_with_stapel/git_directive.html#using-filters"
ru: "/advanced/building_images_with_stapel/git_directive.html#использование-фильтров"
- name: stageDependencies
description:
en: "The organization of restarting assembly instructions when defined changes occur in the git repository"
ru: "Настройка перевыполнения сборочных инструкций при изменениях определённых файлов в репозитории"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-changes-in-the-git-repo"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-изменений-в-git-репозитории"
directives:
- name: install
value: "[ glob, ... ]"
description:
en: "Globs for install stage"
ru: "Глобы стадии install"
- name: beforeSetup
value: "[ glob, ... ]"
description:
en: "Globs for beforeSetup stage"
ru: "Глобы стадии beforeSetup"
- name: setup
value: "[ glob, ... ]"
description:
en: "Globs for setup stage"
ru: "Глобы стадии setup"
- name: shell
description:
en: "Shell assembly instructions"
ru: "Shell сборочные инструкции"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#shell"
collapsible: true
isCollapsedByDefault: false
directives:
- name: beforeInstall
value: "[ string, ... ]"
description:
en: "Commands for beforeInstall stage"
ru: "Команды для стадии beforeInstall"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#shell"
- name: install
value: "[ string, ... ]"
description:
en: "Commands for install stage"
ru: "Команды для стадии install"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#shell"
- name: beforeSetup
value: "[ string, ... ]"
description:
en: "Commands for beforeSetup stage"
ru: "Команды для стадии beforeSetup"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#shell"
- name: setup
value: "[ string, ... ]"
description:
en: "Commands for setup stage"
ru: "Команды для стадии setup"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#shell"
- name: cacheVersion
value: "string"
description:
en: "Common cache version"
ru: "Общая версия кеша"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: beforeInstallCacheVersion
value: "string"
description:
en: "Cache version for beforeInstall stage"
ru: "Версия кеша для стадии beforeInstall"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: installCacheVersion
value: "string"
description:
en: "Cache version for install stage"
ru: "Версия кеша для стадии install"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: beforeSetupCacheVersion
value: "string"
description:
en: "Cache version for beforeSetup stage"
ru: "Версия кеша для стадии beforeSetup"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: setupCacheVersion
value: "string"
description:
en: "Cache version for setup stage"
ru: "Версия кеша для стадии setup"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: ansible
description:
en: "Ansible assembly instructions"
ru: "Ansible сборочные инструкции"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#ansible"
collapsible: true
isCollapsedByDefault: false
directives:
- name: beforeInstall
value: "[ task, ... ]"
description:
en: "Tasks for beforeInstall stage"
ru: "Задания для стадии beforeInstall"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#ansible"
- name: install
value: "[ task, ... ]"
description:
en: "Tasks for install stage"
ru: "Задания для стадии install"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#ansible"
- name: beforeSetup
value: "[ task, ... ]"
description:
en: "Tasks for beforeSetup stage"
ru: "Задания для стадии beforeSetup"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#ansible"
- name: setup
value: "[ task, ... ]"
description:
en: "Tasks for setup stage"
ru: "Задания для стадии setup"
detailsArticle:
all: "/advanced/building_images_with_stapel/assembly_instructions.html#ansible"
- name: cacheVersion
value: "string"
description:
en: "Common cache version"
ru: "Общая версия кеша"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: beforeInstallCacheVersion
value: "string"
description:
en: "Cache version for beforeInstall stage"
ru: "Версия кеша для стадии beforeInstall"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: installCacheVersion
value: "string"
description:
en: "Cache version for install stage"
ru: "Версия кеша для стадии install"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: beforeSetupCacheVersion
value: "string"
description:
en: "Cache version for beforeSetup stage"
ru: "Версия кеша для стадии beforeSetup"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: setupCacheVersion
value: "string"
description:
en: "Cache version for setup stage"
ru: "Версия кеша для стадии setup"
detailsArticle:
en: "/advanced/building_images_with_stapel/assembly_instructions.html#dependency-on-the-cacheversion-value"
ru: "/advanced/building_images_with_stapel/assembly_instructions.html#зависимость-от-значения-cacheversion"
- name: docker
description:
en: "Set of directives to effect on an image manifest"
ru: "Набор директив для изменения манифеста образа"
detailsArticle:
all: "/advanced/building_images_with_stapel/docker_directive.html"
collapsible: true
isCollapsedByDefault: false
directives:
- name: USER
value: "string"
description:
en: "The user name (or UID) and optionally the user group (or GID)"
ru: "Имя пользователя (или UID) и опционально пользовательская группа (или GID)"
detailsLink: "https://docs.docker.com/engine/reference/builder/#user"
- name: WORKDIR
value: "string"
description:
en: "The working directory"
ru: "Рабочая директория"
detailsLink: "https://docs.docker.com/engine/reference/builder/#workdir"
- name: VOLUME
value: "[ string, ... ]"
description:
en: "Mount points"
ru: "Точки монтирования"
detailsLink: "https://docs.docker.com/engine/reference/builder/#volume"
- name: ENV
value: "{ name string: value string, ... }"
description:
en: "The environment variables"
ru: "Переменные окружения"
detailsLink: "https://docs.docker.com/engine/reference/builder/#env"
- name: LABEL
value: "{ name string: value string, ... }"
description:
en: "The metadata to an image"
ru: "Метаданные"
detailsLink: "https://docs.docker.com/engine/reference/builder/#label"
- name: EXPOSE
value: "[ string, ... ]"
description:
en: "To inform Docker that the container listens on the specified network ports at runtime"
ru: "Описание сетевых портов, которые будут прослушиваться в запущенном контейнере"
detailsLink: "https://docs.docker.com/engine/reference/builder/#expose"
- name: ENTRYPOINT
value: "string | [ string, ... ]"
description:
en: "To configure a container that will run as an executable"
ru: "Команда по умолчанию, которая будет выполнена при запуске контейнера"
detailsLink: "https://docs.docker.com/engine/reference/builder/#entrypoint"
detailsCustomLinks:
en:
- text: "How the Stapel builder processes CMD and ENTRYPOINT"
article: "/internals/build_process.html#how-the-stapel-builder-processes-cmd-and-entrypoint"
ru:
- text: "Как сборщик Stapel работает с CMD и ENTRYPOINT"
article: "/internals/build_process.html#как-сборщик-stapel-работает-с-cmd-и-entrypoint"
- name: CMD
value: "string"
description:
en: "To provide default arguments for the ENTRYPOINT to configure a container that will run as an executable"
ru: "Аргументы по умолчанию для ENTRYPOINT"
detailsLink: "https://docs.docker.com/engine/reference/builder/#cmd"
detailsCustomLinks:
en:
- text: "How the Stapel builder processes CMD and ENTRYPOINT"
article: "/internals/build_process.html#how-the-stapel-builder-processes-cmd-and-entrypoint"
ru:
- text: "Как сборщик Stapel работает с CMD и ENTRYPOINT"
article: "/internals/build_process"
- name: HEALTHCHECK
value: string
description:
en: "To tell Docker how to test a container to check that it is still working"
ru: "Инструкции, которые Docker может использовать для проверки работоспособности запущенного контейнера"
detailsLink: "https://docs.docker.com/engine/reference/builder/#healthcheck"
- name: mount
description:
en: "Mount points"
ru: "Точки монтирования"
detailsArticle:
all: "/advanced/building_images_with_stapel/mount_directive.html"
collapsible: true
isCollapsedByDefault: false
directiveList:
- name: from
value: "tmp_dir || build_dir"
description:
en: "Service folder name"
ru: "Имя служебной директории"
- name: fromPath
value: "string"
description:
en: "Absolute or relative path to an arbitrary file or folder on host"
ru: "Абсолютный или относительный путь до произвольного файла на хосте"
- name: to
value: "string"
description:
en: "Absolute path in image"
ru: "Абсолютный путь в образе"
- name: import
description:
en: "Imports"
ru: "Импортирование из образов и артефактов"
detailsArticle:
all: "/advanced/building_images_with_stapel/import_directive.html"
collapsible: true
isCollapsedByDefault: false
directiveList:
- name: artifact
value: "string"
description:
en: "The artifact name from which you want to copy files"
ru: "Имя артефакта, из которого выполнять копирование файлов"
- name: image
value: "string"
description:
en: "The image name from which you want to copy files"
ru: "Имя образа, из которого выполнять копирование файлов"
- name: stage
value: "string"
description:
en: "The stage name from which you want to copy files (the latest one by default)"
ru: "Имя стадии, из которой выполнять копирование файлов (по умолчанию последняя)"
- name: before
value: "string"
description:
en: "The stage name before which to perform importing files. At present, only install and setup stages are supported"
ru: "Выбор стадии импортирования файлов при сборке, до стадии install или setup"
- name: after
value: "string"
description:
en: "The stage name after which to perform importing files. At present, only install and setup stages are supported"
ru: "Выбор стадии импортирования файлов при сборке, после стадии install или setup"
- name: add
value: "string"
description:
en: "The absolute file or folder path in source image for copying"
ru: "Абсолютный путь до файла или директории в выбранном образе/артефакте"
- name: to
value: "string"
description:
en: "The absolute path in destination image. In case of absence, destination path equals source path"
ru: "Абсолютный путь в конечном образе. По умолчанию соответствует пути add"
- name: owner
value: "string"
description:
en: "The name or UID of the owner"
ru: "Имя или UID владельца"
- name: group
value: "string"
description:
en: "The name or GID of the owner’s group"
ru: "Имя или GID группы"
- name: includePaths
value: "[ glob, ... ]"
description:
en: "Globs for including"
ru: "Глобы добавления"
- name: excludePaths
value: "[ glob, ... ]"
description:
en: "Globs for excluding"
ru: "Глобы исключения"
- name: dependencies
description:
en: "Dependencies images for current image"
ru: "Образы-зависимости для текущего образа"
#detailsArticle:
#all: "/advanced/building_images_with_stapel/import_directive.html"
collapsible: true
isCollapsedByDefault: false
directiveList:
- name: image
value: "string"
description:
en: "Dependency image name, which should be built before building current image"
ru: "Имя зависимого образа, который должен быть собран до сборки текущего образа"
- name: before
value: "string"
description:
en: "The stage name before which image info should be imported (specify install or setup). Specified target env variables will be available at user stages after stage specified by this directive."
ru: "Выбор стадии перед которой должна быть импортирована информация об образе (требуется указать install или setup). Указанные переменные окружения будут доступны в пользовательских стадиях после указанной данной директивой стадии."
- name: after
value: "string"
description:
en: "The stage name after which image info should be imported (specify install or setup). Specified target env variables will be available at user stages after stage specified by this directive."
ru: "Выбор стадии после которой должна быть импортирована информация об образе (требуется указать install или setup). Указанные переменные окружения будут доступны в пользовательских стадиях после указанной данной директивой стадии."
- name: imports
description:
en: "Define target environment variables to import image information into current image (optional)"
ru: "Определить аргументы для импорта информации о зависимом образе в текущий образ используя переменные окружения (опционально)"
collapsible: false
isCollapsedByDefault: false
directiveList:
- name: type
value: "string"
description:
en: "Type of image info: ImageName, ImageID, ImageRepo or ImageTag"
ru: "Тип импортируемой информации об образе: ImageName, ImageID, ImageRepo или ImageTag"
- name: targetEnv
value: "string"
description:
en: "Name of environment variable which will contain specified type of information about image"
ru: "Имя переменной окружения, которая будет содержать указанный тип информации об образе"