Skip to content

docs(fleet.yaml): example typo — clusterGroupSelector incorrectly nests clusterSelector #364

@nikbonk

Description

@nikbonk

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

The fleet.yaml "Full Example" page contains a typo in the rolloutStrategy.partitions example: clusterGroupSelector is shown containing a nested clusterSelector object. This causes confusion and may mislead users into writing invalid YAML or expecting Fleet to accept the nested structure.

Page: https://fleet.rancher.io/ref-fleet-yaml (Version: Next)

rolloutStrategy:
  partitions:
    - name: canary
      # ...
      clusterGroupSelector:
        clusterSelector:
          matchLabels:
            env: prod

There is no actual error happening, the partitioning is just not respected. You can only pinpoint it to an "error" when checking the YAML of the bundle with the applied Rollout Strategy:

rolloutStrategy:
  partitions:
    - clusterGroupSelector: {}
      name: canary

Expected Behavior

The docs example should show clusterGroupSelector with matchLabels: (or matchExpressions:) directly, like:

rolloutStrategy:
  partitions:
    - name: canary
      # ...
      clusterSelector:
        matchLabels:
          env: prod

      # OR, if selecting by ClusterGroup labels:
      clusterGroupSelector:
        matchLabels:
          env: prod

Steps To Reproduce

  1. Visit https://fleet.rancher.io/ref-fleet-yaml#full-example
  2. Search for "rolloutStrategy:"

Environment

/

Logs

Anything else?

It is just a minor documentation error but it cost me some minutes until I noticed my error when the rollout partitions where not respected.

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    📋 Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions