Skip to content

docs: document config-db default retention periods #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: document config-db default retention periods #441

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb0b708
Initial plan
Copilot Nov 25, 2025
de4e345
docs: document config-db default retention periods
Copilot Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions mission-control/docs/guide/config-db/concepts/retention.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,31 @@ sidebar_custom_props:

After scraping we can choose to retain results on the basis of name, age, count and more.

## Default Retention Periods

When retention rules are not explicitly configured, config-db applies the following default retention periods:

| Type | Default Period | Description |
| --------------- | -------------- | --------------------------------------------------- |
| Config Items | 7 days | Configuration items are retained for 7 days |
| Changes | 60 days | Change records are retained for 60 days |
| Config Analysis | 60 days | Configuration analysis data is retained for 60 days |

These defaults ensure that your database doesn't grow unbounded while maintaining a reasonable history of configuration changes and analysis.

The retention rules are applied for each unique catalog item. If `changes` is specified with type `X` and count `20`, last 20 changes of `X` type would be kept for each catalog item

| Field | Description | Scheme |
| -------------- | ------------------------------------------------------------------ | ------------------------------------- |
| `types` | Specify retention rules for config items | [`[]ConfigItem`](#config-items) |
| `changes` | Specify retention rules for changes | [`[]Change`](#changes) |
| Field | Description | Scheme |
| -------------- | ------------------------------------------------------------------ | ------------------------------------------ |
| `types` | Specify retention rules for config items | [`[]ConfigItem`](#config-items) |
| `changes` | Specify retention rules for changes | [`[]Change`](#changes) |
| `staleItemAge` | Config items that were last scraped after this age will be deleted | [Duration](/docs/reference/types#duration) |

## Config Items

| Field | Description | Scheme |
| ------------ | ----------------------------------------------------------------- | ------------------------------------- |
| `name` | Specify retention rules for changes | `string` |
| Field | Description | Scheme |
| ------------ | ----------------------------------------------------------------- | ------------------------------------------ |
| `name` | Specify retention rules for changes | `string` |
| `createdAge` | Age after a config item is created it will be deleted | [Duration](/docs/reference/types#duration) |
| `updatedAge` | Age after a config item last updated, that it will be deleted | [Duration](/docs/reference/types#duration) |
| `deletedAge` | Age after a config item is soft deleted, will it be hard deleted. | [Duration](/docs/reference/types#duration) |
Expand Down Expand Up @@ -53,7 +65,7 @@ metadata:
name: kubernetes-scraper
spec:
retention:
//highlight-next-line
//highlight-next-line
staleItemAge: 30m
kubernetes:
clusterName: local
Expand All @@ -63,11 +75,11 @@ spec:

Changes can quickly accumulate and grow large over time. While it's important to retain some changes, others can be discarded after a period.

| Field | Description | Scheme | Required |
| ------- | ------------------------------------------------------- | ------------------------------------- | -------- |
| `name` | Name of the change type | `string` | `true` |
| Field | Description | Scheme | Required |
| ------- | ------------------------------------------------------- | ------------------------------------------ | -------- |
| `name` | Name of the change type | `string` | `true` |
| `age` | Maximum age of the change type to retain (`12h`, `30d`) | [Duration](/docs/reference/types#duration) | |
| `count` | Maximum count to retain the change type | `int` | |
| `count` | Maximum count to retain the change type | `int` | |

```yaml title="kubernetes-scraper.yaml"
apiVersion: configs.flanksource.com/v1
Expand Down