Skip to content

Commit

Permalink
Add v1alpha2 migration doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Fedosin committed Aug 23, 2023
1 parent bb02215 commit 20d532c
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions docs/migrating.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Migrating from v1alpha1 to v1alpha2

This document describes changes that were introduced in v1alpha2 API and how to update your templates to the new version.

## ImageMeta -> imageURL conversion

In v1alpha1 we use ImageMeta object that consists of 3 parts:

- Repository (optional string): image registry (e.g., "example.com/repo")
- Name (optional string): image name (e.g., "provider-image")
- Tag (optional string): image tag (e.g., "v1.0.0")

In v1alpha2 it is just a string, which represents the URL, e.g. `example.com/repo/image-name:v1.0.0`.

Example:

v1alpha1
```yaml
spec:
deployment:
containers:
- name: manager
image:
repository: "example.com/repo"
name: "image-name"
tag: "v1.0.0"
```

v1alpha2
```yaml
spec:
deployment:
containers:
- name: manager
imageURL: "example.com/repo/image-name:v1.0.0"
```

## secretName/secretNamespace -> configSecret conversion

In v1alpha1 we have 2 separate top-level fields to point to a config secret: `secretName` and `secretNamespace`. In v1alpha2 we reworked them into an object `configSecret` that has 2 fields: `name` and `namespace`.

Example:

v1alpha1
```yaml
spec:
secretName: azure-variables
secretNamespace: capz-system
```

v1alpha2
```yaml
spec:
configSecret:
name: azure-variables
namespace: capz-system
```

0 comments on commit 20d532c

Please sign in to comment.