/
documentation.yml
776 lines (522 loc) · 23.6 KB
/
documentation.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
# This file is generated by "regen.sh" command.
# DO NOT EDIT!
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
# This file is generated by "werf docs" command.
# DO NOT EDIT!
cli: &cli
- title: Overview of command groups
url: /reference/cli/overview.html
- title: Delivery commands
f:
- title: werf converge
url: /reference/cli/werf_converge.html
- title: werf dismiss
url: /reference/cli/werf_dismiss.html
- title: werf bundle
f:
- title: werf bundle apply
url: /reference/cli/werf_bundle_apply.html
- title: werf bundle download
url: /reference/cli/werf_bundle_download.html
- title: werf bundle export
url: /reference/cli/werf_bundle_export.html
- title: werf bundle publish
url: /reference/cli/werf_bundle_publish.html
- title: werf bundle render
url: /reference/cli/werf_bundle_render.html
- title: Cleaning commands
f:
- title: werf cleanup
url: /reference/cli/werf_cleanup.html
- title: werf purge
url: /reference/cli/werf_purge.html
- title: Helper commands
f:
- title: werf ci-env
url: /reference/cli/werf_ci_env.html
- title: werf build
url: /reference/cli/werf_build.html
- title: werf export
url: /reference/cli/werf_export.html
- title: werf run
url: /reference/cli/werf_run.html
- title: werf compose
f:
- title: werf compose config
url: /reference/cli/werf_compose_config.html
- title: werf compose down
url: /reference/cli/werf_compose_down.html
- title: werf compose run
url: /reference/cli/werf_compose_run.html
- title: werf compose up
url: /reference/cli/werf_compose_up.html
- title: werf slugify
url: /reference/cli/werf_slugify.html
- title: werf render
url: /reference/cli/werf_render.html
- title: Low-level management commands
f:
- title: werf config
f:
- title: werf config graph
url: /reference/cli/werf_config_graph.html
- title: werf config list
url: /reference/cli/werf_config_list.html
- title: werf config render
url: /reference/cli/werf_config_render.html
- title: werf managed-images
f:
- title: werf managed-images add
url: /reference/cli/werf_managed_images_add.html
- title: werf managed-images ls
url: /reference/cli/werf_managed_images_ls.html
- title: werf managed-images rm
url: /reference/cli/werf_managed_images_rm.html
- title: werf host
f:
- title: werf host cleanup
url: /reference/cli/werf_host_cleanup.html
- title: werf host purge
url: /reference/cli/werf_host_purge.html
- title: werf helm
f:
- title: werf helm create
url: /reference/cli/werf_helm_create.html
- title: werf helm dependency
f:
- title: werf helm dependency build
url: /reference/cli/werf_helm_dependency_build.html
- title: werf helm dependency list
url: /reference/cli/werf_helm_dependency_list.html
- title: werf helm dependency update
url: /reference/cli/werf_helm_dependency_update.html
- title: werf helm env
url: /reference/cli/werf_helm_env.html
- title: werf helm get
f:
- title: werf helm get all
url: /reference/cli/werf_helm_get_all.html
- title: werf helm get hooks
url: /reference/cli/werf_helm_get_hooks.html
- title: werf helm get manifest
url: /reference/cli/werf_helm_get_manifest.html
- title: werf helm get notes
url: /reference/cli/werf_helm_get_notes.html
- title: werf helm get values
url: /reference/cli/werf_helm_get_values.html
- title: werf helm get-autogenerated-values
url: /reference/cli/werf_helm_get_autogenerated_values.html
- title: werf helm get-namespace
url: /reference/cli/werf_helm_get_namespace.html
- title: werf helm get-release
url: /reference/cli/werf_helm_get_release.html
- title: werf helm history
url: /reference/cli/werf_helm_history.html
- title: werf helm install
url: /reference/cli/werf_helm_install.html
- title: werf helm lint
url: /reference/cli/werf_helm_lint.html
- title: werf helm list
url: /reference/cli/werf_helm_list.html
- title: werf helm migrate2to3
url: /reference/cli/werf_helm_migrate2to3.html
- title: werf helm package
url: /reference/cli/werf_helm_package.html
- title: werf helm plugin
f:
- title: werf helm plugin install
url: /reference/cli/werf_helm_plugin_install.html
- title: werf helm plugin list
url: /reference/cli/werf_helm_plugin_list.html
- title: werf helm plugin uninstall
url: /reference/cli/werf_helm_plugin_uninstall.html
- title: werf helm plugin update
url: /reference/cli/werf_helm_plugin_update.html
- title: werf helm pull
url: /reference/cli/werf_helm_pull.html
- title: werf helm registry
f:
- title: werf helm registry login
url: /reference/cli/werf_helm_registry_login.html
- title: werf helm registry logout
url: /reference/cli/werf_helm_registry_logout.html
- title: werf helm repo
f:
- title: werf helm repo add
url: /reference/cli/werf_helm_repo_add.html
- title: werf helm repo index
url: /reference/cli/werf_helm_repo_index.html
- title: werf helm repo list
url: /reference/cli/werf_helm_repo_list.html
- title: werf helm repo remove
url: /reference/cli/werf_helm_repo_remove.html
- title: werf helm repo update
url: /reference/cli/werf_helm_repo_update.html
- title: werf helm rollback
url: /reference/cli/werf_helm_rollback.html
- title: werf helm search
f:
- title: werf helm search hub
url: /reference/cli/werf_helm_search_hub.html
- title: werf helm search repo
url: /reference/cli/werf_helm_search_repo.html
- title: werf helm secret
f:
- title: werf helm secret decrypt
url: /reference/cli/werf_helm_secret_decrypt.html
- title: werf helm secret encrypt
url: /reference/cli/werf_helm_secret_encrypt.html
- title: werf helm secret file
f:
- title: werf helm secret file decrypt
url: /reference/cli/werf_helm_secret_file_decrypt.html
- title: werf helm secret file edit
url: /reference/cli/werf_helm_secret_file_edit.html
- title: werf helm secret file encrypt
url: /reference/cli/werf_helm_secret_file_encrypt.html
- title: werf helm secret generate-secret-key
url: /reference/cli/werf_helm_secret_generate_secret_key.html
- title: werf helm secret rotate-secret-key
url: /reference/cli/werf_helm_secret_rotate_secret_key.html
- title: werf helm secret values
f:
- title: werf helm secret values decrypt
url: /reference/cli/werf_helm_secret_values_decrypt.html
- title: werf helm secret values edit
url: /reference/cli/werf_helm_secret_values_edit.html
- title: werf helm secret values encrypt
url: /reference/cli/werf_helm_secret_values_encrypt.html
- title: werf helm show
f:
- title: werf helm show all
url: /reference/cli/werf_helm_show_all.html
- title: werf helm show chart
url: /reference/cli/werf_helm_show_chart.html
- title: werf helm show crds
url: /reference/cli/werf_helm_show_crds.html
- title: werf helm show readme
url: /reference/cli/werf_helm_show_readme.html
- title: werf helm show values
url: /reference/cli/werf_helm_show_values.html
- title: werf helm status
url: /reference/cli/werf_helm_status.html
- title: werf helm template
url: /reference/cli/werf_helm_template.html
- title: werf helm test
url: /reference/cli/werf_helm_test.html
- title: werf helm uninstall
url: /reference/cli/werf_helm_uninstall.html
- title: werf helm upgrade
url: /reference/cli/werf_helm_upgrade.html
- title: werf helm verify
url: /reference/cli/werf_helm_verify.html
- title: werf helm version
url: /reference/cli/werf_helm_version.html
- title: werf cr
f:
- title: werf cr login
url: /reference/cli/werf_cr_login.html
- title: werf cr logout
url: /reference/cli/werf_cr_logout.html
- title: Other commands
f:
- title: werf synchronization
url: /reference/cli/werf_synchronization.html
- title: werf completion
url: /reference/cli/werf_completion.html
- title: werf version
url: /reference/cli/werf_version.html
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
entries:
en:
f:
- title: Overview
url: /index.html
- title: Quickstart
url: /quickstart.html
- title: Using with CI/CD systems
url: /using_with_ci_cd_systems.html
- title: Reference
f:
- title: werf.yaml
url: /reference/werf_yaml.html
- title: werf.yaml template engine
url: /reference/werf_yaml_template_engine.html
- title: werf-giterminism.yaml
url: /reference/werf_giterminism_yaml.html
- title: Deploy annotations
url: /reference/deploy_annotations.html
- title: Command line interface
f: *cli
- title: Advanced
f:
- title: Giterminism
url: /advanced/giterminism.html
- title: Helm
f:
- title: Overview
url: /advanced/helm/overview.html
- title: Configuration
f:
- title: Chart
url: /advanced/helm/configuration/chart.html
- title: Templates
url: /advanced/helm/configuration/templates.html
- title: Values
url: /advanced/helm/configuration/values.html
- title: Giterminism
url: /advanced/helm/configuration/giterminism.html
- title: Secrets
url: /advanced/helm/configuration/secrets.html
- title: Chart dependencies
url: /advanced/helm/configuration/chart_dependencies.html
- title: Deploy process
f:
- title: Steps
url: /advanced/helm/deploy_process/steps.html
- title: Helm hooks
url: /advanced/helm/deploy_process/helm_hooks.html
- title: Annotating and labeling of chart resources
url: /advanced/helm/deploy_process/annotating_and_labeling.html
- title: Releases
f:
- title: Release
url: /advanced/helm/releases/release.html
- title: Naming
url: /advanced/helm/releases/naming.html
- title: Manage releases
url: /advanced/helm/releases/manage_releases.html
- title: Storage layouts
url: /advanced/storage_layouts.html
- title: Cleanup
url: /advanced/cleanup.html
- title: Bundles
url: /advanced/bundles.html
- title: Buildah mode
url: /advanced/buildah_mode.html
- title: CI/CD
f:
- title: CI/CD workflow basics
url: /advanced/ci_cd/ci_cd_workflow_basics.html
- title: Generic CI/CD integration
url: /advanced/ci_cd/generic_ci_cd_integration.html
- title: GitLab CI/CD
url: /advanced/ci_cd/gitlab_ci_cd.html
- title: GitHub Actions
url: /advanced/ci_cd/github_actions.html
- title: Run in containers (experimental)
f:
- title: Use Docker container
url: /advanced/ci_cd/run_in_container/use_docker_container.html
- title: Use Kubernetes
url: /advanced/ci_cd/run_in_container/use_kubernetes.html
- title: Use GitLab CI/CD with Docker executor
url: /advanced/ci_cd/run_in_container/use_gitlab_ci_cd_with_docker_executor.html
- title: Use GitLab CI/CD with Kubernetes executor
url: /advanced/ci_cd/run_in_container/use_gitlab_ci_cd_with_kubernetes_executor.html
- title: How it works
url: /advanced/ci_cd/run_in_container/how_it_works.html
- title: werf with ArgoCD (experimental)
f:
- title: CI/CD flow overview
url: /advanced/ci_cd/werf_with_argocd/ci_cd_flow_overview.html
- title: Prepare Kubernetes cluster
url: /advanced/ci_cd/werf_with_argocd/prepare_kubernetes_cluster.html
- title: Configure CI/CD
url: /advanced/ci_cd/werf_with_argocd/configure_ci_cd.html
- title: Building images with stapel
f:
- title: Base image (required)
url: /advanced/building_images_with_stapel/base_image.html
- title: Adding docker instructions
url: /advanced/building_images_with_stapel/docker_directive.html
- title: Adding source code from git repositories
url: /advanced/building_images_with_stapel/git_directive.html
- title: Running assembly instructions
url: /advanced/building_images_with_stapel/assembly_instructions.html
- title: Reducing image size and speeding up a build by mounts
url: /advanced/building_images_with_stapel/mount_directive.html
- title: Importing from images and artifacts
url: /advanced/building_images_with_stapel/import_directive.html
- title: Artifacts
url: /advanced/building_images_with_stapel/artifacts.html
- title: Development and debug
f:
- title: Stage Introspection
url: /advanced/development_and_debug/stage_introspection.html
- title: Lint and render chart
url: /advanced/development_and_debug/lint_and_render_chart.html
- title: Supported container registries
url: /advanced/supported_container_registries.html
- title: Synchronization in werf
url: /advanced/synchronization.html
- title: Internals
f:
- title: Stages and storage
url: /internals/stages_and_storage.html
- title: Build process
url: /internals/build_process.html
- title: How CI/CD integration works
f:
- title: General overview
url: /internals/how_ci_cd_integration_works/general_overview.html
- title: GitLab CI/CD
url: /internals/how_ci_cd_integration_works/gitlab_ci_cd.html
- title: GitHub Actions
url: /internals/how_ci_cd_integration_works/github_actions.html
- title: Names slug algorithm
url: /internals/names_slug_algorithm.html
- title: Integration with SSH agent
url: /internals/integration_with_ssh_agent.html
- title: Development
f:
- title: Stapel image
url: /internals/development/stapel_image.html
- title: What's new in v1.2
f:
- title: Changelog
url: /whats_new_in_v1_2/changelog.html
- title: How to migrate from v1.1 to v1.2
url: /whats_new_in_v1_2/how_to_migrate_from_v1_1_to_v1_2.html
ru:
f:
- title: Обзор
url: /index.html
- title: Быстрый старт
url: /quickstart.html
- title: Использование в CI/CD системах
url: /using_with_ci_cd_systems.html
- title: Справочник
f:
- title: werf.yaml
url: /reference/werf_yaml.html
- title: Шаблонизатор werf.yaml
url: /reference/werf_yaml_template_engine.html
- title: werf-giterminism.yaml
url: /reference/werf_giterminism_yaml.html
- title: Аннотации для деплоя
url: /reference/deploy_annotations.html
- title: Интерфейс командной строки
f: *cli
- title: Документация продвинутого уровня
f:
- title: Гитерминизм
url: /advanced/giterminism.html
- title: Helm
f:
- title: Обзор
url: /advanced/helm/overview.html
- title: Конфигурация
f:
- title: Чарт
url: /advanced/helm/configuration/chart.html
- title: Шаблоны
url: /advanced/helm/configuration/templates.html
- title: Данные (values)
url: /advanced/helm/configuration/values.html
- title: Гитерминизм
url: /advanced/helm/configuration/giterminism.html
- title: Секреты
url: /advanced/helm/configuration/secrets.html
- title: Зависимости чарта
url: /advanced/helm/configuration/chart_dependencies.html
- title: Процесс деплоя
f:
- title: Шаги
url: /advanced/helm/deploy_process/steps.html
- title: Helm хуки
url: /advanced/helm/deploy_process/helm_hooks.html
- title: Аннотации и лейблы для ресурсов чарта
url: /advanced/helm/deploy_process/annotating_and_labeling.html
- title: Релизы
f:
- title: Релиз
url: /advanced/helm/releases/release.html
- title: Именование
url: /advanced/helm/releases/naming.html
- title: Управление релизами
url: /advanced/helm/releases/manage_releases.html
- title: Организация хранилища стадий
url: /advanced/storage_layouts.html
- title: Очистка
url: /advanced/cleanup.html
- title: Бандлы
url: /advanced/bundles.html
- title: Buildah
url: /advanced/buildah_mode.html
- title: CI/CD
f:
- title: Основы организации CI/CD
url: /advanced/ci_cd/ci_cd_workflow_basics.html
- title: Интеграция с CI/CD-системами
url: /advanced/ci_cd/generic_ci_cd_integration.html
- title: Интеграция с GitLab CI/CD
url: /advanced/ci_cd/gitlab_ci_cd.html
- title: Интеграция с GitHub Actions
url: /advanced/ci_cd/github_actions.html
- title: Запуск в контейнерах (experimental)
f:
- title: В Docker-контейнере
url: /advanced/ci_cd/run_in_container/use_docker_container.html
- title: В Kubernetes
url: /advanced/ci_cd/run_in_container/use_kubernetes.html
- title: В GitLab CI/CD с Docker executor
url: /advanced/ci_cd/run_in_container/use_gitlab_ci_cd_with_docker_executor.html
- title: В GitLab CI/CD с Kubernetes executor
url: /advanced/ci_cd/run_in_container/use_gitlab_ci_cd_with_kubernetes_executor.html
- title: Принципы работы
url: /advanced/ci_cd/run_in_container/how_it_works.html
- title: Сборка образов с помощью Stapel
f:
- title: Базовый образ
url: /advanced/building_images_with_stapel/base_image.html
- title: Использование Docker-инструкций
url: /advanced/building_images_with_stapel/docker_directive.html
- title: Добавление исходного кода из git-репозиториев
url: /advanced/building_images_with_stapel/git_directive.html
- title: Запуск инструкций сборки
url: /advanced/building_images_with_stapel/assembly_instructions.html
- title: Ускорение сборки и уменьшение размера за счёт монтирования
url: /advanced/building_images_with_stapel/mount_directive.html
- title: Импорт из артефактов и образов
url: /advanced/building_images_with_stapel/import_directive.html
- title: Артефакты
url: /advanced/building_images_with_stapel/artifacts.html
- title: Разработка и отладка
f:
- title: Интроспекция стадий
url: /advanced/development_and_debug/stage_introspection.html
- title: Рендеринг и проверка конфигурации
url: /advanced/development_and_debug/lint_and_render_chart.html
- title: Поддерживаемые container registries
url: /advanced/supported_container_registries.html
- title: Синхронизация в werf
url: /advanced/synchronization.html
- title: Внутренности
f:
- title: Стадии и хранилище
url: /internals/stages_and_storage.html
- title: Процесс сборки
url: /internals/build_process.html
- title: Как работает интеграция с CI/CD
f:
- title: Общие сведения
url: /internals/how_ci_cd_integration_works/general_overview.html
- title: GitLab CI/CD
url: /internals/how_ci_cd_integration_works/gitlab_ci_cd.html
- title: GitHub Actions
url: /internals/how_ci_cd_integration_works/github_actions.html
- title: Преобразование имен в werf
url: /internals/names_slug_algorithm.html
- title: Интеграция с SSH-агентом
url: /internals/integration_with_ssh_agent.html
- title: Для разработчиков
f:
- title: Образ Stapel
url: /internals/development/stapel_image.html
- title: Что нового в v1.2
f:
- title: Changelog
url: /whats_new_in_v1_2/changelog.html
- title: Как мигрировать с v1.1 на v1.2
url: /whats_new_in_v1_2/how_to_migrate_from_v1_1_to_v1_2.html