Skip to content

Commit a5db933

Browse files
committed
feat(helm): Create git precommit hook for helm docs
1 parent 7f928b0 commit a5db933

3 files changed

Lines changed: 5 additions & 2 deletions

File tree

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ repos:
33
rev: v1.14.2
44
hooks:
55
- id: helm-docs-container
6-
files: helm-charts/medcat-service-helm/(.*)
6+
files: helm-charts/medcat-service-helm/.*
77
args:
88
# Make the tool search for charts only under the `example-charts` directory
99
- --chart-search-root=helm-charts/medcat-service-helm

helm-charts/medcat-service-helm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ You should see the NVIDIA GPU device listing if the GPU is properly accessible.
175175
| readinessProbe.httpGet.path | string | `"/api/health/ready"` | |
176176
| readinessProbe.httpGet.port | string | `"http"` | |
177177
| replicaCount | int | `1` | This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ |
178-
| resources | object | `{}` | |
178+
| resources | object | `{}` | Configure resources for the pod. More information can be found here: https://kubernetes.io/docs/concepts/containers/ Recommendation for a default production model is { requests: { cpu: 1, memory: 4Gi }, limits: { cpu: null <unset>, memory: 4Gi } } |
179179
| runtimeClassName | string | `""` | Runtime class name for the pod (e.g., "nvidia" for GPU workloads) More information: https://kubernetes.io/docs/concepts/containers/runtime-class/ |
180180
| securityContext | object | `{}` | |
181181
| service.port | int | `5000` | This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports |

helm-charts/medcat-service-helm/values.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ ingress:
163163
# hosts:
164164
# - chart-example.local
165165

166+
# -- Configure resources for the pod. More information can be found here: https://kubernetes.io/docs/concepts/containers/
167+
# Recommendation for a default production model is { requests: { cpu: 1, memory: 4Gi }, limits: { cpu: null <unset>, memory: 4Gi } }
166168
resources: {}
167169
# We usually recommend not to specify default resources and to leave this as a conscious
168170
# choice for the user. This also increases chances charts run on environments with little
@@ -228,6 +230,7 @@ hostAliases: []
228230
# - ip: "127.0.0.1"
229231
# hostnames:
230232
# - "foo.local"
233+
231234
networkPolicy:
232235
# -- Choose to create a default network policy blocking all ingress other than to the service port.
233236
enabled: true

0 commit comments

Comments
 (0)