Skip to content

Define and improve clarity on parameters and their targets relating to Desired state. #167

@ajcraig

Description

@ajcraig

Bug description

This bug/lack of clarity within the specification was brought up following plugfest.
Ambiguity Between ENV.* and PORTS.* in targets
Observed issues

  • The spec introduces parameterized keys such as ENV.* and PORTS.* inside targets.
  • The Nextcloud example uses PORTS.80, implying:
    • Numeric suffixes are allowed
    • Keys may map to runtime-specific constructs (Compose ports)
  • However, the spec does not define:
    • Whether ENV.* is:
      • A general parameter namespace (like .env)
      • Or strictly a mapping to services[].environment in Compose
    • Whether PORTS.* is:
      • A shorthand for Compose ports
      • Or a generic “exposed capability” to be interpreted by the WFM

Proposed fix

Introduce a explicit Target Parameter model section

Add a subsection under Target Attributes:
Target Parameters and Substitution Model
This section should explicitly state:

  1. Targets provide parameter values, not deployment logic
  2. Parameters are namespaced to avoid ambiguity
  3. Interpretation is defined per deployment profile (Compose, Helm)

Anything else (optional)

https://lfmargo.sharepoint.com/:w:/s/TechnicalWorkingGroup/IQDc0P5P9F71S4cal7haXFP2AZJoIhWyveCpIMGbhBmHbpg?e=GrakxY

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    General Improvements(Small/medium effort)

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions