이 문서는 Xray 검사를 위해 자원을 인덱싱 관리하는 방법에 대 가이드를 공유하기 위해 작성되었다.
도구명 | JFrog Artifactory |
---|---|
문서 작성 기준 버전 | 7.84.14 |
지원 Edition | COMMUNITY PRO PRO X ENTERPRISE X ENTERPRISE + |
목차
Xray 스캔을 위해 리소스를 Indexed Resources에 추가하기
저장소, 빌드 등에 Xray 스캔을 수행하기 위해서는 Watch에 추가 전에 Xray의 Indexed Resources에 해당 저장소, 빌드 등을 추가해야 합니다.
- 관리자 메뉴 → Xray - Settings → General - Indexed Resources → Add a Repository
- 추가 가능한 리소스 : Repositories, Builds, Release Bundles
저장소 (Repositories) 추가하기
일부 저장소만 추가하고자 하는 경우, 개별 리소스를 선택 후, 오른쪽 화살표 >
를 클릭하여 추가합니다.
모든 저장소 추가하고자 할 때는 >
>
를 클릭하여 한번에 추가합니다.
수동을 빌드 (Builds) 추가하기
일부 빌드만 추가하고자 하는 경우, 개별 리소스를 선택 후, 오른쪽 화살표 >
를 클릭하여 추가합니다.
모든 빌드 추가하고자 할 때는 >
>
를 클릭하여 한번에 추가합니다.
모든 빌드가 자동으로 인덱싱된 리소스에 추가
빌드 도구에서 Xray 검사를 수행하려고 할 때마다
Build <Build_name> is not selected for indexing
라는 오류와 함께 빌드가 실패하면 이는 빌드가 검사를 위해 Xray로 전송되었지만 해당 빌드가 Xray의 인덱싱된 리소스에 추가되어 있지 않기 때문입니다.
이는 수동 프로세스이며 다른 새 빌드에 대해 동일하게 반복해야 합니다.
이를 극복하기 위해서는 패턴으로 정의하는 방법이 있습니다.
Build Name Include Pattern에 */**
라고 입력 후 저장합니다.
Indexed Resources에 대한 보관 기간 설정
Xray의 인덱싱된 리소스는 시스템에 보관되므로 대량의 데이터가 저장되어 스토리지에 영향을 미치고 성능 문제가 발생할 수 있습니다.
보관 기간은 Xray가 아티팩트 스캔 데이터를 보관하는 기간을 정의하며, 설정된 보관 기간이 지나면 이 데이터가 삭제되어 성능이 향상되고 스토리지 공간을 확보할 수 있습니다.
보관 기간의 Default 값
- 저장소 보관 기간의 기본값 : 90일
- 빌드 보관 기간의 기본값 : 15일
기본값을 변경하기 위해서는 YAML 설정에서 server.repo.defaultRetentionDaysForIndexedRepo (Repository),
의 값(단위 : days)을 변경할 수 있습니다.
server.build.defaultRetentionDaysForIndexedBuild (Build)
저장소 보존 기간 변경하기
- 관리자 메뉴 → Xray - Settings → General - Indexed Resources
저장소 리스트 중에서 우측 액션 메뉴 중 Configure 클릭
Scan all artifacts
해당 저장소의 모든 아티팩트에 보관 기간 일괄 적용합니다.
Scan by pattern
패턴 별로 보다 세부적으로 보존 기간을 설정할 수 있습니다.
패턴은 리포지토리 아티팩트 경로에 대해 간단한 쉼표로 구분된 와일드카드 패턴을 사용하여 설정됩니다(선행 슬래시 없음).
Ant 스타일 경로 표현식이 지원됩니다(*, **, ?). 예: "org/apache/**
"
패턴은 저장소당 10개로 제한됩니다.
빌드 보존 기간 변경하기
- 관리자 메뉴 → Xray - Settings → General - Indexed Resources
빌드 리스트 중 설정하고자 하는 빌드의 우측에 마우스를 올려 Set Retention 버튼 클릭
Xray 데이터 보존을 지원하는 YAML Configure 시스템의 파라미터
시스템 매개변수 | 설명 | 기본값 |
---|---|---|
| 저장소의 아티팩트에 대한 최대 보관 기간 한도입니다. | 1000 |
| 저장소 당 저장소 경로의 패턴 개수의 최대 한도입니다. | 10 |
| 인덱스 리포지토리의 아티팩트에 대한 기본 보존 기간입니다. 이 값은 보존 기간이 구성되지 않은 경우 적용됩니다. | 90 |
| 인덱싱되지 않은 저장소의 아티팩트에 대한 기본 보관 기간입니다. | 3 |
| 데이터 정리를 비활성화합니다. | false |
| 인덱싱된 빌드의 기본 보존 기간. 이 값은 빌드 이름이나 패턴에 보존 기간이 구성되지 않은 경우 적용됩니다. | 15 |
| 인덱싱을 위해 표시되지 않은 빌드의 기본 보관 기간입니다. | 3 |
참조
- https://jfrog.com/help/r/xray-how-to-index-and-scan-all-builds-in-xray-in-the-unified-platform/xray-how-to-index-and-scan-all-builds-in-xray-in-the-unified-platform
- https://jfrog.com/help/r/jfrog-security-documentation/indexing-xray-resources