Skip to content

Commit 6fc3ffe

Browse files
authored
docs: add delete-dependency-<id> to README (#556)
Signed-off-by: Dmitry Mordvinov <dmitry.mordvinov@flant.com>
1 parent 295d3e5 commit 6fc3ffe

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Nelm is production-ready: as the werf deployment engine, it was battle-tested ac
4444
- [Reference](#reference)
4545
- [`werf.io/weight` annotation](#werfioweight-annotation)
4646
- [`werf.io/deploy-dependency-<id>` annotation](#werfiodeploy-dependency-id-annotation)
47+
- [`werf.io/delete-dependency-<id>` annotation](#werfiodelete-dependency-id-annotation)
4748
- [`<id>.external-dependency.werf.io/resource` annotation](#idexternal-dependencywerfioresource-annotation)
4849
- [`<id>.external-dependency.werf.io/name` annotation](#idexternal-dependencywerfioname-annotation)
4950
- [`werf.io/ownership` annotation](#werfioownership-annotation)
@@ -351,7 +352,7 @@ Default:
351352
352353
### `werf.io/deploy-dependency-<id>` annotation
353354
354-
The resource will deploy only after all of its dependencies are satisfied. It waits until the specified resource is just `present` or is also `ready`. It serves as a more powerful alternative to hooks and `werf.io/weight`. You can only point to resources in the release. This annotation has higher priority than `werf.io/weight` and `helm.sh/hook-weight`.
355+
The resource will deploy only after all of its dependencies are satisfied. It waits until the specified resource is just `present` or is also `ready`. It serves as a more powerful alternative to hooks and `werf.io/weight`. You can only point to resources in the release. This annotation has higher priority than `werf.io/weight` and `helm.sh/hook-weight`. This annotation has no effect if the resource on which we depend upon is outside the stage (pre, main, post, ...) of the resource with the annotation.
355356
356357
Example:
357358
```yaml
@@ -363,6 +364,20 @@ Format:
363364
werf.io/deploy-dependency-<anything>: state=ready|present[,name=<name>][,namespace=<namespace>][,kind=<kind>][,group=<group>][,version=<version>]
364365
```
365366
367+
### `werf.io/delete-dependency-<id>` annotation
368+
369+
The resource will be deleted only after all of its dependencies are satisfied. It waits until the specified resource is `absent`. You can only point to resources in the release. This annotation has no effect if the resource on which we depend upon is outside the stage (pre, main, post, ...) of the resource with the annotation.
370+
371+
Example:
372+
```yaml
373+
werf.io/delete-dependency-db: state=absent,kind=StatefulSet,name=postgres
374+
werf.io/delete-dependency-app: state=absent,kind=Deployment,group=apps,version=v1,name=app,namespace=app
375+
```
376+
Format:
377+
```
378+
werf.io/delete-dependency-<anything>: state=absent[,name=<name>][,namespace=<namespace>][,kind=<kind>][,group=<group>][,version=<version>]
379+
```
380+
366381
### `<id>.external-dependency.werf.io/resource` annotation
367382
368383
The resource will deploy only after all of its external dependencies are satisfied. It waits until the specified resource is `present` and `ready`. You can only point to resources outside the release.

0 commit comments

Comments
 (0)