When writing Garden configuration, is it possible to conditionally include a YAML object using the variable syntax? If for example I need to provide a

configurationValues

object when a certain environment is detected I would expect to be able to use Garden's

$if; $then; $else

syntax to conditionally include or exclude that object. i.e. Starting from this:

SomeParentValue:
  configurationValues:
    debug: true
    application_url: "localhost"
    log_level: debug

I might then want to transition to a config like this:

SomeParentValue:
  $if: ${local.env.DEBUG_MODE}
  $then:
    configurationValues:
      debug: true
      application_url: "localhost"
      log_level: debug

This doesn't appear to function or validate. Is there a canonical way to achieve this?

Hi @clever-policeman-58407 thanks for asking the question here! $if: $then: $else: does work exactly like you described, I'm always making a small mini-project to reproduce issues like that:

apiVersion: garden.io/v1
kind: Project
name: foo

environments:
  - name: dev

providers: []

---
kind: Test
type: exec
name: test
spec:
  command: [echo, "${yamlEncode(var.conditionalObject)}"]
variables:
  conditionalObject:
    $if: ${local.env.FOO == "1"}
    $then:
      foo: bar
    $else:
      bar: baz

When you run

FOO=1 garden test -l3

it behaves as expected (printing

foo: bar

) I guess where things become interesting if

SomeParentValue

also has other keys:

conditionalObject:
    hello: world
    $if: ${local.env.FOO == "1"}
    $then:
      foo: bar
    $else:
      bar: baz

This leads to the error

Found one or more unexpected keys on $if object: "hello". Expected: $if, $then and $else

You can solve that by using `$merge`:

conditionalObject:
    hello: world
    $merge:
      $if: ${local.env.FOO == "1"}
      $then:
        foo: bar
      $else:
        bar: baz

The command

FOO=1 garden test -l3

with this config results in

hello: world
foo: bar

This does actually seem to work when used within a child resource, and I wonder if maybe my issue is actually specific to root configuration instead. I wanted to optionally include a value for

providers.deploymentRegistry

based on which Kubernetes cluster tool was running and attempting to do something similar results in the following:

Found one or more unexpected keys on $if object: "name", "environments", "namespace", "defaultHostname", "context", "setupIngressController", "sync" and "dependencies". Expected: $if, $then and $else

Thanks for the feedback. Looking at your code, I understand why you expect it to work this way. At the moment you need to write your config like this:

YAML
apiVersion: garden.io/v1
kind: Project
name: foobar
defaultEnvironment: local

environments:
  - name: local
    defaultNamespace: default

providers:
  - name: local-kubernetes
    environments: [local]
    namespace: foobar
    defaultHostname: localhost
    context: "k3d-default"

    setupIngressController: nginx

    $merge:
      $if: ${local.env.FOO == "1"}
      $then:
        deploymentRegistry:
          hostname: k3d-registry
          port: 5000
          insecure: true
          namespace: ${kebabCase(local.username)}

For differing configs across different environments, one can declare environment-specific variables like so; Maybe this is the way to go in your case:

YAML
apiVersion: garden.io/v1
kind: Project
name: foobar
defaultEnvironment: local

environments:
  - name: local
    defaultNamespace: default
    variables:
      deploymentRegistry:
        $if: ${local.env.FOO == "1"}
        $then:
          hostname: k3d-registry
          port: 5000
          insecure: true
          namespace: ${kebabCase(local.username)}

providers:
  - name: local-kubernetes
    environments: [local]
    namespace: foobar
    defaultHostname: localhost
    context: "k3d-default"

    setupIngressController: nginx

    deploymentRegistry: ${var.deploymentRegistry}

Not what I'd expect, but that works too 👍