# RenderTemplate Reference

Below is the schema reference for `RenderTemplate` configuration files. To learn more about config templates, see the [Config Templates guide](https://docs.garden.io/features/config-templates).

The reference is divided into two sections:

* [YAML Schema](#yaml-schema) contains the config YAML schema
* [Configuration keys](#configuration-keys) describes each individual schema key for the configuration files.

Also check out the [`ConfigTemplate` reference](https://docs.garden.io/reference/config-template-config).

## YAML Schema

The values in the schema below are the default values.

```yaml
kind: RenderTemplate

# A unique identifier for the Render config.
name:

# Set to true to skip rendering this template.
disabled: false

# The ConfigTemplate to render.
template:

# A map of inputs to pass to the ConfigTemplate. These must match the inputs schema of the ConfigTemplate.
#
# Note: You can use template strings for the inputs, but be aware that inputs that are used to generate the resulting
# config names and other top-level identifiers must be resolvable when scanning for configs, and thus cannot reference
# other actions, modules or runtime variables. See the [environment configuration context
# reference](./template-strings/environments.md) to see template strings that are safe to use for inputs used to
# generate config identifiers.
inputs:

# Render this template multiple times, for each combination of the inputs.
#
# Each key should be the name of an input, and the value should be a list of values to pass to the input.
#
# If the `inputs` is also provided, the values in the `matrix` will be overridden by the values in the `inputs` field.
# You can combine the two fields if there are more inputs than just the ones specified in the `matrix` field, and you
# want to specify some inputs that should not be overridden.
#
# See the [Matrix templates guide](../features/matrix-templates.md) for more information.
#
# Note: You can use template strings for the inputs, but be aware that inputs that are used to generate the resulting
# config names and other top-level identifiers must be resolvable when scanning for configs, and thus cannot reference
# other actions, modules or runtime variables. See the [environment configuration context
# reference](./template-strings/environments.md) to see template strings that are safe to use for inputs used to
# generate config identifiers.
matrix:
```

## Configuration Keys

### `kind`

| Type     | Allowed Values   | Default            | Required |
| -------- | ---------------- | ------------------ | -------- |
| `string` | "RenderTemplate" | `"RenderTemplate"` | Yes      |

### `name`

A unique identifier for the Render config.

| Type     | Required |
| -------- | -------- |
| `string` | No       |

### `disabled`

Set to true to skip rendering this template.

| Type      | Default | Required |
| --------- | ------- | -------- |
| `boolean` | `false` | No       |

### `template`

The ConfigTemplate to render.

| Type     | Required |
| -------- | -------- |
| `string` | No       |

### `inputs`

A map of inputs to pass to the ConfigTemplate. These must match the inputs schema of the ConfigTemplate.

Note: You can use template strings for the inputs, but be aware that inputs that are used to generate the resulting config names and other top-level identifiers must be resolvable when scanning for configs, and thus cannot reference other actions, modules or runtime variables. See the [environment configuration context reference](https://docs.garden.io/reference/template-strings/environments) to see template strings that are safe to use for inputs used to generate config identifiers.

| Type     | Required |
| -------- | -------- |
| `object` | No       |

### `matrix`

Render this template multiple times, for each combination of the inputs.

Each key should be the name of an input, and the value should be a list of values to pass to the input.

If the `inputs` is also provided, the values in the `matrix` will be overridden by the values in the `inputs` field. You can combine the two fields if there are more inputs than just the ones specified in the `matrix` field, and you want to specify some inputs that should not be overridden.

See the [Matrix templates guide](https://docs.garden.io/features/matrix-templates) for more information.

Note: You can use template strings for the inputs, but be aware that inputs that are used to generate the resulting config names and other top-level identifiers must be resolvable when scanning for configs, and thus cannot reference other actions, modules or runtime variables. See the [environment configuration context reference](https://docs.garden.io/reference/template-strings/environments) to see template strings that are safe to use for inputs used to generate config identifiers.

| Type     | Required |
| -------- | -------- |
| `object` | No       |