The Purge Settings define the configuration parameters to manage the purging of FlexDeploy execution data from the database repository, and purging of the artifacts stored in the artifacts repository. These settings should be carefully adjusted to meet your data retention requirements for audit, and at the same time purging data which is no longer required to ensure a high performing system.
| Property | Description |
|---|---|
Purge Enabled | Indicates whether the purge process is enabled. Purge runs every 24 hours if enable, beginning with a few minutes after server startup. If you have concerns with running purge at some specific milestone deployment event, you can disable the purge temporarily. |
| Keep Success Count | How many successful project version builds to keep regardless of Retention Days (Operational) This is a global setting for each project, and not specific to an environment/instance. |
| Keep Failed Count | How many failed project version builds to keep regardless of Retention Days (Operational) This is a global setting for each project, and not specific to an environment/instance. |
| Keep Count | How many project versions to keep for each environment/instance regardless of Retention Days (Operational). This helps you keep a specific number of latest deployments so that you can revert back to previous versions if desired. |
| Keep Pipeline Executions by Release Count | How many pipeline executions to keep per release. |
Retention Days | How many days of execution data to keep. Age of data is determined based on creation time. |
Retention Days (Artifacts and Logs) | How many days to keep artifacts and execution logs. |
Purge Rules
- Any workflow execution that is the last successful deployment to an environment is automatically excluded from the purge.
- The four KEEP related parameters override the
DAYSparameters (e.g. ifRetention Days is1 day, anything which was deployed more than 1 day ago AND is one that needs to be kept to satisfy theKEEPparameters will be retained). - When artifacts have been purged, a red circle will appear on the project version indicating that the artifacts have been purged. This project version will also no longer be available to deploy to any environment. To redeploy this version you would need to perform a new build using the same revision of the source code.
- The
Retention Daysare based on the first date found in this sequence:- End time of the workflow execution
- Start time of the workflow execution
- Created time of the workflow execution
- Requested start time of the workflow request
- Created time of the workflow request.
Examples of configuring the purge
Scenario 1: Retain the last 3 successful builds in each environment/instance and keep the last 12 successful builds and last 2 failed builds overall. Artifacts will be purged from the file system after 15 days and execution data will be archived after 30 days. Data will remain in the archive for 365 days.
Scenario 2: Retain 60 days of execution data and artifacts
Understanding the purge KEEP parameters
Project Deployments:
| Environment | DEV | QA | PROD |
|---|---|---|---|
| Project Versions | v9 (Failed) | ||
| v10 | v10 | v10 | |
| v13 | v13 | ||
| v15 | v15 | ||
| v16 | |||
| v17 | |||
| v18 (Failed) | |||
| v19 |
Properties:
| Property | Value | Versions Retained due to property value |
|---|---|---|
| Keep Count | 2 | v11, v12, v14, v15, v17, v19 |
| Keep Success Count | 4 | v15, v16, v17, v19 |
| Keep Failed Count | 1 | v18 |
| DEPLOYED TO AN ENVIRNOMENT | AUTOMATIC | v12, v15, v19 |
Retention Days would be v9, v10, and v13. Those three versions will only be purged/archived in they are older than the retention days parameters.