Skip to content

ClusterTemplateChain docs missing required 'version' field in availableUpgrades #732

Description

@cdunkelb

Description

The Template Life Cycle Management documentation shows a ClusterTemplateChain example where availableUpgrades entries only have a name field:

apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterTemplateChain
metadata:
  name: aws
  namespace: kcm-system
spec:
  supportedTemplates:
    - name: aws-standalone-cp-0-0-2
      availableUpgrades:
        - name: aws-standalone-cp-1-0-22
    - name: aws-standalone-cp-1-0-22

However, the KCM CRD requires a version field in each availableUpgrades entry. Without it, the API returns:

422 Unprocessable Entity: spec.supportedTemplates[0].availableUpgrades[0].version: Required value

This was confirmed by live testing against KCM 1.8.0. Both ClusterTemplateChain and ServiceTemplateChain are affected since they share the same TemplateChainSpec type.

Expected Documentation

The example should include the required version field:

apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterTemplateChain
metadata:
  name: aws
  namespace: kcm-system
spec:
  supportedTemplates:
    - name: aws-standalone-cp-0-0-2
      availableUpgrades:
        - name: aws-standalone-cp-1-0-22
          version: 1.0.22
    - name: aws-standalone-cp-1-0-22

Affected Pages

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions