Skip to content

Commit

Permalink
Merge branch 'main' into docbot/auto-update-credits
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-fenton-octopus authored Jan 29, 2025
2 parents e6fb277 + 64cfff4 commit c68cc0e
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 7 deletions.
17 changes: 14 additions & 3 deletions src/pages/docs/administration/retention-policies/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-08-02
modDate: 2025-01-28
title: Retention policies
icon: fa-solid fa-broom
description: Retention policies allow you to specify the releases, packages and files you want to keep as well as the ones you want cleaned up.
Expand Down Expand Up @@ -36,12 +36,23 @@ Octopus will never remove the latest release or the release previous to the late

### Tentacle files \{#targets-whats-deleted}

The Tentacle settings delete **packages**, and **files and folders** extracted from packages on the Tentacle machine that is being deployed to. Note that if you use the [Custom Installation Directory ](/docs/projects/steps/configuration-features/custom-installation-directory) feature, we will never delete from that directory during retention policies as it's assumed this directory has a working release in it. This can be purged during deployment in the project step settings.

:::div{.hint}
We talk about Tentacles here, but the same process and logic applies to [SSH Targets](/docs/infrastructure/deployment-targets/linux/ssh-target) also.
:::

#### Deployed files

Retention policies are applied to target Tentacle machines via the Retention Policy set in the Lifecycle. They clean up the files (and folders) that are deployed, e.g., the contents of a package extracted to a folder. They are run as the last step in the deployment. Retention Policies are applied to Environment/Project/Tenant/Step/Machine combinations. For example, the last three releases to the machine for the given step of a project deployed to environment/tenant will be kept.
Workers also clean up any files and folders older than 90 days.

Note that if you use the [Custom Installation Directory](/docs/projects/steps/configuration-features/custom-installation-directory) feature, we will never delete from that directory during retention policies as it's assumed this directory has a working release in it. This can be purged during deployment in the project step settings.


#### Packages

Packages that are transferred during the deployment are managed based on free disk space. For each deployment, prior to acquiring the package, the free disk space is checked and if less than 20% it will delete the “least used” package(s) from the Tentacle file store location. Packages that gets removed will be reacquired if needed for another deployment.
The disk space calculation for both targets and workers looks at the entire disk, however Octopus only cleans up in the file store.

### Built-in repository \{#built-in-repo-whats-deleted}

A retention policy can be applied to packages in the built-in Octopus package repository. By default, the policy is set to keep all packages indefinitely. This policy is *separate* from the [release retention policy](#releases-whats-deleted) described above.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2025-01-20
modDate: 2025-01-27
title: Linux targets
description: Configuring Linux servers as deployment targets in Octopus.
navOrder: 30
Expand Down Expand Up @@ -41,7 +41,6 @@ Since tooling used to invoke Octopus workloads is based on .NET 6, Octopus Serve

| OS | Versions |
|--------------------------------------------------------|------------------------|
| [Alpine](https://alpinelinux.org) | 3.20, 3.19, 3.18, 3.17 |
| [CentOS Stream](https://centos.org/) | 9 |
| [Debian](https://www.debian.org/) | 12, 11 |
| [Fedora](https://fedoraproject.org/) | 40, 39 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The build information step requires
- Octopus URL: URL of your Octopus server
- API Key: API key to use for uploading
- (Optional) Space name: Name of the space to upload the build information to
- Package ID: List of package IDs to associate the build information to
- Package ID: List of package IDs to associate the build information to. For maven packages hosted in external feeds the groupID and packageID are required, for more information see our [maven documentation](/docs/packaging-applications/package-repositories/maven-feeds#troubleshooting-maven-feeds)).
- Package version: The version of the packages

:::div{.hint}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ $templates.Items | ForEach-Object {
$template = $_
$name = $template.Name.Replace(" ", "-")
Write-Host "Writing $PSScriptRoot/step-templates/$name.json"
($template | ConvertTo-Json) | Out-File -FilePath "$PSScriptRoot/step-templates/$name.json"
($template | ConvertTo-Json -Depth 100) | Out-File -FilePath "$PSScriptRoot/step-templates/$name.json"
}
```

Expand Down

0 comments on commit c68cc0e

Please sign in to comment.