Skip to content

Commit

Permalink
Merge pull request #4180 from werf/docs-bundles-werf-bundle-render
Browse files Browse the repository at this point in the history
docs(bundles): explain new "werf bundle render" command
  • Loading branch information
ilya-lesikov committed Feb 17, 2022
2 parents 262412a + 6c3026e commit e55accd
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/pages_en/advanced/bundles.md
Expand Up @@ -50,6 +50,18 @@ werf will check that bundle has been updated in the container registry for the s

## Other commands to work with bundles

### Render bundle manifests

[`werf bundle render`]({{ "/reference/cli/werf_bundle_render.html" | true_relative_url }}) command renders Kubernetes manifests that can be passed to other software which will handle the deployment part (e.g. ArgoCD) or can be used just for the debugging.

Command **does not require project git directory**. One of the two options has to be specified:
1. `--repo`, to render bundle from the remote OCI-repository.
2. or `--bundle-dir`, to render bundle from the directory containing the extracted bundle.

If you are going to deploy resulting manifests, then you should provide values for the options `--release` and `--namespace`, otherwise stub values will be used for them.

Option `--output` might be used to save rendered manifests to an arbitrary file.

### Export bundle into the directory

[werf-bundle-export]({{ "/reference/cli/werf_bundle_export.html" | true_relative_url }}) command will create bundle directory in the same way as it will be published into the container registry.
Expand Down
12 changes: 12 additions & 0 deletions docs/pages_ru/advanced/bundles.md
Expand Up @@ -50,6 +50,18 @@ werf позволяет разделить процесс выпуска нов

## Другие команды для работы с бандлами

### Рендеринг манифестов бандла

Команда [`werf bundle render`]({{ "/reference/cli/werf_bundle_render.html" | true_relative_url }}) позволяет отрендерить Kubernetes-манифесты в окончательном виде, что может использоваться для дальнейшего деплоя с другим ПО (например, с ArgoCD) или для отладки.

Команда **не требует запуска в git проекта**. Требуется указать одну из двух опций:
1. `--repo`, чтобы отрендерить бандл из удалённого OCI-репозитория.
2. или `--bundle-dir`, чтобы отрендерить бандл, находящийся в указанной директории в распакованном виде.

Если собираетесь деплоить получившиеся манифесты, то следует указать значения для опций `--release` и `--namespace`, иначе в качестве release и namespace будут использованы заглушки.

Опцию `--output` можно использовать для сохранения результата в произвольный файл.

### Экспорт бандла в директорию

Команда [`werf bundle export`]({{ "/reference/cli/werf_bundle_export.html" | true_relative_url }}) позволяет создать директорию чарта в том виде, в котором он будет опубликован в container registry.
Expand Down

0 comments on commit e55accd

Please sign in to comment.