adcm-bundle-dsl

Authoring config.yaml

config.yaml is a list of prototypes. One is the top-level object (type: cluster or type: provider), the rest are its services, and components are nested inside their service. Everything ADCM shows and enforces comes from here.

Key inventories are in the reference files — this page is the decision rules and the traps. reference/prototype-keys.md, reference/config-params.md, reference/action-keys.md.

Declare the contract before anything else

- name: my_product
  type: cluster
  display_name: My Product
  description: ...
  version: &version 1.2.3
  edition: {{ edition }}
  adcm_min_version: 2.12.0        # refuse to upload to older ADCM
  contract_version: "2.1"         # which DSL dialect this bundle speaks
  license: adcm_cluster_eula/EULA.txt

adcm_min_version and contract_version are not decoration. contract_version selects the DSL dialect, and several keys that were normal in 1.x are rejected under 2.x — type: job|task on an action, venv:, config_jinja: and scripts_jinja: are all deprecated and unsupported from contract version 2.0. If a key you copied from an older bundle is rejected, check the contract version before assuming the key is wrong.

version is what ADCM keys the bundle by. Anchor it (&version) and reference it (*version) from every service so a bump cannot drift.

license: points at a file inside the archive. A bundle with a license cannot be used to create a cluster until the license is accepted against the prototype — that is a one-time API call, not a bundle defect.

states and masking are alternatives, never both

This is the single most common structural error in an action.

# Simple availability: a list of states, plus the transitions
install:
  display_name: Install
  states:
    available: [created]
    on_success: installed
    on_fail: created

# Rich availability: combine state and multi_state, positively or negatively
reload:
  display_name: Reload
  masking:
    state:
      available: [installed]
    multi_state:
      unavailable: [external]
  on_success:
    state: installed
    multi_state:
      unset: [needs_reload]