Skip to content

Commit 361d068

Browse files
chore: add helm migration section (#573)
Signed-off-by: Kavindu Dodanduwa <[email protected]>
1 parent 8bf9e42 commit 361d068

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

docs/v1beta_migration.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ Consider below example with diff from old version to new version,
1313

1414
```diff
1515
- apiVersion: core.openfeature.dev/v1alpha3
16+
- kind: FeatureFlagConfiguration
1617
+ apiVersion: core.openfeature.dev/v1beta1
17-
kind: FeatureFlagConfiguration
18+
+ kind: FeatureFlag
1819
metadata:
1920
name: end-to-end
2021
labels:
@@ -31,12 +32,13 @@ spec:
3132
defaultVariant: 'off'
3233
```
3334

34-
## openfeature.dev annotations
35+
## openfeature.dev annotations & FlagSourceConfiguration renaming
3536

36-
There are several [annotations](./annotations.md) to control how OFO works on your workload.
37+
There are two [annotations](./annotations.md) to control how OFO works on your workload.
3738

3839
With the upgrade to `v1beta1`, we no longer support deprecated `openfeature.dev/featureflagconfiguration` annotation.
3940
Workloads which require feature flagging now need to use `openfeature.dev/featureflagsource` annotation, referring a [FeatureFlagSource](./feature_flag_source.md) CRD.
41+
This is the CRD previously named `FlagSourceConfiguration`.
4042

4143
```diff
4244
annotations:
@@ -48,9 +50,11 @@ Workloads which require feature flagging now need to use `openfeature.dev/featur
4850
`FeatureFlagSource` provide more flexibility by allowing users to configure the injected flag with many options.
4951
Consider below example for a `FeatureFlagSource` where flagd is instructed to use `FeatureFlag` custom resource named `end-to-end` as its flag source
5052

51-
```yaml
52-
apiVersion: core.openfeature.dev/v1beta1
53-
kind: FeatureFlagSource
53+
```diff
54+
- apiVersion: core.openfeature.dev/v1alpha3
55+
- kind: FlagSourceConfiguration
56+
+ apiVersion: core.openfeature.dev/v1beta1
57+
+ kind: FeatureFlagSource
5458
metadata:
5559
name: end-to-end
5660
labels:
@@ -60,3 +64,17 @@ spec:
6064
- source: end-to-end
6165
provider: kubernetes
6266
```
67+
68+
## Migration on helm
69+
70+
The new operator no longer support older API versions. Because of this, you need to plan your upgrade carefully.
71+
72+
We recommend following migration steps,
73+
74+
1. Remove all the old custom resources while running the older version of the operator
75+
2. Update the operator to the latest version
76+
3. Install upgraded custom resources
77+
4. Update annotation of your workloads to the latest supported version
78+
79+
If you have used `flagd-proxy` provider, then you have to upgrade the image used by the `flagd-proxy` deployment.
80+
For this, please edit the deployment of `flagd-proxy` to version [v0.3.1](https://github.com/open-feature/flagd/pkgs/container/flagd-proxy/152333134?tag=v0.3.1) or above.

0 commit comments

Comments
 (0)