Overview
To avoid lengthy and intensive analysis processes, Xray does not automatically analyze all the resources in the system but allows you to manually select the repositories, builds, and release bundles to be indexed.
Add Resources for Indexing
To configure your indexed resources, in the Administration module, go to Xray | Settings | General and click Indexed Resources.
From the Indexed Resources page do the following:
To add resources for indexing:
Select the resource type to index (Repositories | Builds | Release Bundles).
Add Repositories/Builds/Release Bundles from the available resources in Artifactory.
For repositories, from the list of available repositories in Artifactory
For builds and release Bundles, according to Name or Pattern
Review the list of added resources.
To remove indexed repositories:
From the Repositories tab, select Add a Repository.
In the list of repositories in the right column, select the repositories you want to remove from being indexed and click the arrow to move them to the right column.
This will remove the repositories from the list and Xray will stop indexing those repositories.
Indexing All Builds
To index all current and any future builds, you can add an Include Pattern containing */**
Note
Index Artifacts History and the Xray Data Retention features require Artifactory version 7.33.x and above.
Index Artifacts History
Index Artifacts history enables you to narrow down the selection criteria of artifacts in the repositories you want to index. Because indexing entire repositories that are large and contain a large number of artifacts all at once may be too lengthy of a process, and the data consumption that is required will consume a large amount of disk space, the index artifacts history feature offers a solution to this issue.
You can select which artifacts to index in a repository by doing one or a combination of the following:
Limit which artifacts to index, by selecting a time range for artifacts that were loaded in the last number of days you set.
Define a repository path to include or exclude an inner folder within the repository, to index artifacts that reside within that folder.
Use a combination of both a time range and a path, for example, set a repository path to a production folder within the repository, and set the time range to only index artifacts within that folder that were uploaded in the last 90 days.
Use a combination of both all artifacts and a path, for example, to index all artifacts in the production folder within the repository.
Set a Retention Period
As Xray's indexed resources are retained in the system, this can result in large amounts of data being stored, which impacts your storage and causes performance issues. Starting from Xray version 3.41.4, you can set retention periods for repositories and builds. The retention period defines how long Xray will retain artifacts scan data, and after the set retention period, this data is deleted, thus improving performance and freeing up storage space.
The default period is 90 days. You can change the default period using the server.repo.defaultRetentionDaysForIndexedRepo in the Xray System YAML.
Repositories Retention Period
To set the retention period for a repository, do the following:
In the Administration module, go to Xray | Settings | General and click Indexed Resources.
Select the repository or multiple repositories and select Configure.
Select one of the following:
Any artifact from the last number of days: The artifact will be retained for the number of days you set here, after the artifact is scanned. This will apply to all artifacts in the repository.
By Pattern: By pattern enables you to set a more granular retention period. It enables you to scan future artifacts within the specific path, and set a retention period for the historical data of artifacts after they are scanned.
Index: If checked, Xray will scan newly added artifacts in the path. Note that existing artifacts will not be scanned. If the folder contains existing artifacts that have been scanned, and you do not want to index new artifacts in that folder, you can choose not to index that folder.
Retention period: The number of days to retain artifacts data after they are scanned by Xray.
For example, if you have one repository that contains all of your artifacts, you can set a retention period for artifacts within a folder in the repository. Let's assume your repository contains a production folder, and you would like to set a retention period for artifacts within that folder. You can provide the path to that folder as an include pattern and set the retention period. If that folder also contains other folders that you do not want to be scanned or retained, you can exclude it using the exclude pattern.
Note
Patterns are set using simple comma-separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: "org/apache/**"
Patterns are limited to 10 patterns per repository.
If you select by pattern, you must define a retention period for all other artifacts in the repository in the All Other Artifacts setting.
Builds Retention Period
To set the retention period for a Build, do the following:
In the Administration module, go to Xray | Settings | General and click Indexed Resources. Select the Builds tab.
Click the Set Retention icon next to the Build you want to configure.
Set the retention period. The default is 15 days.
Xray Data Retention REST API Support
Repository Configuration is also supported through the following REST APIs:
Xray Data Retention System YAML Configurations
The following table lists all the configuration system parameters that support Xray Data Retention:
System Parameter | Description | Default Value |
|---|---|---|
| Max limit of retention period for artifacts in a repository. | 1000 |
| Max limit of number of patterns in repository paths per repository. | 10 |
| Default retention period for artifacts of an index repository. This value is applied when the retention period is not configured. | 90 |
| Default retention period for artifacts in a non-indexed repository. | 3 |
| Disable data cleanup. | FALSE |
| Default retention period for indexed builds. This value is applied when the retention period is not configured for the build name or pattern. | 15 |
| Default retention period for builds that are not marked for indexing. | 3 |