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

Add values.schema.json #2286

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ElijahQuinones
Copy link
Member

What type of PR is this?

/kind feature

What is this PR about? / Why do we need it?

This PR adds the values.schema.json file. Allowing us to make sure changes to helm chart parameters also appear in the eks add-on version of the driver as long as it makes sense to do so.

How was this change tested?

❯ helm lint .
==> Linting .
[INFO] Chart.yaml: icon is recommended

1 chart(s) linted, 0 chart(s) failed

Does this PR introduce a user-facing change?

Add values.schema.json to validate changes in values.yaml make it to the add-on schema.

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Jan 9, 2025
@k8s-ci-robot k8s-ci-robot requested a review from ConnorJC3 January 9, 2025 22:06
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 9, 2025
@k8s-ci-robot k8s-ci-robot requested a review from torredil January 9, 2025 22:06
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from elijahquinones. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jan 9, 2025
Copy link

github-actions bot commented Jan 9, 2025

Code Coverage Diff

This PR does not change the code coverage

@ElijahQuinones ElijahQuinones force-pushed the schema branch 2 times, most recently from 8fd4a86 to 34e7f54 Compare January 10, 2025 15:11
Copy link
Member

@torredil torredil left a comment

Choose a reason for hiding this comment

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

One suggested improvement, otherwise PR largely lgtm.

Comment on lines +736 to +743
"priorityClassName": {
"description": "Priority class for the Node Daemonset",
"type": [
"string",
"null"
],
"default": ""
},
Copy link
Member

Choose a reason for hiding this comment

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

I was wondering why this diff exists (for the add-on, this section is defined as follows):

"priorityClassName": {
      "description": "Priority class for the Node Daemonset",
       "type": "string",
       "default": "system-node-critical"
},

Which is correct, because that default value is defined in the node template:

priorityClassName: {{ .Values.node.priorityClassName | default "system-node-critical" }}

but is not currently set in values.yaml:

I think this would be a good opportunity to fix that discrepancy.

Copy link
Member Author

Choose a reason for hiding this comment

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

will do !

Copy link
Contributor

@AndrewSirenko AndrewSirenko left a comment

Choose a reason for hiding this comment

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

/lgtm

Largely looks good to me, thank you!

The real test will be going through release process and merging with add-on.

},
"tag": {
"type": "string",
"default": "v0.5.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

We're going to need to update our /hack/release-scripts/generate-sidecar-tags script to update default sidecar tags like this.

Can you add a backlog task for it or update the script?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 21, 2025
},
"fips": {
"type": "boolean",
"description": "Instruct the AWS SDK to use AWS FIPS endpoints, and deploy container built with BoringCrypto (a FIPS-validated cryptographic library) instead of the Go default. The EBS CSI Driver FIPS images have not undergone FIPS certification, and no official guarnatee is made about the compliance of these images under the FIPS standard. Users relying on these images for FIPS compliance should perform their own independent evaluation",
Copy link
Contributor

Choose a reason for hiding this comment

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

There is a typo here for guarantee. Did we run a spellcheck on this file? Your IDE should do this for you (or have a plugin).

Copy link
Contributor

@AndrewSirenko AndrewSirenko left a comment

Choose a reason for hiding this comment

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

Can we run this file through a spellcheck? (Your IDE should do this for you)

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants