-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
4134de2
commit 85630f9
Showing
3 changed files
with
151 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,51 @@ jobs: | |
|
|
||
| - run: helm lint deploy/charts/version-checker | ||
|
|
||
| docs: | ||
| name: Generate Helm Docs | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
| - name: Check for values.yaml changes | ||
| uses: dorny/paths-filter@v2 | ||
| id: filter | ||
| with: | ||
| filters: | | ||
| values: | ||
| - 'deploy/charts/version-checker/values.yaml' | ||
| - name: Install Helm Docs | ||
| if: steps.filter.outputs.values == 'true' | ||
| uses: envoy/[email protected] | ||
| with: | ||
| version: 1.11.0 | ||
| - name: Update Helm Docs | ||
| run: | | ||
| set -ex | ||
| cd deploy/charts/version-checker | ||
| helm-docs | ||
| - name: Check for README.md changes | ||
| uses: dorny/paths-filter@v2 | ||
| id: filter-readme | ||
| with: | ||
| base: HEAD | ||
| filters: | | ||
| readme: | ||
| - 'deploy/charts/version-checker/README.md' | ||
| - name: Commit Helm Docs | ||
| if: steps.filter-readme.outputs.readme == 'true' | ||
| run: | | ||
| set -ex | ||
| git config --local user.email "github-actions[bot]@users.noreply.github.com" | ||
| git config --local user.name "github-actions[bot]" | ||
| git add deploy/charts/version-checker | ||
| git commit -m "[HELM] Update helm docs" | ||
| git push | ||
| test: | ||
| name: Run unit tests for Helm Chart | ||
| runs-on: ubuntu-latest | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # version-checker | ||
|
|
||
|   | ||
|
|
||
| A Helm chart for version-checker | ||
|
|
||
| **Homepage:** <https://github.com/jetstack/version-checker> | ||
|
|
||
| ## Maintainers | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | davidcollom | | | | ||
|
|
||
| ## Values | ||
|
|
||
| | Key | Type | Default | Description | | ||
| |-----|------|---------|-------------| | ||
| | acr | object | `{"password":null,"refreshToken":null,"username":null}` | Azure Container Registry Credentials Configuration | | ||
| | acr.password | string | `nil` | | | ||
| | acr.refreshToken | string | `nil` | | | ||
| | acr.username | string | `nil` | | | ||
| | additionalAnnotations | object | `{}` | | | ||
| | additionalLabels | object | `{}` | | | ||
| | docker.password | string | `nil` | | | ||
| | docker.token | string | `nil` | | | ||
| | docker.username | string | `nil` | | | ||
| | ecr.accessKeyID | string | `nil` | | | ||
| | ecr.iamRoleArn | string | `nil` | Provide AWS EKS Iam Role ARN following: [Specify A ServiceAccount Role](https://docs.aws.amazon.com/eks/latest/userguide/specify-service-account-role.html) | | ||
| | ecr.secretAccessKey | string | `nil` | | | ||
| | ecr.sessionToken | string | `nil` | | | ||
| | env | object | `{}` | Can be used to provide custom environment variables e.g. proxy settings | | ||
| | gcr.token | string | `nil` | | | ||
| | ghcr.token | string | `nil` | | | ||
| | image.pullPolicy | string | `"IfNotPresent"` | Set the Image Pull Policy | | ||
| | image.repository | string | `"quay.io/jetstack/version-checker"` | | | ||
| | image.tag | string | `nil` | Override the chart version | | ||
| | livenessProbe | object | `{"enabled":true,"httpGet":{"path":"/readyz","port":8080},"initialDelaySeconds":3,"periodSeconds":3}` | Configure the healthcheck probe for version-checker | | ||
| | livenessProbe.enabled | bool | `true` | Enable/Disable the setting of a livenessProbe | | ||
| | prometheus | object | `{"enabled":false,"replicas":1,"serviceAccountName":"prometheus"}` | Prometheus Operator | | ||
| | prometheus.enabled | bool | `false` | Deploy a Prometheus-Operator Prometheus Object to collect version-checker metrics | | ||
| | prometheus.serviceAccountName | string | `"prometheus"` | ServiceAccount for new Prometheus Object | | ||
| | quay.token | string | `nil` | | | ||
| | readinessProbe | object | `{"enabled":true,"httpGet":{"path":"/readyz","port":8080},"initialDelaySeconds":3,"periodSeconds":3}` | Configure the readiness probe for version-checker | | ||
| | readinessProbe.enabled | bool | `true` | Enable/Disable the setting of a readinessProbe | | ||
| | replicaCount | int | `1` | Replica Count for version-checker | | ||
| | resources | object | `{}` | Setup version-checkers resource requests/limits | | ||
| | selfhosted | []{name: "", host: "", username:"", password:"", token:""}] | `[]` | Setup a number of SelfHosted Repositories and their credentials | | ||
| | service | object | `{"annotations":{},"labels":{},"port":8080}` | Configure version-checkers Service | | ||
| | service.port | int | `8080` | Port to expose within the service | | ||
| | serviceMonitor | object | `{"additionalLabels":{},"enabled":false}` | Configure a Prometheus-Operator ServiceMonitor object | | ||
| | serviceMonitor.enabled | bool | `false` | Disable/Enable ServiceMonitor Object | | ||
| | versionChecker | object | `{"imageCacheTimeout":"30m","logLevel":"info","metricsServingAddress":"0.0.0.0:8080","testAllContainers":true}` | Configure version-checkers behaviour | | ||
| | versionChecker.imageCacheTimeout | string | `"30m"` | How long to hold on to image tags and their versions | | ||
| | versionChecker.logLevel | string | `"info"` | Configure version-checkers logging, valid options are: debug, info, warn, error, fatal, panic | | ||
| | versionChecker.metricsServingAddress | string | `"0.0.0.0:8080"` | Port/interface to which version-checker should bind too | | ||
| | versionChecker.testAllContainers | bool | `true` | Enable/Disable the requirement for an enable.version-checker.io annotation on pods. | | ||
|
|
||
| ---------------------------------------------- | ||
| Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters