Skip to content

Commit

Permalink
Merge pull request #4635 from werf/docs-no-activity-timeout
Browse files Browse the repository at this point in the history
docs(helm): `werf.io/no-activity-timeout` annotation
  • Loading branch information
ilya-lesikov committed Jul 18, 2022
2 parents 98b3e3e + e6a5103 commit c2bee51
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
17 changes: 16 additions & 1 deletion docs/pages_en/reference/deploy_annotations.md
Expand Up @@ -15,6 +15,7 @@ This article contains description of annotations which control werf resource ope
- [`werf.io/fail-mode`](#fail-mode) — defines how werf will handle a resource failure condition which occurred after failures threshold has been reached for the resource during deploy process.
- [`werf.io/failures-allowed-per-replica`](#failures-allowed-per-replica) — defines a threshold of failures after which resource will be considered as failed and werf will handle this situation using [fail mode](#fail-mode).
- [`werf.io/ignore-readiness-probe-fails-for-CONTAINER_NAME`](#ignore-readiness-probe-failures-for-container) — override automatically calculated ignore period during which readiness probe failures will not mark resource as failed.
- [`werf.io/no-activity-timeout`](#no-activity-timeout) — change inactivity period after which the resource will be marked as failed.
- [`werf.io/log-regex`](#log-regex) — specifies a template for werf to show only those log lines of the resource that fit the specified regex template.
- [`werf.io/log-regex-for-CONTAINER_NAME`](#log-regex-for-container) — specifies a template for werf to show only those log lines of the resource container that fit the specified regex template.
- [`werf.io/skip-logs`](#skip-logs) — completely disable logs printing for the resource.
Expand Down Expand Up @@ -111,11 +112,25 @@ default, the ignore period is automatically calculated based on readiness probe
if `failureThreshold: 1` specified in the probe configuration then the first received failed probe will fail the
rollout, regardless of ignore period.

The value format is as specified here: https://pkg.go.dev/time#ParseDuration
The value format is specified [here](https://pkg.go.dev/time#ParseDuration).

Example:
`"werf.io/ignore-readiness-probe-fails-for-backend": "20s"`

## No activity timeout

`werf.io/no-activity-timeout: "TIME"`

Default: `4m`

Example: \
`werf.io/no-activity-timeout: "8m30s"` \
`werf.io/no-activity-timeout: "90s"`

If no new events or resource updates received in `TIME` then the resource will be marked as failed.

The value format is specified [here](https://pkg.go.dev/time#ParseDuration).

## Log regex

`"werf.io/log-regex": RE2_REGEX`
Expand Down
17 changes: 16 additions & 1 deletion docs/pages_ru/reference/deploy_annotations.md
Expand Up @@ -14,6 +14,7 @@ toc: false
- [`werf.io/fail-mode`](#fail-mode) — определяет как werf обработает ресурс в состоянии ошибки. Ресурс в свою очередь перейдет в состояние ошибки после превышения порога допустимых ошибок, обнаруженных при отслеживании этого ресурса в процессе выката.
- [`werf.io/failures-allowed-per-replica`](#failures-allowed-per-replica) — определяет порог ошибок, обнаруживаемых при отслеживании этого ресурса в процессе выката, после превышения которого ресурс перейдет в состояние ошибки. werf обработает это состояние в соответствии с настройкой [fail mode](#fail-mode).
- [`werf.io/ignore-readiness-probe-fails-for-CONTAINER_NAME`](#ignore-readiness-probe-failures-for-container) — переопределить высчитываемый автоматически период, в течение которого неуспешные readiness-пробы будут игнорироваться и не будут переводить ресурс в состояние ошибки.
- [`werf.io/no-activity-timeout`](#no-activity-timeout) — переопределить период неактивности, по истечении которого ресурс перейдет в состояние ошибки.
- [`werf.io/log-regex`](#log-regex) — показывать в логах только те строки вывода ресурса, которые подходят под указанный шаблон.
- [`werf.io/log-regex-for-CONTAINER_NAME`](#log-regex-for-container) — показывать в логах только те строки вывода для указанного контейнера, которые подходят под указанный шаблон.
- [`werf.io/skip-logs`](#skip-logs) — выключить логирование вывода для ресурса.
Expand Down Expand Up @@ -108,11 +109,25 @@ readiness-проб автоматически вычисляется на осн
readiness-пробы указано `failureThreshold: 1`, тогда первая же неудачная readiness-проба переведет ресурс в состояние
ошибки, независимо от периода игнорирования.

Формат записи значения описан здесь: https://pkg.go.dev/time#ParseDuration
Формат записи значения описан [здесь](https://pkg.go.dev/time#ParseDuration).

Пример:
`"werf.io/ignore-readiness-probe-fails-for-backend": "20s"`

## No activity timeout

`werf.io/no-activity-timeout: "TIME"`

По умолчанию: `4m`

Пример: \
`werf.io/no-activity-timeout: "8m30s"` \
`werf.io/no-activity-timeout: "90s"`

При отсутствии новых событий и обновлений ресурса в течение `TIME` ресурс перейдет в состояние ошибки.

Формат записи значения описан [здесь](https://pkg.go.dev/time#ParseDuration).

## Log regex

`"werf.io/log-regex": RE2_REGEX`
Expand Down

0 comments on commit c2bee51

Please sign in to comment.