Skip to content

Commit

Permalink
feat(cleanup): change default from unlimited to one image per reference
Browse files Browse the repository at this point in the history
Having an unlimited default for images per reference doesn't make practical sense and can lead to inefficient cleanup processes due to user oversight. Limiting the default to one image per reference ensures a more effective and predictable cleanup behavior.

Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>
  • Loading branch information
alexey-igrychev committed Aug 5, 2024
1 parent 74dfb3a commit 9ab8474
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/pages_en/usage/cleanup/cr_cleanup.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ You can limit the set of references on the basis of the date when the git tag wa

In the example above, werf selects no more than 10 latest branches that have the `features/` prefix in the name and have shown any activity during the last week.

- The `last` parameter allows you to select the last `n` references from the set defined in `branch`/`tag`.
- The `last` parameter allows you to select the last `n` references from the set defined in `branch`/`tag`. By default, there is no limit (`-1`).
- The `in` parameter (see the [documentation](https://golang.org/pkg/time/#ParseDuration) to learn more) allows you to select git tags that were created during the specified period, or git branches with activity within the period. It can also be used for a specific set of `branch` / `tag`.
- The `operator` parameter defines the references resulting from the policy. They may satisfy both conditions or either of them (`And` is set by default).

Expand All @@ -93,7 +93,7 @@ imagesPerReference:
operator: string
```

- The `last` parameter specifies the number of images for each reference. By default, there is no limit (`-1`).
- The `last` parameter specifies the number of images for each reference. By default, there is one image (`1`).
- The `in` parameter (refer to the [documentation](https://golang.org/pkg/time/#ParseDuration) to learn more) defines the period for which to search for images.
- The `operator` parameter determines which images will be saved after applying the policy. The images may satisfy both conditions or either of them (`And` is set by default).

Expand Down
4 changes: 2 additions & 2 deletions docs/pages_ru/usage/cleanup/cr_cleanup.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ branch: main # or /^(main|production)$/

В примере описывается выборка из не более чем 10 последних веток с префиксом `features/` в имени, в которых была какая-либо активность за последнюю неделю.

- Параметр `last` позволяет выбирать последние `n` reference'ов из определённого в `branch`/`tag` множества.
- Параметр `last` позволяет выбирать последние `n` reference'ов из определённого в `branch`/`tag` множества. По умолчанию количество не ограничено (`-1`).
- Параметр `in` (синтаксис доступен [в документации](https://golang.org/pkg/time/#ParseDuration)) позволяет выбирать Git-теги, которые были созданы в указанный период, или Git-ветки с активностью в рамках периода. Также для определённого множества `branch`/`tag`.
- Параметр `operator` определяет, какие referencе'ы будут результатом политики: удовлетворяющие оба условия или любое из них (`And` по умолчанию).

Expand All @@ -93,7 +93,7 @@ imagesPerReference:
operator: string
```

- Параметр `last` определяет количество искомых образов для каждого reference. По умолчанию количество не ограничено (`-1`).
- Параметр `last` определяет количество искомых образов для каждого reference. По умолчанию количество соответствует одному образу (`1`).
- Параметр `in` (синтаксис доступен [в документации](https://golang.org/pkg/time/#ParseDuration)) определяет период, в рамках которого необходимо выполнять поиск образов.
- Параметр `operator` определяет, какие образы сохранятся после применения политики: удовлетворяющие оба условия или любое из них (`And` по умолчанию).

Expand Down
4 changes: 2 additions & 2 deletions pkg/config/meta_cleanup.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ var (
defaultReferencesLimitLast = -1
defaultReferencesLimitOperator = AndOperator

// Unlimited images per reference by default.
defaultImagesPerReferenceLast = -1
// Keep only the last image by default.
defaultImagesPerReferenceLast = 1
defaultImagesPerReferenceOperator = AndOperator
)

Expand Down

0 comments on commit 9ab8474

Please sign in to comment.