Skip to content

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 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 baseline

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-content release.
  • Air-gapped import from a Veckl catalog export.
  • Air-gapped import from raw OSCAL JSON or an existing config/catalog.json.

Use this path when the Veckl backend can reach GitHub.com:

  1. Open Admin.
  2. Open Catalog.
  3. Select Preview.
  4. Review the version and control count.
  5. Select Commit Import.

The import is committed to config/catalog.json.

Use this path when the target environment cannot reach GitHub.com:

  1. In a connected environment, open Admin then Catalog.
  2. Select Air-Gapped Export.
  3. Move veckl-catalog-export.json into the disconnected environment.
  4. Open the disconnected Veckl instance.
  5. Upload the file with Air-Gapped Import.

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.