Cleanup Policies

Cleanup removes files, applications, and configurations to free up storage and improve system performance. Regular cleanup helps optimize disk space and maintain system efficiency.

JFrog cleanup policies remove stale data based on specific criteria. Platform and Project Administrators define custom cleanup policies to identify package, release bundles, or builds that are candidates for removal. This automates cleanup processes that align with organizational needs by customizing these policies.

Key Benefits

• Improved Efficiency

• Optimizes platform performance and loading times.

• Enhanced User Experience

  Simplifies navigation by reducing the number of items, saving time and improving overall user experience.

• Reduced Storage Costs

  Frees up storage space by removing unnecessary items, helping to reduce costs.

Prerequisites

• Subscription: See the Subscription Information note in the Overview below.

• Administrator Access: Platform or Project Administrator

• Project Context

  • Platform Admins can manage cleanup policies globally across all projects or for specific projects.
  • Project Admins can manage policies within their project scope, with visibility into global policies affecting their projects.

Cleanup Policies Overview

There are 3 types of cleanup policies:

• Package Cleanup Policies define which Packages to delete.
• Release Bundles V2 Cleanup Policies define which Release Bundles V2 to delete.
• Build Cleanup Policies define which Builds to delete.

For supported package types, refer to Cleanup Supported Packages.

📘

Subscription Information

• Packages cleanup policies are supported on the Cloud (7.98.2) and Self-Hosted (7.98.7) platforms, with an Enterprise+ or Enterprise X (7.139.1 SaaS) license.
• Release Bundles V2 Cleanup policies are supported on the Cloud (7.104.2) and Self-Hosted (7.104.5) platforms, with an Enterprise+ or Enterprise X (7.139.1 SaaS) license.
• Builds Cleanup policies are supported on the Cloud (7.125) and Self-Hosted (7.125) platforms, with an Enterprise+ or Enterprise X (7.139.1 SaaS) license.

📘

Note

When you clean up Packages, Builds and Release Bundles (RB V2) that have associated evidence, the evidence is also permanently deleted.

Running Cleanup Policies

You can schedule hourly, daily, weekly, or monthly execution of a cleanup policy. You can also define time periods when execution is stopped. This enables you to perform cleanup during weekends or maintenance windows.

If required, you can run the cleanup policy manually. To learn more, refer to the Run Cleanup Policy Manually

As the cleanup process progresses, the system generates detailed logs in the Artifactory service logs.

Cleanup Limitations

The following limitations currently apply when you run a Packages Cleanup Policy:

Supported Repositories

• Supports Local and Federated repositories. Does not support Remote and Virtual repositories.

📘

Note

When cleaning Federated repositories, the run (dry or actual) can take significantly longer compared to Local repositories. This is because the cleanup workflow must check the last download status of each package across all federation members. The more members involved, the longer the process will take.

Recommendations to Optimize Cleanup:

• Adjust Policy Conditions: Narrow the scope of your cleanup policies to reduce the number of packages to be deleted in each run. This can significantly speed up the run.
• Increase Run Frequency: Run cleanup policies more often to process smaller sets of packages. This helps prevent large backlogs and improves long-term performance.

Package Verification

There is no verification if packages are part of a Release Bundle or build. A package-level Cleanup policy may impact build or release bundle promotion.

Cleanup Limits

Cleanup policy can delete up to 100,000 packages in a single run.

Progress Notifications

Notifications on the progress of a cleanup policy run are unavailable.

Visibility of Run Results

Run results for global policies are visible only to Platform admins globally.

Search

A project admin can only perform searches within their project context and does not have access to the global scope.

Artifactory Configuration

The Artifactory Instance can only be a Platform or a Mothership, not an Edge

Concurrent Execution and Queuing of Cleanup Policies

• Cleanup Policies can run concurrently up to a specified maximum. When this limit is reached, additional triggered policies are queued. Any further triggered policies will be skipped entirely if the queue reaches its maximum capacity.
• In the current version of Artifactory, queued or skipped policy runs do not appear in the Runs view. You can find a log of skipped policies in the Artifactory Service log. For example, you might see a message like: "Policy: test_policy run: 1 has been rejected since 3 concurrent runs are already in progress."

The following limitations currently apply when you run a Release Bundle V2 policy:

Distributed Release Bundles

• Cleanup policies will not delete distributed release bundles.

Source Artifacts

The source of release bundles, including associated builds and artifacts, will not be deleted.

Cleanup Known Issues

The following Known Issues were found in the Packages Cleanup Policy:

Editing Existing Cleanup Policy - Time-based Policy Conditions

When you edit a Cleanup Policy created before 7.111, you cannot modify settings for the following Time-based Policy Conditions:

• Packages Older Than

• Packages Not Downloaded Since

  Workaround: Create a new cleanup policy for the packages and configure it according to your needs.

Debian Package

When Debian packages are uploaded directly to the root directory, all packages may be cleaned during cleanup actions.

📘

Impact

Only the Version-based condition is affected by this issue. The Time-based condition remains unaffected.

Workaround: To avoid unintended cleanup, always upload Debian packages to a subdirectory rather than the root.

To learn more, refer to Artifactory 7.98 Known Issues.

SBT Package

When SBT packages are uploaded with the sbt-default repository layout, they are not resolved during cleanup actions.

Workaround: Choose Recommended Repository Layouts as described in the sbt Repository Layouts.

Cleanup Supported Packages

This topic outlines the supported packages with cleanup. It includes the policy conditions that apply to each package type.

Package Type	Supported Release Version	Lead Artifact	Age (Packages Older Than)	Usage (Packages Not Downloaded Since)	Version (Number of Latest Versions to Keep)
Docker	7.98.2	manifest.json			Note: Supported from V 7.115.1
Maven	7.98.2	.pom
npm	7.98.2	.tgz
Gradle	7.98.2	.pom
Generic	7.98.2	-
RPM | YUM	7.98.2	.rpm
Conan	7.98.2	conanfile.py
NuGet	7.98.2	.nupkg
PyPI	7.98.2	tar.gz, tgz, gz, whl, egg, bz2
Helm	7.98.2	.tgz
Go	7.98.2	.mod
Debian	7.98.2	.deb, .ddeb
Gems	7.96.3	.gem
HuggingFaceML	7.100.0	.jfrog_huggingface_model_info.json, .jfrog_huggingface_dataset_info
CocoaPods	7.99.1	.tar.gz, .tgz
Terraform	7.99.1	.zip
Terraform BE	7.103.0	.json
Machine Learning	7.104.2	model-manifest.json
Ansible	7.104.2	tar.gz
Cargo (Rust)	7.102.0	.crate
OCI	7.102.0	manifest.json			Note: Supported from V 7.115.1
Helm OCI	7.102.0	manifest.json			Note: Supported from V 7.115.1
Conda	7.105.2	tar.bz2
SBT	7.108	.pom, .xml
Alpine	7.111.0	.tar.gz, .apk
Hex	7.111.0	*
Vagrant	7.111.0	*
Chef	7.112	*
Puppet	7.112	*
Swift	7.114.1
Composer	7.116

📘

Note

Several package types consist of multiple underlying files. The package-level cleanup policy determines if the entire package should be removed by checking the statistics or metadata of the lead artifact. For example, in a Maven package, the policy checks the statistics of the .pom file. If the file meets the criteria, the entire package is eligible for cleanup.

Docker Image Cleanup

Docker images can have multiple tags and use list.manifests to support different architectures. Each list.manifest points to several specific manifests for various systems.

Learn how the policy executes for the following conditions:

• Time-based Condition: Time-based condition delete images and tags that have not been used within a certain period. This helps keep the connections between tags intact and ensures the stability of multi-architecture references. We recommend using the Packages Not Downloaded Since condition to prevent the deletion of images that are currently in use.

• Version-based Condition: From Artifactory V 7.115.1, we support Version-based policy conditions for Docker. It allows you to keep a specified number of image versions in the Docker repository, which considers the structure of Docker images when deciding what to delete. If a Docker image is a list.manifest, it will either be deleted with all of its related sub-manifests or not deleted at all. This approach maintains the relationships between images. This provides greater control over image management and helps maintain tag relationships and multi-architecture references.

  On the other hand, time-based conditions treat each manifest and list.manifest separately, without considering their hierarchical structure. Each one is evaluated independently based on its status.

📘

Note

• Tag Retention Logic: When this logic is enabled, previous tag revisions (tag retentions) will be removed only when the most recent revision of a tag is deleted.

• Max Unique Tags Logic: When this logic is enabled, the Last N Versions policy will take precedence.

  Example: With Last N Versions set to 2 and Max Unique Tags set to 5, retains only 2 versions/tags of the same image after the policy is executed.

❗️

Avoid Policies with Conflicting Criteria

We recommend to avoid configuring two different policies with conflicting criteria (For example, Last N Versions and Not Downloaded Since) for the same Docker, OCI, or Helm OCI repository.

Getting Started with Cleanup

This topic outlines how to get started with Cleanup. It includes granting permission to a project admin, working with cleanup, and monitoring cleanup operations.

1. Create Cleanup Policy
2. View All Cleanup Policies
3. Perform Dry Run Cleanup Policy
4. Download Last Run Report Cleanup Policy
5. Enable/Disable Cleanup Policy
6. Run Cleanup Policy Manually

Cleanup - User Activities and Authorizations

This topic outlines cleanup user activities and their authorizations.

Grant Permission to Project Admin

Activity	Platform Admin	Project Admin	Non-admin User
Grant Permission to a Project Admin

Create Cleanup Policy

Manage Cleanup - Policies

Manage Cleanup - Runs

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

Grant Permission to a Project Admin

This topic outlines how to grant permission to a project admin. Platform admins can enforce and manage cleanup policies across multiple projects or all projects on the JFrog platform and thereby gain full control over organizational storage management (Global Policies). Platform admins can also delegate permissions to Project admins to manage policies on their project scope only (Project Policies), and Project admins have visibility on Global Policies affecting their projects.

Global Policy: For maintaining consistent cleanup policies across multiple projects, ensuring compliance and standardization.

• Scope: Applies to all packages across the entire Artifactory instance.
• Configuration: Set by platform administrators and affects all projects at global level.

Project Policy: For addressing unique cleanup policies for a project that differ from the global standard, allowing flexibility to project administrators.

• Scope: Applies to individual projects.
• Configuration: Set by project/platform administrators for specific needs and requirements of a project.

To grant permissions to project admins, follow these steps:

1. From the Administration module, click Projects.

   

2. In the Projects screen, select the project where you want to give permissions to the Project Admin.

   The project details appear in read-only mode.

3. Click Edit Settings in the upper right of the project details screen.

4. Go to the section Project Admins, and then click Manage Resources.

5. Add the user to the project from the Users tab.

6. Click Save.

Work with Cleanup

This section outlines working with cleanup. It includes creating and managing cleanup policies and managing cleanup runs

Create Cleanup Policy

This topic outlines how to create a cleanup policy. You create a cleanup policy to delete unintended packages, builds and release bundles V2 in Artifactory.

Authorization

Create Cleanup Policy – Package

This topic outlines how to create a cleanup policy. You create a cleanup policy to delete unintended packages in Artifactory.

To create a Package Cleanup Retention policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, from the Create Policy dropdown list, click Cleanup Policy.

   

2. In the Create New Cleanup Policy page, select Package.

   

3. Configure the following in the Create New Cleanup Policy page:

* * * * * *     (Seconds - Optional)
| | | | | |
| | | | | +---- Day of the week (0 - 6) (Sunday=0)
| | | | +------ Month (1 - 12)
| | | +-------- Day of the month (1 - 31)
| | +---------- Hour (0 - 23)
| +------------ Minute (0 - 59)
+-------------- Second (0 - 59) (Optional)

4. Click Save to save the policy.

   The newly created cleanup policy appears in the Policies list and executes on the scheduled date and time.

   • Perform Dry Run Cleanup Policy: This feature allows you to see which items would be deleted without actually deleting them. We recommend performing a dry run and reviewing the results before enabling a policy.
   • Enable/Disable Cleanup Policy: The policy must be enabled to run automatically according to the schedule or Run Cleanup Policy Manually manually.

Create Cleanup Policy – Release Bundle V2

This topic outlines how to create a cleanup policy. You create a cleanup policy to delete unintended Release Bundle V2 in Artifactory.

To create a Release Bundle V2 Cleanup Retention policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, from the Create Policy dropdown list, click Cleanup Policy.

   

2. In the Create New Cleanup Policy page, select Release Bundle V2.

   

3. Configure the following in the Create New Cleanup Policy page:

* * * * * *     (Seconds - Optional)
| | | | | |
| | | | | +---- Day of the week (0 - 6) (Sunday=0)
| | | | +------ Month (1 - 12)
| | | +-------- Day of the month (1 - 31)
| | +---------- Hour (0 - 23)
| +------------ Minute (0 - 59)
+-------------- Second (0 - 59) (Optional)

4. Click Save to save the policy.

   The newly created cleanup policy appears in the Policies list and executes on the scheduled date and time.

   • Perform Dry Run Cleanup Policy: This feature allows you to see which items would be deleted without actually deleting them. We recommend performing a dry run and reviewing the results before enabling a policy.
   • Enable/Disable Cleanup Policy: The policy must be enabled to run automatically according to the schedule or Run Cleanup Policy Manually manually.

Create Cleanup Policy – Build

This topic outlines how to create a cleanup policy for builds. You create a cleanup policy to delete unintended builds in Artifactory.

Removing a build deletes build entity, build-info and build artifacts. To exclude build artifacts from deletion, uncheck Delete Build Artifacts checkbox under Settings (It is checked by default).

To create a Build Cleanup Retention policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, from the Create Policy dropdown list, click Cleanup Policy.

   

2. In the Create New Cleanup Policy page, select Build.

   

3. Configure the following in the Create New Cleanup Policy page:

* * * * * *     (Seconds - Optional)
| | | | | |
| | | | | +---- Day of the week (0 - 6) (Sunday=0)
| | | | +------ Month (1 - 12)
| | | +-------- Day of the month (1 - 31)
| | +---------- Hour (0 - 23)
| +------------ Minute (0 - 59)
+-------------- Second (0 - 59) (Optional)

4. Click Save to save the policy.

   The newly created cleanup policy appears in the Policies list and executes on the scheduled date and time.

   • Perform Dry Run Cleanup Policy: This feature allows you to see which items would be deleted without actually deleting them. We recommend performing a dry run and reviewing the results before enabling a policy.
   • Enable/Disable Cleanup Policy: The policy must be enabled to run automatically according to the schedule or Run Cleanup Policy Manually manually.

What Happens after the Cleanup Policy is Created?

This topic outlines what happens after a cleanup policy is created.

After the Cleanup policy has been defined and created:

• Enabled cleanup policies execute on the scheduled date and time.

  The cleanup policy can also be manually executed. To learn more, refer to Run Cleanup Policy Manually.

📘

Note

We recommend not to run more than 10 policies at the same time.

The Cleanup policy does not execute when an ongoing mandatory task is in progress (for example, Garbage Collection). If you want to manually Run Cleanup Policy Manually or Perform Dry Run Cleanup Policy, try at a later time.

• The system deleted the items, along with the associated metadata.
• As the cleanup process progresses, View All Cleanup Runs.

Manage Cleanup - Policies

This section outlines the actions you can perform on the Cleanup Policies in Artifactory. It includes enable/disable, search, manual run, dry run, edit, stop, delete, view and delete policies.

The following table lists all the possible actions on the policies and their equivalent links to REST API.

Authorization

View All Cleanup Policies

This section outlines how to view all cleanup policies. It guides you in reviewing key details such as the policy status, associated projects with the policy, timestamps for the last and next scheduled runs, last run status, actions performed on each policy, and options for customizing table columns.

To view all the Cleanup policies, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. Under the Policies tab, you can view all the policies.

Cleanup Policy Table Fields

The following table describes the columns of the cleanup policy table fields.

More Actions

From the more icon you can perform various actions on the policies. The actions are as follows:

Customize Table Columns

Arrange the table columns according to how you want to view them.

Follow these steps to display and arrange the columns:

1. From the Table header, click the Customize Columns at the end.

2. Select which columns to display in the Customize Columns pop-up and drag and drop to reorder them.

3. Click Apply.

   

Refresh Policies

To refresh policies, click Refresh icon from the top right above the table header.

Search Cleanup Policy

This topic outlines how to search for cleanup policies to locate the desired policy easily.

To search the Cleanup policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. Click the Policies tab, enter the policy name in the Search field, and then press enter on the keyboard.

Perform Dry Run Cleanup Policy

This section outlines how to perform a dry run for a cleanup policy. A dry run lets you preview which items will be deleted based on your defined policy criteria, without performing the actual deleting. This helps you understand the potential outcome before executing the policy. After the dry run, a CSV report is generated, listing all items that would be deleted along with relevant details. Review this list to decide whether to proceed with the policy or adjust the settings.

📘

Note

• We recommend performing a dry run and reviewing the results before activating a policy to prevent unintended deletion.
• Dry run results reflect the specific point in time when the dry run is performed. The results of an actual policy execution may differ, as it occurs at a later scheduled time.

To perform a dry run for the Cleanup policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Policies tab, under Policies, locate the policy you want to run, click the ••• icon and then click Dry Run.

   

3. After the dry run is completed:

   1. Download the report from Download Last Run Report Cleanup Policy or Download and Review Cleanup Run Report.
   2. Review its status report, as explained in Cleanup Run Report Overview.

Enable/Disable Cleanup Policy

This topic outlines how to enable/disable a cleanup policy. By default, newly created cleanup policies are disabled. You must activate a policy before it can execute automatically according to the schedule or be triggered manually.

📘

Note

We recommend that you first perform a dry run and review its results before you enable a policy. This helps prevent unintended deletion. For more information on performing a dry run, refer to Perform Dry Run Cleanup Policy.

The following actions can be performed on a disabled policy:

• Perform Dry Run Cleanup Policy
• Edit Cleanup Policy
• Delete Cleanup Policy

To Enable or Disable the Cleanup policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Policies tab, under Policies, locate the policy you want to enable/disable, and then toggle the slider under the Active column.

   Once enabled, the policy will run automatically based on the schedule you set during creation. You can also run it manually, as detailed in the Run Cleanup Policy Manually.

Disable All Cleanup Policies

This topic outlines how to disable all cleanup policies. As a Platform Admin, you can disable all policies globally, making them inactive. Once this is done, you can activate policies individually as needed.

📘

Note

The option to disable all policies is not available to Project Admins.

To disable all the Cleanup policies, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

📘

Note

Applies to Platform Admin only.

1. From the Projects dropdown list, click All Projects.

📘

Note

The Disable All Policies option can be viewed in the global context only.

2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

   The Retention Policies page appears.

3. In the Retention Policies page, click Cleanup.

   

4. From the Policies tab, click Global Stop/Disable dropdown list, and then click Disable All Policies.

   

   The Disable All Policies dialog appears.

5. In the Disable All Policies dialog, click Disable All Policies to confirm.

6. Check the Active column in the policies list to verify that all policies are now disabled.

Run Cleanup Policy Manually

This topic outlines how to run a cleanup policy manually. In addition to the periodic automated execution of the cleanup policy that occurs if you enable the policy and set its Cron Expression, you can also manually run the cleanup policy at any time.

📘

Note

To manually run a cleanup policy, the policy must first be activated. To learn more, refer to Enable/Disable Cleanup Policy.

To run the Cleanup policy manually, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Policies tab, under Policies, locate the policy you want to run, click ••• icon and then click Run.

3. After the run is completed:

   1. Download the completed report from Download Last Run Report Cleanup Policy or Download and Review Cleanup Run Report.
   2. Review downloaded report. To learn more, refer to Cleanup Run Report Overview.

Download Last Run Report Cleanup Policy

This section outlines how to download the last run report. The report is in CSV format and lists all deleted items with relevant information. You can review the list to learn about the deleted items.

To download the report, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Policies tab, under Policies, locate the policy for which you want to download the report, click ••• icon, and then click Download Last Report.

   A zip file is downloaded including one .csv file.

3. Review the downloaded report. To learn more, refer to Cleanup Run Report Overview.

Stop a Running Cleanup Policy

This topic outlines how to stop a running cleanup policy. For some reason, you may want to stop a running cleanup policy that is currently running before it finishes completion.

📘

Note

Once a policy has been stopped, it cannot resume from the point where it stopped. The only way to run the policy again is to restart it from the beginning.

To stop the running Cleanup policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Policies tab, under Policies, locate the policy you want to stop, click ••• icon and then click Stop.

3. In the Status column of Runs tab, the status changes to Stopped for that run.

Stop All Cleanup Policy Runs

This topic outlines how to stop all cleanup policy runs. You can perform this action from the policies tab and runs tab. As a Platform Admin, you can stop all currently running policies. Once a policy run is stopped, it cannot resume from its last point. You must restart the policy from the beginning to rerun it.

📘

Note

The option to stop all running policies is not available to Project Admins.

To stop all the Cleanup policy runs, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

📘

Note

Applies to Platform Admin only.

1. From the Projects dropdown list, click All Projects.

📘

Note

The Stop All Runs option can be viewed in the global context only.

2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

   The Retention Policies page appears.

3. In the Retention Policies page, click Cleanup.

   

4. From the Policies tab, click Global Stop/Disable, and then click Stop All Runs.

   

   Stop All Runs dialog appears.

5. In the Stop All Runs dialog, click Stop All Runs to confirm.

   To verify that all runs have stopped, under the Policies tab, check the Last Run Status column to ensure that all runs have stopped.

Edit Cleanup Policy

This topic outlines how to edit a Cleanup policy. After the cleanup policy has been created, you can change the settings or cleanup criteria.

📘

Note

You cannot update a running policy. If you want to update a policy that is running, you need to either wait for the run to complete or Stop a Running Cleanup Policy.

To edit the Cleanup policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Policies tab, under Policies, locate the policy you want to edit, click ••• icon and then click Edit.

   Edit <Policy Name> Cleanup Policy page appears.

3. In the <Policy Name> Cleanup Policy page, update the settings as needed, and then click Save.

Delete Cleanup Policy

This topic outlines how to delete a Cleanup policy. If you decide that a cleanup policy is no longer needed, you can delete it.

📘

Note

You cannot delete a running policy. If you want to delete a running policy, you need to either wait for the run to complete or Stop a Running Cleanup Policy.

To delete the Cleanup policy, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Policies tab, under Policies, locate the policy you want to delete, click ••• icon and then click Delete.

   Delete Policy dialog appears.

3. In the Delete Policy dialog, click Delete to confirm.

   The policy is deleted and removed from the Policies list.

Manage Cleanup - Runs

This section outlines the actions you can perform on the Cleanup Runs in the Artifactory. It includes view, stop all runs and downloading run reports.

Authorization

View All Cleanup Runs

This section outlines how to view the status of both past and ongoing cleanup runs. It provides guidance on how to review specific details, including the items that have been deleted, the associated timestamps, the status of each cleanup operation, customizing table columns, and applying filters to view the desired information.

To view the Cleanup policy runs, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Runs tab, under Runs, locate the Run Id you want to learn about it.

   In this list, you can review a comprehensive history of executed cleanup policies, including the start time, number and physical size of deleted items, and run status. The list is sorted chronologically, with the most recent run at the top. For more information on run statuses, see the table below.

3. To view a report on a specific policy run, locate the run, and then click Report icon.

   A zip file will be downloaded containing one or more .csv files. If the report is for a dry run, it will show the items that would be deleted in a real run. If it’s for an actual cleanup run, it will detail what was deleted.

📘

Note

• Reports are created and stored in a dedicated repository called jfrog-policy-reports-local. We recommend not deleting this repository to maintain a history of policy executions and their results. Deleting it will result in the loss of this history.
• If no items are deleted (for a real run) or deleted (for a dry run), a report will not be generated.
• The number of previous runs included in the history is defined by the artifactory.policy.cleanup.nodes_cleaned.expiration.days system property. To learn more, refer to Cleanup Policies System Properties.

Cleanup Runs Table Fields

The following table describes the columns of the cleanup runs table fields.

Customize Table Columns

Arrange the table columns according to how you want to view them.

Follow these steps to display and arrange the columns:

1. From the Table header, click Customize Columns icon at the end.

2. Select which columns to display in the Customize Columns pop-up and drag and drop to reorder them.

3. Click Apply.

   

Apply Filters to Sort Run Results

You can apply the filter to the run results to easily access your desired view.

To apply filters, follow these steps:

1. Click the Filter icon from the top right above the table header.

2. Apply the following fields as you want to sort:

3. To remove applied filters, click Clear all.

   

Refresh Cleanup Runs

If you don't see the latest created runs in the list, you can refresh the runs to view them.

To refresh runs, click Refresh icon from the top right above the table header.

Stop All Cleanup Policy Runs

This topic outlines how to stop all cleanup policy runs. You can perform this action from the policies tab and runs tab. As a Platform Admin, you can stop all currently running policies. Once a policy run is stopped, it cannot resume from its last point. You must restart the policy from the beginning to rerun it.

📘

Note

The option to stop all running policies is not available to Project Admins.

To stop all the Cleanup policy runs, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

📘

Note

Applies to Platform Admin only.

1. From the Projects dropdown list, click All Projects.

📘

Note

The Stop All Runs option can be viewed in the global context only.

2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

   The Retention Policies page appears.

   

3. In the Retention Policies page, click Cleanup.

4. From the Policies tab, click Global Stop/Disable, and then click Stop All Runs.

   The Stop All Runs dialog appears.

5. In the Stop All Runs dialog, click Stop All Runs to confirm.

   To verify that all runs have stopped, under the Policies tab, check the Last Run Status column to ensure that all runs have stopped.

Download and Review Cleanup Run Report

This section outlines how to download a cleanup run report. The report is in CSV format and lists all deleted items with relevant information. You can review the list to learn about the deleted items.

📘

Note

The report is generated for both actual run and dry run.

To download the report, follow these steps:

As per the User persona, you can work with the contexts as described below:

• Global Context

  📘

  Note

  Applies to Platform Admin only.

  1. From the Projects drop-down list, click All Projects.

  2. From the Administrator module, click Artifactory Settings, and then click Retention Policies.

     The Retention Policies page appears.

     

• Project Context

  📘

  Note

  Applies to both Platform Admin and Project Admin.

  1. From the Projects drop-down list, choose the desired project.

  2. From the Administrator module, click Artifactory, and then click Retention Policies.

     The Retention Policies page appears.

     

1. In the Retention Policies page, click Cleanup.

2. From the Runs tab, under Runs, locate the run for which you want to download the report, and then click Download icon.

   A zip file is downloaded including one .csv file.

   Possible Download icon statuses are as follows:

Icon	State	Description
	Enabled	Indicates the report is available for download
	Hover	On hovering the mouse pointer,
	Selected	Indicates the download icon is clicked.
	Disabled	Indicates the report is not available.

3. Reveiw the downloaded report. To learn more, refer to Cleanup Run Report Overview

Cleanup Run Report Overview

The downloaded CSV report provides a detailed summary of the cleanup process, including information on the policy used, the status of the run, and the items processed.

• Following are the package cleanup report fields:

• Following are the release bundle cleanup report fields:

• Following are the build cleanup report fields:

Cleanup Policies System Properties

The following properties can be configured in the Artifactory configuration file $JFROG_HOME/etc/artifactory/artifactory.system.properties.