Add Compatible Kubernetes to Version Printout #2446

theishshah · 2020-01-21T18:37:12Z

Description of the change:
Adding necessary fields to the verison, needs implementation on build side to populate.

The build implementation will involve passing along the required values in the ldflags field

version/version.go

estroz · 2020-01-21T19:25:32Z

version/version.go

+	Version                 = "v0.14.0+git"
+	GitVersion              = "unknown"
+	GitCommit               = "unknown"
+	KubernetesVendorVersion = "unknown"


Since we technically support a range of k8s versions, it would be informative to print min and max k8s version variables:

$ operator-sdk version operator-sdk version: "v0.14.0", commit: ..., minKubernetesVersion: "v1.14.0", maxKubernetesVersion: "v1.16.3"

This will reflect the eventual test and compatibility matrices we will be adding as follow-ups. WDYT?

@hasbro17 @joelanford ^

Are we effectively trying to convey the information in the client-go compatibility matrix?

The problem with min and max versions is that the answer to the question "is my code compatible with my kubernetes server?" is "yes if you're using the same client and server version, maybe if your client and server versions differ by exactly 1, and otherwise there are no guarantees"

Because of those nuances, I would suggest that we just list our client-go dependency and add a link to our dependencies section over to the client-go compatibility matrix? WDYT?

Yes that was the intent. The version from the client-go kubernetes-x.y.z tag plus a link is a better approach to capture this information.

We technically do support a range of k8s versions (i.e client-go matrix) but we don't really test against supposedly compatible k8s versions.

So I agree that linking to the client-go matrix as an indirect indication of compatibility is okay but probably not listing out the exact versions here since we haven't tested and guaranteed that the SDK works against all of them.

So right now this would just be the k8s version in our CI K8S_VERSION.

Yep, that sounds good to me.

Ideally (possibly for a follow-on) we would enforce in CI that K8S_VERSION aligns with our client-go dependency. How doable would that be?

joelanford

Whatever we decide to include, we should auto-populate via ldflags from the Makefile. We'll need to add that before merging this.

version/version.go

joelanford · 2020-01-22T00:58:08Z

version/version.go

+	Version                 = "v0.14.0+git"
+	GitVersion              = "unknown"
+	GitCommit               = "unknown"
+	KubernetesVendorVersion = "unknown"


Are we effectively trying to convey the information in the client-go compatibility matrix?

The problem with min and max versions is that the answer to the question "is my code compatible with my kubernetes server?" is "yes if you're using the same client and server version, maybe if your client and server versions differ by exactly 1, and otherwise there are no guarantees"

Because of those nuances, I would suggest that we just list our client-go dependency and add a link to our dependencies section over to the client-go compatibility matrix? WDYT?

joelanford · 2020-02-13T04:36:52Z

cmd/operator-sdk/version/cmd.go

@@ -31,7 +31,7 @@ func NewCmd() *cobra.Command {
 			if version == "unknown" {
 				version = ver.Version
 			}
-			fmt.Printf("operator-sdk version: %q, commit: %q, go version: %q\n", version, ver.GitCommit, ver.GoVersion)
+			fmt.Printf("operator-sdk version: %q, commit: %q, kubernetes version: %q, go version: %q, bulid date: %q\n", version, ver.GitCommit, ver.KubernetesVendorVersion, ver.GoVersion)


Suggested change

fmt.Printf("operator-sdk version: %q, commit: %q, kubernetes version: %q, go version: %q, bulid date: %q\n", version, ver.GitCommit, ver.KubernetesVendorVersion, ver.GoVersion)

fmt.Printf("operator-sdk version: %q, commit: %q, kubernetes version: %q, go version: %q\n", version, ver.GitCommit, ver.KubernetesVendorVersion, ver.GoVersion)

joelanford · 2020-02-13T04:39:33Z

version/version.go

+	Version                 = "v0.14.0+git"
+	GitVersion              = "unknown"
+	GitCommit               = "unknown"
+	KubernetesVendorVersion = "unknown"


Maybe just KubernetesVersion to align with what we output with operator-sdk version?

Makefile

hasbro17 · 2020-03-09T19:16:48Z

Fixes #2118

While we can't have a compatibility matrix without actually testing the matrix first in CI, this should at least specify compatibility for a single version.

Makefile

Co-Authored-By: Joe Lanford <[email protected]>

… into k8sversion-print

estroz

/lgtm

although I don't think this closes #2118 since we don't add what the issue author is asking for here.

joelanford

LGTM

joelanford · 2020-03-27T04:50:14Z

@theishshah Can you also add a line to the CHANGELOG?

openshift-ci-robot · 2020-03-27T15:27:03Z

New changes are detected. LGTM label has been removed.

added flags to version

ac735fc

theishshah requested a review from estroz January 21, 2020 18:37

openshift-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Jan 21, 2020

openshift-ci-robot requested review from AlexNPavel and jmccormick2001 January 21, 2020 18:56

travis nit

6ab235a

estroz reviewed Jan 21, 2020

View reviewed changes

version/version.go Outdated Show resolved Hide resolved

remove redundant goos

a3afa63

estroz reviewed Jan 21, 2020

View reviewed changes

joelanford requested changes Jan 22, 2020

View reviewed changes

joelanford mentioned this pull request Jan 22, 2020

Is there any compatibility matrix? #2452

Closed

openshift-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 10, 2020

rebase to master

bd7f226

openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 12, 2020

add to makefile, remove build date

2eb1015

joelanford requested changes Feb 13, 2020

View reviewed changes

Ish Shah added 2 commits February 13, 2020 08:48

clear build date text

8c2b8ca

update var names

1288982

joelanford reviewed Feb 14, 2020

View reviewed changes

Makefile Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 17, 2020

View reviewed changes

Makefile Show resolved Hide resolved

Ish Shah and others added 5 commits March 23, 2020 10:16

fix travis nit

2e60fac

Merge branch 'master' into k8sversion-print

8246e3a

Update Makefile var naming

1c5921a

Co-Authored-By: Joe Lanford <[email protected]>

pass along version to travis

a9ccec9

Merge branch 'k8sversion-print' of github.com:theishshah/operator-sdk…

7825f37

… into k8sversion-print

theishshah changed the title ~~[WIP] Add Compatible Kubernetes to Version Printout~~ Add Compatible Kubernetes to Version Printout Mar 26, 2020

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 26, 2020

estroz approved these changes Mar 26, 2020

View reviewed changes

openshift-ci-robot assigned estroz Mar 26, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 26, 2020

joelanford approved these changes Mar 27, 2020

View reviewed changes

Merge branch 'master' into k8sversion-print

570be29

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Mar 27, 2020

changelog update

755b392

theishshah merged commit e02c139 into operator-framework:master Mar 27, 2020

theishshah deleted the k8sversion-print branch March 27, 2020 16:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Compatible Kubernetes to Version Printout #2446

Add Compatible Kubernetes to Version Printout #2446

theishshah commented Jan 21, 2020 •

edited by joelanford

Loading

estroz Jan 21, 2020 •

edited

Loading

estroz Jan 21, 2020

joelanford Jan 22, 2020

estroz Jan 22, 2020

hasbro17 Jan 22, 2020

hasbro17 Jan 22, 2020

joelanford Jan 22, 2020

joelanford left a comment

joelanford Jan 22, 2020

joelanford Feb 13, 2020

joelanford Feb 13, 2020

hasbro17 commented Mar 9, 2020

estroz left a comment

joelanford left a comment

joelanford commented Mar 27, 2020

openshift-ci-robot commented Mar 27, 2020

	fmt.Printf("operator-sdk version: %q, commit: %q, kubernetes version: %q, go version: %q, bulid date: %q\n", version, ver.GitCommit, ver.KubernetesVendorVersion, ver.GoVersion)
	fmt.Printf("operator-sdk version: %q, commit: %q, kubernetes version: %q, go version: %q\n", version, ver.GitCommit, ver.KubernetesVendorVersion, ver.GoVersion)

Add Compatible Kubernetes to Version Printout #2446

Add Compatible Kubernetes to Version Printout #2446

Conversation

theishshah commented Jan 21, 2020 • edited by joelanford Loading

estroz Jan 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joelanford left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasbro17 commented Mar 9, 2020

estroz left a comment

Choose a reason for hiding this comment

joelanford left a comment

Choose a reason for hiding this comment

joelanford commented Mar 27, 2020

openshift-ci-robot commented Mar 27, 2020

theishshah commented Jan 21, 2020 •

edited by joelanford

Loading

estroz Jan 21, 2020 •

edited

Loading