Migrate to XP ManagementPolicies #163

lsviben · 2023-11-28T14:32:27Z

Description of your changes

Provider-kubernetes started using its own version of ManagementPoliciey before the core Crossplane. In the meantime, Crossplane developed its own native ManagementPolicies. This PR tries to smoothly migrate to the Crossplane ones.

⚠️ Bumps Object version from v1alpha1 to v1alpha2. There should not be any manual steps needed, as we are using conversion webhook to convert from v1alpha1 to v1alpha2.

⚠️ This will not work with Crossplane versions v1.14.0 and v1.14.1 because the provider service was assigned a wrong name, fixed in 1.14.2.

Fixes #162

I have:

Read and followed Crossplane's contribution process.
Run make reviewable test to ensure this PR is ready for review.

How has this code been tested

make e2e

make e2e

local on kind with examples

local deploy based on the Readme
Go through examples/object/policy and test each yaml.
Test with examples/in-composition

and

there is a difference between

kubectl delete/get -f examples/object/object.yaml
and
kubectl delete/get -f objects.kubernetes.crossplane.io sample-namespace

the first one will convert the result back to v1alpha1 if the object.yaml is in that version, the second one will just use v1beta1 without conversion (stored version).

This is important for DELETE for example because if the conversion FROM v1beta1 to v1alpha1 is not implemented correctly, the DELETED object will be saved as the "translated" object v1alpha2 -> v1alpha1 -> v1alpha2. If the translation back to v1alpha1 is not made correctly it could lose some important fields.(learned that the hard way :) )

Tested with a configuration.

lsviben · 2023-11-28T14:33:40Z

For now the combo that translates from ObserveDelete - > ["Observe", "Delete"] is not supported by default by controller-runtime. Ill add a PR which adds it to the list

lsviben · 2023-11-28T14:39:03Z

Still needs something to keep the objject webhook config in the yaml. WIP

lsviben · 2023-11-29T14:34:13Z

For now the combo that translates from ObserveDelete - > ["Observe", "Delete"] is not supported by default by controller-runtime. Ill add a PR which adds it to the list

added a PR for above

lsviben · 2023-12-01T11:43:41Z

The codecov/project fails but not sure where to add more tests. I assume this is because v1beta1 Object was added? Most code is added in conversion and that has tests

turkenh

Looking pretty good, great work @lsviben 🙌

I like the way how you solved injecting conversion config to CRDs, even though it introduced another layer, I agree that there is no better way.

Two concerns that I have in general :

This would require a Crossplane version with the recent fix, so:

We should test what happens if someone with an old XP version, bumps provider-kubernetes to latest with this change.
Make it explicit as much as we can that this requires a specific XP version.

Could you also test how this behaves when Objects are part of compositions and may be compositions being part of Configurations. So, basically, what would be the migration path we suggest? Nothing to do by users? can we validate that?

Makefile

cmd/provider/main.go

examples/object/migration/default.yaml

examples/object/policy/observe.yaml

internal/controller/object/object.go

lsviben · 2023-12-15T12:57:06Z

During my testing I noticed that in some cases the provider-kubernetes logs:

http: TLS handshake error from 192.168.183.0:54694: EOF

Not sure yet why. Other then this in the logs, the conversion works fine, and nothing else looks amiss. But I would like to check more before merging this. cc: @turkenh

turkenh · 2023-12-18T09:34:35Z

For those who want to test this PR with the latest state (i.e. dea49e1), I just built/pushed an image which could be installed/upgraded to:

index.docker.io/turkenh/provider-kubernetes:v0.10.0-rc.0.39.gdea49e1

apis/object/v1beta1/conversion.go

Signed-off-by: Hasan Turken <turkenh@gmail.com>

Looks like we need to have at least v1beta1 for conversion, otherwise getting: invalid: spec.conversion.conversionReviewVersions: Invalid value: []string{"v1alpha2"}: must include at least one of v1, v1beta1 Signed-off-by: Hasan Turken <turkenh@gmail.com>

Signed-off-by: lsviben <sviben.lovro@gmail.com>

lsviben · 2024-01-10T13:35:20Z

I noticed TLS errors in the logs:

2024/01/10 13:27:39 http: TLS handshake error from x.x.x.0:33524: EOF
2024/01/10 13:27:39 http: TLS handshake error from x.x.x.0:56824: EOF
2024/01/10 13:27:39 http: TLS handshake error from x.x.x.0:48834: EOF

Everything seems to be working fine with the conversion, and nothing came out of my investigation. Found that it seems like a known issue from Go which appears on Kubernetes .

So dropping further investigation of this for now, the PR should be good to go

turkenh

Thank you @lsviben 🙌

I've successfully validated that conversion works well and observed no functional issues. Regarding the TLS error logs, I would suggest not blocking this PR and create a separate ticket to track it further.

haarchri · 2024-01-19T22:32:47Z

examples/in-composition/composition.yaml

@@ -184,7 +184,7 @@ spec:
              string:
                fmt: "%s-argocd"
    - base:
-        apiVersion: kubernetes.crossplane.io/v1alpha1
+        apiVersion: kubernetes.crossplane.io/v1beta1


think this needs to be fixed in master branch

kubernetes.crossplane.io/v1alpha2

This one is actually the ProviderConfig, we didnt touch versioning of that. But the below one for the Object is wrong, ill fix it. Thanks for noticing!

haarchri · 2024-01-19T22:32:54Z

examples/in-composition/composition.yaml

@@ -206,7 +206,7 @@ spec:
      readinessChecks:
        - type: None
    - base:
-        apiVersion: kubernetes.crossplane.io/v1alpha1
+        apiVersion: kubernetes.crossplane.io/v1beta1


think this needs to be fixed in master branch

kubernetes.crossplane.io/v1alpha2

lsviben mentioned this pull request Nov 29, 2023

Add [Observe, Delete] as a supported management policy crossplane/crossplane-runtime#613

Merged

2 tasks

lsviben mentioned this pull request Dec 1, 2023

[Backport release-1.14] Add [Observe, Delete] as a supported management policy crossplane/crossplane-runtime#615

Merged

2 tasks

lsviben requested a review from turkenh December 1, 2023 11:41

lsviben marked this pull request as ready for review December 1, 2023 11:41

turkenh reviewed Dec 5, 2023

View reviewed changes

lsviben force-pushed the mpm branch from 513b2bd to da2de48 Compare December 11, 2023 12:21

turkenh reviewed Dec 21, 2023

View reviewed changes

apis/object/v1beta1/conversion.go Outdated Show resolved Hide resolved

turkenh and others added 17 commits January 9, 2024 10:07

Add Object v1alpha2

86ccaa5

Signed-off-by: Hasan Turken <turkenh@gmail.com>

Remove managementPolicy from the controller

1630dc8

Signed-off-by: Hasan Turken <turkenh@gmail.com>

Add conversion between v1alpha1 and v1alpha2

6acc4fb

Signed-off-by: Hasan Turken <turkenh@gmail.com>

Fix unit tests after offloading management policies to runtime

7ed493b

Signed-off-by: Hasan Turken <turkenh@gmail.com>

Add conversion config to object CRD

d7809ff

Signed-off-by: Hasan Turken <turkenh@gmail.com>

rename leftover v1alpha2 to v1beta1

ce2c5c4

Signed-off-by: lsviben <sviben.lovro@gmail.com>

add .idea to gitignore

7400561

Signed-off-by: lsviben <sviben.lovro@gmail.com>

set the webhook to convert alpha versions

5323a52

Signed-off-by: lsviben <sviben.lovro@gmail.com>

add full conversion between object versions

2cf1998

Signed-off-by: lsviben <sviben.lovro@gmail.com>

enable managementpolicies

3b7becc

Signed-off-by: lsviben <sviben.lovro@gmail.com>

fix lint

272eb33

Signed-off-by: lsviben <sviben.lovro@gmail.com>

kustomization for adding conversion webhook

e694985

Signed-off-by: lsviben <sviben.lovro@gmail.com>

add conversion unit test

b58c045

Signed-off-by: lsviben <sviben.lovro@gmail.com>

fix Makefile kubectl

84dde7a

Signed-off-by: lsviben <sviben.lovro@gmail.com>

fix lint

f1b4a2b

Signed-off-by: lsviben <sviben.lovro@gmail.com>

update examples

4ae391c

Signed-off-by: lsviben <sviben.lovro@gmail.com>

lsviben added 7 commits January 9, 2024 10:10

Deprecate v1alpha1

6eb22cb

Signed-off-by: lsviben <sviben.lovro@gmail.com>

review improvements

cc27979

Signed-off-by: lsviben <sviben.lovro@gmail.com>

make sure go.generate is run before kustomize.gen

ff8363b

Signed-off-by: lsviben <sviben.lovro@gmail.com>

fix v1alpha1 leftovers after rebase

7ca28d9

Signed-off-by: lsviben <sviben.lovro@gmail.com>

handle nil cases in conversion

ca2246d

Signed-off-by: lsviben <sviben.lovro@gmail.com>

get cert dir from env

c8bbc9e

Signed-off-by: lsviben <sviben.lovro@gmail.com>

update to v1alpha2 instead of v1beta1

b825147

Signed-off-by: lsviben <sviben.lovro@gmail.com>

lsviben force-pushed the mpm branch from 0e32645 to b825147 Compare January 9, 2024 09:18

lsviben added 2 commits January 9, 2024 12:29

handle empty management policy

1e57b70

Signed-off-by: lsviben <sviben.lovro@gmail.com>

handle non controlling management policy readiness

e3215fe

Signed-off-by: lsviben <sviben.lovro@gmail.com>

turkenh approved these changes Jan 11, 2024

View reviewed changes

turkenh merged commit cc10a8c into crossplane-contrib:main Jan 11, 2024
7 of 8 checks passed

lsviben mentioned this pull request Jan 12, 2024

TLS error logs #175

Open

haarchri reviewed Jan 19, 2024

View reviewed changes

ravilr mentioned this pull request Feb 24, 2024

fix missing ToConnectionSecretKey in conversion #204

Merged

2 tasks

lsviben mentioned this pull request May 21, 2024

local development error from **make run** main: error: Cannot start controller manager: open /tls/server/tls.crt: no such file or directory #249

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate to XP ManagementPolicies #163

Migrate to XP ManagementPolicies #163

lsviben commented Nov 28, 2023 •

edited

Loading

lsviben commented Nov 28, 2023

lsviben commented Nov 28, 2023

lsviben commented Nov 29, 2023

lsviben commented Dec 1, 2023

turkenh left a comment

lsviben commented Dec 15, 2023

turkenh commented Dec 18, 2023 •

edited

Loading

lsviben commented Jan 10, 2024

turkenh left a comment

haarchri Jan 19, 2024

lsviben Jan 21, 2024

haarchri Jan 19, 2024

Migrate to XP ManagementPolicies #163

Migrate to XP ManagementPolicies #163

Conversation

lsviben commented Nov 28, 2023 • edited Loading

Description of your changes

How has this code been tested

make e2e

local on kind with examples

lsviben commented Nov 28, 2023

lsviben commented Nov 28, 2023

lsviben commented Nov 29, 2023

lsviben commented Dec 1, 2023

turkenh left a comment

Choose a reason for hiding this comment

lsviben commented Dec 15, 2023

turkenh commented Dec 18, 2023 • edited Loading

lsviben commented Jan 10, 2024

turkenh left a comment

Choose a reason for hiding this comment

haarchri Jan 19, 2024

Choose a reason for hiding this comment

lsviben Jan 21, 2024

Choose a reason for hiding this comment

haarchri Jan 19, 2024

Choose a reason for hiding this comment

lsviben commented Nov 28, 2023 •

edited

Loading

turkenh commented Dec 18, 2023 •

edited

Loading