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

Feature: Add helm chart #66

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

jessebot
Copy link

Description

This adds a basic helm chart for users to customize values for the manifests. This solves the issue of some users needing increased resources as they can adjust it themselves, instead of needing to fork the repo and possibly submit a PR.

helm chart features

  • generic-device-plugin daemonset
    • configurable resource limits and requests
    • configurable tolerations
    • configurable labels/annotations
    • configurable service account
  • optional PodMonitor resource (can be disabled)
  • service account

I've also used helm-docs to generate some very basic docs for the values.yaml parameters.

included two github workflows

  • ci - will lint the chart each time someone pushes to a PR branch in the charts/generic-device-plugin directory
  • release - will release the helm chart using github-pages (NOTE: to use this, you need to create a branch called gh-pages according to the helm/chart-releaser-action docs)

Tips on installing the chart

If you choose to release this helm chart, the install process is as follows (after the chart is released):

# add the chart repo to your helm repos
helm repo add generic-device-plugin https://squat.github.io/generic-device-plugin

# download the values.yaml and edit it with your own values such as YOUR hostname
helm show values generic-device-plugin/generic-device-plugin > values.yaml

# install the chart after editing any values you want to change in values.yaml
helm install --namespace kube-system generic-device-plugin/generic-device-plugin --values values.yaml

If you don't release the chart, then users can still use the chart, but they need to clone the repo, something like this:

# clone the repo
git clone https://github.com/squat/generic-device-plugin

# change to the chart directory
cd charts/generic-device-plugin

# install the helm chart in the kube-system namespace
helm install -n kube-system generic-device-plugin .

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

Successfully merging this pull request may close these issues.

1 participant