Skip to content

Commit

Permalink
select tag clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
lena-larionova committed Oct 21, 2024
1 parent d2437d1 commit 46ed046
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
13 changes: 10 additions & 3 deletions app/_src/deck/guides/distributed-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,16 @@ configuration of other teams. You no longer need to maintain Kong's
configuration in a single repository, where multiple teams need to
co-ordinate.

The `--select-tag` flag is present on those two commands for use cases where
the file cannot have `select_tags` defined inside it. It is strongly advised
that you do not supply select-tags to sync and diff commands via flags.
### Select-tag in sync and diff

The `--select-tag` flag in `diff` and `sync` is meant only for use cases where
the file cannot have `select_tags` defined inside it.

This flag will only look for decK files where `select_tags` matches the provided value.
It _cannot_ filter a full configuration based on values found in `tags`, therefore you can't use this
flag to sync a subset of a decK file.

We strongly recommend not using select-tags to sync and diff commands via the `--select-tag` flag.
This is because the tag information should be part of the declarative
configuration file itself in order to provide a practical declarative file.
The tagging information and entity definitions should be present in one place,
Expand Down
4 changes: 4 additions & 0 deletions app/_src/deck/reference/deck_diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ and exit code 1 if an error occurs. (Default: `false`)
: only entities matching tags specified via this flag are diffed.
When this setting has multiple tag values, entities must match each of them.

: This flag will only look for decK files where `select_tags` matches the provided value.
It _cannot_ filter a full configuration based on values found in `tags`, therefore you can't use this
flag to diff a subset of a decK file.

{% if_version gte:1.8.x %}

`--silence-events`
Expand Down
4 changes: 4 additions & 0 deletions app/_src/deck/reference/deck_sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ See `db_update_propagation` in `kong.conf`. (Default: `0`)
: only entities matching tags specified via this flag are synced.
When this setting has multiple tag values, entities must match every tag.

: This flag will only look for decK files where `select_tags` matches the provided value.
It _cannot_ filter a full configuration based on values found in `tags`, therefore you can't use this
flag to sync a subset of a decK file.

{% if_version gte:1.8.x %}

`--silence-events`
Expand Down

0 comments on commit 46ed046

Please sign in to comment.