Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use get-ocp-range to translate Kube to OCP ranges #423

Merged

Conversation

mgoerens
Copy link
Contributor

@mgoerens mgoerens commented Feb 6, 2024

This work had been started as part of commit f08a985

This commit removes the mapping of Kubernetes versions to OCP versions and calls get-ocp-range instead.

closes #418

Comment on lines 195 to 197
if kubeVersionString == "" {
kubeVersionString = tool.GetLatestKubeVersion()
kubeVersionString = "1.27" // This is *not* a viable solution, to be discussed in PR comments
}
Copy link
Contributor Author

@mgoerens mgoerens Feb 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See also how this function is called:

func certifyImages(r Result, opts *CheckOptions, registry string) Result {
kubeVersion := ""
kubeConfig := tool.GetClientConfig(opts.HelmEnvSettings)
kubectl, kubeErr := tool.NewKubectl(kubeConfig)
if kubeErr == nil {
serverVersion, versionErr := kubectl.GetServerVersion()
if versionErr == nil {
kubeVersion = fmt.Sprintf("%s.%s", serverVersion.Major, serverVersion.Minor)
}
}
images, err := getImageReferences(opts.URI, opts.Values, kubeVersion)
if err != nil {
r.SetResult(false, fmt.Sprintf("%s : Failed to get images, error running helm template : %v", ImageCertifyFailed, err))
}

In my understanding, there is an attempt (with tool.GetClientConfig) to determine the Kubernetes version (that this chart supports ??) based on Helm related environment variables that might be set. I somehow ended here in my investigations.

In case that failed (for instance because the environment variables are not set), then there is a fallback here, that defaults to the latest known Kubernetes version (i.e. the latest set in internal/tool/kubeOpenShiftVersionMap.yaml).

I'm wondering:

  1. what exactly does this Kubernetes version represents. Is this supposed to be the supported version for this chart ?
  2. if defaulting to the latest Kubernetes version really makes sense here.
  3. if the fallback serves a real-world scenario or is just to accommodate the tests, when the Helm env vars are not set.

I'll continue pulling those threads, but in the meantime I wanted to post my thoughts here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Effectively, this kubeVersion value seems to align with the server that's being used for testing, and if the server is not available, then it defaults to the newest version.

The image reference resolution code effectively emulates helm template, and seems to be emulating the design of the upstream action library: https://pkg.go.dev/helm.sh/helm/v3@v3.14.0/pkg/action.

As I read it, the summary is that the RenderManifests function that ultimately underpins getImageReferences takes in the user's helm-relevant input values (such as values.yaml), and then uses a template rendering strategy to derive manifests with their values.yaml-provided images rendered out. Otherwise, images would be templated in the manifests being scanned, and they would all fail (for being invalid). It also makes sense for cases where a partner is rendering one value for upstream Kubernetes, and another values for OpenShift.

As far as why a kubeclient is necessary, I'd have to dig deeper. Happy to do that if you'd like. I stopped at this point because I think the end goal is that a cluster being unavailable should not prevent the templating from taking place. I'm presuming that no actual calls to the cluster are made, but the upstream actions being called ask for an actions.Configuration, which requires a client. As such, the latest version is being subbed in to produce a client, regardless of whether calls to a given cluster are made - and only checks that are related to image reference resolution.

Hope that helps, let me know if I can expand.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. That helped.

After giving it a fresh look at it I found don't need to set a kubeVersion at all, hence we can remove the problematic logic from the code.

This kubeVersion variable is in fact not needed to instantiate a new Kubernetes Client. That is done here using a fake client.

It turns out that the kubeVersion that was set only serves an informative purpose. It is fed into the chartutil.Capabilities struct. By using the chartutil.DefaultCapabilities we are already provided with a default kubeVersion. I don't believe we need to set our own.

This work had been started as part of commit
f08a985

This commit removes the mapping of Kubernetes versions to OCP versions
and calls the external get-ocp-range library instead.

closes redhat-certification#418

Signed-off-by: Matthias Goerens <mgoerens@redhat.com>
Copy link
Contributor

@komish komish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@mgoerens mgoerens merged commit d5e8c65 into redhat-certification:main Feb 14, 2024
6 checks passed
@mgoerens mgoerens deleted the remove_kube_to_ocp_mapping branch February 14, 2024 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants