feat: Add 1.26, 1.27 and 1.29 deprecations

[david-ortiz-saez]

WHAT

This PR is adding the following deprecations.

• v1.26 flowcontrol
• v1.27 CSIStorageCapacity
• v1.29 flowcontrol

Example

This has been tested with the resources included inside fixtures in a k8s v1.24 running cluster. Here is the output:

❯ ./bin/kubent -t 1.26
1:08PM INF >>> Kube No Trouble `kubent` <<<
1:08PM INF version dev (git sha dev)
1:08PM INF Initializing collectors and retrieving data
1:08PM INF Target K8s version is 1.26.0
1:08PM INF Retrieved 198 resources from collector name=Cluster
1:08PM INF Retrieved 7 resources from collector name="Helm v3"
1:08PM INF Loaded ruleset name=custom.rego.tmpl
1:08PM INF Loaded ruleset name=deprecated-1-16.rego
1:08PM INF Loaded ruleset name=deprecated-1-22.rego
1:08PM INF Loaded ruleset name=deprecated-1-25.rego
1:08PM INF Loaded ruleset name=deprecated-1-26.rego
1:08PM INF Loaded ruleset name=deprecated-1-27.rego
1:08PM INF Loaded ruleset name=deprecated-1-29.rego
1:08PM INF Loaded ruleset name=deprecated-future.rego
__________________________________________________________________________________________
>>> Deprecated APIs removed in 1.26 <<<
------------------------------------------------------------------------------------------
KIND                         NAMESPACE     NAME                    API_VERSION                            REPLACE_WITH (SINCE)
FlowSchema                   <undefined>   service-accounts-test   flowcontrol.apiserver.k8s.io/v1beta1   flowcontrol.apiserver.k8s.io/v1beta3 (1.26.0)
PriorityLevelConfiguration   <undefined>   workload-medium         flowcontrol.apiserver.k8s.io/v1beta1   flowcontrol.apiserver.k8s.io/v1beta3 (1.26.0)
__________________________________________________________________________________________
>>> Deprecated APIs removed in 1.27 <<<
------------------------------------------------------------------------------------------
KIND                 NAMESPACE   NAME              API_VERSION              REPLACE_WITH (SINCE)
CSIStorageCapacity   default     my-csi-capacity   storage.k8s.io/v1beta1   storage.k8s.io/v1 (1.24.0)

NOTE. There is an existing open PR with this purpose, but it has been stalled for 60 days.

[david-ortiz-saez]

I see that Sonar failed, but it is only complaining about duplicated entries of flowcontrol.apiserver.k8s.io inside pkg/collector/cluster.go I think that's fine as it is the same as per example storage.k8s.io

[david-ortiz-saez]

Could you kindly review @dark0dave, @stepanstipl?

[dark0dave]

I am happy to approve, @stepanstipl can we get this merged?

[stepanstipl]

Looks good to me 👍 I'm happy to merge if the only failing test is the SonarCloud smell.

Many thanks for your effort @david-ortiz-saez 🎉 👍

[dark0dave]

Please rebase but looks good to me as well.

[david-ortiz-saez]

hi @dark0dave, @stepanstipl, I've rebased with master, everything should be fine now. Thanks for taking a look!

[stepanstipl]

Hi @david-ortiz-saez thanks 👍 , I see there are 2 tests failing, both minor cosmetic bits:

• Couple of new lines at the end in several files ¹
• And we require code to be formatted according to go standards (go fmt) ²

Footnotes

1. https://github.com/doitintl/kube-no-trouble/actions/runs/5924046263/job/16060898402?pr=504 ↩

2. https://github.com/doitintl/kube-no-trouble/actions/runs/5924046263/job/16060898910?pr=504 ↩

[david-ortiz-saez]

I think it is fixed now @stepanstipl. Thanks for the tip

[stepanstipl]

Thanks @david-ortiz-saez - I was looking further into the last remaining issue, and it appears to be the rego file causing the trouble actually (apologies, I too quickly suggested it's the go code in my last comment):

$ opa fmt -d -l pkg/rules/rego/*                                                                                                0
pkg/rules/rego/deprecated-1-27.rego

$ opa fmt -d pkg/rules/rego/*                                                                                                   0
--- /var/folders/xq/17348xc93zx6hzxlcwt5kjtc0000gn/T/.opafmt666689532   2023-08-21 14:09:33.000000000 +0200
+++ /var/folders/xq/17348xc93zx6hzxlcwt5kjtc0000gn/T/.opafmt016151851   2023-08-21 14:09:33.000000000 +0200
@@ -21,9 +21,9 @@

 deprecated_api(kind, api_version) = api {
        deprecated_apis = {"CSIStorageCapacity": {
-                       "old": ["storage.k8s.io/v1beta1"],
-                       "new": "storage.k8s.io/v1",
-                       "since": "1.24",
+               "old": ["storage.k8s.io/v1beta1"],
+               "new": "storage.k8s.io/v1",
+               "since": "1.24",
        }}

        deprecated_apis[kind].old[_] == api_version

You should be able to fix the formatting by running opa fmt -w pkg/rules/rego/*.

[david-ortiz-saez]

My bad @stepanstipl. I identified the file and modified it but I did it manually because I wasn't aware of the -w option in the opa fmt command.
Nevertheless, it is fixed now. Thanks for your patience :)

[stepanstipl]

Hi @david-ortiz-saez thanks... I still see one of the tests failing ¹ - it's about the <summary> part of the commit message should be capitalized, e.g.:

- feat: include new deprecations in rego files
+ feat: Include new deprecations in rego files

Almost there 😄, let's get this merged...

Footnotes

1. https://github.com/doitintl/kube-no-trouble/actions/runs/5926212143/job/16067784870?pr=504 ↩

[david-ortiz-saez]

I understand @stepanstipl, but how should I fix it? It is enough to add a new silly commit following that pattern so semantic release is triggered or do I need to force-push all the changes again in one single commit following the pattern?

[stepanstipl]

Hi @david-ortiz-saez, all commits are checked to follow the pattern, i.e. it's not enough to just add one commit at the end. Here's how I do this - interactive rebase, which lets you edit commit messages, i.e.:

# make sure your local master is up-to-date
git checkout master
git pull
# switch to PR branch
git checkout add-126-127-129-deprecations
# rebase
git rebase -i master

In the editor you'll change the beginning of commits you want to change to r (or reword) and save (don't edit the actuall commit messages yet), and then git will take you through the individual commits marked for reword and let you edit the messages.

You'll need to force-push after.

Hope this helps 🤞

[david-ortiz-saez]

thanks for the tip @stepanstipl! Everything should be fine now (I hope)

[stepanstipl]

Hi @david-ortiz-saez all the tests look good, great job! 👍

One - hopefully really last thing - we require all commits to be signed, more on that ¹² (I typically recommend going with GPG). Feel free to let me know if you need any help with that. Cheers 🙏

Footnotes

1. https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits ↩

2. https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification ↩

[david-ortiz-saez]

Hi @stepanstipl, I had configured the signing, but somehow during last rebase they were lost?
I'm sorry but can you please guide me how can I sign the commits that are already there? When I execute git rebase -i master I get the following

pick 6c86763 dep: Docker Bump golang from 1.20-alpine3.17 to 1.21-alpine3.17
pick 2ec21a9 fix: Missing buildx added to ci
pick a509671 dep: Go Bump github.com/rs/zerolog from 1.29.0 to 1.30.0
pick 801d5d3 chore: Add brew installation method
pick 17b650a feat: Include new deprecations in rego files
pick a563508 feat: Include new elements in cluster collector
pick 2aaa8a1 test: Add tests for new deprecations
pick d053b19 style: Include new lines at end of files and rego fmt
pick 6c39a9d style: Fix space identation

When I forced pushed these changes, the UI told me that my branch was not updated with master and I clicked on rebase button on the UI, then the 4 initial commits disappeared, but the signature in my commits was also removed.

What should be the proper approach here?

[stepanstipl]

Hi @david-ortiz-saez, ok if you have git configured to sign then it should be ok when you just do rebase, but I assume if you use the GH UI functionality, it's not signing the commits (sorry, not sure, I don't use it).

The actual steps might depend a bit on how is your repo set up (forked), but based on the "not updated" message you mentioned, I'm assuming you're rebasing on your fork, instead of this repo master.

You can try smth. like this:

git remote add upstream git@github.com:doitintl/kube-no-trouble.git
git fetch upstream
git rebase -i upstream/master

and push. 🤞

[david-ortiz-saez]

@stepanstipl I think this is the good one, I've modified the commits and force pushed, I see that the branch is updated and the commits are compliance and signed.
Many thanks for your help! I've learned a lot in the process :D

[stepanstipl]

All good, thanks a lot for getting this through @david-ortiz-saez! 🎉

[mkurde]

When can we expect the release of this PR?

[stepanstipl]

I would recommend using the latest nightly for now ¹, which has this in. But 🤞 soon (~week or so). We just want to look at a couple of other things on the list ², but I would like to get one out relatively soon.

Footnotes

1. https://github.com/doitintl/kube-no-trouble/releases/tag/nightly-0.7.0-51-gf6ebd85 ↩

2. https://github.com/doitintl/kube-no-trouble/milestone/6 ↩

[mkurde]

I would recommend using the latest nightly for now 1, which has this in. But 🤞 soon (~week or so).

Great news. I saw in the nightly build that the 1.27 deprecation (storage api) was listed in "future" deprecations even when I select target version 1.27.