Update helm-docs version and add PR action to ensure docs are updated

Use Helm-Docs container

Helm-Docs Enforcement - Bump Chart Version
This commit is contained in:
GuyTempleton 2020-10-07 23:01:22 +01:00
parent 5a7e7cf5cc
commit 927eaca421
No known key found for this signature in database
GPG Key ID: 1293A624D42B68E0
6 changed files with 23 additions and 11 deletions

View File

@ -38,5 +38,19 @@ jobs:
uses: helm/chart-testing-action@v1.0.0-rc.2
with:
command: install
helm-docs-validate:
if: ${{ needs.changes.outputs.charts == 'true' }}
name: Helm Docs
needs:
- changes
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Run helm-docs
uses: docker://jnorwood/helm-docs:v1.3.0
- name: Check for changes
run: git diff --quiet charts/*/README.md
name: Lint and Test Charts
on: pull_request

View File

@ -10,5 +10,6 @@ repos:
rev: v0.1.9
- hooks:
- id: helm-docs
files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
repo: https://github.com/norwoodj/helm-docs
rev: v0.13.0
rev: v1.3.0

View File

@ -27,8 +27,6 @@ $ pre-commit install
### Install hook dependencies
The pre-commit hooks themselves call binaries under the hood; they can be installed via the following command:
The pre-commit hooks themselves call binaries under the hood; they can be installed via the [instructions found here](https://github.com/norwoodj/helm-docs#installation).
```shell
$ brew install helm norwoodj/tap/helm-docs
```
Note: You should ensure that whichever installation method you are using you either install the same version of helm-docs as used in the PR workflow to ensure your PR passes CI checks or update the version used by the workflow to match.

View File

@ -17,4 +17,4 @@ name: cluster-autoscaler-chart
sources:
- https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler
type: application
version: 1.0.4
version: 1.0.5

View File

@ -1,5 +1,4 @@
cluster-autoscaler-chart
========================
# cluster-autoscaler-chart
Scales Kubernetes worker nodes within autoscaling groups.
@ -286,7 +285,7 @@ Containers:
Though enough for the majority of installations, the default PodSecurityPolicy _could_ be too restrictive depending on the specifics of your release. Please make sure to check that the template fits with any customizations made or disable it by setting `rbac.pspEnabled` to `false`.
## Chart Values
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
@ -335,8 +334,8 @@ Though enough for the majority of installations, the default PodSecurityPolicy _
| resources | object | `{}` | Pod resource requests and limits. |
| securityContext | object | `{}` | [Security context for pod](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) |
| service.annotations | object | `{}` | Annotations to add to service |
| service.labels | object | `{}` | Labels to add to service |
| service.externalIPs | list | `[]` | List of IP addresses at which the service is available. Ref: https://kubernetes.io/docs/user-guide/services/#external-ips. |
| service.labels | object | `{}` | Labels to add to service |
| service.loadBalancerIP | string | `""` | IP address to assign to load balancer (if supported). |
| service.loadBalancerSourceRanges | list | `[]` | List of IP CIDRs allowed access to load balancer (if supported). |
| service.portName | string | `"http"` | Name for service port. |

View File

@ -252,7 +252,7 @@ For Kubernetes clusters that use Amazon EKS, the service account can be configur
In order to accomplish this, you will first need to create a new IAM role with the above mentions policies. Take care in [configuring the trust relationship](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html#iam-role-configuration) to restrict access just to the service account used by cluster autoscaler.
Once you have the IAM role configured, you would then need to `--set rbac.serviceAccountAnnotations."eks\.amazonaws\.com/role-arn"=arn:aws:iam::123456789012:role/MyRoleName` when installing.
Once you have the IAM role configured, you would then need to `--set rbac.serviceAccount.annotations."eks\.amazonaws\.com/role-arn"=arn:aws:iam::123456789012:role/MyRoleName` when installing.
## Troubleshooting