maintainer
praqma-thi

Artifactory retention

Repository used to manage Artifactory repository retention policies.

Adopting this for own usage

Change the artifactory server URL in scripts/ArtifactRetention.groovy and scripts/BuildRetention.groovy
Set up any desired retention policies using the guide below
Run the retention using the guide below

Setting up a retention policy

You can either subscribe it to a premade retention policy or create a custom policy.

Subscribing your repository to a premade retention policy

Add an entry for your repository in the config/template-subscription.json file under the template you wish to subscribe to.

Available templates

Unused

-repo-name: The target repository -ttl-without-dl: Time to keep artifacts with zero total downloads

Setting up a custom retention policy

If none of the premade policies suit you, add a custom AQL file under the aql/artifact/ directory named <repository-name>.aql. This should contain an AQL query that fetches the items you want to clean up.

Creating a new retention policy template

New templates can be defined under the aql/templates dir. The expandTemplates.sh script creates a copy of the template under aql/artifact/ for each of its subscribers defined in the config/template-subscription.json file. Any string in the template that matches a key passed in by a subscriber will be replaced by the subscriber's value.

Setting up build retention

Build retention works identical to artifact retention, except that you add AQL scripts to the aql/build/ dir. Templates are not supported.

Running retention

To run artifact retention, you can run the runRetention.sh script present in the repository: ./runRetention.groovy artifacts <repo-name> [user] [password]

Note: If you subscribed to a retention policy, you must run ./expandTemplates.sh first.

To run build retention, you can run the runRetention.sh script present in the repository: ./runRetention.groovy builds <retention-name> [user] [password]

Automating the retention

The repository contains two Jenkinsfiles for automating retention runs as well as integrating changes, you'll find them under the jenkins directory. You should be able to adopt them with minor changes.

brad-payne / artifactory-retention Goto Github PK