Skip to content

Document deployment.stagingRetention.maxCount and payloadRetention.maxSize #668

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

Open
dawsontoth wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −0
Open

Document deployment.stagingRetention.maxCount and payloadRetention.maxSize #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions reference/configuration/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,23 @@ agent:

---

## `deployment`

Retention for what `deploy_component` leaves behind. See [`deploy_component`](../operations-api/operations.md#deploy_component).

```yaml
deployment:
payloadRetention:
maxSize: 10485760
stagingRetention:
maxCount: 5
```

- `payloadRetention.maxSize` — Bytes. After a successful deploy, a payload larger than this has its stored tarball (`payload_blob`) dropped from the `hdb_deployment` row; the row and its metadata stay. Set it very high to retain every payload; _Default_: `10485760` (10 MiB)
- `stagingRetention.maxCount` <VersionBadge version="v5.3.0" /> — How many complete, unactivated staged builds may remain per component under `<componentsRoot>/.deploy-staging`. The newest survive; older ones are removed at the start of that component's next deploy and at startup, and `drop_component` removes all of them. `0` keeps none. This bounds dormant builds only, not a disk quota: staging directories that belong to an in-flight or unsettled deploy are never touched; _Default_: `5`
Comment thread
dawsontoth marked this conversation as resolved.

---

## `applications`

Added in: v5.0.0
Expand Down
6 changes: 6 additions & 0 deletions release-notes/v5-lincoln/5.3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ Replication URLs now also bracket a bare IPv6 literal correctly (`::1` becomes `

See [Configuration Options](/reference/v5/configuration/options#node).

## Component Deploys

### Staged Build Retention

`deploy_component` builds each release under `<componentsRoot>/.deploy-staging/<deploymentId>` and validates it before swapping it live. A build that completes but is never activated now survives startup, bounded per component by the new `deployment.stagingRetention.maxCount` setting (default `5`; `0` keeps none). Older builds are removed at the start of the component's next deploy and at startup; anything belonging to an in-flight or unsettled deploy is never touched. Groundwork for deploying from an already-staged build ([harper#2315](https://github.com/HarperFast/harper/issues/2315)). See [Configuration Options](/reference/v5/configuration/options#deployment).
Comment thread
dawsontoth marked this conversation as resolved.

## Security

### Route-Owned Authentication
Expand Down