Skip to content

Commit

Permalink
docs: update migration docs with info on apiVersion field
Browse files Browse the repository at this point in the history
  • Loading branch information
shumailxyz authored and vvagaytsev committed May 11, 2023
1 parent 9a09f80 commit abcf1be
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/reference/project-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ Please refer to those for more details on provider configuration.
The values in the schema below are the default values.

```yaml
# Schema version of the config.
apiVersion: garden.io/v1

# Indicate what kind of config this is.
kind: Project

Expand Down Expand Up @@ -196,6 +199,14 @@ variables: {}
## Configuration Keys
### `apiVersion`

Schema version of the config.

| Type | Allowed Values | Default | Required |
| -------- | ------------------------------ | ---------------- | -------- |
| `string` | "garden.io/v0", "garden.io/v1" | `"garden.io/v1"` | Yes |

### `kind`

Indicate what kind of config this is.
Expand Down
1 change: 1 addition & 0 deletions docs/tutorials/migrating-to-bonsai.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ On the other hand, the optional new configuration format is easier to read and w

Here is the list of breaking changes when upgrading your `garden` CLI tool. This lets you use your old Module-style configuration files with minimal changes.

- `apiVersion` is now mandatory in project config files for new action-Kind configs. It's recommended to set the value to `garden.io/v1` for new projects. For backwards compatibility, garden will assume the apiVersion `garden.io/v0`.
- `cert-manager` integration has been removed. New documentation has been created in the [ext dns and cert manager example](../../examples/cert-manager-ext-dns)
- `dev-mode` has been renamed to `sync`, both in the configuration as well as on the CLI
- `garden delete` has been renamed to `garden cleanup`
Expand Down

0 comments on commit abcf1be

Please sign in to comment.