Variables and templating

kind: some-action
spec:
  env:
    OTHER_ACTION_VERSION: ${actions.build.some-build.version}

OTHER_ACTION_ENDPOINT: http://other-action/api/${actions.deploy.some-deploy.version}

kind: Deploy
variables:
  log-level: ${local.env.LOG_LEVEL || "info"}
  namespace: ${local.env.CI_BRANCH || local.username || "default"}

kind: Deploy
disabled: ${environment.name == 'prod'}

kind: Build
allowPublish: ${environment.name != 'prod'}

kind: Deploy
type: container
spec:
  replicas: "${environment.name == 'prod' ? 3 : 1}"

kind: Deploy
type: container
spec:
  replicas: ${var.default-replicas * 2}
  cpu:
    max: ${var.default-cpu-max + 2000}

apiVersion: garden.io/v2
kind: Project
variables:
  some-values: ["a", "b"]
  other-values: ["c", "d"]
  str1: "foo"
  str2: "bar"
---
kind: Deploy
type: helm
values:
  some-array: ${var.some-values + var.other-values}
  str12: ${var.str1 + var.str2}

kind: Deploy
spec:
  command:
    $if: ${environment.name == "dev"}
    $then: [npm, run, watch]
    $else: [npm, start]

variables:
  some-script: |
    #!/bin/sh
    echo "Hello, I'm a bash script!"

    ${if environment.name == "dev"}
    echo "-> debug mode"
    DEBUG=true
    ${else}
    DEBUG=false
    ${endif}

apiVersion: garden.io/v2
kind: Project
variables:
  - replicas:
      dev: 1
      prod: 3

kind: Deploy
type: container
spec:
  replicas: ${var.replicas["${environment.name}"]}

kind: Project
...
variables:
  commonArgs:
    - npm
    - test
    - -g
---
kind: Test
type: exec
name: test-a
spec:
  # resolves to [npm, test, -g, suite-a]
  command:
    - $concat: ${var.commonArgs}
    - suite-a
---
kind: Test
type: exec
name: test-b
spec:
  # resolves to [npm, test, -g, suite-b]
  command:
    - $concat: ${var.commonArgs}
    - suite-b

kind: Run
variables:
  values:
    - some_name
    - AnotherName
    - __YET_ANOTHER_NAME__
spec:
  args:
    $forEach: ${var.values}
    $return: ${kebabCase(item.value)}

kind: Deploy
type: container
variables:
  ports:
    - 80
    - 8000
    - 8100
    - 8200
spec:
  ports:
    # loop through the ports list declared above
    $forEach: ${var.ports}
    # only use values higher than 1000
    $filter: ${item.value > 1000}
    # for each port number, create an object with a name and a port key
    $return:
      name: port-${item.key}  # item.key is the array index, starting with 0
      containerPort: ${item.value}

kind: Deploy
type: container
variables:
  ports:
    http: 8000
    admin: 8100
    debug: 8200
spec:
  ports:
    # loop through the ports map declared above
    $forEach: ${var.ports}
    # for each port number, create an object with a name and a port key
    $return:
      name: ${item.key}
      containerPort: ${item.value}

kind: Deploy
type: container
variables:
  ports:
    http:
      container: 8000
      service: 80
    admin:
      container: 8100
    debug:
      container: 8200
spec:
  ports:
    # loop through the ports map declared above
    $forEach: ${var.ports}
    # for each port number, create an object with a name and a port key
    $return:
      name: ${item.key}
      # see how we can reference nested keys on item.value
      containerPort: ${item.value.container}
      # resolve to the service key if it's set, otherwise the container key
      servicePort: ${item.value.service || item.value.container}

kind: Project
variables:
  - commonEnvVars:
      LOG_LEVEL: info
      FEATURE_FLAGS: search,export
      EXTERNAL_API_URL: http://api.example.com

kind: Deploy
type: container
name: service-a
spec:
  env:
    $merge: ${var.commonEnvVars}
    OTHER_ENV_VAR: something
    LOG_LEVEL: debug  # <- This overrides the value set in commonEnvVars, because it is below the $merge key
---
kind: Deploy
type: container
name: service-b
spec:
  env:
    FEATURE_FLAGS: none # <- Because this is above the $merge key, FEATURE_FLAGS from commonEnvVars will override this
    $merge: ${var.commonEnvVars}

kind: Build
type: container
name: api
spec:
  dockerfile: ${var.dockerfile}?

kind: Project
variables:
  log-level: info
environments:
  - name: dev
    variables:
      log-level: debug
  - name: ci

---

kind: Deploy
spec:
  env:
    LOG_LEVEL: ${var.log-level}   # <- resolves to "debug" for the "dev" environment, "info" for the "ci" env

kind: Project
variables:
  dockerBuildArgs: [--no-cache, --squash]  # (this is just an example, not suggesting you actually do this :)
  envVars:
    LOG_LEVEL: debug
    SOME_OTHER_VAR: something

---

kind: Build
spec:
  buildArgs: ${var.dockerBuildArgs}  # <- resolves to the whole dockerBuildArgs list

---

kind: Deploy
spec:
  env: ${var.envVars}  # <- resolves to the whole envVars object

# my-deploy/garden.yml
kind: Deploy
name: my-deploy
# Here, we use per-environment action varfiles as an optional override for variables (these have a higher precedence
# than those in the `variables` field below).
#
varfiles:
  # If a varfile is defined but not found, an error is thrown in order to prevent misconfigurations silently passing.
  - my-service.${environment.name}.yaml
  # To add an optional varfile, specify an object with the following properties:
  # - path: The relative path to the varfile from the action root directory.
  # - optional: A boolean value indicating whether the varfile is optional or required.
  - path: my-service-2.${environment.name}.yaml
    optional: true
variables:
  # This overrides the project-level hostname variable
  hostname: my-service.${var.hostname}
  # You can specify maps or lists as variables
  envVars:
    LOG_LEVEL: debug
spec:
  ingresses:
    - path: /
      port: http
      # This resolves to the hostname variable set above, not the project-level hostname variable
      hostname: ${var.hostname}
  # Referencing the above envVar action variable
  env: ${var.envVars}

# Override three specific variables value and run a task.
# Use dot notation to override nested variables
garden run my-run --var my-run-arg=foo,some-numeric-var=123,my-nested-vars.var1=bar

# garden.yml
apiVersion: garden.io/v2
kind: Project
...
variables:
  log-level: debug
environments:
  - name: dev
    ...
  - name: ci
    ...

# garden.ci.env
log-level=info

# my-service/garden.yml
kind: Deploy
spec:
  env:
    LOG_LEVEL: ${var.log-level}

kind: Deploy
type: helm
spec:
  values:
    # Resolves to the image name of the build, with the build version as the tag (e.g. "my-image:abcdef12345")
    image: ${actions.build.my-build.outputs.deployment-image-id}

kind: Run
type: exec
name: prep-run
spec:
  command: [echo, "my run output"]
---
kind: Deploy
name: my-deploy
dependencies: [run.prep-run]
spec:
  env:
    PREP_TASK_OUTPUT: ${actions.run.prep-run.outputs.log}  # <- resolves to "my run output"