Catalogs and Components
Veckl needs two kinds of admin data before test case creation feels smooth:
- A controls catalog.
- A component registry.
Both are stored in the configured GitHub repository under config/.
Components
Section titled “Components”Components describe what is being tested: systems, products, environments, baselines, or other meaningful targets.
Each component has:
- Code.
- Name.
- Description.
The code is permanent after creation because Veckl uses it in generated test case IDs.
Example:
components: - code: WIN2022 name: Windows Server 2022 description: Domain member server baseline - code: RHEL9 name: Red Hat Enterprise Linux 9 description: Linux server baselineControls Catalog
Section titled “Controls Catalog”The catalog supplies control IDs, titles, statements, assessment objectives, and related metadata for picker and validation workflows.
Veckl supports three import paths:
- Online import from the latest
usnistgov/oscal-contentrelease. - Air-gapped import from a Veckl catalog export.
- Air-gapped import from raw OSCAL JSON or an existing
config/catalog.json.
Connected Catalog Import
Section titled “Connected Catalog Import”Use this path when the Veckl backend can reach GitHub.com:
- Open Admin.
- Open Catalog.
- Select Preview.
- Review the version and control count.
- Select Commit Import.
The import is committed to config/catalog.json.
Air-Gapped Catalog Import
Section titled “Air-Gapped Catalog Import”Use this path when the target environment cannot reach GitHub.com:
- In a connected environment, open Admin then Catalog.
- Select Air-Gapped Export.
- Move
veckl-catalog-export.jsoninto the disconnected environment. - Open the disconnected Veckl instance.
- Upload the file with Air-Gapped Import.
When to Reimport
Section titled “When to Reimport”Reimport the catalog when your organization adopts a new catalog version or when the existing catalog is incomplete.
Existing test cases keep their committed control IDs and metadata. New validation and picker behavior uses the current catalog.