Skip to content

Commit fa56301

Browse files
committed
feat(ci): test Helm
Re-generating the README.md strips the "tips" section, but that's acceptable IMO to get CI working and get this PR merged. Signed-off-by: squat <lserven@gmail.com>
1 parent 8b7ebcb commit fa56301

4 files changed

Lines changed: 23 additions & 38 deletions

File tree

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
apiVersion: v2
22
name: generic-device-plugin
33
description: A Helm chart for deploying the generic-device-plugin on Kubernetes
4-
54
# A chart can be either an 'application' or a 'library' chart.
65
#
76
# Application charts are a collection of templates that can be packaged into versioned archives
@@ -11,18 +10,15 @@ description: A Helm chart for deploying the generic-device-plugin on Kubernetes
1110
# a dependency of application charts to inject those utilities and functions into the rendering
1211
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
1312
type: application
14-
1513
# This is the chart version. This version number should be incremented each time you make changes
1614
# to the chart and its templates, including the app version.
1715
# Versions are expected to follow Semantic Versioning (https://semver.org/)
1816
version: 0.1.0
19-
2017
# This is the version number of the application being deployed. This version number should be
2118
# incremented each time you make changes to the application. Versions are not expected to
2219
# follow Semantic Versioning. They should reflect the version the application is using.
2320
# It is recommended to use it with quotes.
24-
appVersion: "0.1.0"
25-
21+
appVersion: 0.2.0
2622
maintainers:
27-
- name: squat
28-
url: https://github.com/squat
23+
- name: squat
24+
url: https://github.com/squat
Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,8 @@
11
# generic-device-plugin
22

3-
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
3+
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.0](https://img.shields.io/badge/AppVersion-0.2.0-informational?style=flat-square)
44

5-
A Helm chart for deploying the generic-device-plugin on Kubernetes.
6-
7-
## Tips
8-
9-
Ensure that this is deployed into the `kube-system` namespace.
10-
11-
### Installing directly from the git repo
12-
13-
```bash
14-
# clone the repo
15-
git clone https://github.com/squat/generic-device-plugin
16-
17-
# change to the chart directory
18-
cd charts/generic-device-plugin
19-
20-
# install the helm chart in the kube-system namespace
21-
helm install -n kube-system generic-device-plugin .
22-
```
5+
A Helm chart for deploying the generic-device-plugin on Kubernetes
236

247
## Maintainers
258

@@ -47,4 +30,4 @@ helm install -n kube-system generic-device-plugin .
4730
| tolerations | list | `[{"effect":"NoExecute","operator":"Exists"},{"effect":"NoSchedule","operator":"Exists"}]` | tolerations of kubernetes taints |
4831

4932
----------------------------------------------
50-
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
33+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
# Default values for generic-device-plugin.
22
# This is a YAML-formatted file.
33
# Declare variables to be passed into your templates.
4-
54
image:
65
# -- container image repo
76
repository: squat/generic-device-plugin
87
# -- image pullPolicy is set to always because tag is set to latest
98
pullPolicy: Always
109
# -- Overrides the image tag whose default is the chart appVersion.
1110
tag: "latest"
12-
1311
# -- override the name of the chart resources
1412
nameOverride: ""
1513
# -- override the fullname of the chart resources
1614
fullnameOverride: ""
17-
1815
serviceAccount:
1916
# -- Specifies whether a service account should be created
2017
create: true
@@ -25,12 +22,10 @@ serviceAccount:
2522
# -- The name of the service account to use.
2623
# If not set and create is true, a name is generated using the fullname template
2724
name: ""
28-
2925
# -- additional annotations for the generic-device-plugin pod
3026
podAnnotations: {}
3127
# -- additional labels for the generic-device-plugin pod
3228
podLabels: {}
33-
3429
# -- resource requests and limits for the generic-device-plugin pod
3530
resources:
3631
requests:
@@ -39,13 +34,11 @@ resources:
3934
limits:
4035
cpu: 50m
4136
memory: 20Mi
42-
4337
# -- tolerations of kubernetes taints
4438
tolerations:
45-
- operator: "Exists"
46-
effect: "NoExecute"
47-
- operator: "Exists"
48-
effect: "NoSchedule"
49-
39+
- operator: "Exists"
40+
effect: "NoExecute"
41+
- operator: "Exists"
42+
effect: "NoSchedule"
5043
# -- deploy the podMonitor (requires PodMonitor CRD to be installed)
5144
deployPodMonitor: true

flake.nix

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,20 @@
110110
yamlfmt.excludes = [
111111
".github"
112112
"vendor"
113+
"charts/generic-device-plugin/templates"
113114
];
115+
helm-docs = {
116+
enable = true;
117+
name = "helm-docs";
118+
package = pkgs.helm-docs;
119+
entry = "${pkgs.helm-docs}/bin/helm-docs --chart-search-root=.";
120+
files = "^charts/";
121+
pass_filenames = false;
122+
};
123+
chart-testing = {
124+
enable = true;
125+
entry = "${pkgs.chart-testing}/bin/ct lint --all --skip-helm-dependencies --validate-maintainers=false";
126+
};
114127
header = {
115128
enable = true;
116129
name = "Header";

0 commit comments

Comments
 (0)