Skip to content

Establish Environment-Scoped Lab Intent

  • Purpose: Establish one reviewable execution source for the complete lifecycle of a selected environment.
  • Owner: Platform operations
  • Impact: Changes the intent resolved by later validate, preflight, deploy, access, recovery, and destroy operations in one environment.
  • Rollback strategy: Restore the previous overlay from version control or initialise it again with --force only when replacement is intended.

Pre-checks

Confirm the environment and blueprint reference:

ENV=<environment>
REF=<blueprint-ref>
hyops show env --env "$ENV"

Supported lab references include gcp/eve-ng@v1, onprem/eve-ng@v1, gcp/gns3@v1, onprem/gns3@v1, gcp/containerlab@v1, and linux/containerlab@v1.

Execute

Initialise the environment-owned definition and open it:

hyops blueprint init --env "$ENV" --ref "$REF" --edit

For an existing overlay:

hyops blueprint edit --env "$ENV" --ref "$REF"

Validate the saved definition before execution:

hyops blueprint validate --env "$ENV" --ref "$REF"
hyops blueprint plan --env "$ENV" --ref "$REF"
hyops blueprint preflight --env "$ENV" --ref "$REF"

Core resolves the environment definition automatically after initialisation. Do not edit the installed release. Use --file only for an intentional one-run override.

Verify

Validation must report the environment blueprint path and status=ok. Plan output must show the intended dependency order. Preflight, deploy, access, recovery, and destroy must continue to resolve the same environment source.

Records

The overlay is stored under:

~/.hybridops/envs/<environment>/config/blueprints/

Rollback

If the overlay is invalid, correct it with hyops blueprint edit. Use hyops blueprint init --force only after preserving any required local settings.

References