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 checks for best-practices #142

Open
tongpu opened this issue Dec 18, 2020 · 6 comments
Open

Add checks for best-practices #142

tongpu opened this issue Dec 18, 2020 · 6 comments
Assignees
Labels
enhancement New feature or request

Comments

@tongpu
Copy link
Member

tongpu commented Dec 18, 2020

Is your feature request related to a problem? Please describe.
We've learned about certain things that we should look out for over time and we should add some checks to catch those. I'm currently aware of of the issue that ArgoCD doesn't like trailing slashes for .repoURL (#141) and that our best practices are to explicitly configure a name for each chart in our *-apps charts (#136).

Describe the solution you'd like
Simply yamllint check to verify the correct configuration of values.yaml in our *-apps charts.

Describe alternatives you've considered
Not applicable.

Affected chart
*-apps charts mostly.

@tongpu tongpu added the enhancement New feature or request label Dec 18, 2020
@eyenx eyenx self-assigned this Dec 18, 2020
@eyenx
Copy link
Member

eyenx commented Dec 23, 2020

I was thinking about writing a own rule set for this for yamllint, but it looks like implementing custom rules in yamllint isn't as easy as doing it for ansible-lint
adrienverge/yamllint#123

Now looking into ct lint perhaps we can do it there somehow

https://github.com/helm/chart-testing/blob/master/doc/ct_lint.md

@eyenx
Copy link
Member

eyenx commented Dec 23, 2020

yeah ct lint isn't gonna help, as it only checks the Chart.yaml

@eyenx
Copy link
Member

eyenx commented Dec 23, 2020

we could use yamale, which is used internally by ct lint, with a custom schema for our values.yaml.

@hairmare
Copy link
Contributor

I've recently been thinking of things like helm-unittest and hcunit lately. For the *-apps charts it might even be worth it to update the ct deployment to also include an actual argo cd based deployment but I'm not sure how easy that would be to implement.

@hairmare
Copy link
Contributor

For -app charts argo cd headless might be the way to test complete installs, i'm not sure how far along the project is tho.

@hairmare hairmare changed the title Add sanity checks for best-practices Add checks for best-practices Feb 7, 2022
@hairmare
Copy link
Contributor

hairmare commented Feb 7, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants