Baselines

Manage Project Baselines

The Project Baselines section in Admin Settings allows administrators to manage baseline configurations that define the complete modeling environment for projects. Each baseline version is displayed as an individual card with its metadata and lifecycle status.

Viewing Baselines

The baselines overview displays all available baseline versions as cards, showing:

• Accent color and icon: Visual identifiers from the baseline specifications
• Name: Display name of the baseline
• Description: Human-readable description
• Version number: Semantic version (e.g., 1.0.0)
• Status: Current lifecycle state (Draft, Published, or Deprecated)
• Tags: Categorization tags for filtering and organization

Filtering Baselines

Use status filters to control which baselines are displayed:

• Draft (default: enabled): Baselines under development
• Published (default: enabled): Released baselines available for project creation
• Deprecated (default: disabled): Baselines no longer recommended

Adding a New Baseline

To add a new baseline:

1. Click the Add baseline button
2. In the sidebar that opens, upload a ZIP file containing the baseline
3. Click Add to upload (or Cancel to abort)

Validation

When adding a baseline, the system validates:

• File format: Must be a valid ZIP archive
• Baseline structure: The ZIP must contain required files (k5-baseline.yaml, k5-oml.yaml)
• Files do only contain text or markdown content (file ending .md, .txt)
• Profile references: All profiles referenced in the baseline must exist in the OML profiles section

If validation fails, appropriate error messages are displayed.

❗️info

All newly added baselines start in Draft status, allowing you to test and refine them before publishing.

Managing Baseline Lifecycle

Each baseline card provides a menu with the following operations:

Upload New File

Icon: Upload Availability: Only when status is Draft

Allows you to replace the baseline file with an updated version. Opens the same upload dialog as adding a new baseline. Use this to iterate on a baseline before publishing it.

Download File

Icon: Download Availability: Always available

Downloads the baseline ZIP file to your local machine. Useful for:

• Creating backups
• Sharing baselines with other teams
• Using as templates for new baselines

Set Status to Published

Icon: Rocket Availability: When status is Draft or Deprecated

Publishes the baseline, making it available for project creation.

Once published, a baseline becomes immutable and cannot be modified or deleted.

⚠warning

Published baselines cannot be reverted to Draft status. Ensure thorough testing before publishing.

Set Status to Deprecated

Icon: Archive Availability: When status is Draft or Published

Marks the baseline as deprecated, indicating it's no longer recommended for new projects. Deprecated baselines:

• Remain available for existing projects using them
• Are hidden by default in the baseline overview (unless the Deprecated filter is enabled)

Best Practices

• Version incrementally: Create new versions rather than modifying published baselines and use semantic versioning
• Document changes: Use clear descriptions and tags to communicate what each version provides
• Deprecate gracefully: When superseding a baseline, deprecate the old version
• Validate profiles first: Ensure all required OML profiles are published before publishing a baseline
• Backup regularly: Download baseline files periodically for disaster recovery

Baseline Lifecycle States

Status	Description	Can Modify	Can Delete	Available for Projects
Draft	Under development	Yes	Yes	No (admin testing only)
Published	Released for use	No	No	Yes
Deprecated	No longer recommended	No	No	Yes (existing projects)

Related Documentation

• Project Baselines Overview - Understanding baseline concepts and structure
• Creating Custom Baselines - Step-by-step guide to creating baselines
• OML Profiles - Managing the profiles referenced by baselines