Purge Settings

The Purge Settings define the configuration parameters to manage the archiving and purging of FlexDeploy execution data from the database repository, and purging of the artifacts stored in the artifacts repository.



PropertyDescription

Purge Enabled

Indicates whether the purge process is enabled. Purge runs every day if enabled. Run time is dependent on when FlexDeploy was started. If you have concerns with running purge at some specific milestone deployment event, you can disable Purge temporarily.

Keep Success CountHow many successful project version builds to keep regardless of Retention Days (Operational) (Note: this is a global setting and not specific to an environment/instance)
Keep Failed CountHow many failed project version builds to keep regardless of Retention Days (Operational) (Note: this is a global setting and not specific to an environment/instance)
Keep CountHow many project versions to keep for each environment/instance regardless of Retention Days (Operational). This helps you keep specific number of latest deployments so that you can back out to previous versions if desired.
Keep Pipeline Executions by Release CountHow many pipeline executions to keep per release.

Retention Days (Operational)

How many days of execution data to keep in the operational tables. After this data will be moved to Archive tables. Age of data is determined based on original created time.

Retention Days (Artifacts and Logs)

How many days to keep artifacts and execution logs for data that doesn't fall into the "Keep" settings above before deleting them.

Retention Days (Archive)

How many days of execution data to keep in the archive tables. Age of data is determined based on original created time. This means that you should keep this value higher than Retention Days (Operational). No criteria are performed on the data which is already in the archive tables other than time.

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 DAYS parameters (i.e. if Retention Days (Operational) is 1 day, anything that was deployed more than 1 day ago AND is one that needs to be kept to satisfy the KEEP parameters will be excluded from the archive/purge).
  • There is no archive of artifacts or plugin logs.
  • 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, the version of the source would need to be retrieved from source code repository (like SVN) in use and taken through the build/deploy cycle again.
  • The Retention Days are based on the first date it finds 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, or the 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.

 Click to show properties
PropertyValue
Retention Days (Operational)30
Retention Days (Artifacts)15
Keep Count3
Keep Success Count12
Keep Failed Count2
Retention Days (Archive)365
Retention Days for Logs365

Scenario 2: Retain 60 days of execution data and artifacts

 Click to show properties
PropertyValue
Retention Days (Operational)60
Retention Days (Artifacts)60
Keep Count2
Keep Success Count2
Keep Failed Count1
Retention Days (Archive)60
Retention Days for Logs60

Understanding the purge KEEP parameters

Project Deployments:

EnvironmentDEVQA

PROD

Project Versionsv9 (Failed)


v10v10v10

 v11  v11  v11 

 v12  v12  v12 

v13v13

 v14  v14 

v15v15

v16


v17


v18 (Failed)


v19

Properties:

PropertyValueVersions Retained due to property value
Keep Count2v11, v12, v14, v15, v17, v19
Keep Success Count4v15, v16, v17, v19
Keep Failed Count1v18
DEPLOYED TO AN ENVIRNOMENTAUTOMATICv12, v15, v19


In this example, the only project versions that will be checked against the 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.