Helm chart: apply license, update description #282

jgehrcke · 2025-03-12T12:40:16Z

This follows the instructions in https://www.apache.org/legal/apply-license.html. In particular, this adheres to

To apply the ALv2 to a new software distribution, include one copy of the license text by copying the contents of LICENSE-2.0.txt into a file called LICENSE in the top directory of your distribution

If the distribution is a jar or tar file, try to add the LICENSE file first in order to place it at the top of the archive. This covers the collective licensing for the distribution.

In addition, you must include a correct NOTICE file in the same directory as the LICENSE file.

For the record, a screenshot from a staging environment where we see that the top-level tarball does not contain LICENSE & NOTICE files:

The goal of this patch is to make LICENSE file and NOTICE file pop up there (add them to the top-level tarball directory).

jgehrcke · 2025-03-12T12:40:55Z

deployments/helm/nvidia-dra-driver-gpu/LICENSE

@@ -0,0 +1,202 @@
+


This file is the result of curl https://www.apache.org/licenses/LICENSE-2.0.txt > LICENSE.

jgehrcke · 2025-03-12T12:41:25Z

deployments/helm/nvidia-dra-driver-gpu/NOTICE

@@ -0,0 +1,4 @@
+Copyright 2025 NVIDIA CORPORATION


cf. https://www.apache.org/legal/src-headers.html#notice

Should this include the same / similar text as # SPDX-FileCopyrightText: in the license header?

:) No.

The header facilitates discovering the license applied to a project/file in an automated fashion. It's typically used for SBOM generation / scanning / compliance purposes.

The NOTICE file is an implementation detail of the AL2.

Sorry, I meant to ask whether we should include & AFFILIATES, not the SPDX tags.

This follows the instructions in https://www.apache.org/legal/apply-license.html In particular, this adheres to > If the distribution is a jar or tar file, > try to add the LICENSE file first in order to > place it at the top of the archive. This > covers the collective licensing for the distribution. Signed-off-by: Dr. Jan-Philip Gehrcke <[email protected]> Signed-off-by: Dr. Jan-Philip Gehrcke <[email protected]>

jgehrcke · 2025-03-12T12:48:00Z

deployments/helm/nvidia-dra-driver-gpu/Chart.yaml

@@ -1,6 +1,21 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0


Taken from internal Wiki page.

Copilot

Pull Request Overview

This PR applies the Apache License text as header comments to the Helm chart and refines the chart description to better reflect its purpose.

Added Apache license header information to Chart.yaml
Updated the chart description to specify that it is the official Helm chart for the NVIDIA DRA driver for Kubernetes
Revised templating comments regarding the appVersion handling for image tagging

Comments suppressed due to low confidence (1)

deployments/helm/nvidia-dra-driver-gpu/Chart.yaml:1

The Apache guidelines require the inclusion of a LICENSE file and a NOTICE file in the top-level directory of the distribution. Ensure that these files are added to the root of your Helm chart distribution in addition to the license comment block in Chart.yaml.

# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

jgehrcke · 2025-03-12T13:24:30Z

The copilot got this. 🛩️ Sweet:

The Apache guidelines require the inclusion of a LICENSE file and a NOTICE file in the top-level directory of the distribution. Ensure that these files are added to the root of your Helm chart distribution in addition to the license comment block in Chart.yaml.

ArangoGutierrez

just one nit

ArangoGutierrez · 2025-03-12T13:23:51Z

deployments/helm/nvidia-dra-driver-gpu/Chart.yaml


-# Note(JP): this currently defines the default `tag` value in a k8s
-# image specification. A "v" is prefixed in our template helpers to ensure consistency.
+# Note(JP): templating logic consumes `appVersion` for building the default `tag`


I am all for notes, maybe we can use your github handle for better bookeeping
Note (@jgehrcke)

elezar · 2025-03-12T13:31:38Z

deployments/helm/nvidia-dra-driver-gpu/LICENSE

@@ -0,0 +1,202 @@
+


Does it make sense to symlink to the LICENSE file in the root? I suppose their contents are the same.

I like the idea, maybe all we need to check is if the command helm package would agree with this, if so, I like Evan's idea

I have confirmed that when making the following changes:

git status On branch jp/helm-apply-license Changes to be committed: (use "git restore --staged <file>..." to unstage) new file: NOTICE Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git restore <file>..." to discard changes in working directory) typechange: deployments/helm/nvidia-dra-driver-gpu/LICENSE typechange: deployments/helm/nvidia-dra-driver-gpu/NOTICE

and generating the package using hack/package-helm-charts.sh the resultant tar does contain the LICENSE and NOTICE files with the expected content.

I like this ++

Thanks for thinking about linking without blinking.

:) okäse 🧀 pushed a commit.

I thought about this (symlinking) when making this patch. Thoughts were: in this case, cost of duplication is ~zero. I also wanted to quickly get over with it and thought that it might even be smart to keep things decoupled. The most important part is that the tarball contains the proper files. From the git repo point of view we can choose not to care (is a symlinked license an actual license? what would the supreme court say? would elon come to our rescue? is armageddon about to happen soon?).

elezar

Thanks @jgehrcke

I have some comments / questions, but these could be considered out of scope. I'd be more than happy to address them in a follow-up instead.

Signed-off-by: Dr. Jan-Philip Gehrcke <[email protected]>

elezar

Minor question regarding & AFFILIATES, but otherwise lgtm.

jgehrcke · 2025-03-12T14:36:01Z

deployments/helm/nvidia-dra-driver-gpu/Chart.yaml

@@ -1,6 +1,21 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.


Good question about "AFFILIATES" @elezar . Also wondered about this specific wording. But I don't want to understand/resolve this today.

We got this instruction:

ensure the Helm chart has the NVIDIA copyright and Apache License header: url-to-confluence-page

I copy & pasted verbatim from there.

jgehrcke · 2025-03-12T14:37:33Z

Inclusion of proper files confirmed with logging:

± bash hack/package-helm-charts.sh 
walk.go:75: found symbolic link in path: /home/jgehrcke/dev/k8s-dra-driver-gpu/deployments/helm/nvidia-dra-driver-gpu/LICENSE resolves to /home/jgehrcke/dev/k8s-dra-driver-gpu/LICENSE. Contents of linked file included and used
walk.go:75: found symbolic link in path: /home/jgehrcke/dev/k8s-dra-driver-gpu/deployments/helm/nvidia-dra-driver-gpu/NOTICE resolves to /home/jgehrcke/dev/k8s-dra-driver-gpu/NOTICE. Contents of linked file included and used
Successfully packaged chart and saved it to: /home/jgehrcke/dev/k8s-dra-driver-gpu/nvidia-dra-driver-gpu-25.3.0-rc.1.tgz

jgehrcke commented Mar 12, 2025

View reviewed changes

jgehrcke mentioned this pull request Mar 12, 2025

Add helm license header #278

Closed

jgehrcke force-pushed the jp/helm-apply-license branch from 2ac78c0 to 4ed4515 Compare March 12, 2025 12:47

jgehrcke commented Mar 12, 2025

View reviewed changes

ArangoGutierrez requested review from Copilot, elezar and klueska March 12, 2025 13:21

Copilot AI reviewed Mar 12, 2025

View reviewed changes

ArangoGutierrez reviewed Mar 12, 2025

View reviewed changes

elezar reviewed Mar 12, 2025

View reviewed changes

elezar approved these changes Mar 12, 2025

View reviewed changes

jgehrcke added 2 commits March 12, 2025 15:25

Helm chart: update description, tweak comment

0771644

Signed-off-by: Dr. Jan-Philip Gehrcke <[email protected]>

Add NOTICE, symlink LICENSE&NOTICE in helm dir

6d2fee1

Signed-off-by: Dr. Jan-Philip Gehrcke <[email protected]>

jgehrcke force-pushed the jp/helm-apply-license branch from 4ed4515 to 6d2fee1 Compare March 12, 2025 14:25

elezar approved these changes Mar 12, 2025

View reviewed changes

jgehrcke commented Mar 12, 2025

View reviewed changes

jgehrcke merged commit f265df2 into NVIDIA:main Mar 12, 2025
13 checks passed

faganihajizada mentioned this pull request Mar 12, 2025

[no-relnote] Improve helm chart documentation #261

Closed

jgehrcke mentioned this pull request Mar 12, 2025

helm: remove symlinks (fix helm repo update) #284

Merged

jgehrcke added this to the v25.3.0 milestone Mar 13, 2025

klueska added this to Planning Board: k8s-dra-driver-gpu Jun 16, 2025

github-project-automation bot moved this to Backlog in Planning Board: k8s-dra-driver-gpu Jun 16, 2025

		@@ -1,6 +1,21 @@
		# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
		# SPDX-License-Identifier: Apache-2.0

Helm chart: apply license, update description #282

Helm chart: apply license, update description #282

Uh oh!

Conversation

jgehrcke commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elezar Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

jgehrcke commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ArangoGutierrez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elezar Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jgehrcke Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elezar left a comment

Choose a reason for hiding this comment

Uh oh!

elezar left a comment

Choose a reason for hiding this comment

Uh oh!

jgehrcke Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jgehrcke commented Mar 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jgehrcke commented Mar 12, 2025 •

edited

Loading

elezar Mar 12, 2025 •

edited

Loading

jgehrcke commented Mar 12, 2025 •

edited

Loading

elezar Mar 12, 2025 •

edited

Loading

jgehrcke Mar 12, 2025 •

edited

Loading

jgehrcke Mar 12, 2025 •

edited

Loading