diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fd16ba2..40f2146 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,10 +1,20 @@ # See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks repos: -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v3.2.0 - hooks: - - id: trailing-whitespace - - id: end-of-file-fixer - - id: check-yaml - - id: check-added-large-files +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v3.2.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + exclude: ^README.md$ + - id: check-yaml + - id: check-added-large-files +- repo: https://github.com/rapidsai/frigate/ + rev: v0.4.0 + hooks: + - id: frigate + args: + - --output=README.rst + - --format=rst + - --no-credits + - --no-deps diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e6c642 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ + +Lib +=========== + +Common functions for my helm charts at home + + +## Configuration + +The following table lists the configurable parameters of the Lib chart and their default values. + +| Parameter | Description | Default | +| ------------------------ | ----------------------- | -------------- | +| `namespace` | namespace to install to | `"default"` | +| `controller.enabled` | should the main workload be included or not | `true` | +| `controller.type` | valid options are deployment, statefulset, job | `"deployment"` | +| `controller.replicas` | number of replicas | `1` | +| `image.repository` | container image name | `null` | +| `image.pullPolicy` | kubernetes pull policy | `null` | +| `image.tag` | Overrides the image tag whose default is the chart appVersion. | `""` | +| `fullnameOverride` | override the name of the helm release | `""` | +| `service.main.enabled` | | `false` | +| `service.main.type` | | `"ClusterIP"` | +| `service.main.annotations` | | `{}` | +| `service.main.labels` | | `{}` | +| `service.main.ports` | | `null` | +| `ingress.enabled` | | `false` | +| `ingress.service` | what service should the ingress target | `"main"` | +| `ingress.servicePort` | | `80` | +| `ingress.className` | | `""` | +| `ingress.annotations` | | `{}` | +| `ingress.hosts` | | `[{"host": "chart-example.local", "paths": [{"path": "/", "pathType": "ImplementationSpecific"}]}]` | +| `ingress.tls` | | `[]` | +| `resources` | | `{}` | +| `autoscaling.enabled` | | `false` | +| `autoscaling.minReplicas` | | `1` | +| `autoscaling.maxReplicas` | | `5` | +| `autoscaling.targetCPUUtilizationPercentage` | | `80` | +| `secrets` | Secrets that needs to be created | `{}` | +| `configs` | ConfigMaps that needs to be created | `{}` | +| `env` | environment variables the controller should have | `{}` | +| `volumes` | | `[]` | +| `volumeMounts` | | `[]` | +| `volumeClaimTemplates` | used for statefulset https://kubernetes.io/docs/concepts/workloads/controllers/statefulset | `[]` | +| `serviceAccount.create` | | `true` | +| `serviceAccount.automount` | | `true` | +| `serviceAccount.annotations` | | `{}` | +| `serviceAccount.name` | | `""` | +| `livenessProbe` | | `{}` | +| `readinessProbe` | | `{}` | +| `nodeSelector` | | `{}` | +| `tolerations` | | `[]` | +| `affinity` | | `{}` | + + + +