Skip to main content

Configuration

The CLI reads ~/.shoulders/config.yaml by default. Use --config <path> to point at a different file, and repeatable --set key=value flags to override file values.

Generate a starter file:

shoulders init --provider vind
shoulders init --provider existing --config ./shoulders.yaml

Example:

current_workspace: ""

cluster:
  provider: vind          # vind | existing
  name: shoulders
  kubeconfig: ""
  context: ""

platform:
  profile: medium        # small | medium | large
  cilium:
    enabled: true
    version: "1.19.2"
  flux:
    source: git             # git | oci
    gitRepository:
      url: "https://github.com/jherreros/shoulders.git"
      branch: "main"
    ociRepository:
      url: ""
      tag: ""
      insecure: false
    pathPrefix: "."

Notes:

  • provider: existing skips cluster creation and targets the configured kube context.
  • platform.profile selects the addon footprint (see Profiles).
  • platform.flux.* lets you point Flux at a different repo, branch, subdirectory, or OCI artifact.
  • --set supports current_workspace, cluster.provider, cluster.name, cluster.kubeconfig, cluster.context, platform.profile, platform.domain, platform.cilium.enabled, platform.cilium.version, platform.flux.*.

Global flags: --config, --set key=value, --kubeconfig, --output table|json|yaml.