File helm-docs-1.14.2.obscpio of Package helm-docs
07070100000000000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001900000000helm-docs-1.14.2/.github07070100000001000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002800000000helm-docs-1.14.2/.github/ISSUE_TEMPLATE07070100000002000081A4000000000000000000000001668BBBD200000C5D000000000000000000000000000000000000003700000000helm-docs-1.14.2/.github/ISSUE_TEMPLATE/bug_report.ymlname: 🐞 Bug Report
description: File a new bug report
title: '[Bug]: <title>'
labels:
- "bug"
- "triage"
assignees:
- "norwoodj"
- "Nepo26"
body:
- type: markdown
attributes:
value: 'Thanks for taking the time to fill out this bug report!'
- type: checkboxes
attributes:
label: 'Is there an existing issue for this?'
description: 'Please [search :mag: the issues](https://github.com/norwoodj/helm-docs/issues) to check if this bug has already been reported.'
options:
- label: 'I have searched the existing issues'
required: true
- type: textarea
attributes:
label: 'Current Behavior'
description: 'Describe the problem you are experiencing. **Please do not paste your logs here.** Screenshots are welcome.'
validations:
required: true
- type: textarea
attributes:
label: 'Expected Behavior'
description: 'Describe what you expect to happen instead.'
validations:
required: true
- type: textarea
attributes:
label: 'Reference Chart'
description: |
Please provide an example chart, be it the full code or just a reference to a repository.
> OBS.: :warning: _Remember to redact or remove any sensitive information!_
validations:
required: true
- type: textarea
attributes:
label: 'Reference Template'
description: |
If you are using a custom template, put it in here, so we can help you better.
validations:
required: false
- type: textarea
attributes:
label: 'Environment'
description: 'Please provide the following information about your environment; feel free to remove any items which are not relevant.'
value: |
- Operating system:
- Helm version (output of `helm version`):
- GO version (output of `go version`):
- Method of calling `helm-docs` (manual, jenkins, github action ...):
#TODO Add when the version function is implemented:
# - **helm-docs** version (output of `helm-docs version`):
validations:
required: false
- type: input
attributes:
label: 'Link to `helm-docs` Logs'
description: |
Create a [Gist](https://gist.github.com)—which contains your _full_ `helm-docs` logs—and link it here. Alternatively, you can attach a logfile to this issue (drag it into the "Further Information" field below).
Remember to use the following flag `--log-level debug`
> OBS.: :warning: _Remember to redact or remove any sensitive information!_
placeholder: 'https://gist.github.com/...'
validations:
required: false
- type: textarea
attributes:
label: Further Information
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
_Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in._
validations:
required: false
- type: markdown
attributes:
value: ':stop_sign: _For support questions, you may create an issue with the question template._'
07070100000003000081A4000000000000000000000001668BBBD20000001E000000000000000000000000000000000000003300000000helm-docs-1.14.2/.github/ISSUE_TEMPLATE/config.ymlblank_issues_enabled: false
07070100000004000081A4000000000000000000000001668BBBD20000040E000000000000000000000000000000000000003B00000000helm-docs-1.14.2/.github/ISSUE_TEMPLATE/feature_request.md---
name: Feature request
about: Suggest an idea for this project
title: "[Feat]: <title>"
labels:
- enhancement
assignees:
- Nepo26
---
<!--- Provide a general summary of the issue in the Title above -->
## Is your feature request related to a problem? Please describe and/or link to a bug issue
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
## Expected Behavior
<!--- Tell us how it should work -->
## Current Behavior
<!--- Explain the difference from current behavior -->
## Possible Solution
<!--- Ideas on how to implement the addition or change -->
## Describe alternatives you've considered
<!--- A clear and concise description of any alternative solutions or features you've considered. -->
## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
<!--- Add any other context or screenshots about the feature request here. -->
07070100000005000081A4000000000000000000000001668BBBD2000007F7000000000000000000000000000000000000003D00000000helm-docs-1.14.2/.github/ISSUE_TEMPLATE/feature_request.yamlname: 🌟 Feature Request
description: Suggest an idea for this project
title: "[Feat]: <title>"
labels:
- "enhancement"
- "triage"
assignees:
- "norwoodj"
- "Nepo26"
body:
- type: markdown
attributes:
value: "Thank you for the interest in the project! :blush:"
- type: textarea
attributes:
label: "General Summary"
description: "Provide a general summary of the issue in the Title above"
validations:
required: true
- type: textarea
attributes:
label: "Is your feature request related to a problem? Please describe and/or link to a bug issue."
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
validations:
required: true
- type: textarea
attributes:
label: "Expected Behavior"
description: "Tell us how it should work"
validations:
required: false
- type: textarea
attributes:
label: "Current Behavior"
description: "Explain the difference from current behavior"
validations:
required: false
- type: textarea
attributes:
label: "Possible Solution"
description: "Ideas on how to implement the addition or change"
validations:
required: false
- type: textarea
attributes:
label: "Alternatives you've considered"
description: "A clear and concise description of any alternative solutions or features you've considered."
validations:
required: false
- type: textarea
attributes:
label: Further Information
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
- How has this issue affected you? What are you trying to accomplish?
- Providing context helps us come up with a solution that is most useful in the real world
_Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in._
validations:
required: false
07070100000006000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002F00000000helm-docs-1.14.2/.github/PULL_REQUEST_TEMPLATE07070100000007000081A4000000000000000000000001668BBBD2000005C3000000000000000000000000000000000000004300000000helm-docs-1.14.2/.github/PULL_REQUEST_TEMPLATE/general_template.md## Proposed changes
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
## Types of changes
What types of changes does your code introduce to `helm-docs`?
_Put an `x` in the boxes that apply_
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation Update (if none of the other choices apply)
## Checklist
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
- [ ] I have read the [CONTRIBUTING](https://github.com/norwoodj/helm-docs/blob/master/CONTRIBUTING.md) doc
- [ ] Lint and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)
- [ ] Any dependent changes have been merged and published in downstream modules
## Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
07070100000008000081A4000000000000000000000001668BBBD200000119000000000000000000000000000000000000002800000000helm-docs-1.14.2/.github/dependabot.ymlversion: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
- package-ecosystem: gomod
directory: /
schedule:
interval: weekly
- package-ecosystem: docker
directory: /
schedule:
interval: weekly
07070100000009000081A4000000000000000000000001668BBBD2000006B1000000000000000000000000000000000000002700000000helm-docs-1.14.2/.github/signature.asc-----BEGIN PGP PUBLIC KEY BLOCK-----
mQENBF8sdg4BCACcJMhLU1lzSYtjApDungY6o4YRwAUjtCvtCnBlVrp4hXw36S/j
AIk5i5B1Tw01hg283JgygJufAIYhTTHfbk+DqQ16ds+xEupGhbS2P6wYKMvmZUTn
W6K3IZndeGJ1kAiVLDf4b19r/EqBxgS8ZrSSPkm8ikaYsv4sFR/9pvs+Lm9tOt7R
vQpd9q0zavtcIGBOtCDlXpkAt1zG+MA57/9jT1Ok0s9xs7GkeVTI7uNw64x8WBMy
3FMIRUDZ2/pPcxNYjxmxTXbHIO3TgBVFl41Pf91zN/YjBObpe3BBnFwBdreQt9Fj
vCpBAQ+Ez970B3yyOfer+h5CRGYyJa3Ia8Q5ABEBAAG0CWhlbG0tZG9jc4kBTgQT
AQgAOBYhBJpDpTNgM0VH62ap7vG7/dhd8PBfBQJfLHYOAhsDBQsJCAcCBhUKCQgL
AgQWAgMBAh4BAheAAAoJEPG7/dhd8PBfc0YH/jZhBJcrvxfvIi6jBziui5kdZlpd
VHXQ/JtG7WwXt53WJZ0a2/XGh+50wT1fYD9K5LellRCj9tsJwiFWHvM0tCoZimV6
snmTP/lfYE1D9B1xyDbxbwQJNffV3k45oC4dIaJT8NufwYMyuSzA19k5u3ye2O61
L3qEVJwApBiA79mQ6O6I8pSiFP5dvh7hrz8OHm8df/GLSMalkI3d0XOzJoj1jxW2
qZLYi670oxbmUlejg41Qmqg8K2vnxO0irHI4AGNS9SFxvl84/h02TytWkI+wWxDO
+Ata05klnYEQ0VQ6pRNzECx5d20863T9fZDpiFh8KtnmVYLeUsfPDbiNyFG5AQ0E
Xyx2DgEIANGhHyRfBgoY0ZJN3Dla+8EgQJ90as+t+TMChK1xB7TCZ5PpvZdtUbZw
mYlXxAyrJOUTez1MT5z4Qt/SFpKqgy1ehGNguFvCud/p0ExfGOgZRptje/HVah3f
NHJlLd65uDczobnYqUnYJfeay4sEANsZ3SD6w3HrNbc/kHYQE7R+9Ps2WfP1Kd7G
BcHEy4lfWiK5dqj0FKFGf8XeqNZLSC/EyJ2THkEQKKLtwAlAvFA81hFrf5PmrDN0
irPKsfS4C7bhvYUX8/AAhVL5mtYAtwY1kay7N/iS789kke0NtTYeHNhYrZx7WdVF
U32RLEV4Reva86SmZhMcK9M5QBNzJkUAEQEAAYkBNgQYAQgAIBYhBJpDpTNgM0VH
62ap7vG7/dhd8PBfBQJfLHYOAhsMAAoJEPG7/dhd8PBfHvoH/3x2dcW/V+CQOoHy
TmqEfTIKmaFByxQG2sfNvrJ2WA8OJqazhjwYnDb5aMtgyHz6j7lTS3kM5gkH5jcM
dM8Agw99xnfBbl4jSAs8NyzPByyEhFvQVrIDklXiHGiv9h0MNw0zLA6LWNKCyxz8
+hBp3TcOL+AcF36piKV/HORuZHnGwg1vcYWWjHFMVQ4OVKPSGViifXYShex82bwk
EM5tR68PFW0XxQy5DvTIXRjLFH2ai4AIWWuYv6b72p0lwZRMMl1St1iNy3Vs9H2y
fmJZkZh88k65CSvARWjFOx6juITXAKVgH9UAKHE2bypYS4CRovMTxXvfiP1Dtj3o
xC3v6C0=
=JO1k
-----END PGP PUBLIC KEY BLOCK-----
0707010000000A000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002300000000helm-docs-1.14.2/.github/workflows0707010000000B000081A4000000000000000000000001668BBBD200000299000000000000000000000000000000000000002D00000000helm-docs-1.14.2/.github/workflows/build.ymlname: Build
on:
push:
branches:
- "*"
tags-ignore:
- "*"
pull_request:
types: [opened, reopened]
jobs:
build:
runs-on: ubuntu-latest
env:
DOCKER_CLI_EXPERIMENTAL: "enabled"
steps:
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v6
with:
args: release --snapshot --skip=sign
- if: always()
run: rm -f ${HOME}/.docker/config.json
0707010000000C000081A4000000000000000000000001668BBBD200000430000000000000000000000000000000000000002F00000000helm-docs-1.14.2/.github/workflows/release.ymlname: Release
on:
push:
tags:
- "v*"
jobs:
release:
runs-on: ubuntu-latest
env:
DOCKER_CLI_EXPERIMENTAL: "enabled"
steps:
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
- name: Login to Docker hub
if: ${{ !env.ACT }}
run: docker login -u ${{ secrets.DOCKER_HUB_USER }} -p ${{ secrets.DOCKER_HUB_PASSWORD }}
- name: Import GPG key
if: ${{ !env.ACT }}
id: import_gpg
uses: crazy-max/ghaction-import-gpg@v6
with:
gpg_private_key: ${{ secrets.SIGNING_KEY }}
- name: Release Helm-Docs
if: ${{ !env.ACT }}
uses: goreleaser/goreleaser-action@v6
with:
args: release
env:
GITHUB_TOKEN: ${{ secrets.NORWOODJ_ORG_TOKEN }}
GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
- if: always()
run: rm -f ${HOME}/.docker/config.json
0707010000000D000081A4000000000000000000000001668BBBD200000046000000000000000000000000000000000000001C00000000helm-docs-1.14.2/.gitignore/helm-docs
/cmd/helm-docs/helm-docs
dist
.idea/
*.iml
.vscode/
vendor/0707010000000E000081A4000000000000000000000001668BBBD200000C97000000000000000000000000000000000000002100000000helm-docs-1.14.2/.goreleaser.ymlversion: 2
project_name: helm-docs
before:
hooks:
- go mod download
- go test ./...
builds:
- main: ./cmd/helm-docs
env:
- CGO_ENABLED=0
goarch:
- amd64
- arm
- arm64
goarm:
- 6
- 7
goos:
- darwin
- linux
- windows
archives:
- id: default
name_template: >-
{{ .ProjectName }}_
{{- .Version }}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else if eq .Arch "arm" }}{{ .Arch }}{{ .Arm }}
{{- else }}{{ .Arch }}{{ end }}
checksum:
name_template: checksums.txt
snapshot:
name_template: "{{ .Tag }}-next"
changelog:
sort: asc
filters:
exclude:
- "^docs:"
- "^test:"
signs:
- artifacts: checksum
args: [ '{{ if index .Env "GPG_FINGERPRINT" }}-u {{ .Env.GPG_FINGERPRINT }}{{ else }}-s{{ end }}', "--output", "${signature}","--detach-sign", "${artifact}"]
nfpms:
- vendor: helm-docs
homepage: https://github.com/norwoodj/helm-docs
maintainer: norwoodj
description: A tool for automatically generating markdown documentation for helm charts
license: GPL-3.0-or-later
formats:
- deb
- rpm
file_name_template: >-
{{ .ProjectName }}_
{{- .Version}}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else if eq .Arch "arm" }}{{ .Arch }}{{ .Arm }}
{{- else }}{{ .Arch }}{{ end }}
brews:
- repository:
owner: norwoodj
name: homebrew
directory: Formula
homepage: https://github.com/norwoodj/helm-docs
description: Automatically generate markdown documentation for helm charts
install: |
bin.install "helm-docs"
test: |
system "#{bin}/helm-docs --version"
dockers:
- goos: linux
goarch: amd64
dockerfile: Dockerfile
use: buildx
build_flag_templates:
- --platform=linux/amd64
image_templates:
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-amd64
- goos: linux
goarch: arm64
dockerfile: Dockerfile
use: buildx
build_flag_templates:
- --platform=linux/arm64
image_templates:
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64
- goos: linux
goarch: arm
goarm: 6
dockerfile: Dockerfile
use: buildx
build_flag_templates:
- --platform=linux/arm/v6
image_templates:
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v6
- goos: linux
goarch: arm
goarm: 7
dockerfile: Dockerfile
use: buildx
build_flag_templates:
- --platform=linux/arm/v7
image_templates:
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v7
docker_manifests:
- name_template: jnorwood/{{ .ProjectName }}:{{ .Tag }}
image_templates:
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-amd64
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v6
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v7
- name_template: jnorwood/{{ .ProjectName }}:latest
image_templates:
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-amd64
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v6
- jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v7
0707010000000F000081A4000000000000000000000001668BBBD200000042000000000000000000000000000000000000002100000000helm-docs-1.14.2/.helmdocsignoreexample-charts/ignored-zero
example-charts/ignored-one/Chart.yaml
07070100000010000081A4000000000000000000000001668BBBD200000254000000000000000000000000000000000000002900000000helm-docs-1.14.2/.pre-commit-config.yamlrepos:
- repo: https://github.com/norwoodj/helm-docs
rev: v1.2.0
hooks:
- id: helm-docs
args:
# Make the tool search for charts only under the `example-charts` directory
- --chart-search-root=example-charts
# The `./` makes it relative to the chart-search-root set above
- --template-files=./_templates.gotmpl
# Repeating the flag adds this to the list, now [./_templates.gotmpl, README.md.gotmpl]
# A base filename makes it relative to each chart directory found
- --template-files=README.md.gotmpl
07070100000011000081A4000000000000000000000001668BBBD200000444000000000000000000000000000000000000002800000000helm-docs-1.14.2/.pre-commit-hooks.yaml- id: helm-docs
args: []
description: Uses 'helm-docs' to create documentation from the Helm chart's 'values.yaml' file, and inserts the result into a corresponding 'README.md' file.
entry: git-hook/helm-docs
files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
language: script
name: Helm Docs
require_serial: true
- id: helm-docs-built
args: []
description: Uses auto built 'helm-docs' to create documentation from the Helm chart's 'values.yaml' file, and inserts the result into a corresponding 'README.md' file.
entry: helm-docs
files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
language: golang
name: Helm Docs Built
require_serial: true
- id: helm-docs-container
args: []
description: Uses the container image of 'helm-docs' to create documentation from the Helm chart's 'values.yaml' file, and inserts the result into a corresponding 'README.md' file.
entry: jnorwood/helm-docs:latest
files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
language: docker_image
name: Helm Docs Container
require_serial: true
07070100000012000081A4000000000000000000000001668BBBD200004EA2000000000000000000000000000000000000001E00000000helm-docs-1.14.2/CHANGELOG.md1.14.2
- 2024-07-08 Release v1.14.2
- 2024-07-08 fix: Adds check for tag format to release script, also makes release script error on improper tags
- 2024-07-08 Merge pull request #251 from norwoodj/dependabot/go_modules/helm.sh/helm/v3-3.15.2
- 2024-07-08 chore(deps): bump helm.sh/helm/v3 from 3.15.1 to 3.15.2
1.14.1
- 2024-07-08 Release 1.14.1
- 2024-07-08 Merge pull request #248 from WePlan-Software/master
- 2024-07-08 Update go.mod via 'go mod tidy'
- 2024-07-06 chore: generates documentation using new v1.14.0
1.14.0
- 2024-07-06 Release 1.14.0
- 2024-07-06 Merge pull request #237 from norwoodj/dependabot/github_actions/docker/setup-qemu-action-3
- 2024-07-06 chore(deps): bump docker/setup-qemu-action from 2 to 3
- 2024-07-06 Merge pull request #236 from norwoodj/dependabot/github_actions/crazy-max/ghaction-import-gpg-6
- 2024-07-06 chore(deps): bump crazy-max/ghaction-import-gpg from 5 to 6
- 2024-07-06 Merge pull request #238 from norwoodj/dependabot/docker/alpine-3.20
- 2024-07-06 chore(deps): bump alpine from 3.19 to 3.20
- 2024-07-06 Merge pull request #239 from norwoodj/dependabot/github_actions/docker/setup-buildx-action-3
- 2024-07-06 chore(deps): bump docker/setup-buildx-action from 2 to 3
- 2024-07-06 Merge pull request #246 from norwoodj/jnorwood/fix-goreleaser
- 2024-07-06 fix: Fixes goreleaser action by using new flag
- 2024-07-06 Merge pull request #240 from norwoodj/dependabot/github_actions/goreleaser/goreleaser-action-6
- 2024-07-06 chore(deps): bump goreleaser/goreleaser-action from 4 to 6
- 2024-07-06 Merge pull request #220 from gbprz/skip-helm-version-footer
- 2024-02-27 add a flag to remove the version footer
- 2024-07-06 Merge pull request #230 from ebuildy/feat_yaml_functions
- 2024-05-11 revert go.mod
- 2024-05-11 add toYaml example
- 2024-05-11 add example
- 2024-07-06 Merge pull request #176 from jasondamour/master
- 2023-03-29 feat: add toYaml and fromYaml to functions map
- 2024-07-06 Merge pull request #243 from norwoodj/dependabot/go_modules/github.com/spf13/cobra-1.8.1
- 2024-07-06 chore(deps): bump github.com/spf13/cobra from 1.7.0 to 1.8.1
- 2024-07-06 Merge pull request #244 from norwoodj/dependabot/go_modules/github.com/stretchr/testify-1.9.0
- 2024-07-06 chore(deps): bump github.com/stretchr/testify from 1.8.3 to 1.9.0
- 2024-07-06 Merge pull request #232 from lucacome/helm3
- 2024-05-30 Use helm v3
- 2024-07-06 Merge pull request #233 from lucacome/dependabot
- 2024-05-30 Add dependabot
- 2024-05-12 Merge pull request #224 from ebuildy/fix_go_mod_version
- 2024-03-28 chore: set go version to 1.22.0
- 2024-03-02 chore: renders example chart documentation using v1.13.1
1.13.1
- 2024-03-02 Release v1.13.1
- 2024-03-02 chore: updates golang.org/x/crypto to fix vulnerability
- 2024-03-02 Merge pull request #219 from mpluhar/master
- 2024-02-26 Update documentation for default template
- 2024-02-24 chore: updates chart docs with v1.13.0
1.13.0
- 2024-02-24 Release v1.13.0
- 2024-02-24 chore: adds git-cliff configuration, generates historical changelog and adds a release script
- 2024-02-24 fix: Solves #217 where helm-docs would segfault due in charts with certain comment format
- 2024-02-24 Merge pull request #212 from chenrui333/update-license-to-use-spdx-id
- 2024-02-01 license: update to use spdx id
- 2024-02-24 Merge pull request #209 from UnsolvedCypher/master
- 2024-01-03 fix: Correct the name of the GitHub repository in the README
- 2024-02-24 Merge pull request #211 from Footur/update-alpine
- 2024-01-10 Update Alpine to v3.19
- 2024-02-24 Merge pull request #213 from chenrui333/go-1.22
- 2024-02-07 feat: update to use go1.22
- 2023-12-21 chore: updates generated chart documentation for version v1.12.0
1.12.0
- 2023-12-21 Merge pull request #194 from Haepaxlog/sections
- 2023-11-29 conform to MD022
- 2023-11-08 Change example section chart to new templates
- 2023-11-08 Add some comments about parsing of key comments
- 2023-11-08 Sectioned values are default if provied
- 2023-11-08 Factor out sorting value rows and add dedicated default section
- 2023-09-06 Put the creation and sorting of sectioned Value Rows in its own functions
- 2023-09-05 Add Tests for section feature
- 2023-09-05 Give an example of how to use sections
- 2023-09-05 Add possibility to generate subsectioned Values Tables
- 2023-11-02 Merge pull request #159 from terrycain/files_asmap
- 2022-07-18 Adds AsMap to iterate over .Files.Glob
- 2023-11-02 Merge pull request #167 from RetGal/patch-1
- 2022-11-30 Fix filename
- 2023-11-02 Merge pull request #172 from gianklug/patch-1
- 2023-02-23 fix(README): change the way helm-docs is installed
- 2023-11-02 Merge pull request #184 from sblundy/notation-on-null-values
- 2023-07-12 Copy NotationType in Nil Values
- 2023-10-21 Merge pull request #191 from Labelbox/add-docker-to-pre-commit-hooks
- 2023-10-16 Update README.md with pre-commit usage examples
- 2023-10-16 Update .pre-commit-hooks.yaml
- 2023-08-17 Pin container version to tagged release v1.11.0
- 2023-08-15 Add containerized pre-commit hook
1.11.3
- 2023-10-10 Merge pull request #201 from Nepo26/200-bug-binary-artifacts-renamed-in-v1112
- 2023-10-10 hotfix: changing back artifacts name
- 2023-09-26 Merge pull request #199 from norwoodj/feat/improving-community-standards
- 2023-09-23 fix: correct contributing link referent in pr template
- 2023-09-23 fix: changed to always get the latest version on the helm docs pre commit
- 2023-09-20 Merge pull request #198 from brettmorien/master
- 2023-09-15 Bump all available dependencies to latest.
1.11.2
- 2023-09-10 Revert "fix: String additional empty line from generated README.md"
- 2023-09-10 chore: update github actions to be able to reproduce using act
- 2023-09-10 chore: adding todo to refactor main test
- 2023-09-10 fix: removing goreleaser project env var to be able to test locally
- 2023-09-10 fix: remove var env dependency by moving tests
- 2023-07-25 chore: change readme to trigger ci
1.11.1
- 2023-07-25 chore: change readme to trigger ci
- 2023-07-25 Merge pull request #181 from edmondop/issue-169
- 2023-07-25 Update pkg/helm/chart_info.go
- 2023-07-25 fix: change error to err to not conflict with builtin interface
- 2023-07-25 fix: update goreleaser and way to get env
- 2023-07-25 fix: update actions
- 2023-06-29 Fixed GoReleaser
- 2023-06-29 Fixing build
- 2023-06-29 Fixed deprecation
- 2023-06-29 Fixing GoReleaser deprecated action
- 2023-06-29 Introducing options from the CLI and unit test to confirm strict linting of documentation comments
- 2023-07-01 Merge pull request #178 from jlec/fix-177
- 2023-04-03 fix: String additional empty line from generated README.md
- 2022-06-29 chore: updates example chart READMEs for v1.11.0
1.11.0
- 2022-06-29 fix: fixes file operations to work when not running from the chart root and fixes several tests
- 2022-06-29 Merge pull request #141 from j-buczak/ignoring_values
- 2022-05-11 Improve code according to mjpitz suggestions
- 2022-05-10 Add option for ignoring values
- 2022-06-29 Merge pull request #139 from terrycain/107-files
- 2022-05-11 Added file lazy loading
- 2022-04-26 Added Helm .Files
- 2022-06-29 Merge pull request #142 from j-buczak/rename_section_to_raw
- 2022-05-11 Rename @section to @raw
- 2022-06-29 Merge pull request #145 from j-buczak/charts_to_generate_flag
- 2022-05-12 Add an option to list charts to generate
- 2022-06-29 Merge pull request #146 from j-buczak/fix_file_sorter
- 2022-05-12 fix broken file sorting
- 2022-06-29 Merge pull request #151 from armosec/master
- 2022-05-23 adding ignore-non-descriptions flag
- 2022-05-10 chore: generate READMEs for example charts with new version
1.10.0
- 2022-05-10 Merge pull request #140 from norwoodj/fix/nil-value-types
- 2022-05-10 fix: types on nil values
- 2022-05-10 Merge pull request #87 from lucernae/notation-type
- 2021-02-02 Add support for custom notation type
- 2022-04-25 Generated example charts with new version
1.9.1
- 2022-04-25 Revert "Add angle brackets around urls in requirementsTable"
- 2022-04-25 Generated example charts with new version
1.9.0
- 2022-04-25 Merge pull request #112 from armsnyder/umbrella-values
- 2022-03-22 Fix issue where an empty global object in a child chart would be listed in the root docs
- 2021-10-27 Warn about remote dependencies without erroring; Parse local file:// repositories
- 2021-10-14 Fix documented globals prefixed with the sub-chart alias
- 2021-10-12 Tolerate dependency charts without values.yaml
- 2021-10-04 New flag --document-dependency-values
- 2022-04-25 Merge pull request #136 from norwoodj/pr-124
- 2022-04-25 Updates alpine docker image to fix issue #124
- 2022-04-25 Merge pull request #134 from vladimir-babichev/no-bare-urls-in-requirements-table
- 2022-04-06 Add angle brackets around urls in requirementsTable
- 2022-04-03 Runs newest helm-docs to update docs for example charts
1.8.1
- 2022-04-03 Don't print angle brackets for URL/email if not present
1.8.0
- 2022-04-03 Merge pull request #102 from dfarrell07/no_raw_url
- 2021-06-25 Avoid raw URLs in maintainer tables
- 2022-04-03 Updgrades sprig to v3
- 2022-04-03 Merge pull request #121 from dirien/badge-style
- 2022-04-03 Merge branch 'master' into badge-style
- 2022-04-03 Merge pull request #130 from maybolt/values-file-option-argument
- 2022-03-21 Add option for a values file named other than `values.yaml`.
- 2022-04-03 Merge pull request #132 from norwoodj/jnorwood/fix/131
- 2022-04-01 Updgrades golang/x/sys to fix #131
1.7.0
- 2022-01-19 ci: fix environment variable reference
- 2022-01-19 ci: add job for importing GPG private key (#122)
- 2022-01-19 fix: updates signing key so release builds can work again
- 2022-01-18 Merge pull request #99 from bmcustodio/bmcustodio-fix-comments
- 2021-06-08 Ignore comment nodes not containing '# --'.
- 2021-05-20 Consider only the last group of comments starting with '# --'.
- 2022-01-16 feat: make the badge style from shields.io configurable
- 2021-12-10 remove deprecated goreleaser use_buildx option
- 2021-11-29 Merge pull request #113 from armsnyder/benchmark
- 2021-10-05 Add a benchmark
- 2021-10-20 Merge pull request #114 from jrottenberg/pre-commit.com-559
- 2021-10-10 No jump required
- 2021-10-10 wip
- 2021-09-06 Merge pull request #104 from kd7lxl/fix-empty
- 2021-07-30 fix type definition when description is empty
- 2021-05-18 fix: makes description appear even if unrelated comment appears before description comment fixes #92
- 2021-05-18 Merge pull request #95 from sc250024/chore-GoReleaserM1
- 2021-04-26 ci(github): updating for docker multi-arch builds
- 2021-04-26 ci(goreleaser): updating for docker multi-arch builds
- 2021-04-26 ci(github): updating actions for apple silicon builds
- 2021-04-26 ci(goreleaser): updating linux package naming for consistency
- 2021-04-26 Merge pull request #93 from goostleek/patch-1
- 2021-04-04 Extend README Installation section with scoop alternative for Windows
- 2021-02-10 Merge pull request #79 from sagikazarmark/fix-77
- 2021-01-13 Do not stop loading templates when a file cannot be found
- 2021-01-13 Add breaking test for default template loading
- 2021-01-13 Add test for template loading
- 2021-02-10 Merge pull request #85 from jsoref/spelling
- 2021-02-01 spelling: search
- 2021-02-01 spelling: equivalently
- 2021-02-10 Merge pull request #83 from stretched/typo-fix
- 2021-01-19 Fix typo: serach -> search
- 2021-01-14 Merge pull request #80 from sagikazarmark/fix-typo
- 2021-01-13 Fix typo in readme
- 2021-01-14 Merge pull request #81 from alexrashed/bugfix/default-for-nil
- 2021-01-14 fix: fixes @default for variables without value
- 2021-01-12 chore: runs newest helm-docs version against example charts
1.5.0
- 2021-01-12 fix: fixes small formatting issue
- 2021-01-12 fix: fixes broken comment parsing on values files with dos line endings
- 2021-01-12 Merge pull request #69 from horacimacias/master
- 2020-10-30 Parse requirement's alias and display "alias(name)" if 'alias' was defined
- 2021-01-12 Merge pull request #75 from sagikazarmark/add-badges-section
- 2021-01-07 Update full-template example
- 2021-01-07 Update the default template to use badgesSection
- 2021-01-07 Add badgesSection template
- 2021-01-12 Merge pull request #76 from sagikazarmark/fix-set-env
- 2021-01-07 Upgrade go version
- 2021-01-07 Update setup-go action
1.4.0
- 2020-10-20 Merge pull request #66 from sc250024/issue-51
- 2020-10-10 fix(goreleaser): adding more os and arch types
- 2020-10-10 chore(goreleaser): fixing brew github deprecation
- 2020-10-06 chore: updates charts with new helm-docs version
- 2020-10-06 Merge pull request #65 from norwoodj/rb/use-file-order
1.3.0
- 2020-10-06 fix: fixes tests by calling correct method
- 2020-10-06 fix: small issue in sorting by file location
- 2020-10-02 change flag
- 2020-10-01 feat: add support for sorting based on presence in file
- 2020-10-06 fix: link to hashbash
- 2020-10-06 Merge pull request #64 from norwoodj/jnorwood/comprehensive-example
- 2020-10-06 feat: adds a new chart with good examples, cleans up README a bit more, and shhhh... fixes a bug
- 2020-10-04 chore: updates readmes with latest version of helm-docs
1.2.1
- 2020-10-04 fix: makes it so charts with empty values files still get helm-docs-version footers
- 2020-10-04 chore: updates readmes with latest version of helm-docs
1.2.0
- 2020-10-04 chore: updates pre-commit hook version
- 2020-10-04 Merge pull request #63 from norwoodj/add-helm-docs-version-line
- 2020-10-04 feat: updates default chart to add a footer to markdown files with the helm-docs version, if set
- 2020-10-03 Merge pull request #62 from norwoodj/fix-diry
- 2020-10-03 feat: updates to add chart search path flag and to search for template files differently based on how they're presented fixes #47
- 2020-10-03 Merge pull request #54 from DirtyCajunRice/master
- 2020-09-13 allow multiple templates
- 2020-10-03 Merge pull request #61 from norwoodj/fix-dash-versions
- 2020-10-03 fix: escapes dashes in version badges so complicated versions work fixes #56
1.1.0
- 2020-10-03 Merge pull request #60 from norwoodj/new-style-comment-parity
- 2020-10-03 feat: Largely expands all features for old comments to new comments, old-style comments effectively deprecated
1.0.0
- 2020-10-02 Merge pull request #59 from norwoodj/auto-find-comments
- 2020-10-02 feat!: Adds the capability to provide comments without the path to the documented field fixes #58
0.15.0
- 2020-08-07 Merge pull request #50 from sc250024/fix-GithubRelease
- 2020-08-07 fix: GitHub token for Homebrew tap
0.14.0
- 2020-08-06 feat: updates signature public key for action
- 2020-08-06 Merge pull request #41 from ccremer/actions
- 2020-05-04 Add FPM/DEB packaging method, sign checksums
- 2020-05-04 Add Github Actions CI/CD workflows
- 2020-08-06 Merge pull request #46 from matheusfm/feature/name-template
- 2020-06-19 add 'chart.name' template description in 'Available Templates' section
- 2020-06-17 add chart name template to examples
- 2020-06-17 add template to the chart name
- 2020-08-06 Merge pull request #49 from sc250024/fix-PreCommitHookReadmeTemplate
- 2020-07-30 fix: Updating hook config for README.md.gotmpl
- 2020-08-06 Merge pull request #43 from acim/install-from-source
- 2020-05-29 add doc how to install from source
- 2020-05-22 Merge pull request #42 from Artus-LHIND/master
- 2020-05-15 Merge pull request #4 from Artus-LHIND/develop
- 2020-05-15 chore: update default template in README.md
- 2020-05-15 Merge pull request #3 from Artus-LHIND/develop
- 2020-05-15 fix: no double whitespace using the badges
- 2020-05-15 feat: add two regex for markdown linting
- 2020-05-14 Merge pull request #2 from Artus-LHIND/develop
- 2020-05-14 refactor: badges at default template
- 2020-05-14 Merge pull request #1 from Artus-LHIND/develop
- 2020-05-14 feat: add full-template example
- 2020-05-13 feat: fixed and updated READMEs
- 2020-05-13 feat: check for line templates, update README.md
- 2020-05-13 feat: deprecation, badges, styling, more options
- 2020-05-22 Merge pull request #40 from ccremer/patch-1
- 2020-05-04 Improve Docker usage documentation
0.13.0
- 2020-04-29 Merge pull request #38 from nvtkaszpir/dockerfile-workdir
- 2020-04-14 Add WORKDIR to Dockerfile to allow mounting charts, expand docs
0.12.0
- 2020-04-08 fix: fixes docker image name
- 2020-04-08 Merge pull request #36 from eddycharly/master
- 2020-04-03 attempt to add docker to goreleaser
0.11.1
- 2020-03-31 Merge pull request #34 from norwoodj/update-custom-default-rendering
- 2020-03-31 fix: Doesn't backtick-quote custom default values, back to the way originally implemented
0.11.0
- 2020-03-30 Merge pull request #33 from norwoodj/issue-28-output
- 2020-03-30 feat: adds a --output-file cli option for specifying the file to which documentation is written (fixes #28)
- 2020-03-30 Merge pull request #32 from norwoodj/issue-24-special
- 2020-03-29 fix: renders <, >, and & characters from default values correctly (fixes #24)
- 2020-03-30 Merge pull request #31 from norwoodj/improve-custom-default-rendering
- 2020-03-29 chore: slightly changes format of @default values as they're rendered in the mardown output
0.10.0
- 2020-03-29 Merge pull request #29 from eddycharly/master
- 2020-03-25 add comments continuation and default value
0.9.0
- 2020-01-02 Merge pull request #23 from skaro13/feature/helm-3-compatibility
- 2019-12-30 Updated Build Var Name
- 2019-12-30 Added Type field & dependencies compatibilty for Helm 3 v2 API
0.8.0
- 2019-08-13 Merge pull request #19 from norwoodj/minor-fixes
- 2019-08-10 fix: cleans up some code and minor fix to ignore case
0.7.0
- 2019-08-10 Merge pull request #18 from norwoodj/improve-ignoring
- 2019-08-09 feat: improves ignore feature, accepting an ignore file at the root of the repository as well as in the directory
- 2019-08-09 Merge pull request #17 from norwoodj/git-hook-changes
- 2019-08-09 feat: changes files for git hook slightly
- 2019-08-09 Merge pull request #16 from norwoodj/fix-chart-links
- 2019-08-09 feat: updates links to source in chart files
- 2019-08-09 Feature => Pre-commit hook (#14)
0.6.0
- 2019-08-07 Merge pull request #15 from norwoodj/add-ignore-file
- 2019-08-07 feat: adds support for an ignore file to exclude charts from processing
- 2019-08-05 Merge pull request #11 from norwoodj/add-goreport
- 2019-08-05 feat: adds goreport to the readme
0.5.0
- 2019-07-29 Merge pull request #10 from norwoodj/document-lists-and-objects
- 2019-07-28 feat: updates values table generation allowing for non-empty lists/maps to be documented
0.4.0
- 2019-07-18 feat: updates documentation with homebrew installation instructions
0.3.0
- 2019-07-18 Merge pull request #7 from norwoodj/homebrew-6
- 2019-07-18 feat: adds goreleaser configuration to deploy a homebrew tap
0.2.0
- 2019-07-17 Merge pull request #5 from norwoodj/issue-3
- 2019-07-17 feat: refactor to use gotemplates to render documentation, adds new example charts
- 2019-07-10 chore: removes unnecessary log message
0.1.1
- 2019-07-10 fix: updates name of version var to get a version in the CLI flag
0.1.0
- 2019-07-10 feat: adds goreleaser to create proper releases, creates packages, adds cobra/viper
19.0614
- 2019-06-14 Merge pull request #2 from RemingtonReackhof/fix-nil-values
- 2019-06-14 fix: change rendering of <nil> in markdown to render correctly
- 2019-06-14 Merge pull request #1 from RemingtonReackhof/fix-nil-values
- 2019-06-14 chore: update readme to include simple instructions on nil values
- 2019-06-14 fix: generate docs for nil values and include types for them
- 2019-06-14 style: run go fmt
19.0110
- 2019-01-10 Updates to follow better go project conventions
- 2018-09-15 Updates to allow for helm-docs to recursively search for charts within the project and generate docs for all of them
- 2018-09-01 Adds an example chart and some documentation. Also fixes a few small issues
- 2018-09-01 Adds most of a README, fixes a small issue with list parsing
- 2018-09-01 Adds code for the initial version, and a Makefile for building it
- 2018-09-01 Initial commit
07070100000013000081A4000000000000000000000001668BBBD2000002C3000000000000000000000000000000000000002100000000helm-docs-1.14.2/CONTRIBUTING.md# Contributing to helm-docs
## Build
To build from source in this repository:
```bash
cd cmd/helm-docs
go build
```
Or you can install from source:
```bash
GO111MODULE=on go get github.com/norwoodj/helm-docs/cmd/helm-docs
```
## Testing
### Benchmarks
If you are working on a feature that is likely to impact performance, consider running benchmarks
and comparing the results before and after your change.
To run benchmarks, run the command:
```
go test -run=^$ -bench=. ./cmd/helm-docs
```
### Github Actions
You may use [act](https://github.com/nektos/act) to test
locally the workflow.By issuing the following command you can
see if a release will work as expected.
```bash
act -j release
```
07070100000014000081A4000000000000000000000001668BBBD200000059000000000000000000000000000000000000001C00000000helm-docs-1.14.2/DockerfileFROM alpine:3.20
COPY helm-docs /usr/bin/
WORKDIR /helm-docs
ENTRYPOINT ["helm-docs"]
07070100000015000081A4000000000000000000000001668BBBD20000894B000000000000000000000000000000000000001900000000helm-docs-1.14.2/LICENSE GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
07070100000016000081A4000000000000000000000001668BBBD200000139000000000000000000000000000000000000001A00000000helm-docs-1.14.2/Makefilehelm-docs:
go build github.com/norwoodj/helm-docs/cmd/helm-docs
install:
go install github.com/norwoodj/helm-docs/cmd/helm-docs
.PHONY: fmt
fmt:
go fmt ./...
.PHONY: test
test:
go test -v ./...
.PHONY: clean
clean:
rm -f helm-docs
.PHONY: dist
dist:
goreleaser release --rm-dist --snapshot --skip=sign
07070100000017000081A4000000000000000000000001668BBBD20000671E000000000000000000000000000000000000001B00000000helm-docs-1.14.2/README.mdhelm-docs
=========
[](https://goreportcard.com/report/github.com/norwoodj/helm-docs)
The helm-docs tool auto-generates documentation from helm charts into markdown files. The resulting
files contain metadata about their respective chart and a table with each of the chart's values, their defaults, and an
optional description parsed from comments.
The markdown generation is entirely [gotemplate](https://golang.org/pkg/text/template) driven. The tool parses metadata
from charts and generates a number of sub-templates that can be referenced in a template file (by default `README.md.gotmpl`).
If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.
The most useful aspect of this tool is the auto-detection of field descriptions from comments:
```yaml
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgres
# -- database for the [hashbash](https://github.com/norwoodj/hashbash-backend-go) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
statefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresql
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
```
Resulting in a resulting README section like so:
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash-backend-go) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresql:11"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"18.0831"` | |
You'll notice that some complex fields (lists and objects) are documented while others aren't, and that some simple fields
like `statefulset.image.tag` are documented even without a description comment. The rules for what is and isn't documented in
the final table will be described in detail later in this document.
## Installation
helm-docs can be installed using [homebrew](https://brew.sh/):
```bash
brew install norwoodj/tap/helm-docs
```
or [scoop](https://scoop.sh):
```bash
scoop install helm-docs
```
This will download and install the [latest release](https://github.com/norwoodj/helm-docs/releases/latest)
of the tool.
To build from source in this repository:
```bash
cd cmd/helm-docs
go build
```
Or install from source:
```bash
go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
```
## Usage
### Pre-commit hook
If you want to automatically generate `README.md` files with a pre-commit hook, make sure you
[install the pre-commit binary](https://pre-commit.com/#install), and add a [.pre-commit-config.yaml file](./.pre-commit-config.yaml)
to your project. Then run:
```bash
pre-commit install
pre-commit install-hooks
```
Future changes to your chart's `requirements.yaml`, `values.yaml`, `Chart.yaml`, or `README.md.gotmpl` files will cause an update to documentation when you commit.
There are several variants of `pre-commit` hooks to choose from depending on your use case.
#### `helm-docs` Uses `helm-docs` binary located in your `PATH`
```yaml
---
repos:
- repo: https://github.com/norwoodj/helm-docs
rev: ""
hooks:
- id: helm-docs
args:
# Make the tool search for charts only under the `charts` directory
- --chart-search-root=charts
```
#### `helm-docs-built` Uses `helm-docs` built from code in git
```yaml
---
repos:
- repo: https://github.com/norwoodj/helm-docs
rev: ""
hooks:
- id: helm-docs-built
args:
# Make the tool search for charts only under the `charts` directory
- --chart-search-root=charts
```
#### `helm-docs-container` Uses the container image of `helm-docs:latest`
```yaml
---
repos:
- repo: https://github.com/norwoodj/helm-docs
rev: ""
hooks:
- id: helm-docs-container
args:
# Make the tool search for charts only under the `charts` directory
- --chart-search-root=charts
```
#### To pin the `helm-docs` container to a specific tag, follow the example below:
```yaml
---
repos:
- repo: https://github.com/norwoodj/helm-docs
rev: ""
hooks:
- id: helm-docs-container
entry: jnorwood/helm-docs:x.y.z
args:
# Make the tool search for charts only under the `charts` directory
- --chart-search-root=charts
```
### Running the binary directly
To run and generate documentation into READMEs for all helm charts within or recursively contained by a directory:
```bash
helm-docs
# OR
helm-docs --dry-run # prints generated documentation to stdout rather than modifying READMEs
```
The tool searches recursively through subdirectories of the current directory for `Chart.yaml` files and generates documentation
for every chart that it finds.
### Using docker
You can mount a directory with charts under `/helm-docs` within the container.
Then run:
```bash
docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
```
## Ignoring Chart Directories
helm-docs supports a `.helmdocsignore` file, exactly like a `.gitignore` file in which one can specify directories to ignore
when searching for charts. Directories specified need not be charts themselves, so parent directories containing potentially
many charts can be ignored and none of the charts underneath them will be processed. You may also directly reference the
Chart.yaml file for a chart to skip processing for it.
## Generating Doc with Dependency values
Umbrella Helm chart documentation can include dependency values with `document-dependency-values` flag.
All dependency values will be merged into values of umbrella chart documentation.
If you want to include dependency values, but don't want to generate doc for each dependency:
* set `chart-search-root` parameter to directory that contains umbrella chart and all dependency charts.
* list all charts you want to generate doc using `chart-to-generate` flag
* set `document-dependency-values` flag to true
## Markdown Rendering
There are two important parameters to be aware of when running helm-docs. `--chart-search-root` specifies the directory
under which the tool will recursively search for charts to render documentation for. `--template-files` specifies the list
of gotemplate files that should be used in rendering the resulting markdown file for each chart found. By default
`--chart-search-root=.` and `--template-files=README.md.gotmpl`.
If a template file is specified as a filename only as with the default above, the file is interpreted as being _relative to each chart directory found_.
If however a template file is specified as a relative path, e.g. the first of `--template-files=./_templates.gotmpl --template-files=README.md.gotmpl`
then the file is interpreted as being relative to the `chart-search-root`.
This repo is a good example of this in action. If you take a look at the [.pre-commit-config.yaml file](./.pre-commit-config.yaml)
here, you'll see our search root is set to [example-charts](./example-charts) and the list of templates used for each chart
is the [_templates.gotmpl file in that directory](./example-charts/_templates.gotmpl) and the README.md.gotmpl file in
each chart directory.
If any of the specified template files is not found for a chart (you'll notice most of the example charts do not have a README.md.gotmpl)
file, then the internal default template is used instead.
In addition to extra defined templates you specify in these template files, there are quite a few built-in templates that
can be used as well:
| Name | Description |
|------|-------------|
| chart.header | The main heading of the generated markdown file |
| chart.name | The _name_ field from the chart's `Chart.yaml` file |
| chart.deprecationWarning | A deprecation warning which is displayed when the _deprecated_ field from the chart's `Chart.yaml` file is `true` |
| chart.description | A description line containing the _description_ field from the chart's `Chart.yaml` file, or "" if that field is not set |
| chart.version | The _version_ field from the chart's `Chart.yaml` file |
| chart.versionBadge | A badge stating the current version of the chart |
| chart.type | The _type_ field from the chart's `Chart.yaml` file |
| chart.typeBadge | A badge stating the current type of the chart |
| chart.appVersion | The _appVersion_ field from the chart's `Chart.yaml` file |
| chart.appVersionBadge | A badge stating the current appVersion of the chart |
| chart.homepage | The _home_ link from the chart's `Chart.yaml` file, or "" if that field is not set |
| chart.homepageLine | A text line stating the current homepage of the chart |
| chart.maintainersHeader | The heading for the chart maintainers section |
| chart.maintainersTable | A table of the chart's maintainers |
| chart.maintainersSection | A section headed by the maintainersHeader from above containing the maintainersTable from above or "" if there are no maintainers |
| chart.sourcesHeader | The heading for the chart sources section |
| chart.sourcesList | A list of the chart's sources |
| chart.sourcesSection | A section headed by the sourcesHeader from above containing the sourcesList from above or "" if there are no sources |
| chart.kubeVersion | The _kubeVersion_ field from the chart's `Chart.yaml` file |
| chart.kubeVersionLine | A text line stating the required Kubernetes version for the chart |~~~~
| chart.requirementsHeader | The heading for the chart requirements section |
| chart.requirementsTable | A table of the chart's required sub-charts |
| chart.requirementsSection | A section headed by the requirementsHeader from above containing the kubeVersionLine and/or the requirementsTable from above or "" if there are no requirements |
| chart.valuesHeader | The heading for the chart values section |
| chart.valuesTable | A table of the chart's values parsed from the `values.yaml` file (see below) |
| chart.valuesSection | A section headed by the valuesHeader from above containing the valuesTable from above or "" if there are no values |
| chart.valuesTableHtml | Like `chart.valuesTable` but it is rendered as (X)HTML tags to allow further rendering customization, instead of markdown tables format. |
| chart.valuesSectionHtml | Like `chart.valuesSection` but uses `chart.valuesTableHtml` |
| chart.valueDefaultColumnRender | This is a hook template if you want to redefine how helm-docs render the default values in `chart.valuesTableHtml` mode. This is especially useful when combined with (X)HTML tags, so that you can nicely format multiline default values, like YAML/JSON object tree snippet with codeblock syntax highlighter, which is not possible or difficult when using the markdown table format. It can be redefined in your template file. |
| helm-docs.versionFooter | A footer that contains the version of helm docs being used. |
The default internal template mentioned above uses many of these and looks like this:
```
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
```
The tool also includes the [sprig templating library](https://github.com/Masterminds/sprig), so those functions can be used
in the templates you supply.
### values.yaml metadata
This tool can parse descriptions and defaults of values from `values.yaml` files. The defaults are pulled directly from
the yaml in the file.
It was formerly the case that descriptions had to be specified with the full path of the yaml field. This is no longer
the case, although it is still supported. Where before you would document a values.yaml like so:
```yaml
controller:
publishService:
# controller.publishService.enabled -- Whether to expose the ingress controller to the public world
enabled: false
# controller.replicas -- Number of nginx-ingress pods to load balance between.
# Do not set this below 2.
replicas: 2
```
You may now equivalently write:
```yaml
controller:
publishService:
# -- Whether to expose the ingress controller to the public world
enabled: false
# -- Number of nginx-ingress pods to load balance between.
# Do not set this below 2.
replicas: 2
```
New-style comments are much the same as the old-style comments, except that while old comments for a field could appear
anywhere in the file, new-style comments must appear **on the line(s) immediately preceding the field being documented.**
I invite you to check out the [example-charts](./example-charts) to see how this is done in practice. The `but-auto-comments`
examples in particular document the new comment format.
Note that comments can continue on the next line. In that case leave out the double dash, and the lines will simply be
appended with a space in-between, as in the `controller.replicas` field in the example above
The following rules are used to determine which values will be added to the values table in the README:
* By default, only _leaf nodes_, that is, fields of type `int`, `string`, `float`, `bool`, empty lists, and empty maps
are added as rows in the values table. These fields will be added even if they do not have a description comment
* Lists and maps which contain elements will not be added as rows in the values table _unless_ they have a description
comment which refers to them
* Adding a description comment for a non-empty list or map in this way makes it so that leaf nodes underneath the
described field will _not_ be automatically added to the values table. In order to document both a non-empty list/map
_and_ a leaf node within that field, description comments must be added for both
e.g. In this case, both `controller.livenessProbe` and `controller.livenessProbe.httpGet.path` will be added as rows in
the values table, but `controller.livenessProbe.httpGet.port` will not
```yaml
controller:
# -- Configure the healthcheck for the ingress controller
livenessProbe:
httpGet:
# -- This is the liveness check endpoint
path: /healthz
port: http
```
Results in:
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.livenessProbe | object | `{"httpGet":{"path":"/healthz","port":8080}}` | Configure the healthcheck for the ingress controller |
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
If we remove the comment for `controller.livenessProbe` however, both leaf nodes `controller.livenessProbe.httpGet.path`
and `controller.livenessProbe.httpGet.port` will be added to the table, with or without description comments:
```yaml
controller:
livenessProbe:
httpGet:
# -- This is the liveness check endpoint
path: /healthz
port: http
```
Results in:
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| controller.livenessProbe.httpGet.port | string | `"http"` | |
### nil values
If you would like to define a key for a value, but leave the default empty, you can still specify a description for it
as well as a type. This is possible with both the old and the new comment format:
```yaml
controller:
# -- (int) Number of nginx-ingress pods to load balance between
replicas:
# controller.image -- (string) Number of nginx-ingress pods to load balance between
image:
```
This could be useful when wanting to enforce user-defined values for the chart, where there are no sensible defaults.
### Default values/column
In cases where you do not want to include the default value from `values.yaml`, or where the real default is calculated
inside the chart, you can change the contents of the column like so:
```yaml
service:
# -- Add annotations to the service, this is going to be a long comment across multiple lines
# but that's fine, these will be concatenated and the @default will be rendered as the default for this field
# @default -- the chart will add some internal annotations automatically
annotations: []
```
The order is important. The first comment line(s) must be the one specifying the key or using the auto-detection feature and
the description for the field. The `@default` comment must follow.
See [here](./example-charts/custom-template/values.yaml) for an example.
### Ignoring values
In cases you would like to ignore certain values, you can mark it with @ignored tag:
```yaml
# @ignored
service:
port: 8080
```
### Spaces and Dots in keys
In the old-style comment, if a key name contains any "." or " " characters, that section of the path must be quoted in
description comments e.g.
```yaml
service:
annotations:
# service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
configMap:
# configMap."not real config param" -- A completely fake config parameter for a useful example
not real config param: value
```
### Advanced table rendering
Some helm chart `values.yaml` uses complicated structure for the key/value
pairs. For example, it may uses a multiline string of Go template text instead
of plain strings. Some values might also refer to a certain YAML/JSON object
structure, like internal k8s value type, or an enum. For these use case,
a standard markdown table format might be inadequate and you want to use HTML
tags to render the table.
Some example use case on why you need advanced table rendering:
- Hyperlinking the value type to an anchor or HTML link somewhere for reference
- Collapsible value description using `<summary>` tags to save space
- Multiline default values as codeblocks, instead of one line JSON structure for readability
- Custom rendering, for colors, actions, bookmarking, cross-reference, etc
- Cascading the markdown file generated by helm-docs to be post-processed by Jamstack into a static HTML docs site.
In order to accomodate this, `helm-docs` provides an extensible and flexible way to customize rendering.
1. Use the HTML value renderer instead of the default markdown format
You can use `chart.valuesSectionHtml` to render the values table as HTML tags,
instead of using `chart.valuesSection`. Using HTML tables provides more
flexibility because it can be processed by markdown viewer as a nested blocks,
instead of one row per line. This allows you to customize how each columns in a
row are rendered.
2. Overriding built-in templates
You can always overrides or redefine built-in templates in your own `_templates.gotmpl`
file. The built-in templates can be thought of as a template hook.
For example, if you need to change the HTML table, for example to add a new
column, or define maximum width/height, you can override `chart.valuesTableHtml`. Your overrides will then be called by `chart.valuesSectionHtml`.
You can add your own rendering logic for each column. For example, we have `chart.valueDefaultColumnRender` that is used to render "default value" column for each rows. If you want to override how helm-docs render the
"type" column, just define your own rendering template and call it from
`chart.valuesTableHtml` for each of the rows.
3. Using the metadata of each rows of values
Custom styling and rendering can be done as flexible as you want, but you
still need a metadata that describes each rows of values. You can access
this information from the templates.
When you override `chart.valuesTableHtml`, as you can see in the original
definition in `func getValuesTableTemplates()` [pkg/document/template.go](pkg/document/template.go), we iterates each row of values.
For each "Value", it is modeled as a struct defined in `valueRow` struct
in [pkg/document/model.go](pkg/document/model.go). You can then use the
fields in your template.
Some fields here are directly referenced from `values.yaml`:
- `Key`: the full name of the key referenced in `values.yaml`
- `Type`: the type of the value of the key in `values.yaml`. Can be automatically inferred from YAML structure, or annotated using `# -- (mytype)` where `mytype` can be any string that you refer as the type of the value.
- `NotationType`: the notation of the type used to render the default value. If `Type` refers to the data type of the value, then `NotationType` refers to **how** this value should be written/rendered by helm-docs. Generally helm-docs only remembers the notation type, but it was the writer's responsibility to make a template tag to render a specific notation type. Annotate the key with `# @notationType -- (mynotation)` where `mynotation` is an identifier to tell the renderer how to write the value.
- `Default`: this is the default value of the key, found from `values.yaml`. It is either inferred from the YAML structure or defined using `# @default -- my default value` annotation, in case you need to show other example values.
- `Description`: this is the description of the key/value, taken from the comments found in the `values.yaml` for the referred key.
- `LineNumber`: this is the line number associated with where the key is declared. You can use this to construct an anchor to the actual `values.yaml` file.
Note that helm-docs only provides these information, but the default behaviour is to always render it in plain Markdown file to be viewed locally.
4. Use markdown files generated by helm-docs as intermediary files to be processed further
Public helm charts sometimes needs to be published as static content
instead of just stored in a repository. This is needed for helm users to
be able to view or browse the chart options and dependencies.
It is often more than enough to just browse the chart values options on
git hosting that is able to render markdown files as a nice HTML page, like GitHub or GitLab.
However, for a certain use case, you may want to use your own
documentation generator to host or publish the output of helm-docs.
If you use some kind of Jamstack like Gatsby or Hugo, you can use the
output of helm-docs as an input for these doc generator. A typical use
case is to override helm-docs built-in template so that it renders a
markdown or markdownX files to be processed by Gatsby or Hugo into
a static Web/Javascript page.
For a more concrete examples on how to do these custom rendering, see [example here](./example-charts/custom-value-notation-type/README.md)
## Strict linting
Sometimes you might want to enforce helm-docs to fail when some values are not documented correctly.
By default, this option is turned off:
```shell
./helm-docs -c example-charts/helm-3
INFO[2023-06-29T07:54:29-07:00] Found Chart directories [.]
INFO[2023-06-29T07:54:29-07:00] Generating README Documentation for chart example-charts/helm-3
```
but you can use the `-x` flag to turn it on:
```shell
helm-docs -x -c example-charts/helm-3
INFO[2023-06-29T07:55:12-07:00] Found Chart directories [.]
WARN[2023-06-29T07:55:12-07:00] Error parsing information for chart ., skipping: values without documentation:
controller
controller.name
controller.image
controller.extraVolumes.[0].name
controller.extraVolumes.[0].configMap
controller.extraVolumes.[0].configMap.name
controller.livenessProbe.httpGet
controller.livenessProbe.httpGet.port
controller.publishService
controller.service
controller.service.annotations
controller.service.annotations.external-dns.alpha.kubernetes.io/hostname
```
The CLI also supports excluding fields by regexp using the `-z` argument
```shell
helm-docs -x -z="controller.*" -c example-charts/helm-3
INFO[2023-06-29T08:18:55-07:00] Found Chart directories [.]
INFO[2023-06-29T08:18:55-07:00] Generating README Documentation for chart example-charts/helm-3
```
Multiple regexp can be passed, as in the following example:
```shell
helm-docs -x -z="controller.image.*" -z="controller.service.*" -z="controller.extraVolumes.*" -c example-charts/helm-3
INFO[2023-06-29T08:21:04-07:00] Found Chart directories [.]
WARN[2023-06-29T08:21:04-07:00] Error parsing information for chart ., skipping: values without documentation:
controller
controller.name
controller.livenessProbe.httpGet
controller.livenessProbe.httpGet.port
controller.publishService
```
It is also possible to ignore specific errors using the `-y` argument.
```shell
helm-docs -x -y="controller.name" -y="controller.service" -c example-charts/helm-3
INFO[2023-06-29T08:23:40-07:00] Found Chart directories [.]
WARN[2023-06-29T08:23:40-07:00] Error parsing information for chart ., skipping: values without documentation:
controller
controller.image
controller.extraVolumes.[0].name
controller.extraVolumes.[0].configMap
controller.extraVolumes.[0].configMap.name
controller.livenessProbe.httpGet
controller.livenessProbe.httpGet.port
controller.publishService
controller.service.annotations
controller.service.annotations.external-dns.alpha.kubernetes.io/hostname
```
07070100000018000081A4000000000000000000000001668BBBD200000654000000000000000000000000000000000000001D00000000helm-docs-1.14.2/SECURITY.md## Security
We take this project and its users security seriously.
If you believe you have found a security vulnerability in any part of this repo,
please report it to us as described below.
## Reporting Security Issues
**Please do not report security vulnerabilities through public GitHub issues.**
Instead, please report them in the [private vulnerability reporting](https://github.com/norwoodj/helm-docs/security/advisories).
If you prefer to submit without logging in, send email to [norwood.john.m@gmail.com](mailto:norwood.john.m@gmail.com) or
[nepo26.hn@gmail.com](mailto:nepo26.hn@gmail.com).
[//]: # ( If possible, encrypt your message with our PGP key )
[//]: # (TODO Create a public PGP key and make it available for anyone that needs it )
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to
ensure we received your original message.
Please include the requested information listed below (as much as you can provide) to help us better
understand the nature and scope of the possible issue:
* Type of issue (e.g. buffer overflow, etc.)
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
## Preferred Languages
We prefer all communications to be in English.
07070100000019000081A4000000000000000000000001668BBBD2000001D0000000000000000000000000000000000000001C00000000helm-docs-1.14.2/cliff.toml[changelog]
header = ""
body = """
{% if version %}\
{{ version | trim_start_matches(pat="v") }}\
{% else %}\
Unreleased\
{% endif %}\
{% for commit in commits %}
- {{ commit.author.timestamp | date }} {{ commit.message | split(pat="\n") | first }}\
{% endfor %}
"""
footer = ""
[git]
conventional_commits = false
commit_parsers = [
{ message = "^Pull request", skip = true }
]
filter_commits = false
tag_pattern = "[v0-9]*"
sort_commits = "newest"
0707010000001A000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001500000000helm-docs-1.14.2/cmd0707010000001B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001F00000000helm-docs-1.14.2/cmd/helm-docs0707010000001C000081A4000000000000000000000001668BBBD200000EFA000000000000000000000000000000000000002F00000000helm-docs-1.14.2/cmd/helm-docs/command_line.gopackage main
import (
"fmt"
"os"
"strings"
"github.com/norwoodj/helm-docs/pkg/document"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
var version string
func possibleLogLevels() []string {
levels := make([]string, 0)
for _, l := range log.AllLevels {
levels = append(levels, l.String())
}
return levels
}
func initializeCli() {
logLevelName := viper.GetString("log-level")
logLevel, err := log.ParseLevel(logLevelName)
if err != nil {
log.Errorf("Failed to parse provided log level %s: %s", logLevelName, err)
os.Exit(1)
}
log.SetFormatter(&log.TextFormatter{FullTimestamp: true})
log.SetLevel(logLevel)
}
func newHelmDocsCommand(run func(cmd *cobra.Command, args []string)) (*cobra.Command, error) {
command := &cobra.Command{
Use: "helm-docs",
Short: "helm-docs automatically generates markdown documentation for helm charts from requirements and values files",
Version: version,
Run: run,
}
logLevelUsage := fmt.Sprintf("Level of logs that should printed, one of (%s)", strings.Join(possibleLogLevels(), ", "))
command.PersistentFlags().StringP("chart-search-root", "c", ".", "directory to search recursively within for charts")
command.PersistentFlags().BoolP("dry-run", "d", false, "don't actually render any markdown files just print to stdout passed")
command.PersistentFlags().Bool("ignore-non-descriptions", false, "ignore values without a comment, this values will not be included in the README")
command.PersistentFlags().StringP("ignore-file", "i", ".helmdocsignore", "The filename to use as an ignore file to exclude chart directories")
command.PersistentFlags().StringP("log-level", "l", "info", logLevelUsage)
command.PersistentFlags().StringP("output-file", "o", "README.md", "markdown file path relative to each chart directory to which rendered documentation will be written")
command.PersistentFlags().StringP("sort-values-order", "s", document.AlphaNumSortOrder, fmt.Sprintf("order in which to sort the values table (\"%s\" or \"%s\")", document.AlphaNumSortOrder, document.FileSortOrder))
command.PersistentFlags().StringSliceP("template-files", "t", []string{"README.md.gotmpl"}, "gotemplate file paths relative to each chart directory from which documentation will be generated")
command.PersistentFlags().StringP("badge-style", "b", "flat-square", "badge style to use for charts")
command.PersistentFlags().StringP("values-file", "f", "values.yaml", "Path to values file")
command.PersistentFlags().BoolP("document-dependency-values", "u", false, "For charts with dependencies, include the dependency values in the chart values documentation")
command.PersistentFlags().StringSliceP("chart-to-generate", "g", []string{}, "List of charts that will have documentation generated. Comma separated, no space. Empty list - generate for all charts in chart-search-root")
command.PersistentFlags().BoolP("documentation-strict-mode", "x", false, "Fail the generation of docs if there are undocumented values")
command.PersistentFlags().StringSliceP("documentation-strict-ignore-absent", "y", []string{"service.type", "image.repository", "image.tag"}, "A comma separate values which are allowed not to be documented in strict mode")
command.PersistentFlags().StringSliceP("documentation-strict-ignore-absent-regex", "z", []string{".*service\\.type", ".*image\\.repository", ".*image\\.tag"}, "A comma separate values which are allowed not to be documented in strict mode")
command.PersistentFlags().Bool("skip-version-footer", false, "if true the helm-docs version footer will not be shown in the default README template")
viper.AutomaticEnv()
viper.SetEnvPrefix("HELM_DOCS")
viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
err := viper.BindPFlags(command.PersistentFlags())
return command, err
}
0707010000001D000081A4000000000000000000000001668BBBD20000198A000000000000000000000000000000000000002700000000helm-docs-1.14.2/cmd/helm-docs/main.gopackage main
import (
"fmt"
"os"
"path"
"path/filepath"
"reflect"
"regexp"
"runtime"
"strings"
"sync"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"github.com/norwoodj/helm-docs/pkg/document"
"github.com/norwoodj/helm-docs/pkg/helm"
)
// parallelProcessIterable runs the visitFn function on each element of the iterable, using
// parallelism number of worker goroutines. The iterable may be a slice or a map. In the case of a
// map, the argument passed to visitFn will be the key.
func parallelProcessIterable(iterable interface{}, parallelism int, visitFn func(elem interface{})) {
workChan := make(chan interface{})
wg := &sync.WaitGroup{}
wg.Add(parallelism)
for i := 0; i < parallelism; i++ {
go func() {
defer wg.Done()
for elem := range workChan {
visitFn(elem)
}
}()
}
iterableValue := reflect.ValueOf(iterable)
if iterableValue.Kind() == reflect.Map {
for _, key := range iterableValue.MapKeys() {
workChan <- key.Interface()
}
} else {
sliceLen := iterableValue.Len()
for i := 0; i < sliceLen; i++ {
workChan <- iterableValue.Index(i).Interface()
}
}
close(workChan)
wg.Wait()
}
func getDocumentationParsingConfigFromArgs() (helm.ChartValuesDocumentationParsingConfig, error) {
var regexps []*regexp.Regexp
regexpStrings := viper.GetStringSlice("documentation-strict-ignore-absent-regex")
for _, item := range regexpStrings {
regex, err := regexp.Compile(item)
if err != nil {
return helm.ChartValuesDocumentationParsingConfig{}, err
}
regexps = append(regexps, regex)
}
return helm.ChartValuesDocumentationParsingConfig{
StrictMode: viper.GetBool("documentation-strict-mode"),
AllowedMissingValuePaths: viper.GetStringSlice("documentation-strict-ignore-absent"),
AllowedMissingValueRegexps: regexps,
}, nil
}
func readDocumentationInfoByChartPath(chartSearchRoot string, parallelism int) (map[string]helm.ChartDocumentationInfo, error) {
var fullChartSearchRoot string
if path.IsAbs(chartSearchRoot) {
fullChartSearchRoot = chartSearchRoot
} else {
cwd, err := os.Getwd()
if err != nil {
return nil, fmt.Errorf("error getting working directory: %w", err)
}
fullChartSearchRoot = filepath.Join(cwd, chartSearchRoot)
}
chartDirs, err := helm.FindChartDirectories(fullChartSearchRoot)
if err != nil {
return nil, fmt.Errorf("error finding chart directories: %w", err)
}
log.Infof("Found Chart directories [%s]", strings.Join(chartDirs, ", "))
templateFiles := viper.GetStringSlice("template-files")
log.Debugf("Rendering from optional template files [%s]", strings.Join(templateFiles, ", "))
documentationInfoByChartPath := make(map[string]helm.ChartDocumentationInfo, len(chartDirs))
documentationInfoByChartPathMu := &sync.Mutex{}
documentationParsingConfig, err := getDocumentationParsingConfigFromArgs()
if err != nil {
return nil, fmt.Errorf("error parsing the linting config%w", err)
}
parallelProcessIterable(chartDirs, parallelism, func(elem interface{}) {
chartDir := elem.(string)
info, err := helm.ParseChartInformation(filepath.Join(chartSearchRoot, chartDir), documentationParsingConfig)
if err != nil {
log.Warnf("Error parsing information for chart %s, skipping: %s", chartDir, err)
return
}
documentationInfoByChartPathMu.Lock()
documentationInfoByChartPath[info.ChartDirectory] = info
documentationInfoByChartPathMu.Unlock()
})
return documentationInfoByChartPath, nil
}
func getChartToGenerate(documentationInfoByChartPath map[string]helm.ChartDocumentationInfo) map[string]helm.ChartDocumentationInfo {
generateDirectories := viper.GetStringSlice("chart-to-generate")
if len(generateDirectories) == 0 {
return documentationInfoByChartPath
}
documentationInfoToGenerate := make(map[string]helm.ChartDocumentationInfo, len(generateDirectories))
var skipped = false
for _, chartDirectory := range generateDirectories {
if info, ok := documentationInfoByChartPath[chartDirectory]; ok {
documentationInfoToGenerate[chartDirectory] = info
} else {
log.Warnf("Couldn't find documentation Info for <%s> - skipping", chartDirectory)
skipped = true
}
}
if skipped {
possibleCharts := []string{}
for path := range documentationInfoByChartPath {
possibleCharts = append(possibleCharts, path)
}
log.Warnf("Some charts listed in `chart-to-generate` wasn't found. List of charts to choose: [%s]", strings.Join(possibleCharts, ", "))
}
return documentationInfoToGenerate
}
func writeDocumentation(chartSearchRoot string, documentationInfoByChartPath map[string]helm.ChartDocumentationInfo, dryRun bool, parallelism int) {
templateFiles := viper.GetStringSlice("template-files")
badgeStyle := viper.GetString("badge-style")
skipVersionFooter := viper.GetBool("skip-version-footer")
log.Debugf("Rendering from optional template files [%s]", strings.Join(templateFiles, ", "))
documentDependencyValues := viper.GetBool("document-dependency-values")
documentationInfoToGenerate := getChartToGenerate(documentationInfoByChartPath)
parallelProcessIterable(documentationInfoToGenerate, parallelism, func(elem interface{}) {
info := documentationInfoByChartPath[elem.(string)]
var err error
var dependencyValues []document.DependencyValues
if documentDependencyValues {
dependencyValues, err = document.GetDependencyValues(info, documentationInfoByChartPath)
if err != nil {
log.Warnf("Error evaluating dependency values for chart %s, skipping: %v", info.ChartDirectory, err)
return
}
}
document.PrintDocumentation(info, chartSearchRoot, templateFiles, dryRun, version, badgeStyle, dependencyValues, skipVersionFooter)
})
}
func helmDocs(_ *cobra.Command, _ []string) {
initializeCli()
chartSearchRoot := viper.GetString("chart-search-root")
dryRun := viper.GetBool("dry-run")
parallelism := runtime.NumCPU() * 2
// On dry runs all output goes to stdout, and so as to not jumble things, generate serially.
if dryRun {
parallelism = 1
}
documentationInfoByChartPath, err := readDocumentationInfoByChartPath(chartSearchRoot, parallelism)
if err != nil {
log.Fatal(err)
}
writeDocumentation(chartSearchRoot, documentationInfoByChartPath, dryRun, parallelism)
}
func main() {
command, err := newHelmDocsCommand(helmDocs)
if err != nil {
log.Errorf("Failed to create the CLI commander: %s", err)
os.Exit(1)
}
if err := command.Execute(); err != nil {
log.Errorf("Failed to start the CLI: %s", err)
os.Exit(1)
}
}
0707010000001E000081A4000000000000000000000001668BBBD20000182A000000000000000000000000000000000000002C00000000helm-docs-1.14.2/cmd/helm-docs/main_test.gopackage main
import (
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"strings"
"testing"
"github.com/spf13/viper"
"github.com/norwoodj/helm-docs/pkg/document"
)
// BenchmarkHelmDocs benchmarks the entire helm-docs command by running on testdata.
//
// To run benchmarks, run the command:
//
// go test -run=^$ -bench=. ./cmd/helm-docs
func BenchmarkHelmDocs(b *testing.B) {
// Copy testdata to a new temporary directory, to keep the working directory clean.
tmp := copyToTempDir(b, os.DirFS(filepath.Join("testdata", "benchmark")))
// Bind commandline flags.
// NOTE: Flags must be specified even if they use the default value.
if err := viper.BindFlagValues(testFlagSet{
"chart-search-root": tmp,
"log-level": "warn",
"ignore-file": ".helmdocsignore",
"output-file": "README.md",
"sort-values-order": document.AlphaNumSortOrder,
"document-dependency-values": true,
}); err != nil {
b.Fatal(err)
}
// Benchmark the main function.
for n := 0; n < b.N; n++ {
helmDocs(nil, nil)
}
}
var _ viper.FlagValueSet = &testFlagSet{}
type testFlagSet map[string]interface{}
func (s testFlagSet) VisitAll(fn func(viper.FlagValue)) {
for k, v := range s {
flagVal := &testFlagValue{
name: k,
value: fmt.Sprintf("%v", v),
}
switch v.(type) {
case bool:
flagVal.typ = "bool"
default:
flagVal.typ = "string"
}
fn(flagVal)
}
}
var _ viper.FlagValue = &testFlagValue{}
type testFlagValue struct {
name string
value string
typ string
}
func (v *testFlagValue) HasChanged() bool {
return false
}
func (v *testFlagValue) Name() string {
return v.name
}
func (v *testFlagValue) ValueString() string {
return v.value
}
func (v *testFlagValue) ValueType() string {
return v.typ
}
// copyToTempDir copies the specified readonly filesystem into a new temporary directory and returns
// the path to the temporary directory. It fails the benchmark on any error and handles cleanup when
// the benchmark finishes.
// TODO make use of B.TempDir instead of implementing directly https://pkg.go.dev/testing#B.TempDir
func copyToTempDir(b *testing.B, fsys fs.FS) string {
// Create the temporary directory.
tmp, err := os.MkdirTemp("", "")
if err != nil {
b.Fatal(err)
}
// Register a cleanup function on the benchmark to clean up the temporary directory.
b.Cleanup(func() {
if err := os.RemoveAll(tmp); err != nil {
b.Fatal(err)
}
})
// Copy the filesystem to the temporary directory.
if err := fs.WalkDir(fsys, ".", func(path string, d fs.DirEntry, _ error) error {
// Get the path info (contains permissions, etc.)
info, err := d.Info()
if err != nil {
return err
}
// Calculate the target path in the temporary directory.
targetPath := filepath.Join(tmp, path)
// If the path is a directory, create it.
if d.IsDir() {
if err := os.MkdirAll(targetPath, info.Mode()); err != nil {
return err
}
return nil
}
// If the path is a file, open it for reading.
readFile, err := fsys.Open(path)
if err != nil {
return err
}
defer readFile.Close()
// Open a new file in the temporary directory for writing.
writeFile, err := os.OpenFile(targetPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, info.Mode())
if err != nil {
return err
}
defer writeFile.Close()
// Copy the file.
if _, err := io.Copy(writeFile, readFile); err != nil {
return err
}
return nil
}); err != nil {
b.Fatal(err)
}
return tmp
}
func TestSkipsVersionFooter(t *testing.T) {
// Ensure the skip-version-footer flag is true, meaning the README should not contain the footer.
if err := viper.BindFlagValues(testFlagSet{
"chart-search-root": filepath.Join("testdata", "skip-version-footer"),
"template-files": "README.md.gotmpl",
"values-file": "values.yaml",
"output-file": "README.md",
"ignore-file": ".helmdocsignore",
"log-level": "warn",
"sort-values-order": document.AlphaNumSortOrder,
"document-dependency-values": true,
"skip-version-footer": true,
}); err != nil {
t.Fatal(err)
}
// Clean up the generated README after testing.
readmePath := filepath.Join("testdata", "skip-version-footer", "README.md")
t.Cleanup(func() {
if err := os.Remove(readmePath); err != nil {
t.Fatal(err)
}
})
// Generate the README, setting the helm-docs version number.
version = "1.2.3"
helmDocs(nil, nil)
// Confirm the helm-docs version is not present.
docBytes, err := os.ReadFile(readmePath)
if err != nil {
t.Fatal(err)
}
doc := string(docBytes)
if strings.Contains(doc, "Autogenerated from chart metadata using [helm-docs v1.2.3]") {
t.Errorf("generated documentation should not contain the helm-docs version footer, got %s", doc)
}
}
func TestIncludesVersionFooter(t *testing.T) {
// Ensure the skip-version-footer flag is true, meaning the README must contain the footer.
if err := viper.BindFlagValues(testFlagSet{
"chart-search-root": filepath.Join("testdata", "skip-version-footer"),
"template-files": "README.md.gotmpl",
"values-file": "values.yaml",
"output-file": "README.md",
"ignore-file": ".helmdocsignore",
"log-level": "warn",
"sort-values-order": document.AlphaNumSortOrder,
"document-dependency-values": true,
"skip-version-footer": false,
}); err != nil {
t.Fatal(err)
}
// Clean up the generated README after testing.
readmePath := filepath.Join("testdata", "skip-version-footer", "README.md")
t.Cleanup(func() {
if err := os.Remove(readmePath); err != nil {
t.Fatal(err)
}
})
// Generate the README, setting the helm-docs version number.
version = "1.2.3"
helmDocs(nil, nil)
// Confirm the helm-docs version is present
docBytes, err := os.ReadFile(readmePath)
if err != nil {
t.Fatal(err)
}
doc := string(docBytes)
if !strings.Contains(doc, "Autogenerated from chart metadata using [helm-docs v1.2.3]") {
t.Errorf("generated documentation must contain the helm-docs version footer, got %s", doc)
}
}
0707010000001F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002800000000helm-docs-1.14.2/cmd/helm-docs/testdata07070100000020000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark07070100000021000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-0107070100000022000081A4000000000000000000000001668BBBD200000088000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/Chart.yamlapiVersion: v2
name: deep-01
version: 0.1.0
dependencies:
- name: level-3-a
version: 0.1.0
- name: level-3-b
version: 0.1.0
07070100000023000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004100000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts07070100000024000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a07070100000025000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
07070100000026000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts07070100000027000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a07070100000028000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
07070100000029000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts0707010000002A000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-a0707010000002B000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
0707010000002C000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000002D000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-b0707010000002E000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
0707010000002F000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000030000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000031000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b07070100000032000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
07070100000033000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts07070100000034000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-a07070100000035000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000036000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000037000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-b07070100000038000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000039000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000003A000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000003B000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000003C000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b0707010000003D000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
0707010000003E000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts0707010000003F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a07070100000040000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
07070100000041000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts07070100000042000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-a07070100000043000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000044000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000045000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-b07070100000046000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000047000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000048000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000049000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b0707010000004A000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
0707010000004B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts0707010000004C000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-a0707010000004D000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
0707010000004E000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000004F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-b07070100000050000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000051000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000052000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000053000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000054000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-01/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000055000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-0207070100000056000081A4000000000000000000000001668BBBD200000088000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/Chart.yamlapiVersion: v2
name: deep-02
version: 0.1.0
dependencies:
- name: level-3-a
version: 0.1.0
- name: level-3-b
version: 0.1.0
07070100000057000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004100000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts07070100000058000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a07070100000059000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
0707010000005A000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts0707010000005B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a0707010000005C000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
0707010000005D000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts0707010000005E000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-a0707010000005F000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000060000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000061000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-b07070100000062000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000063000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000064000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000065000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b07070100000066000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
07070100000067000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts07070100000068000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-a07070100000069000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
0707010000006A000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000006B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-b0707010000006C000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
0707010000006D000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000006E000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000006F000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000070000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b07070100000071000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
07070100000072000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts07070100000073000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a07070100000074000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
07070100000075000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts07070100000076000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-a07070100000077000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000078000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000079000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-b0707010000007A000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
0707010000007B000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000007C000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000007D000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b0707010000007E000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
0707010000007F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts07070100000080000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-a07070100000081000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000082000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000083000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-b07070100000084000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000085000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000086000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000087000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000088000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-02/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000089000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-030707010000008A000081A4000000000000000000000001668BBBD200000088000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/Chart.yamlapiVersion: v2
name: deep-03
version: 0.1.0
dependencies:
- name: level-3-a
version: 0.1.0
- name: level-3-b
version: 0.1.0
0707010000008B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004100000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts0707010000008C000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a0707010000008D000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
0707010000008E000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts0707010000008F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a07070100000090000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
07070100000091000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts07070100000092000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-a07070100000093000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000094000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000095000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-b07070100000096000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000097000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000098000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000099000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b0707010000009A000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
0707010000009B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts0707010000009C000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-a0707010000009D000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
0707010000009E000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
0707010000009F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-b070701000000A0000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000A1000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000A2000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000A3000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000A4000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b070701000000A5000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
070701000000A6000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts070701000000A7000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a070701000000A8000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
070701000000A9000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts070701000000AA000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-a070701000000AB000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000AC000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000AD000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-b070701000000AE000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000AF000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000B0000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000B1000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b070701000000B2000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
070701000000B3000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts070701000000B4000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-a070701000000B5000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000B6000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000B7000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-b070701000000B8000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000B9000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000BA000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000BB000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000BC000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-03/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000BD000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04070701000000BE000081A4000000000000000000000001668BBBD200000088000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/Chart.yamlapiVersion: v2
name: deep-04
version: 0.1.0
dependencies:
- name: level-3-a
version: 0.1.0
- name: level-3-b
version: 0.1.0
070701000000BF000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004100000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts070701000000C0000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a070701000000C1000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
070701000000C2000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts070701000000C3000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a070701000000C4000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
070701000000C5000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts070701000000C6000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-a070701000000C7000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000C8000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000C9000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-b070701000000CA000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000CB000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000CC000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000CD000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b070701000000CE000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
070701000000CF000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts070701000000D0000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-a070701000000D1000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000D2000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000D3000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-b070701000000D4000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000D5000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000D6000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000D7000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000D8000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004B00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b070701000000D9000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000005600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
- name: level-2-a
version: 0.1.0
- name: level-2-b
version: 0.1.0
070701000000DA000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005200000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts070701000000DB000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a070701000000DC000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
070701000000DD000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts070701000000DE000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-a070701000000DF000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000E0000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E1000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-b070701000000E2000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000E3000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E4000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E5000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000005C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b070701000000E6000081A4000000000000000000000001668BBBD20000008A000000000000000000000000000000000000006700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
- name: level-1-a
version: 0.1.0
- name: level-1-b
version: 0.1.0
070701000000E7000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006300000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts070701000000E8000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-a070701000000E9000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000EA000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000EB000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000006D00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-b070701000000EC000081A4000000000000000000000001668BBBD20000002E000000000000000000000000000000000000007800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000ED000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000007900000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000EE000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000006800000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000EF000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000005700000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000F0000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/deep-04/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000F1000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-01070701000000F2000081A4000000000000000000000001668BBBD20000002C000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-01/Chart.yamlapiVersion: v2
name: flat-01
version: 0.1.0
070701000000F3000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-01/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000F4000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-02070701000000F5000081A4000000000000000000000001668BBBD20000002C000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-02/Chart.yamlapiVersion: v2
name: flat-02
version: 0.1.0
070701000000F6000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-02/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000F7000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-03070701000000F8000081A4000000000000000000000001668BBBD20000002C000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-03/Chart.yamlapiVersion: v2
name: flat-03
version: 0.1.0
070701000000F9000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-03/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000FA000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-04070701000000FB000081A4000000000000000000000001668BBBD20000002C000000000000000000000000000000000000004500000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-04/Chart.yamlapiVersion: v2
name: flat-04
version: 0.1.0
070701000000FC000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004600000000helm-docs-1.14.2/cmd/helm-docs/testdata/benchmark/flat-04/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
070701000000FD000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003C00000000helm-docs-1.14.2/cmd/helm-docs/testdata/skip-version-footer070701000000FE000081A4000000000000000000000001668BBBD200000072000000000000000000000000000000000000004700000000helm-docs-1.14.2/cmd/helm-docs/testdata/skip-version-footer/Chart.yamlapiVersion: v2
name: skip-version-footer
description: unit test for skipping the version footer
version: "0.1.0"
070701000000FF000081A4000000000000000000000001668BBBD200000069000000000000000000000000000000000000004800000000helm-docs-1.14.2/cmd/helm-docs/testdata/skip-version-footer/values.yamlconfig:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
07070100000100000081A4000000000000000000000001668BBBD2000015CC000000000000000000000000000000000000002400000000helm-docs-1.14.2/code-of-conduct.md
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[norwood.john.m@gmail.com](mailto:norwood.john.m@gmail.com) or
[nepo26.hn@gmail.com](mailto:nepo26.hn@gmail.com).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
07070100000101000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002000000000helm-docs-1.14.2/example-charts07070100000102000081A4000000000000000000000001668BBBD2000000C7000000000000000000000000000000000000003200000000helm-docs-1.14.2/example-charts/_templates.gotmpl{{ define "extra.flower" -}}
```
,-.
, ,-. ,-.
/ \ ( )-( )
\ | ,.>-( )-<
\|,' ( )-( )
Y ___`-' `-'
|/__/ `-'
|
|
| -hi-
__|_____________
```
{{- end }}07070100000103000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003400000000helm-docs-1.14.2/example-charts/best-values-example07070100000104000081A4000000000000000000000001668BBBD2000001CD000000000000000000000000000000000000003F00000000helm-docs-1.14.2/example-charts/best-values-example/Chart.yamlapiVersion: v2
name: best-values-example
description: One of the best values parsing example charts here, exhibits several more complicated examples
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"]
engine: gotpl
type: application
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
07070100000105000081A4000000000000000000000001668BBBD20000078C000000000000000000000000000000000000003E00000000helm-docs-1.14.2/example-charts/best-values-example/README.md# best-values-example
 
One of the best values parsing example charts here, exhibits several more complicated examples
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresq"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"11"` | |
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000106000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000004000000000helm-docs-1.14.2/example-charts/best-values-example/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000107000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003000000000helm-docs-1.14.2/example-charts/custom-template07070100000108000081A4000000000000000000000001668BBBD2000001B9000000000000000000000000000000000000003B00000000helm-docs-1.14.2/example-charts/custom-template/Chart.yamlapiVersion: v1
name: custom-template
description: Basically the same as the nginx-ingress chart, but using a custom template to include some other content
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/custom-template"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/custom-template"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
07070100000109000081A4000000000000000000000001668BBBD200000A6E000000000000000000000000000000000000003A00000000helm-docs-1.14.2/example-charts/custom-template/README.md# custom-template
Basically the same as the nginx-ingress chart, but using a custom template to include some other content
## Additional Information
```
,-.
, ,-. ,-.
/ \ ( )-( )
\ | ,.>-( )-<
\|,' ( )-( )
Y ___`-' `-'
|/__/ `-'
|
|
| -hi-
__|_____________
```
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/custom-template
```
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
| controller.extraVolumes[0].name | string | `"config-volume"` | |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000010A000081A4000000000000000000000001668BBBD200000408000000000000000000000000000000000000004100000000helm-docs-1.14.2/example-charts/custom-template/README.md.gotmpl{{ template "chart.header" . }}
{{ template "chart.description" . }}
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
## Additional Information
{{ template "extra.flower" . }}
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/{{ template "chart.name" . }}
```
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
0707010000010B000081A4000000000000000000000001668BBBD200000056000000000000000000000000000000000000004200000000helm-docs-1.14.2/example-charts/custom-template/requirements.yamldependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
0707010000010C000081A4000000000000000000000001668BBBD200000403000000000000000000000000000000000000003C00000000helm-docs-1.14.2/example-charts/custom-template/values.yamlcontroller:
name: controller
image:
repository: nginx-ingress-controller
tag: "18.0831"
# -- List of persistent volume claims to create.
# For very long comments, break them into multiple lines.
# @default -- the chart will construct this list internally unless specified
persistentVolumeClaims: []
extraVolumes:
- name: config-volume
configMap:
# -- Uses the name of the configmap created by this chart
name: nginx-ingress-config
# -- Name of the ingress class to route through this controller
ingressClass: nginx
# -- The labels to be applied to instances of the controller pod
podLabels: {}
publishService:
# -- Whether to expose the ingress controller to the public world
enabled: false
# -- (int) Number of nginx-ingress pods to load balance between
replicas:
service:
annotations:
# -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
type: LoadBalancer
0707010000010D000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003B00000000helm-docs-1.14.2/example-charts/custom-value-notation-type0707010000010E000081A4000000000000000000000001668BBBD200000299000000000000000000000000000000000000004600000000helm-docs-1.14.2/example-charts/custom-value-notation-type/Chart.yamlapiVersion: v2
name: django
version: 0.2.1
appVersion: 3.1
description: Generic chart for basic Django-based web app
keywords:
- Django
- Web
home: https://www.djangoproject.com/
sources:
- https://github.com/django/django
maintainers:
- name: Rizky Maulana Nugraha
email: lana.pcfre@gmail.com
icon: https://raw.githubusercontent.com/kartoza/charts/master/assets/logo/django.png
engine: gotpl
dependencies:
- name: postgis
version: 0.2.1
repository: "file://../../postgis/v0.2.1"
condition: postgis.enabled
tags:
- database-backend
- postgis
- name: common
version: 1.0.0
repository: "file://../../common/v1.0.0"
0707010000010F000081A4000000000000000000000001668BBBD2000066F5000000000000000000000000000000000000004500000000helm-docs-1.14.2/example-charts/custom-value-notation-type/README.md# django
 
Generic chart for basic Django-based web app
**Homepage:** <https://www.djangoproject.com/>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| Rizky Maulana Nugraha | <lana.pcfre@gmail.com> | |
## Source Code
* <https://github.com/django/django>
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| file://../../common/v1.0.0 | common | 1.0.0 |
| file://../../postgis/v0.2.1 | postgis | 0.2.1 |
# Some Long Description
This is a sample README with custom overrides.
Check the template in [README.md.gotmpl](README.md.gotmpl).
In that file, we redefine the template definition of `chart.valueDefaultColumnRender`
for some custom `@notationType` such as `string/email`.
This chart README uses `chart.valuesSectionHtml` instead of `chart.valuesSection`.
Using HTML table directly instead of using Markdown table allows us to control the table
presentation, such as the height. This is especially useful for very long `values.yaml` file,
and you need to scroll both horizontally and vertically to navigate the values.
In the template file, we redefine `chart.valuesTableHtml` so that we use table height of
400px at most. Github can understand that attribute. The more sophisticated use case is if you
want to combine helm-docs with a Jamstack static generator where you can have your own page generated
from this README.
The customization can goes even further. Normally, you can't define anchor in markdown unless it is a heading. But you can do so easily using HTML tags.
You can override the column key renderer by adding an `id` attribute so that it can be referred.
This way, when you write markdown links like [ingress.tls.secretName](#ingress--tls--secretName), clicking the link
will take you to the value description row.
## Value Types
One of the benefit of using HTML table is we can make a simple tooltip and anchor.
For example, the value [global.adminEmail](#global--adminEmail) is annotated as type `string/email`. We create
the definition of the value type here and can be anchored by links with `#stringemail` hyperlinks.
We can also create custom type column renderer, where we can assign a tooltip for each type.
Try this out. Go navigate to [global.adminEmail](#global--adminEmail) value, hover on the value type `string/email`, you will then see
some tooltip. Clicking the type link will direct you back to it's relevant value type section below.
Other useful case is If the type is a known type, like
Kubernetes service type, you can anchor the type to redirect user to k8s documentation page to learn more.
Check the value [persistence.staticDir.accessModes](#persistence--staticDir--accessModes)
### string/email
This value type is for a valid email address format. Such as owner@somedomain.org.
## Notation Type
Another reason to use HTML table is because in some cases we want to custom-render the default value.
In helm chart templates, sometimes author designs the template to accept a go template string value.
That means, the template string can be processed by helm chart and be replaced with dynamic computed values, before it was
rendered to the chart. Although it is very useful and flexible to make the default value be dynamic,
it is not entirely obvious for the chart users to see a go template as value in a `values.yml`.
It would then be helpful to custom-render these default values in the helm README, so that it is not
treated as a pure JSON object (because the syntax highlighter would be incorrect).
Instead we can custom render the presentation so it would make sense to the user.
In our example here, any key with a type `tpl/xxx` would be rendered as `<pre></pre>`
HTML tag, in which we both put the key name and the YAML multiline modifier `|` to make
it really clear that the key accept a multiline string as value, because it would be rendered as
YAML object by helm after the values are interpolated/substituted.
Take a look at [extraPodEnv](#extraPodEnv). The `Default` column shows the key name `extraPodEnv`, the multiline YAML
modifier `|`, and the template string which contains some go string template syntax `{{ }}`.
You can also control the HTML styling directly. In some markdown viewer, the HTML tag and inline styles
are respected, so the custom styles can be seen. Combined with a Jamstack approach, you can
design your template to also incorporate some custom React styles or simple CSS.
In our example here, [global.adminEmail](#global--adminEmail) is annotated with `email` notationType.
This allows you to insert custom rendering code for email. For supported markdown viewer, like Visual Studio Code,
the default value will have `green` color, and if clicked will direct you to your default email composer.
The reason we have two separate annotation, value type and notation type, is because several different types
can have the same type renderer. For example, any type `tpl/xxx` is a go template string, so it will be rendered the same
in our docs if we annotate it with `@notationType -- tpl`.
## Customized Rendering
This README also shows some possible customization with helm-docs. In the [README.md.gotmpl](README.md.gotmpl)
file, you can see that we modified the column `Key` to also be hyperlinked with the definition in `values.yaml`.
If you view this README.md files in GitHub and click the value's key, you will be directed to the
key location in the `values.yaml` file.
You can also render a raw string into the comments using `@raw` annotations.
You can jump to [sampleYaml](#sampleYaml) key and check it's description where it
uses HTML `<summary>` tag to collapse some part of the comments.
## Values
<table height="400px" >
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
<tr>
<td id="extraConfigMap"><a href="./values.yaml#L111">extraConfigMap</a></td>
<td>
tpl/dict
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
extraConfigMap: |
</pre>
</div>
</td>
<td>Define this for extra config map to be included in django-shared-config</td>
</tr>
<tr>
<td id="extraPodEnv"><a href="./values.yaml#L88">extraPodEnv</a></td>
<td>
tpl/array
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
extraPodEnv: |
- name: DJANGO_SETTINGS_MODULE
value: "django.settings"
- name: DEBUG
value: {{ .Values.global.debug | quote }}
- name: ROOT_URLCONF
value: {{ .Values.global.rootURLConf | quote }}
- name: MAIN_APP_NAME
value: {{ .Values.global.mainAppName | quote }}
</pre>
</div>
</td>
<td>Define this for extra Django environment variables</td>
</tr>
<tr>
<td id="extraPodSpec"><a href="./values.yaml#L100">extraPodSpec</a></td>
<td>
tpl/object
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
extraPodSpec: |
</pre>
</div>
</td>
<td>This will be evaluated as pod spec</td>
</tr>
<tr>
<td id="extraSecret"><a href="./values.yaml#L106">extraSecret</a></td>
<td>
tpl/dict
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
extraSecret: |
</pre>
</div>
</td>
<td>Define this for extra secrets to be included in django-shared-secret secret</td>
</tr>
<tr>
<td id="extraVolume"><a href="./values.yaml#L125">extraVolume</a></td>
<td>
tpl/array
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
extraVolume: |
</pre>
</div>
</td>
<td>Define this for extra volume (in pair with extraVolumeMounts)</td>
</tr>
<tr>
<td id="extraVolumeMounts"><a href="./values.yaml#L116">extraVolumeMounts</a></td>
<td>
tpl/array
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
extraVolumeMounts: |
</pre>
</div>
</td>
<td>Define this for extra volume mounts in the pod</td>
</tr>
<tr>
<td id="global"><a href="./values.yaml#L14">global</a></td>
<td>
object
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{
"adminEmail": "admin@localhost",
"adminPassword": {
"value": null,
"valueFrom": {
"secretKeyRef": {
"key": "admin-password",
"name": null
}
}
},
"adminUser": "admin",
"databaseHost": "postgis",
"databaseName": "django",
"databasePassword": {
"value": null,
"valueFrom": {
"secretKeyRef": {
"key": "database-password",
"name": null
}
}
},
"databasePort": 5432,
"databaseUsername": "django_db_user",
"debug": "False",
"djangoArgs": "[\"uwsgi\",\"--chdir=${REPO_ROOT}\",\"--module=${MAIN_APP_NAME}.wsgi\",\"--socket=:8000\",\"--http=0.0.0.0:8080\",\"--processes=5\",\"--buffer-size=8192\"]\n",
"djangoCommand": "[\"/opt/django/scripts/docker-entrypoint.sh\"]\n",
"djangoSecretKey": {
"value": null,
"valueFrom": {
"secretKeyRef": {
"key": "django-secret",
"name": null
}
}
},
"djangoSettingsModule": "django.settings",
"existingSecret": "",
"mainAppName": "django",
"mediaRoot": "/opt/django/media",
"nameOverride": "django",
"rootURLConf": "django.urls",
"sharedSecretName": "django-shared-secret",
"siteName": "django",
"staticRoot": "/opt/django/static"
}
</pre>
</div>
</td>
<td>This key name is used for service interconnection between subcharts and parent charts.</td>
</tr>
<tr>
<td id="global--adminEmail"><a href="./values.yaml#L43">global.adminEmail</a></td>
<td>
<a href="#stringemail" title="
This value type is for a valid email address format. Such as owner@somedomain.org.">string/email</a>
</td>
<td>
<div style="max-width: 300px;">
<a href="mailto:admin@localhost" style="color: green;">"admin@localhost"</a>
</div>
</td>
<td>Default admin email sender</td>
</tr>
<tr>
<td id="global--adminPassword--value"><a href="./values.yaml#L36">global.adminPassword.value</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
</td>
<td>Specify this password value. If not, it will be autogenerated everytime chart upgraded</td>
</tr>
<tr>
<td id="global--adminUser"><a href="./values.yaml#L33">global.adminUser</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"admin"
</pre>
</div>
</td>
<td>Default super user admin username</td>
</tr>
<tr>
<td id="global--databaseHost"><a href="./values.yaml#L63">global.databaseHost</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"postgis"
</pre>
</div>
</td>
<td>Django database host location. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend, you must provide the value</td>
</tr>
<tr>
<td id="global--databaseName"><a href="./values.yaml#L61">global.databaseName</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django"
</pre>
</div>
</td>
<td>Django database name</td>
</tr>
<tr>
<td id="global--databasePassword--value"><a href="./values.yaml#L55">global.databasePassword.value</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
</td>
<td>Specify this password value. If not, it will be autogenerated everytime chart upgraded. If you use external backend, you must provide the value</td>
</tr>
<tr>
<td id="global--databasePort"><a href="./values.yaml#L65">global.databasePort</a></td>
<td>
int
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
5432
</pre>
</div>
</td>
<td>Django database port. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend, you must provide the value</td>
</tr>
<tr>
<td id="global--databaseUsername"><a href="./values.yaml#L52">global.databaseUsername</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django_db_user"
</pre>
</div>
</td>
<td>Database username backend to connect to. If you use external backend, provide the value</td>
</tr>
<tr>
<td id="global--debug"><a href="./values.yaml#L67">global.debug</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"False"
</pre>
</div>
</td>
<td>Python boolean literal, this will correspond to `DEBUG` environment variable inside the Django container. Useful as a debug switch.</td>
</tr>
<tr>
<td id="global--djangoArgs"><a href="./values.yaml#L30">global.djangoArgs</a></td>
<td>
tpl/array
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
global.djangoArgs: |
["uwsgi","--chdir=${REPO_ROOT}","--module=${MAIN_APP_NAME}.wsgi","--socket=:8000","--http=0.0.0.0:8080","--processes=5","--buffer-size=8192"]
</pre>
</div>
</td>
<td>The django command args to be passed to entrypoint command</td>
</tr>
<tr>
<td id="global--djangoCommand"><a href="./values.yaml#L26">global.djangoCommand</a></td>
<td>
tpl/array
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
global.djangoCommand: |
["/opt/django/scripts/docker-entrypoint.sh"]
</pre>
</div>
</td>
<td>The django entrypoint command to execute</td>
</tr>
<tr>
<td id="global--djangoSecretKey--value"><a href="./values.yaml#L46">global.djangoSecretKey.value</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
</td>
<td>Specify this Django Secret string value. If not, it will be autogenerated everytime chart upgraded</td>
</tr>
<tr>
<td id="global--djangoSettingsModule"><a href="./values.yaml#L71">global.djangoSettingsModule</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django.settings"
</pre>
</div>
</td>
<td>Django settings module to be used</td>
</tr>
<tr>
<td id="global--existingSecret"><a href="./values.yaml#L18">global.existingSecret</a></td>
<td>
tpl/string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
global.existingSecret: |
</pre>
</div>
</td>
<td>Name of existing secret</td>
</tr>
<tr>
<td id="global--mainAppName"><a href="./values.yaml#L69">global.mainAppName</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django"
</pre>
</div>
</td>
<td>The main app name to execute. Affects which settings, wsgi, and rootURL to use.</td>
</tr>
<tr>
<td id="global--mediaRoot"><a href="./values.yaml#L77">global.mediaRoot</a></td>
<td>
path
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/media"
</pre>
</div>
</td>
<td>Location to the media directory</td>
</tr>
<tr>
<td id="global--rootURLConf"><a href="./values.yaml#L73">global.rootURLConf</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django.urls"
</pre>
</div>
</td>
<td>Django root URL conf to be used</td>
</tr>
<tr>
<td id="global--sharedSecretName"><a href="./values.yaml#L20">global.sharedSecretName</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django-shared-secret"
</pre>
</div>
</td>
<td>Name of shared secret store that will be generated</td>
</tr>
<tr>
<td id="global--siteName"><a href="./values.yaml#L23">global.siteName</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django"
</pre>
</div>
</td>
<td>The site name. It will be used to construct url such as http://django/</td>
</tr>
<tr>
<td id="global--staticRoot"><a href="./values.yaml#L75">global.staticRoot</a></td>
<td>
path
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/static"
</pre>
</div>
</td>
<td>Location to the static directory</td>
</tr>
<tr>
<td id="image"><a href="./values.yaml#L2">image</a></td>
<td>
object
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{
"pullPolicy": "IfNotPresent",
"registry": "docker.io",
"repository": "lucernae/django-sample",
"tag": "3.1"
}
</pre>
</div>
</td>
<td>Image map</td>
</tr>
<tr>
<td id="image--pullPolicy"><a href="./values.yaml#L10">image.pullPolicy</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"IfNotPresent"
</pre>
</div>
</td>
<td>Image pullPolicy</td>
</tr>
<tr>
<td id="image--registry"><a href="./values.yaml#L4">image.registry</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"docker.io"
</pre>
</div>
</td>
<td>Image registry</td>
</tr>
<tr>
<td id="image--repository"><a href="./values.yaml#L6">image.repository</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"lucernae/django-sample"
</pre>
</div>
</td>
<td>Image repository</td>
</tr>
<tr>
<td id="image--tag"><a href="./values.yaml#L8">image.tag</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"3.1"
</pre>
</div>
</td>
<td>Image tag</td>
</tr>
<tr>
<td id="ingress--annotations"><a href="./values.yaml#L155">ingress.annotations</a></td>
<td>
dict
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
</td>
<td>Custom Ingress annotations</td>
</tr>
<tr>
<td id="ingress--enabled"><a href="./values.yaml#L150">ingress.enabled</a></td>
<td>
bool
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
</td>
<td>Set to true to generate Ingress resource</td>
</tr>
<tr>
<td id="ingress--host"><a href="./values.yaml#L153">ingress.host</a></td>
<td>
tpl/string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
ingress.host: |
</pre>
</div>
</td>
<td>Set custom host name. (DNS name convention)</td>
</tr>
<tr>
<td id="ingress--labels"><a href="./values.yaml#L157">ingress.labels</a></td>
<td>
dict
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
</td>
<td>Custom Ingress labels</td>
</tr>
<tr>
<td id="ingress--tls--enabled"><a href="./values.yaml#L160">ingress.tls.enabled</a></td>
<td>
bool
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
</td>
<td>Set to true to enable HTTPS</td>
</tr>
<tr>
<td id="ingress--tls--secretName"><a href="./values.yaml#L162">ingress.tls.secretName</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"django-tls"
</pre>
</div>
</td>
<td>You must provide a secret name where the TLS cert is stored</td>
</tr>
<tr>
<td id="labels"><a href="./values.yaml#L81">labels</a></td>
<td>
map
</td>
<td>
<div style="max-width: 300px;">
<pre lang="yaml">
user/workload: "true"
client-name: "my-boss"
project-name: "awesome-project"
</pre>
</div>
</td>
<td>The deployment label</td>
</tr>
<tr>
<td id="persistence--mediaDir--accessModes[0]"><a href="./values.yaml#L199">persistence.mediaDir.accessModes[0]</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"ReadWriteOnce"
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--mediaDir--annotations"><a href="./values.yaml#L200">persistence.mediaDir.annotations</a></td>
<td>
object
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--mediaDir--enabled"><a href="./values.yaml#L193">persistence.mediaDir.enabled</a></td>
<td>
bool
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
true
</pre>
</div>
</td>
<td>Allow persistence</td>
</tr>
<tr>
<td id="persistence--mediaDir--existingClaim"><a href="./values.yaml#L194">persistence.mediaDir.existingClaim</a></td>
<td>
bool
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--mediaDir--mountPath"><a href="./values.yaml#L195">persistence.mediaDir.mountPath</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/media"
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--mediaDir--size"><a href="./values.yaml#L197">persistence.mediaDir.size</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"8Gi"
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--mediaDir--subPath"><a href="./values.yaml#L196">persistence.mediaDir.subPath</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"media"
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--staticDir--accessModes"><a href="./values.yaml#L188">persistence.staticDir.accessModes</a></td>
<td>
<a target="_blank"
href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes"
>k8s/storage/persistent-volume/access-modes</a>
</td>
<td>
<div style="max-width: 300px;">
<pre lang="yaml">
- ReadWriteOnce
</pre>
</div>
</td>
<td>Static Dir access modes</td>
</tr>
<tr>
<td id="persistence--staticDir--annotations"><a href="./values.yaml#L190">persistence.staticDir.annotations</a></td>
<td>
object
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--staticDir--enabled"><a href="./values.yaml#L181">persistence.staticDir.enabled</a></td>
<td>
bool
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
true
</pre>
</div>
</td>
<td>Allow persistence</td>
</tr>
<tr>
<td id="persistence--staticDir--existingClaim"><a href="./values.yaml#L182">persistence.staticDir.existingClaim</a></td>
<td>
bool
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--staticDir--mountPath"><a href="./values.yaml#L183">persistence.staticDir.mountPath</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/static"
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--staticDir--size"><a href="./values.yaml#L185">persistence.staticDir.size</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"8Gi"
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="persistence--staticDir--subPath"><a href="./values.yaml#L184">persistence.staticDir.subPath</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"static"
</pre>
</div>
</td>
<td></td>
</tr>
<tr>
<td id="postgis--enabled"><a href="./values.yaml#L170">postgis.enabled</a></td>
<td>
bool
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
true
</pre>
</div>
</td>
<td>Enable postgis as database backend by default. Set to false if using different external backend.</td>
</tr>
<tr>
<td id="postgis--existingSecret"><a href="./values.yaml#L174">postgis.existingSecret</a></td>
<td>
tpl/string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
postgis.existingSecret: |
{{ include "common.sharedSecretName" . | quote -}}
</pre>
</div>
</td>
<td>Existing secret to be used</td>
</tr>
<tr>
<td id="probe"><a href="./values.yaml#L166">probe</a></td>
<td>
tpl/object
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
probe: |
</pre>
</div>
</td>
<td>Probe can be overridden</td>
</tr>
<tr>
<td id="sampleYaml"><a href="./values.yaml#L227">sampleYaml</a></td>
<td>
dict
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
</td>
<td>Values with long description
Sometimes you need a very long description
for your values.
Any comment section for a given key with **@raw** attribute
will be treated as raw string and stored as is.
Since it generates in Markdown format, you can do something like this:
```yaml
hello:
bar: true
```
Markdown also accept subset of HTML tags. So you can also do this:
<details>
<summary>+Expand</summary>
```bash
execute some command
```
</details></td>
</tr>
<tr>
<td id="service--annotations"><a href="./values.yaml#L146">service.annotations</a></td>
<td>
dict
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
</td>
<td>Extra service annotations</td>
</tr>
<tr>
<td id="service--clusterIP"><a href="./values.yaml#L135">service.clusterIP</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
""
</pre>
</div>
</td>
<td>Specify `None` for headless service. Otherwise, leave them be.</td>
</tr>
<tr>
<td id="service--externalIPs"><a href="./values.yaml#L138">service.externalIPs</a></td>
<td>
tpl/array
</td>
<td>
<div style="max-width: 300px;">
<pre lang="tpl">
service.externalIPs: |
</pre>
</div>
</td>
<td>Specify for LoadBalancer service type</td>
</tr>
<tr>
<td id="service--nodePort"><a href="./values.yaml#L143">service.nodePort</a></td>
<td>
int
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
</td>
<td>Specify node port, for NodePort service type</td>
</tr>
<tr>
<td id="service--port"><a href="./values.yaml#L140">service.port</a></td>
<td>
int
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
80
</pre>
</div>
</td>
<td>Specify service port</td>
</tr>
<tr>
<td id="service--type"><a href="./values.yaml#L133">service.type</a></td>
<td>
string
</td>
<td>
<div style="max-width: 300px;">
<pre lang="json">
"ClusterIP"
</pre>
</div>
</td>
<td>Define k8s service for Django.</td>
</tr>
</tbody>
</table>
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000110000081A4000000000000000000000001668BBBD200001D18000000000000000000000000000000000000004C00000000helm-docs-1.14.2/example-charts/custom-value-notation-type/README.md.gotmpl{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
{{ template "chart.requirementsSection" . }}
# Some Long Description
This is a sample README with custom overrides.
Check the template in [README.md.gotmpl](README.md.gotmpl).
In that file, we redefine the template definition of `chart.valueDefaultColumnRender`
for some custom `@notationType` such as `string/email`.
This chart README uses `chart.valuesSectionHtml` instead of `chart.valuesSection`.
Using HTML table directly instead of using Markdown table allows us to control the table
presentation, such as the height. This is especially useful for very long `values.yaml` file,
and you need to scroll both horizontally and vertically to navigate the values.
In the template file, we redefine `chart.valuesTableHtml` so that we use table height of
400px at most. Github can understand that attribute. The more sophisticated use case is if you
want to combine helm-docs with a Jamstack static generator where you can have your own page generated
from this README.
The customization can goes even further. Normally, you can't define anchor in markdown unless it is a heading. But you can do so easily using HTML tags.
You can override the column key renderer by adding an `id` attribute so that it can be referred.
This way, when you write markdown links like [ingress.tls.secretName](#ingress--tls--secretName), clicking the link
will take you to the value description row.
## Value Types
One of the benefit of using HTML table is we can make a simple tooltip and anchor.
For example, the value [global.adminEmail](#global--adminEmail) is annotated as type `string/email`. We create
the definition of the value type here and can be anchored by links with `#stringemail` hyperlinks.
We can also create custom type column renderer, where we can assign a tooltip for each type.
Try this out. Go navigate to [global.adminEmail](#global--adminEmail) value, hover on the value type `string/email`, you will then see
some tooltip. Clicking the type link will direct you back to it's relevant value type section below.
Other useful case is If the type is a known type, like
Kubernetes service type, you can anchor the type to redirect user to k8s documentation page to learn more.
Check the value [persistence.staticDir.accessModes](#persistence--staticDir--accessModes)
### string/email
{{- define "chart.valuetypes.email" }}
This value type is for a valid email address format. Such as owner@somedomain.org.
{{- end }}
{{ template "chart.valuetypes.email" . }}
## Notation Type
Another reason to use HTML table is because in some cases we want to custom-render the default value.
In helm chart templates, sometimes author designs the template to accept a go template string value.
That means, the template string can be processed by helm chart and be replaced with dynamic computed values, before it was
rendered to the chart. Although it is very useful and flexible to make the default value be dynamic,
it is not entirely obvious for the chart users to see a go template as value in a `values.yml`.
It would then be helpful to custom-render these default values in the helm README, so that it is not
treated as a pure JSON object (because the syntax highlighter would be incorrect).
Instead we can custom render the presentation so it would make sense to the user.
In our example here, any key with a type `tpl/xxx` would be rendered as `<pre></pre>`
HTML tag, in which we both put the key name and the YAML multiline modifier `|` to make
it really clear that the key accept a multiline string as value, because it would be rendered as
YAML object by helm after the values are interpolated/substituted.
Take a look at [extraPodEnv](#extraPodEnv). The `Default` column shows the key name `extraPodEnv`, the multiline YAML
modifier `|`, and the template string which contains some go string template syntax `{{"{{ }}"}}`.
You can also control the HTML styling directly. In some markdown viewer, the HTML tag and inline styles
are respected, so the custom styles can be seen. Combined with a Jamstack approach, you can
design your template to also incorporate some custom React styles or simple CSS.
In our example here, [global.adminEmail](#global--adminEmail) is annotated with `email` notationType.
This allows you to insert custom rendering code for email. For supported markdown viewer, like Visual Studio Code,
the default value will have `green` color, and if clicked will direct you to your default email composer.
The reason we have two separate annotation, value type and notation type, is because several different types
can have the same type renderer. For example, any type `tpl/xxx` is a go template string, so it will be rendered the same
in our docs if we annotate it with `@notationType -- tpl`.
## Customized Rendering
This README also shows some possible customization with helm-docs. In the [README.md.gotmpl](README.md.gotmpl)
file, you can see that we modified the column `Key` to also be hyperlinked with the definition in `values.yaml`.
If you view this README.md files in GitHub and click the value's key, you will be directed to the
key location in the `values.yaml` file.
You can also render a raw string into the comments using `@raw` annotations.
You can jump to [sampleYaml](#sampleYaml) key and check it's description where it
uses HTML `<summary>` tag to collapse some part of the comments.
{{ define "chart.valueDefaultColumnRender" }}
{{- $defaultValue := (default .Default .AutoDefault) -}}
{{- $notationType := .NotationType }}
{{- if (and (hasPrefix "`" $defaultValue) (hasSuffix "`" $defaultValue) ) -}}
{{- $defaultValue = (toPrettyJson (fromJson (trimAll "`" (default .Default .AutoDefault) ) ) ) -}}
{{- $notationType = "json" }}
{{- end -}}
{{- if (eq $notationType "tpl" ) }}
<pre lang="{{ $notationType }}">
{{ .Key }}: |
{{- $defaultValue | nindent 2 }}
</pre>
{{- else if (eq $notationType "email") }}
<a href="mailto:{{ $defaultValue }}" style="color: green;">"{{ $defaultValue }}"</a>
{{- else }}
<pre lang="{{ $notationType }}">
{{ $defaultValue }}
</pre>
{{- end }}
{{ end }}
{{ define "chart.typeColumnRender" }}
{{- if (eq .Type "string/email") }}
<a href="#stringemail" title="{{- template "chart.valuetypes.email" -}}">{{.Type}}</a>
{{- else if (eq .Type "k8s/storage/persistent-volume/access-modes" )}}
<a target="_blank"
href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes"
>{{- .Type }}</a>
{{- else }}
{{ .Type }}
{{- end }}
{{ end }}
{{ define "chart.valuesTableHtml" }}
<table height="400px" >
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
{{- range .Values }}
<tr>
<td id="{{ .Key | replace "." "--" }}"><a href="./values.yaml#L{{ .LineNumber }}">{{ .Key }}</a></td>
<td>{{- template "chart.typeColumnRender" . -}}</td>
<td>
<div style="max-width: 300px;">{{ template "chart.valueDefaultColumnRender" . }}</div>
</td>
<td>{{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}</td>
</tr>
{{- end }}
</tbody>
</table>
{{ end }}
{{ template "chart.valuesSectionHtml" . }}
{{ template "helm-docs.versionFooter" . }}
07070100000111000081A4000000000000000000000001668BBBD200001B5E000000000000000000000000000000000000004700000000helm-docs-1.14.2/example-charts/custom-value-notation-type/values.yaml# -- Image map
image:
# -- Image registry
registry: docker.io
# -- Image repository
repository: lucernae/django-sample
# -- Image tag
tag: "3.1"
# -- Image pullPolicy
pullPolicy: IfNotPresent
# -- This key name is used for service interconnection between subcharts and parent charts.
global:
nameOverride: django
# -- (tpl/string) Name of existing secret
# @notationType -- tpl
existingSecret: |
# -- (string) Name of shared secret store that will be generated
sharedSecretName: django-shared-secret
# generic values
# -- (string) The site name. It will be used to construct url such as http://django/
siteName: django
# -- (tpl/array) The django entrypoint command to execute
# @notationType -- tpl
djangoCommand: |
["/opt/django/scripts/docker-entrypoint.sh"]
# -- (tpl/array) The django command args to be passed to entrypoint command
# @notationType -- tpl
djangoArgs: |
["uwsgi","--chdir=${REPO_ROOT}","--module=${MAIN_APP_NAME}.wsgi","--socket=:8000","--http=0.0.0.0:8080","--processes=5","--buffer-size=8192"]
# -- (string) Default super user admin username
adminUser: admin
adminPassword:
# -- (string) Specify this password value. If not, it will be autogenerated everytime chart upgraded
value:
valueFrom:
secretKeyRef:
name:
key: admin-password
# -- (string/email) Default admin email sender
# @notationType -- email
adminEmail: admin@localhost
djangoSecretKey:
# -- (string) Specify this Django Secret string value. If not, it will be autogenerated everytime chart upgraded
value:
valueFrom:
secretKeyRef:
name:
key: django-secret
# -- (string) Database username backend to connect to. If you use external backend, provide the value
databaseUsername: django_db_user
databasePassword:
# -- (string) Specify this password value. If not, it will be autogenerated everytime chart upgraded. If you use external backend, you must provide the value
value:
valueFrom:
secretKeyRef:
name:
key: database-password
# -- (string) Django database name
databaseName: django
# -- (string) Django database host location. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend, you must provide the value
databaseHost: postgis
# -- (int) Django database port. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend, you must provide the value
databasePort: 5432
# -- (string) Python boolean literal, this will correspond to `DEBUG` environment variable inside the Django container. Useful as a debug switch.
debug: "False"
# -- (string) The main app name to execute. Affects which settings, wsgi, and rootURL to use.
mainAppName: django
# -- (string) Django settings module to be used
djangoSettingsModule: django.settings
# -- (string) Django root URL conf to be used
rootURLConf: django.urls
# -- (path) Location to the static directory
staticRoot: /opt/django/static
# -- (path) Location to the media directory
mediaRoot: /opt/django/media
# -- (map) The deployment label
# @notationType -- yaml
labels:
user/workload: "true"
client-name: "my-boss"
project-name: "awesome-project"
# -- (tpl/array) Define this for extra Django environment variables
# @notationType -- tpl
extraPodEnv: |
- name: DJANGO_SETTINGS_MODULE
value: "django.settings"
- name: DEBUG
value: {{ .Values.global.debug | quote }}
- name: ROOT_URLCONF
value: {{ .Values.global.rootURLConf | quote }}
- name: MAIN_APP_NAME
value: {{ .Values.global.mainAppName | quote }}
# -- (tpl/object) This will be evaluated as pod spec
# @notationType -- tpl
extraPodSpec: |
# nodeSelector:
# a.label: value
# -- (tpl/dict) Define this for extra secrets to be included in django-shared-secret secret
# @notationType -- tpl
extraSecret: |
# key_1: value_1
# -- (tpl/dict) Define this for extra config map to be included in django-shared-config
# @notationType -- tpl
extraConfigMap: |
# file_1: conf content
# -- (tpl/array) Define this for extra volume mounts in the pod
# @notationType -- tpl
extraVolumeMounts: |
# You may potentially mount a config map/secret
# - name: custom-config
# mountPath: /docker-entrypoint.sh
# subPath: docker-entrypoint.sh
# readOnly: true
# -- (tpl/array) Define this for extra volume (in pair with extraVolumeMounts)
# @notationType -- tpl
extraVolume: |
# You may potentially mount a config map/secret
# - name: custom-config
# configMap:
# name: geonode-config
service:
# -- (string) Define k8s service for Django.
type: ClusterIP
# -- (string) Specify `None` for headless service. Otherwise, leave them be.
clusterIP: ""
# -- (tpl/array) Specify for LoadBalancer service type
# @notationType -- tpl
externalIPs: |
# -- (int) Specify service port
port: 80
# -- (int) Specify node port, for NodePort service type
nodePort:
# -- (dict) Extra service annotations
annotations: {}
ingress:
# -- (bool) Set to true to generate Ingress resource
enabled: false
# -- (tpl/string) Set custom host name. (DNS name convention)
# @notationType -- tpl
host: |
# -- (dict) Custom Ingress annotations
annotations: {}
# -- (dict) Custom Ingress labels
labels: {}
tls:
# -- (bool) Set to true to enable HTTPS
enabled: false
# -- (string) You must provide a secret name where the TLS cert is stored
secretName: django-tls
# -- (tpl/object) Probe can be overridden
# @notationType -- tpl
probe: |
postgis:
# -- (bool) Enable postgis as database backend by default. Set to false if using different external backend.
enabled: true
# -- (tpl/string) Existing secret to be used
# @notationType -- tpl
existingSecret: |
{{ include "common.sharedSecretName" . | quote -}}
persistence:
staticDir:
# -- (bool) Allow persistence
enabled: true
existingClaim: false
mountPath: /opt/django/static
subPath: "static"
size: 8Gi
# -- (k8s/storage/persistent-volume/access-modes) Static Dir access modes
# @notationType -- yaml
accessModes:
- ReadWriteOnce
annotations: {}
mediaDir:
# -- (bool) Allow persistence
enabled: true
existingClaim: false
mountPath: /opt/django/media
subPath: "media"
size: 8Gi
accessModes:
- ReadWriteOnce
annotations: {}
# -- (dict) Values with long description
# @raw
# Sometimes you need a very long description
# for your values.
#
# Any comment section for a given key with **@raw** attribute
# will be treated as raw string and stored as is.
# Since it generates in Markdown format, you can do something like this:
#
# ```yaml
# hello:
# bar: true
# ```
#
# Markdown also accept subset of HTML tags. So you can also do this:
#
# <details>
# <summary>+Expand</summary>
#
# ```bash
# execute some command
# ```
#
# </details>
sampleYaml: {}07070100000112000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003100000000helm-docs-1.14.2/example-charts/dos-line-endings07070100000113000081A4000000000000000000000001668BBBD200000174000000000000000000000000000000000000003D00000000helm-docs-1.14.2/example-charts/dos-line-endings/.helmignore# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
07070100000114000081A4000000000000000000000001668BBBD200000495000000000000000000000000000000000000003C00000000helm-docs-1.14.2/example-charts/dos-line-endings/Chart.yamlapiVersion: v2
name: dos-line-endings
description: A chart whose values file has dos line endings rather than unix ones
# A chart can be either an 'application' or a 'library' chart.
#
# Application charts are a collection of templates that can be packaged into versioned archives
# to be deployed.
#
# Library charts provide useful utilities or functions for the chart developer. They're included as
# a dependency of application charts to inject those utilities and functions into the rendering
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: 1.16.0
07070100000115000081A4000000000000000000000001668BBBD200000406000000000000000000000000000000000000003B00000000helm-docs-1.14.2/example-charts/dos-line-endings/README.md# dos-line-endings
  
A chart whose values file has dos line endings rather than unix ones
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world sdf |
| controller.replicas | int | `2` | Number of nginx-ingress pods to load balance between sdf. Do not set this below 2. |
| livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| livenessProbe.httpGet.port | string | `"http"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000116000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003B00000000helm-docs-1.14.2/example-charts/dos-line-endings/templates07070100000117000081A4000000000000000000000001668BBBD2000000F2000000000000000000000000000000000000004400000000helm-docs-1.14.2/example-charts/dos-line-endings/templates/tls.yaml{{- if .Values.createTLS.enabled }}
apiVersion: v1
kind: Secret
type: kubernetes.io/tls
metadata:
name: {{ .Release.Name }}-tls
data:
tls.crt: {{ .Values.createTLS.tls.cert }}
tls.key: {{ .Values.createTLS.tls.key }}
{{- end }}07070100000118000081A4000000000000000000000001668BBBD2000001DF000000000000000000000000000000000000003D00000000helm-docs-1.14.2/example-charts/dos-line-endings/values.yaml# Default values for helmdoc-test.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
livenessProbe:
httpGet:
# -- This is the liveness check endpoint
path: /healthz
port: http
controller:
publishService:
# -- Whether to expose the ingress controller to the public world sdf
enabled: false
# -- Number of nginx-ingress pods to load balance between sdf.
# Do not set this below 2.
replicas: 2
07070100000119000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002D00000000helm-docs-1.14.2/example-charts/files-values0707010000011A000081A4000000000000000000000001668BBBD2000001CD000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/files-values/Chart.yamlapiVersion: v2
name: best-values-example
description: One of the best values parsing example charts here, exhibits several more complicated examples
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"]
engine: gotpl
type: application
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
0707010000011B000081A4000000000000000000000001668BBBD200000B73000000000000000000000000000000000000003700000000helm-docs-1.14.2/example-charts/files-values/README.md# best-values-example
One of the best values parsing example charts here, exhibits several more complicated examples
 
## Additional Information
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/best-values-example
```
Some file contents:
```
some:
data: "test"
```
Glob contents as config map:
```
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
resource1.yaml: |-
some:
resource: "blah"
resource2.yaml: |-
some:
resource: "blah2"
dataSecret:
resource1.yaml: c29tZToKICByZXNvdXJjZTogImJsYWgi
resource2.yaml: c29tZToKICByZXNvdXJjZTogImJsYWgyIg==
```
File: example-charts/files-values/Chart.yaml
File: example-charts/files-values/somefile.yaml
File: example-charts/files-values/templates/resource1.yaml
File: example-charts/files-values/templates/resource2.yaml
File: example-charts/files-values/values.yaml
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresq"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"11"` | |
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000011C000081A4000000000000000000000001668BBBD200000563000000000000000000000000000000000000003E00000000helm-docs-1.14.2/example-charts/files-values/README.md.gotmpl{{ template "chart.header" . }}
{{ template "chart.description" . }}
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
## Additional Information
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/{{ template "chart.name" . }}
```
Some file contents:
```
{{ .Files.Get "somefile.yaml" }}
```
Glob contents as config map:
```
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
{{ (.Files.Glob "templates/**.yaml").AsConfig | indent 2 }}
dataSecret:
{{ (.Files.Glob "templates/**.yaml").AsSecrets | indent 2 }}
```
{{ range $path, $_ := (.Files.Glob "**.yaml").AsMap -}}
File: {{$path}}
{{ end }}
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
0707010000011D000081A4000000000000000000000001668BBBD200000014000000000000000000000000000000000000003B00000000helm-docs-1.14.2/example-charts/files-values/somefile.yamlsome:
data: "test"0707010000011E000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003700000000helm-docs-1.14.2/example-charts/files-values/templates0707010000011F000081A4000000000000000000000001668BBBD200000018000000000000000000000000000000000000004600000000helm-docs-1.14.2/example-charts/files-values/templates/resource1.yamlsome:
resource: "blah"07070100000120000081A4000000000000000000000001668BBBD200000019000000000000000000000000000000000000004600000000helm-docs-1.14.2/example-charts/files-values/templates/resource2.yamlsome:
resource: "blah2"07070100000121000081A4000000000000000000000001668BBBD200000369000000000000000000000000000000000000003900000000helm-docs-1.14.2/example-charts/files-values/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
07070100000122000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002E00000000helm-docs-1.14.2/example-charts/full-template07070100000123000081A4000000000000000000000001668BBBD200000218000000000000000000000000000000000000003900000000helm-docs-1.14.2/example-charts/full-template/Chart.yamlapiVersion: v2
name: full-template
deprecated: true
version: "1.0.0"
type: application
appVersion: "13.0.0"
description: A chart for showing every README-element
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"]
kubeVersion: "<=1.18"
engine: gotpl
dependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
07070100000124000081A4000000000000000000000001668BBBD2000014C5000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/full-template/README.md# full-template
## `extra.flower`
```
,-.
, ,-. ,-.
/ \ ( )-( )
\ | ,.>-( )-<
\|,' ( )-( )
Y ___`-' `-'
|/__/ `-'
|
|
| -hi-
__|_____________
```
## `chart.deprecationWarning`
> **:exclamation: This Helm Chart is deprecated!**
## `chart.name`
full-template
## `chart.description`
A chart for showing every README-element
## `chart.version`
1.0.0
## `chart.versionBadge`
## `chart.type`
application
## `chart.typeBadge`
## `chart.appVersion`
13.0.0
## `chart.appVersionBadge`
## `chart.badgesSection`
  
## `chart.homepage`
https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template
## `chart.homepageLine`
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
## `chart.maintainersHeader`
## Maintainers
## `chart.maintainersTable`
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## `chart.maintainersSection`
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## `chart.sourcesHeader`
## Source Code
## `chart.sourcesList`
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
## `chart.sourcesSection`
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
## `chart.kubeVersion`
<=1.18
## `chart.kubeVersionLine`
Kubernetes: `<=1.18`
## `chart.requirementsHeader`
## Requirements
## `chart.requirementsTable`
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## `chart.requirementsSection`
## Requirements
Kubernetes: `<=1.18`
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## `chart.valuesHeader`
## Values
## `chart.valuesTable`
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
| controller.extraVolumes[0].name | string | `"config-volume"` | |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
## `chart.valuesSection`
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
| controller.extraVolumes[0].name | string | `"config-volume"` | |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000125000081A4000000000000000000000001668BBBD200000720000000000000000000000000000000000000003F00000000helm-docs-1.14.2/example-charts/full-template/README.md.gotmpl{{ template "chart.header" . }}
## `extra.flower`
{{ template "extra.flower" . }}
## `chart.deprecationWarning`
{{ template "chart.deprecationWarning" . }}
## `chart.name`
{{ template "chart.name" . }}
## `chart.description`
{{ template "chart.description" . }}
## `chart.version`
{{ template "chart.version" . }}
## `chart.versionBadge`
{{ template "chart.versionBadge" . }}
## `chart.type`
{{ template "chart.type" . }}
## `chart.typeBadge`
{{ template "chart.typeBadge" . }}
## `chart.appVersion`
{{ template "chart.appVersion" . }}
## `chart.appVersionBadge`
{{ template "chart.appVersionBadge" . }}
## `chart.badgesSection`
{{ template "chart.badgesSection" . }}
## `chart.homepage`
{{ template "chart.homepage" . }}
## `chart.homepageLine`
{{ template "chart.homepageLine" . }}
## `chart.maintainersHeader`
{{ template "chart.maintainersHeader" . }}
## `chart.maintainersTable`
{{ template "chart.maintainersTable" . }}
## `chart.maintainersSection`
{{ template "chart.maintainersSection" . }}
## `chart.sourcesHeader`
{{ template "chart.sourcesHeader" . }}
## `chart.sourcesList`
{{ template "chart.sourcesList" . }}
## `chart.sourcesSection`
{{ template "chart.sourcesSection" . }}
## `chart.kubeVersion`
{{ template "chart.kubeVersion" . }}
## `chart.kubeVersionLine`
{{ template "chart.kubeVersionLine" . }}
## `chart.requirementsHeader`
{{ template "chart.requirementsHeader" . }}
## `chart.requirementsTable`
{{ template "chart.requirementsTable" . }}
## `chart.requirementsSection`
{{ template "chart.requirementsSection" . }}
## `chart.valuesHeader`
{{ template "chart.valuesHeader" . }}
## `chart.valuesTable`
{{ template "chart.valuesTable" . }}
## `chart.valuesSection`
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
07070100000126000081A4000000000000000000000001668BBBD2000004FD000000000000000000000000000000000000003A00000000helm-docs-1.14.2/example-charts/full-template/values.yamlcontroller:
name: controller
image:
repository: nginx-ingress-controller
tag: "18.0831"
# controller.persistentVolumeClaims -- List of persistent volume claims to create.
# For very long comments, break them into multiple lines.
# @default -- the chart will construct this list internally unless specified
persistentVolumeClaims: []
extraVolumes:
- name: config-volume
configMap:
# controller.extraVolumes[0].configMap.name -- Uses the name of the configmap created by this chart
name: nginx-ingress-config
# controller.ingressClass -- Name of the ingress class to route through this controller
ingressClass: nginx
# controller.podLabels -- The labels to be applied to instances of the controller pod
podLabels: {}
publishService:
# controller.publishService.enabled -- Whether to expose the ingress controller to the public world
enabled: false
# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
replicas:
service:
annotations:
# controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
type: LoadBalancer
07070100000127000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003100000000helm-docs-1.14.2/example-charts/fully-documented07070100000128000081A4000000000000000000000001668BBBD20000020C000000000000000000000000000000000000003C00000000helm-docs-1.14.2/example-charts/fully-documented/Chart.yamlapiVersion: v2
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
type: application
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
dependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
07070100000129000081A4000000000000000000000001668BBBD2000005E6000000000000000000000000000000000000003B00000000helm-docs-1.14.2/example-charts/fully-documented/README.md# nginx-ingress
 
A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller | object | `{"image":{"repository":"nginx-ingress-controller","tag":"18.0831"},"name":"controller"}` | The controller |
| controller.image | object | `{"repository":"nginx-ingress-controller","tag":"18.0831"}` | The image of the controller |
| controller.image.repository | string | `"nginx-ingress-controller"` | The repository of the controller |
| controller.image.tag | string | `"18.0831"` | The tag of the image of the controller |
| controller.name | string | `"controller"` | The name of the controller |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000012A000081A4000000000000000000000001668BBBD200000174000000000000000000000000000000000000003D00000000helm-docs-1.14.2/example-charts/fully-documented/values.yaml# controller -- The controller
controller:
# controller.name -- The name of the controller
name: controller
# controller.image -- The image of the controller
image:
# controller.image.repository -- The repository of the controller
repository: nginx-ingress-controller
# controller.image.tag -- The tag of the image of the controller
tag: "18.0831"
0707010000012B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002E00000000helm-docs-1.14.2/example-charts/funky-version0707010000012C000081A4000000000000000000000001668BBBD20000017D000000000000000000000000000000000000003900000000helm-docs-1.14.2/example-charts/funky-version/Chart.yamlapiVersion: v2
name: funky-version
description: A very simple chart with a funky version
version: "0.1.0-alpha-rc2"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
0707010000012D000081A4000000000000000000000001668BBBD200000288000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/funky-version/README.md# funky-version
A very simple chart with a funky version
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000012E000081A4000000000000000000000001668BBBD200000000000000000000000000000000000000000000003A00000000helm-docs-1.14.2/example-charts/funky-version/values.yaml0707010000012F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002700000000helm-docs-1.14.2/example-charts/helm-307070100000130000081A4000000000000000000000001668BBBD20000020C000000000000000000000000000000000000003200000000helm-docs-1.14.2/example-charts/helm-3/Chart.yamlapiVersion: v2
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
type: application
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
dependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
07070100000131000081A4000000000000000000000001668BBBD200000920000000000000000000000000000000000000003100000000helm-docs-1.14.2/example-charts/helm-3/README.md# nginx-ingress
 
A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes | list | `[{"configMap":{"name":"nginx-ingress-config"},"name":"config-volume"}]` | Additional volumes to be mounted into the ingress controller container |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.livenessProbe | object | `{"httpGet":{"path":"/healthz","port":8080}}` | Configure the healthcheck for the ingress controller |
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | `[]` | List of persistent volume claims to create |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000132000081A4000000000000000000000001668BBBD20000055A000000000000000000000000000000000000003300000000helm-docs-1.14.2/example-charts/helm-3/values.yamlcontroller:
name: controller
image:
repository: nginx-ingress-controller
tag: "18.0831"
# controller.persistentVolumeClaims -- List of persistent volume claims to create
persistentVolumeClaims: []
# controller.extraVolumes -- Additional volumes to be mounted into the ingress controller container
extraVolumes:
- name: config-volume
configMap:
name: nginx-ingress-config
# controller.livenessProbe -- Configure the healthcheck for the ingress controller
livenessProbe:
httpGet:
# controller.livenessProbe.httpGet.path -- This is the liveness check endpoint
path: /healthz
port: 8080
# controller.ingressClass -- Name of the ingress class to route through this controller
ingressClass: nginx
# controller.podLabels -- The labels to be applied to instances of the controller pod
podLabels: {}
publishService:
# controller.publishService.enabled -- Whether to expose the ingress controller to the public world
enabled: false
# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
replicas:
service:
annotations:
# controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
type: LoadBalancer
07070100000133000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002C00000000helm-docs-1.14.2/example-charts/ignored-one07070100000134000081A4000000000000000000000001668BBBD2000001A0000000000000000000000000000000000000003700000000helm-docs-1.14.2/example-charts/ignored-one/Chart.yamlapiVersion: v1
name: ignored-one
description: A demonstration of the ability of a .helmdocsignore file to ignore files by Chart.yaml file
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-one"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-one"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
07070100000135000081A4000000000000000000000001668BBBD200000003000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/ignored-one/values.yaml{}
07070100000136000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003700000000helm-docs-1.14.2/example-charts/ignored-values-example07070100000137000081A4000000000000000000000001668BBBD200000192000000000000000000000000000000000000004200000000helm-docs-1.14.2/example-charts/ignored-values-example/Chart.yamlapiVersion: v2
name: ignored-values-example
description: Based on best-values-example
version: "0.1.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example"]
engine: gotpl
type: application
maintainers:
- email: jakub.buczak@gmail.com
name: Jakub Buczak
07070100000138000081A4000000000000000000000001668BBBD200000783000000000000000000000000000000000000004100000000helm-docs-1.14.2/example-charts/ignored-values-example/README.md# ignored-values-example
 
Based on best-values-example
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| Jakub Buczak | <jakub.buczak@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| configWithAllValuesIgnored | object | `{}` | |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresq"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"11"` | |
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000139000081A4000000000000000000000001668BBBD200000486000000000000000000000000000000000000004300000000helm-docs-1.14.2/example-charts/ignored-values-example/values.yamlstatefulset:
image:
# -- Image to use for deploying, must support an entrypoint
# which creates users/databases from appropriate config files
repository: jnorwood/postgresq
tag: "11"
# -- Additional volumes to be mounted into the database container
extraVolumes:
- name: data
emptyDir: {}
# -- Configure the healthcheck for the database
livenessProbe:
enabled: false
# -- The labels to be applied to instances of the database
podLabels: {}
config:
databasesToCreate:
# -- default database for storage of database metadata
- postgresql
# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
- hashbash
usersToCreate:
# -- admin user
- {name: root, admin: true}
# -- user with access to the database with the same name
- {name: hashbash, readwriteDatabases: [hashbash]}
# @ignore test
- {name: test, readDatabases: [test]}
# @ignore
internalConfig:
rpcPort: 8080
# -- this should also be ignored
generateData: true
# @ignore
ignoredConfig: 6
configWithAllValuesIgnored:
# @ignore
ignoredOne: true
# @ignore
ignoredTwo: "?"
0707010000013A000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002D00000000helm-docs-1.14.2/example-charts/ignored-zero0707010000013B000081A4000000000000000000000001668BBBD2000001A3000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/ignored-zero/Chart.yamlapiVersion: v1
name: ignored-zero
description: A demonstration of the ability of a .helmdocsignore file to ignore charts by directory name
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-zero"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-zero"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
0707010000013C000081A4000000000000000000000001668BBBD200000003000000000000000000000000000000000000003900000000helm-docs-1.14.2/example-charts/ignored-zero/values.yaml{}
0707010000013D000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002B00000000helm-docs-1.14.2/example-charts/most-empty0707010000013E000081A4000000000000000000000001668BBBD200000087000000000000000000000000000000000000003600000000helm-docs-1.14.2/example-charts/most-empty/Chart.yamlapiVersion: v1
name: most-empty
version: "0.2.0"
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
0707010000013F000081A4000000000000000000000001668BBBD200000280000000000000000000000000000000000000003500000000helm-docs-1.14.2/example-charts/most-empty/README.md# most-empty
This is a good example of all the fields that don't appear when they aren't set in chart metadata. `description`,
`requirements`, and `values` are all empty and don't appear here.
There is a flower though:
```
,-.
, ,-. ,-.
/ \ ( )-( )
\ | ,.>-( )-<
\|,' ( )-( )
Y ___`-' `-'
|/__/ `-'
|
|
| -hi-
__|_____________
```
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000140000081A4000000000000000000000001668BBBD20000022B000000000000000000000000000000000000003C00000000helm-docs-1.14.2/example-charts/most-empty/README.md.gotmpl{{ template "chart.header" . }}
{{ template "chart.description" . }}
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
This is a good example of all the fields that don't appear when they aren't set in chart metadata. `description`,
`requirements`, and `values` are all empty and don't appear here.
There is a flower though:
{{ template "extra.flower" . }}
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
07070100000141000081A4000000000000000000000001668BBBD200000000000000000000000000000000000000000000003700000000helm-docs-1.14.2/example-charts/most-empty/values.yaml07070100000142000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002E00000000helm-docs-1.14.2/example-charts/nginx-ingress07070100000143000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004000000000helm-docs-1.14.2/example-charts/nginx-ingress-but-auto-comments07070100000144000081A4000000000000000000000001668BBBD2000001A4000000000000000000000000000000000000004B00000000helm-docs-1.14.2/example-charts/nginx-ingress-but-auto-comments/Chart.yamlapiVersion: v1
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
07070100000145000081A4000000000000000000000001668BBBD200000930000000000000000000000000000000000000004A00000000helm-docs-1.14.2/example-charts/nginx-ingress-but-auto-comments/README.md# nginx-ingress
A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes | list | `[{"configMap":{"name":"nginx-ingress-config"},"name":"config-volume"}]` | Additional volumes to be mounted into the ingress controller container |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.livenessProbe | object | `{"httpGet":{"path":"/healthz","port":8080}}` | Configure the healthcheck for the ingress controller |
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | `[]` | List of persistent volume claims to create |
| controller.podLabels | object | A number of chart-specific labels | The labels to be applied to instances of the controller pod. By default, a number of labels will automatically be applied |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between. Do not set this below 2 |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000146000081A4000000000000000000000001668BBBD200000056000000000000000000000000000000000000005200000000helm-docs-1.14.2/example-charts/nginx-ingress-but-auto-comments/requirements.yamldependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
07070100000147000081A4000000000000000000000001668BBBD2000004C4000000000000000000000000000000000000004C00000000helm-docs-1.14.2/example-charts/nginx-ingress-but-auto-comments/values.yamlcontroller:
name: controller
image:
repository: nginx-ingress-controller
tag: "18.0831"
# -- List of persistent volume claims to create
persistentVolumeClaims: []
# -- Additional volumes to be mounted into the ingress controller container
extraVolumes:
- name: config-volume
configMap:
name: nginx-ingress-config
# -- Configure the healthcheck for the ingress controller
livenessProbe:
httpGet:
# -- This is the liveness check endpoint
path: /healthz
port: 8080
# -- Name of the ingress class to route through this controller
ingressClass: nginx
# -- The labels to be applied to instances of the controller pod.
# By default, a number of labels will automatically be applied
# @default -- A number of chart-specific labels
podLabels: {}
publishService:
# -- Whether to expose the ingress controller to the public world
enabled: false
# -- (int) Number of nginx-ingress pods to load balance between.
# Do not set this below 2
replicas:
service:
annotations:
# -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
type: LoadBalancer
07070100000148000081A4000000000000000000000001668BBBD2000001A4000000000000000000000000000000000000003900000000helm-docs-1.14.2/example-charts/nginx-ingress/Chart.yamlapiVersion: v1
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
07070100000149000081A4000000000000000000000001668BBBD2000008BC000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/nginx-ingress/README.md# nginx-ingress
A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes | list | `[{"configMap":{"name":"nginx-ingress-config"},"name":"config-volume"}]` | Additional volumes to be mounted into the ingress controller container |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.livenessProbe | object | `{"httpGet":{"path":"/healthz","port":8080}}` | Configure the healthcheck for the ingress controller |
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | `[]` | List of persistent volume claims to create |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000014A000081A4000000000000000000000001668BBBD200000056000000000000000000000000000000000000004000000000helm-docs-1.14.2/example-charts/nginx-ingress/requirements.yamldependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
0707010000014B000081A4000000000000000000000001668BBBD20000055A000000000000000000000000000000000000003A00000000helm-docs-1.14.2/example-charts/nginx-ingress/values.yamlcontroller:
name: controller
image:
repository: nginx-ingress-controller
tag: "18.0831"
# controller.persistentVolumeClaims -- List of persistent volume claims to create
persistentVolumeClaims: []
# controller.extraVolumes -- Additional volumes to be mounted into the ingress controller container
extraVolumes:
- name: config-volume
configMap:
name: nginx-ingress-config
# controller.livenessProbe -- Configure the healthcheck for the ingress controller
livenessProbe:
httpGet:
# controller.livenessProbe.httpGet.path -- This is the liveness check endpoint
path: /healthz
port: 8080
# controller.ingressClass -- Name of the ingress class to route through this controller
ingressClass: nginx
# controller.podLabels -- The labels to be applied to instances of the controller pod
podLabels: {}
publishService:
# controller.publishService.enabled -- Whether to expose the ingress controller to the public world
enabled: false
# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
replicas:
service:
annotations:
# controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
type: LoadBalancer
0707010000014C000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003000000000helm-docs-1.14.2/example-charts/no-requirements0707010000014D000081A4000000000000000000000001668BBBD2000001A2000000000000000000000000000000000000003B00000000helm-docs-1.14.2/example-charts/no-requirements/Chart.yamlapiVersion: v1
name: no-requirements
description: A simple chart that installs, let's say PrometheusRules, that needs no sub-charts
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
0707010000014E000081A4000000000000000000000001668BBBD20000052B000000000000000000000000000000000000003A00000000helm-docs-1.14.2/example-charts/no-requirements/README.md# no-requirements
A simple chart that installs, let's say PrometheusRules, that needs no sub-charts
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| rules.latency.percentiles.99.duration | string | `"5m"` | Duration for which the 99th percentile must be above the threshold to alert |
| rules.latency.percentiles.99.threshold | float | `1.5` | Threshold in seconds for our 99th percentile latency above which the alert will fire |
| rules.statusCodes.codes.5xx.duration | string | `"5m"` | Duration for which the percent of 5xx responses must be above the threshold to alert |
| rules.statusCodes.codes.5xx.threshold | float | `1.5` | Threshold percentage of 5xx responses above which the alert will fire |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000014F000081A4000000000000000000000001668BBBD2000002B5000000000000000000000000000000000000003C00000000helm-docs-1.14.2/example-charts/no-requirements/values.yamlrules:
latency:
percentiles:
"99":
# rules.latency.percentiles.99.threshold -- Threshold in seconds for our 99th percentile latency above which the alert will fire
threshold: 1.5
# rules.latency.percentiles.99.duration -- Duration for which the 99th percentile must be above the threshold to alert
duration: 5m
statusCodes:
codes:
5xx:
# rules.statusCodes.codes.5xx.threshold -- Threshold percentage of 5xx responses above which the alert will fire
threshold: 1.5
# rules.statusCodes.codes.5xx.duration -- Duration for which the percent of 5xx responses must be above the threshold to alert
duration: 5m
07070100000150000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002A00000000helm-docs-1.14.2/example-charts/no-values07070100000151000081A4000000000000000000000001668BBBD200000186000000000000000000000000000000000000003500000000helm-docs-1.14.2/example-charts/no-values/Chart.yamlapiVersion: v1
name: no-values
description: A very simple chart that doesn't even need any values for customization
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
07070100000152000081A4000000000000000000000001668BBBD200000285000000000000000000000000000000000000003400000000helm-docs-1.14.2/example-charts/no-values/README.md# no-values
A very simple chart that doesn't even need any values for customization
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000153000081A4000000000000000000000001668BBBD200000000000000000000000000000000000000000000003600000000helm-docs-1.14.2/example-charts/no-values/values.yaml07070100000154000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002900000000helm-docs-1.14.2/example-charts/sections07070100000155000081A4000000000000000000000001668BBBD20000018E000000000000000000000000000000000000003400000000helm-docs-1.14.2/example-charts/sections/Chart.yamlapiVersion: v2
name: sections
version: "1.0.0"
type: application
appVersion: "13.0.0"
description: A chart for showing how to use sections
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/sections"
maintainers:
- email: rohdeconstantin@gmail.com
name: Constantin Rohde
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/sections"]
engine: gotpl07070100000156000081A4000000000000000000000001668BBBD200000FDF000000000000000000000000000000000000003300000000helm-docs-1.14.2/example-charts/sections/README.md# Sections
This creates values, but sectioned into own section tables if a section comment is provided.
## Values
### Some Section
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
### Special Attention
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.ingressClass | string | `"nginx"` | You can also specify value comments like this |
| controller.publishService | object | `{"enabled":false}` | This is a publishService |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
### Other Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].name | string | `"config-volume"` | |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.name | string | `"controller"` | |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
## Values
<h3>Some Section</h3>
<table>
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
<tr>
<td>controller.extraVolumes[0].configMap.name</td>
<td>string</td>
<td><pre lang="json">
"nginx-ingress-config"
</pre>
</td>
<td>Uses the name of the configmap created by this chart</td>
</tr>
<tr>
<td>controller.persistentVolumeClaims</td>
<td>list</td>
<td><pre lang="">
the chart will construct this list internally unless specified
</pre>
</td>
<td>List of persistent volume claims to create.</td>
</tr>
<tr>
<td>controller.podLabels</td>
<td>object</td>
<td><pre lang="json">
{}
</pre>
</td>
<td>The labels to be applied to instances of the controller pod</td>
</tr>
</tbody>
</table>
<h3>Special Attention</h3>
<table>
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
<tr>
<td>controller.ingressClass</td>
<td>string</td>
<td><pre lang="json">
"nginx"
</pre>
</td>
<td>You can also specify value comments like this</td>
</tr>
<tr>
<td>controller.publishService</td>
<td>object</td>
<td><pre lang="json">
{
"enabled": false
}
</pre>
</td>
<td>This is a publishService</td>
</tr>
<tr>
<td>controller.replicas</td>
<td>int</td>
<td><pre lang="json">
null
</pre>
</td>
<td>Number of nginx-ingress pods to load balance between</td>
</tr>
</tbody>
</table>
<h3>Other Values</h3>
<table>
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
<tr>
<td>controller.extraVolumes[0].name</td>
<td>string</td>
<td><pre lang="json">
"config-volume"
</pre>
</td>
<td></td>
</tr>
<tr>
<td>controller.image.repository</td>
<td>string</td>
<td><pre lang="json">
"nginx-ingress-controller"
</pre>
</td>
<td></td>
</tr>
<tr>
<td>controller.image.tag</td>
<td>string</td>
<td><pre lang="json">
"18.0831"
</pre>
</td>
<td></td>
</tr>
<tr>
<td>controller.name</td>
<td>string</td>
<td><pre lang="json">
"controller"
</pre>
</td>
<td></td>
</tr>
<tr>
<td>controller.service.annotations."external-dns.alpha.kubernetes.io/hostname"</td>
<td>string</td>
<td><pre lang="json">
"stupidchess.jmn23.com"
</pre>
</td>
<td>Hostname to be assigned to the ELB for the service</td>
</tr>
<tr>
<td>controller.service.type</td>
<td>string</td>
<td><pre lang="json">
"LoadBalancer"
</pre>
</td>
<td></td>
</tr>
</tbody>
</table>
07070100000157000081A4000000000000000000000001668BBBD2000000BD000000000000000000000000000000000000003A00000000helm-docs-1.14.2/example-charts/sections/README.md.gotmpl# Sections
This creates values, but sectioned into own section tables if a section comment is provided.
{{ template "chart.valuesSection" . }}
{{ template "chart.valuesSectionHtml" . }}
07070100000158000081A4000000000000000000000001668BBBD200000527000000000000000000000000000000000000003500000000helm-docs-1.14.2/example-charts/sections/values.yamlcontroller:
name: controller
image:
repository: nginx-ingress-controller
tag: "18.0831"
# controller.persistentVolumeClaims -- List of persistent volume claims to create.
# @default -- the chart will construct this list internally unless specified
# @section -- Some Section
persistentVolumeClaims: []
extraVolumes:
- name: config-volume
configMap:
# controller.extraVolumes[0].configMap.name -- Uses the name of the configmap created by this chart
# @section -- Some Section
name: nginx-ingress-config
# -- You can also specify value comments like this
# @section -- Special Attention
ingressClass: nginx
# controller.podLabels -- The labels to be applied to instances of the controller pod
# @section -- Some Section
podLabels: {}
# controller.publishService -- This is a publishService
# @section -- Special Attention
publishService:
enabled: false
# -- (int) Number of nginx-ingress pods to load balance between
# @raw
# @section -- Special Attention
replicas:
service:
annotations:
# controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
type: LoadBalancer
07070100000159000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003300000000helm-docs-1.14.2/example-charts/special-characters0707010000015A000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000004500000000helm-docs-1.14.2/example-charts/special-characters-but-auto-comments0707010000015B000081A4000000000000000000000001668BBBD2000001B0000000000000000000000000000000000000005000000000helm-docs-1.14.2/example-charts/special-characters-but-auto-comments/Chart.yamlapiVersion: v2
name: special-characters
description: A chart demonstrating handling of special characters in values files
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"]
engine: gotpl
type: application
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
0707010000015C000081A4000000000000000000000001668BBBD2000005F2000000000000000000000000000000000000004F00000000helm-docs-1.14.2/example-charts/special-characters-but-auto-comments/README.md# special-characters
 
A chart demonstrating handling of special characters in values files
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| elasticsearch.clusterHealthCheckParams | string | `"wait_for_status=yellow&timeout=1s"` | The Elasticsearch cluster health status params that will be used by readinessProbe command |
| elasticsearch.clusterHealthCheckParamsDescription | string | `""` | Now let's put some special characters in the description: wait_for_status=yellow&timeout=1s |
| htmlSnippets.one | string | `"<html>\n <head></head>\n <body>\n <h1>Is this right, I don't know html</h1>\n </body>\n</html>\n"` | |
| htmlSnippets.three | string | `"<html><head></head></html>"` | Another description |
| htmlSnippets.two | string | `""` | Let's put it in the description <html></html> |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000015D000081A4000000000000000000000001668BBBD200000286000000000000000000000000000000000000005100000000helm-docs-1.14.2/example-charts/special-characters-but-auto-comments/values.yamlelasticsearch:
# -- The Elasticsearch cluster health status params that will be used by readinessProbe command
clusterHealthCheckParams: "wait_for_status=yellow&timeout=1s"
# -- Now let's put some special characters in the description: wait_for_status=yellow&timeout=1s
clusterHealthCheckParamsDescription: ""
htmlSnippets:
one: |
<html>
<head></head>
<body>
<h1>Is this right, I don't know html</h1>
</body>
</html>
# nonsense comment before
#
# -- Let's put it in the description <html></html>
two: ""
# -- Another description
# @default -- `"<html><head></head></html>"`
three: ""
0707010000015E000081A4000000000000000000000001668BBBD2000001B0000000000000000000000000000000000000003E00000000helm-docs-1.14.2/example-charts/special-characters/Chart.yamlapiVersion: v2
name: special-characters
description: A chart demonstrating handling of special characters in values files
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"]
engine: gotpl
type: application
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
0707010000015F000081A4000000000000000000000001668BBBD2000005F2000000000000000000000000000000000000003D00000000helm-docs-1.14.2/example-charts/special-characters/README.md# special-characters
 
A chart demonstrating handling of special characters in values files
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| elasticsearch.clusterHealthCheckParams | string | `"wait_for_status=yellow&timeout=1s"` | The Elasticsearch cluster health status params that will be used by readinessProbe command |
| elasticsearch.clusterHealthCheckParamsDescription | string | `""` | Now let's put some special characters in the description: wait_for_status=yellow&timeout=1s |
| htmlSnippets.one | string | `"<html>\n <head></head>\n <body>\n <h1>Is this right, I don't know html</h1>\n </body>\n</html>\n"` | |
| htmlSnippets.three | string | `"<html><head></head></html>"` | Another description |
| htmlSnippets.two | string | `""` | Let's put it in the description <html></html> |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000160000081A4000000000000000000000001668BBBD200000309000000000000000000000000000000000000003F00000000helm-docs-1.14.2/example-charts/special-characters/values.yamlelasticsearch:
# elasticsearch.clusterHealthCheckParams -- The Elasticsearch cluster health status params that will be used by readinessProbe command
clusterHealthCheckParams: "wait_for_status=yellow&timeout=1s"
# unrelated comments
# before
#
# elasticsearch.clusterHealthCheckParamsDescription -- Now let's put some special characters in the description: wait_for_status=yellow&timeout=1s
clusterHealthCheckParamsDescription: ""
htmlSnippets:
one: |
<html>
<head></head>
<body>
<h1>Is this right, I don't know html</h1>
</body>
</html>
# htmlSnippets.two -- Let's put it in the description <html></html>
two: ""
# htmlSnippets.three -- Another description
# @default -- `"<html><head></head></html>"`
three: ""
07070100000161000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002900000000helm-docs-1.14.2/example-charts/umbrella07070100000162000081A4000000000000000000000001668BBBD200000150000000000000000000000000000000000000003400000000helm-docs-1.14.2/example-charts/umbrella/Chart.yamlapiVersion: v2
name: umbrella
description: A chart demonstrating that values documentation from child charts are aggregated on the parent chart.
version: "0.1.0"
type: application
dependencies:
- name: sub-a
version: 0.1.0
- name: sub-b
version: 0.1.0
- name: sub-c
version: 0.1.0
- name: library
version: 0.1.0
07070100000163000081A4000000000000000000000001668BBBD20000047E000000000000000000000000000000000000003300000000helm-docs-1.14.2/example-charts/umbrella/README.md# umbrella
 
A chart demonstrating that values documentation from child charts are aggregated on the parent chart.
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| | library | 0.1.0 |
| | sub-a | 0.1.0 |
| | sub-b | 0.1.0 |
| | sub-c | 0.1.0 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global | object | `{}` | |
| global.myGlobalKey | string | `"my-global-value"` | A global key |
| global.myGlobalSubChartKey | string | `"my-global-sub-chart-value"` | A global key defined in a sub chart |
| myParentKey | string | `"my-parent-value"` | A parent key |
| sub-a.mySubKeyA | string | `"my-sub-value-a"` | Value for sub-chart A |
| sub-b.mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000164000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003000000000helm-docs-1.14.2/example-charts/umbrella/charts07070100000165000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/umbrella/charts/library07070100000166000081A4000000000000000000000001668BBBD200000076000000000000000000000000000000000000004300000000helm-docs-1.14.2/example-charts/umbrella/charts/library/Chart.yamlapiVersion: v2
name: library
description: An example library sub-chart with no values.
version: "0.1.0"
type: library
07070100000167000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003600000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-a07070100000168000081A4000000000000000000000001668BBBD2000000AD000000000000000000000000000000000000004100000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-a/Chart.yamlapiVersion: v2
name: sub-a
description: A sub-chart.
version: "0.1.0"
type: application
dependencies:
- name: library
version: 0.1.0
repository: file://../library
07070100000169000081A4000000000000000000000001668BBBD200000348000000000000000000000000000000000000004000000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-a/README.md# sub-a
 
A sub-chart.
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| file://../library | library | 0.1.0 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global.myGlobalKey | string | `"my-global-value"` | A global key |
| global.myGlobalSubChartKey | string | `"my-global-sub-chart-value"` | A global key defined in a sub chart |
| mySubKeyA | string | `"my-sub-value-a"` | Value for sub-chart A |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000016A000081A4000000000000000000000001668BBBD2000000CE000000000000000000000000000000000000004200000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-a/values.yamlglobal:
# -- A global key
myGlobalKey: my-global-value
# -- A global key defined in a sub chart
myGlobalSubChartKey: my-global-sub-chart-value
# -- Value for sub-chart A
mySubKeyA: my-sub-value-a
0707010000016B000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003600000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-b0707010000016C000081A4000000000000000000000001668BBBD2000000AD000000000000000000000000000000000000004100000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-b/Chart.yamlapiVersion: v2
name: sub-b
description: A sub-chart.
version: "0.1.0"
type: application
dependencies:
- name: library
version: 0.1.0
repository: file://../library
0707010000016D000081A4000000000000000000000001668BBBD2000002DA000000000000000000000000000000000000004000000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-b/README.md# sub-b
 
A sub-chart.
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| file://../library | library | 0.1.0 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global.myGlobalKey | string | `"my-global-value"` | A global key |
| mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
0707010000016E000081A4000000000000000000000001668BBBD200000071000000000000000000000000000000000000004200000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-b/values.yamlglobal:
# -- A global key
myGlobalKey: my-global-value
# -- Value for sub-chart B
mySubKeyB: my-sub-value-b
0707010000016F000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003600000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-c07070100000170000081A4000000000000000000000001668BBBD2000000AD000000000000000000000000000000000000004100000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-c/Chart.yamlapiVersion: v2
name: sub-c
description: A sub-chart.
version: "0.1.0"
type: application
dependencies:
- name: library
version: 0.1.0
repository: file://../library
07070100000171000081A4000000000000000000000001668BBBD20000026F000000000000000000000000000000000000004000000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-c/README.md# sub-c
 
A sub-chart.
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| file://../library | library | 0.1.0 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global | object | `{}` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000172000081A4000000000000000000000001668BBBD20000000B000000000000000000000000000000000000004200000000helm-docs-1.14.2/example-charts/umbrella/charts/sub-c/values.yamlglobal: {}
07070100000173000081A4000000000000000000000001668BBBD20000006B000000000000000000000000000000000000003500000000helm-docs-1.14.2/example-charts/umbrella/values.yamlglobal:
# -- A global key
myGlobalKey: my-global-value
# -- A parent key
myParentKey: my-parent-value
07070100000174000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002E00000000helm-docs-1.14.2/example-charts/use-yaml-file07070100000175000081A4000000000000000000000001668BBBD200000186000000000000000000000000000000000000003900000000helm-docs-1.14.2/example-charts/use-yaml-file/Chart.yamlapiVersion: v1
name: no-values
description: A very simple chart that doesn't even need any values for customization
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values"]
engine: gotpl
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
07070100000176000081A4000000000000000000000001668BBBD20000052B000000000000000000000000000000000000003800000000helm-docs-1.14.2/example-charts/use-yaml-file/README.md# no-values
A very simple chart that doesn't even need any values for customization
## Additional Information
### Snapshot classes
| name | resource group | incremental |
|----------|----------------|-------------|
| azure-incr | true | |
| azure | false | |
| local-incr | true | |
| local | false | |
| mask-data-incr | true | rg-mask-data |
| mask-data | false | rg-mask-data |
### Default resources
```yaml
requests:
cpu: 10m
memory: 100m
```
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/no-values
```
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| resources.requests.cpu | string | `"10m"` | |
| resources.requests.memory | string | `"100m"` | |
| volumeSnapshotClass.azure.parameters | object | `{}` | |
| volumeSnapshotClass.local.parameters | object | `{}` | |
| volumeSnapshotClass.mask-data.parameters.resourceGroup | string | `"rg-mask-data"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.0](https://github.com/norwoodj/helm-docs/releases/v1.14.0)
07070100000177000081A4000000000000000000000001668BBBD200000423000000000000000000000000000000000000003F00000000helm-docs-1.14.2/example-charts/use-yaml-file/README.md.gotmpl{{ template "chart.header" . }}
{{ template "chart.description" . }}
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
## Additional Information
{{ $values := (.Files.Get "values.yaml") | fromYaml }}
### Snapshot classes
| name | resource group | incremental |
|----------|----------------|-------------|
{{- range $name, $spec := $values.volumeSnapshotClass }}
{{- range $parameterIncr := list "true" "false" }}
| {{ $name }}{{- if eq $parameterIncr "true" -}}-incr{{- end }} | {{ $parameterIncr }} | {{ $spec.parameters.resourceGroup | default "" }} |
{{- end }}
{{- end }}
### Default resources
```yaml
{{ $values.resources | toYaml }}
```
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/{{ template "chart.name" . }}
```
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
07070100000178000081A4000000000000000000000001668BBBD2000000C4000000000000000000000000000000000000003A00000000helm-docs-1.14.2/example-charts/use-yaml-file/values.yamlvolumeSnapshotClass:
azure:
parameters: {}
local:
parameters: {}
mask-data:
parameters:
resourceGroup: rg-mask-data
resources:
requests:
cpu: 10m
memory: 100m
07070100000179000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001A00000000helm-docs-1.14.2/git-hook0707010000017A000081ED000000000000000000000001668BBBD2000000E1000000000000000000000000000000000000002400000000helm-docs-1.14.2/git-hook/helm-docs#!/usr/bin/env bash
set -e
if ! command -v helm-docs > /dev/null 2>&1; then
echo "Please install helm-docs to run the pre-commit hook! https://github.com/norwoodj/helm-docs#installation"
exit 1
fi
helm-docs "${@}"
0707010000017B000081A4000000000000000000000001668BBBD20000062D000000000000000000000000000000000000001800000000helm-docs-1.14.2/go.modmodule github.com/norwoodj/helm-docs
go 1.22.0
toolchain go1.22.1
require (
github.com/Masterminds/sprig/v3 v3.2.3
github.com/gobwas/glob v0.2.3
github.com/sirupsen/logrus v1.9.3
github.com/spf13/cobra v1.8.1
github.com/spf13/viper v1.16.0
github.com/stretchr/testify v1.9.0
gopkg.in/yaml.v3 v3.0.1
helm.sh/helm/v3 v3.15.2
)
require (
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver/v3 v3.2.1 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/fsnotify/fsnotify v1.6.0 // indirect
github.com/google/uuid v1.3.0 // indirect
github.com/hashicorp/hcl v1.0.0 // indirect
github.com/huandu/xstrings v1.4.0 // indirect
github.com/imdario/mergo v0.3.13 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/magiconair/properties v1.8.7 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/pelletier/go-toml/v2 v2.0.8 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/shopspring/decimal v1.3.1 // indirect
github.com/spf13/afero v1.9.5 // indirect
github.com/spf13/cast v1.5.1 // indirect
github.com/spf13/jwalterweatherman v1.1.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/subosito/gotenv v1.4.2 // indirect
golang.org/x/crypto v0.21.0 // indirect
golang.org/x/sys v0.18.0 // indirect
golang.org/x/text v0.14.0 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
)
0707010000017C000081A4000000000000000000000001668BBBD20000D17F000000000000000000000000000000000000001800000000helm-docs-1.14.2/go.sumcloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
cloud.google.com/go v0.38.0/go.mod h1:990N+gfupTy94rShfmMCWGDn0LpTmnzTp2qbd1dvSRU=
cloud.google.com/go v0.44.1/go.mod h1:iSa0KzasP4Uvy3f1mN/7PiObzGgflwredwwASm/v6AU=
cloud.google.com/go v0.44.2/go.mod h1:60680Gw3Yr4ikxnPRS/oxxkBccT6SA1yMk63TGekxKY=
cloud.google.com/go v0.44.3/go.mod h1:60680Gw3Yr4ikxnPRS/oxxkBccT6SA1yMk63TGekxKY=
cloud.google.com/go v0.45.1/go.mod h1:RpBamKRgapWJb87xiFSdk4g1CME7QZg3uwTez+TSTjc=
cloud.google.com/go v0.46.3/go.mod h1:a6bKKbmY7er1mI7TEI4lsAkts/mkhTSZK8w33B4RAg0=
cloud.google.com/go v0.50.0/go.mod h1:r9sluTvynVuxRIOHXQEHMFffphuXHOMZMycpNR5e6To=
cloud.google.com/go v0.52.0/go.mod h1:pXajvRH/6o3+F9jDHZWQ5PbGhn+o8w9qiu/CffaVdO4=
cloud.google.com/go v0.53.0/go.mod h1:fp/UouUEsRkN6ryDKNW/Upv/JBKnv6WDthjR6+vze6M=
cloud.google.com/go v0.54.0/go.mod h1:1rq2OEkV3YMf6n/9ZvGWI3GWw0VoqH/1x2nd8Is/bPc=
cloud.google.com/go v0.56.0/go.mod h1:jr7tqZxxKOVYizybht9+26Z/gUq7tiRzu+ACVAMbKVk=
cloud.google.com/go v0.57.0/go.mod h1:oXiQ6Rzq3RAkkY7N6t3TcE6jE+CIBBbA36lwQ1JyzZs=
cloud.google.com/go v0.62.0/go.mod h1:jmCYTdRCQuc1PHIIJ/maLInMho30T/Y0M4hTdTShOYc=
cloud.google.com/go v0.65.0/go.mod h1:O5N8zS7uWy9vkA9vayVHs65eM1ubvY4h553ofrNHObY=
cloud.google.com/go v0.72.0/go.mod h1:M+5Vjvlc2wnp6tjzE102Dw08nGShTscUx2nZMufOKPI=
cloud.google.com/go v0.74.0/go.mod h1:VV1xSbzvo+9QJOxLDaJfTjx5e+MePCpCWwvftOeQmWk=
cloud.google.com/go v0.75.0/go.mod h1:VGuuCn7PG0dwsd5XPVm2Mm3wlh3EL55/79EKB6hlPTY=
cloud.google.com/go/bigquery v1.0.1/go.mod h1:i/xbL2UlR5RvWAURpBYZTtm/cXjCha9lbfbpx4poX+o=
cloud.google.com/go/bigquery v1.3.0/go.mod h1:PjpwJnslEMmckchkHFfq+HTD2DmtT67aNFKH1/VBDHE=
cloud.google.com/go/bigquery v1.4.0/go.mod h1:S8dzgnTigyfTmLBfrtrhyYhwRxG72rYxvftPBK2Dvzc=
cloud.google.com/go/bigquery v1.5.0/go.mod h1:snEHRnqQbz117VIFhE8bmtwIDY80NLUZUMb4Nv6dBIg=
cloud.google.com/go/bigquery v1.7.0/go.mod h1://okPTzCYNXSlb24MZs83e2Do+h+VXtc4gLoIoXIAPc=
cloud.google.com/go/bigquery v1.8.0/go.mod h1:J5hqkt3O0uAFnINi6JXValWIb1v0goeZM77hZzJN/fQ=
cloud.google.com/go/datastore v1.0.0/go.mod h1:LXYbyblFSglQ5pkeyhO+Qmw7ukd3C+pD7TKLgZqpHYE=
cloud.google.com/go/datastore v1.1.0/go.mod h1:umbIZjpQpHh4hmRpGhH4tLFup+FVzqBi1b3c64qFpCk=
cloud.google.com/go/pubsub v1.0.1/go.mod h1:R0Gpsv3s54REJCy4fxDixWD93lHJMoZTyQ2kNxGRt3I=
cloud.google.com/go/pubsub v1.1.0/go.mod h1:EwwdRX2sKPjnvnqCa270oGRyludottCI76h+R3AArQw=
cloud.google.com/go/pubsub v1.2.0/go.mod h1:jhfEVHT8odbXTkndysNHCcx0awwzvfOlguIAii9o8iA=
cloud.google.com/go/pubsub v1.3.1/go.mod h1:i+ucay31+CNRpDW4Lu78I4xXG+O1r/MAHgjpRVR+TSU=
cloud.google.com/go/storage v1.0.0/go.mod h1:IhtSnM/ZTZV8YYJWCY8RULGVqBDmpoyjwiyrjsg+URw=
cloud.google.com/go/storage v1.5.0/go.mod h1:tpKbwo567HUNpVclU5sGELwQWBDZ8gh0ZeosJ0Rtdos=
cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohlUTyfDhBk=
cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs=
cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0=
cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3fOKtUw0Xmo=
dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
github.com/Masterminds/goutils v1.1.1 h1:5nUrii3FMTL5diU80unEVvNevw1nH4+ZV4DSLVJLSYI=
github.com/Masterminds/goutils v1.1.1/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy863GQaJW2MFNU=
github.com/Masterminds/semver/v3 v3.2.0/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ=
github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0=
github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ=
github.com/Masterminds/sprig/v3 v3.2.3 h1:eL2fZNezLomi0uOLqjQoN6BfsDD+fyLtgbJMAj9n6YA=
github.com/Masterminds/sprig/v3 v3.2.3/go.mod h1:rXcFaZ2zZbLRJv/xSysmlgIM1u11eBaRMhvYXJNkGuM=
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
github.com/envoyproxy/go-control-plane v0.9.7/go.mod h1:cwu0lG7PUMfa9snN8LXBig5ynNVH9qI8YYLbd1fK2po=
github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk=
github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
github.com/frankban/quicktest v1.14.4 h1:g2rn0vABPOOXmZUj+vbmUp0lPoXEMuhTpIluN0XL9UY=
github.com/frankban/quicktest v1.14.4/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
github.com/fsnotify/fsnotify v1.6.0 h1:n+5WquG0fcWoWp6xPWfHdbskMCQaFnG6PfBrh1Ky4HY=
github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbSClcnxKAGw=
github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU=
github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y=
github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y=
github.com/golang/mock v1.4.0/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
github.com/golang/mock v1.4.1/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4=
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw=
github.com/golang/protobuf v1.3.4/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw=
github.com/golang/protobuf v1.3.5/go.mod h1:6O5/vntMXwX2lRkT1hjjk0nAC1IDOTvTlVgjlRvqsdk=
github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8=
github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA=
github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs=
github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w=
github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0=
github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8=
github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.4.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0=
github.com/google/martian/v3 v3.1.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0=
github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
github.com/google/pprof v0.0.0-20191218002539-d4f498aebedc/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM=
github.com/google/pprof v0.0.0-20200212024743-f11f1df84d12/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM=
github.com/google/pprof v0.0.0-20200229191704-1ebb73c60ed3/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM=
github.com/google/pprof v0.0.0-20200430221834-fc25d7d30c6d/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM=
github.com/google/pprof v0.0.0-20200708004538-1a94d8640e99/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM=
github.com/google/pprof v0.0.0-20201023163331-3e6fc7fc9c4c/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
github.com/google/pprof v0.0.0-20201203190320-1bf35d6f28c2/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
github.com/google/pprof v0.0.0-20201218002935-b9804c9f04c2/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg=
github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk=
github.com/googleapis/google-cloud-go-testing v0.0.0-20200911160855-bcd43fbb19e8/go.mod h1:dvDLG8qkwmyD9a/MJJN3XJcT3xFxOKAvTZGvuZmac9g=
github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
github.com/huandu/xstrings v1.3.3/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
github.com/huandu/xstrings v1.4.0 h1:D17IlohoQq4UcpqD7fDk80P7l+lwAmlFaBHgOipl2FU=
github.com/huandu/xstrings v1.4.0/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
github.com/imdario/mergo v0.3.13 h1:lFzP57bqS/wsqKssCGmtLAb8A0wKjLGrve2q3PPVcBk=
github.com/imdario/mergo v0.3.13/go.mod h1:4lJ1jqUDcsbIECGy0RUJAXNIhg+6ocWgb1ALK2O4oXg=
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=
github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk=
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY=
github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
github.com/mitchellh/copystructure v1.2.0 h1:vpKXTN4ewci03Vljg/q9QvCGUDttBOGBIa15WveJJGw=
github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HKCj9FbZEVFJRxO9s=
github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ=
github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
github.com/pelletier/go-toml/v2 v2.0.8 h1:0ctb6s9mE31h0/lhu+J6OPmVeDxJn+kYnJc2jZR9tGQ=
github.com/pelletier/go-toml/v2 v2.0.8/go.mod h1:vuYfssBdrU2XDZ9bYydBu6t+6a6PYNcZljzZR9VXg+4=
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pkg/sftp v1.13.1/go.mod h1:3HaPG6Dq1ILlpPZRO0HVMrsydcdLt6HRDccSgb87qRg=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8=
github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/spf13/afero v1.9.5 h1:stMpOSZFs//0Lv29HduCmli3GUfpFoF3Y1Q/aXj/wVM=
github.com/spf13/afero v1.9.5/go.mod h1:UBogFpq8E9Hx+xc5CNTTEpTnuHVmXDwZcZcE1eb/UhQ=
github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
github.com/spf13/cast v1.5.1 h1:R+kOtfhWQE6TVQzY+4D7wJLBgkdVasCEFxSUBYBYIlA=
github.com/spf13/cast v1.5.1/go.mod h1:b9PdjNptOpzXr7Rq1q9gJML/2cdGQAo69NKzQ10KN48=
github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
github.com/spf13/jwalterweatherman v1.1.0 h1:ue6voC5bR5F8YxI5S67j9i582FU4Qvo2bmqnqMYADFk=
github.com/spf13/jwalterweatherman v1.1.0/go.mod h1:aNWZUN0dPAAO/Ljvb5BEdw96iTZ0EXowPYD95IqWIGo=
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/spf13/viper v1.16.0 h1:rGGH0XDZhdUOryiDWjmIvUSWpbNqisK8Wk0Vyefw8hc=
github.com/spf13/viper v1.16.0/go.mod h1:yg78JgCJcbrQOvV9YLXgkLaZqUidkY9K+Dd1FofRzQg=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/subosito/gotenv v1.4.2 h1:X1TuBLAMDFbaTAChgCBLu3DU3UPyELpnF2jjJ2cz/S8=
github.com/subosito/gotenv v1.4.2/go.mod h1:ayKnFf/c6rvx/2iiLrJUk1e6plDbT3edrFNGqEflhK0=
github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
go.opencensus.io v0.22.5/go.mod h1:5pWMHQbX5EPX2/62yrJeAkowc+lfs/XD7Uxpq3pI6kk=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
golang.org/x/crypto v0.3.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4=
golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=
golang.org/x/exp v0.0.0-20190829153037-c13cbed26979/go.mod h1:86+5VVa7VpoJ4kLfm080zCjGlMRFzhUhsZKEZO7MGek=
golang.org/x/exp v0.0.0-20191030013958-a1ab85dbe136/go.mod h1:JXzH8nQsPlswgeRAPE3MuO9GYsAcnJvJ4vnMwN/5qkY=
golang.org/x/exp v0.0.0-20191129062945-2f5052295587/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
golang.org/x/exp v0.0.0-20200119233911-0405dc783f0a/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM=
golang.org/x/exp v0.0.0-20200224162631-6cc2880d07d6/go.mod h1:3jZMyOhIsHpP37uCMkUooju7aAi5cS1Q23tOzKc+0MU=
golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=
golang.org/x/lint v0.0.0-20190301231843-5614ed5bae6f/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/lint v0.0.0-20190409202823-959b441ac422/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/lint v0.0.0-20190909230951-414d861bb4ac/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f/go.mod h1:5qLYkcX4OjUUV8bRuDixDT3tpyyb+LUpUlRWLxfhWrs=
golang.org/x/lint v0.0.0-20200130185559-910be7a94367/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE=
golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o=
golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY=
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
golang.org/x/mod v0.1.1-0.20191107180719-034126e5016b/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190501004415-9ce7a6920f09/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20190628185345-da137c7871d7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200222125558-5a598a2470a0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
golang.org/x/net v0.0.0-20200501053045-e0ff5e5a1de5/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
golang.org/x/net v0.0.0-20200506145744-7e3656a0809f/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
golang.org/x/net v0.0.0-20200513185701-a91f0712d120/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
golang.org/x/net v0.0.0-20200707034311-ab3426394381/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
golang.org/x/net v0.0.0-20201031054903-ff519b6c9102/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/oauth2 v0.0.0-20200902213428-5d25da1a8d43/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
golang.org/x/oauth2 v0.0.0-20201109201403-9fd604954f58/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
golang.org/x/oauth2 v0.0.0-20201208152858-08078c50e5b5/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
golang.org/x/oauth2 v0.0.0-20210218202405-ba52d332ba99/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190502145724-3ef323f4f1fd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20191228213918-04cbcbbfeed8/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200113162924-86b910548bc1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200122134326-e047566fdf82/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200212091648-12a6c2dcc1e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200331124033-c3d80250170d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200501052902-10377860bb8e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200511232937-7e40ca221e25/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200523222454-059865788121/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200803210538-64077c9b5642/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200905004654-be1d3432aa8f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20201201145000-ef89a241ccb3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210104204734-6f8348627aad/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210225134936-a50acf3fe073/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
golang.org/x/tools v0.0.0-20190312170243-e65039ee4138/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
golang.org/x/tools v0.0.0-20190506145303-2d16b83fe98c/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
golang.org/x/tools v0.0.0-20190816200558-6889da9d5479/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20190911174233-4f2ddba30aff/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191113191852-77e3bb0ad9e7/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191115202509-3a792d9c32b2/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191125144606-a911d9008d1f/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191130070609-6e064ea0cf2d/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191216173652-a0e659d51361/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20191227053925-7b8e75db28f4/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200117161641-43d50277825c/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200122220014-bf1340f18c4a/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200204074204-1cc6d1ef6c74/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200212150539-ea181f53ac56/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200224181240-023911ca70b2/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200227222343-706bc42d1f0d/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200304193943-95d2e580d8eb/go.mod h1:o4KQGtdN14AW+yjsvvwRTJJuXz8XRtIHtEnmAXLyFUw=
golang.org/x/tools v0.0.0-20200312045724-11d5b4c81c7d/go.mod h1:o4KQGtdN14AW+yjsvvwRTJJuXz8XRtIHtEnmAXLyFUw=
golang.org/x/tools v0.0.0-20200331025713-a30bf2db82d4/go.mod h1:Sl4aGygMT6LrqrWclx+PTx3U+LnKx/seiNR+3G19Ar8=
golang.org/x/tools v0.0.0-20200501065659-ab2804fb9c9d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
golang.org/x/tools v0.0.0-20200512131952-2bc93b1c0c88/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
golang.org/x/tools v0.0.0-20200515010526-7d3b6ebf133d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
golang.org/x/tools v0.0.0-20200618134242-20370b0cb4b2/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
golang.org/x/tools v0.0.0-20200729194436-6467de6f59a7/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
golang.org/x/tools v0.0.0-20200804011535-6c149bb5ef0d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
golang.org/x/tools v0.0.0-20200825202427-b303f430e36d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
golang.org/x/tools v0.0.0-20200904185747-39188db58858/go.mod h1:Cj7w3i3Rnn0Xh82ur9kSqwfTHTeVxaDqrfMjpcNT6bE=
golang.org/x/tools v0.0.0-20201110124207-079ba7bd75cd/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/tools v0.0.0-20201201161351-ac6f37ff4c2a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/tools v0.0.0-20201208233053-a543418bbed2/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/tools v0.0.0-20210108195828-e2f9c7f1fc8e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/api v0.4.0/go.mod h1:8k5glujaEP+g9n7WNsDg8QP6cUVNI86fCNMcbazEtwE=
google.golang.org/api v0.7.0/go.mod h1:WtwebWUNSVBH/HAw79HIFXZNqEvBhG+Ra+ax0hx3E3M=
google.golang.org/api v0.8.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg=
google.golang.org/api v0.9.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg=
google.golang.org/api v0.13.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI=
google.golang.org/api v0.14.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI=
google.golang.org/api v0.15.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI=
google.golang.org/api v0.17.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE=
google.golang.org/api v0.18.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE=
google.golang.org/api v0.19.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE=
google.golang.org/api v0.20.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE=
google.golang.org/api v0.22.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE=
google.golang.org/api v0.24.0/go.mod h1:lIXQywCXRcnZPGlsd8NbLnOjtAoL6em04bJ9+z0MncE=
google.golang.org/api v0.28.0/go.mod h1:lIXQywCXRcnZPGlsd8NbLnOjtAoL6em04bJ9+z0MncE=
google.golang.org/api v0.29.0/go.mod h1:Lcubydp8VUV7KeIHD9z2Bys/sm/vGKnG1UHuDBSrHWM=
google.golang.org/api v0.30.0/go.mod h1:QGmEvQ87FHZNiUVJkT14jQNYJ4ZJjdRF23ZXz5138Fc=
google.golang.org/api v0.35.0/go.mod h1:/XrVsuzM0rZmrsbjJutiuftIzeuTQcEeaYcSk/mQ1dg=
google.golang.org/api v0.36.0/go.mod h1:+z5ficQTmoYpPn8LCUNVpK5I7hwkpjbcgqA7I34qYtE=
google.golang.org/api v0.40.0/go.mod h1:fYKFpnQN0DsDSKRVRcQSDQNtqWPfM9i+zNPxepjRCQ8=
google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
google.golang.org/appengine v1.5.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
google.golang.org/appengine v1.6.1/go.mod h1:i06prIuMbXzDqacNJfV5OdTW448YApPu5ww/cMBSeb0=
google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
google.golang.org/appengine v1.6.6/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
google.golang.org/genproto v0.0.0-20190307195333-5fe7a883aa19/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE=
google.golang.org/genproto v0.0.0-20190418145605-e7d98fc518a7/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE=
google.golang.org/genproto v0.0.0-20190425155659-357c62f0e4bb/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE=
google.golang.org/genproto v0.0.0-20190502173448-54afdca5d873/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE=
google.golang.org/genproto v0.0.0-20190801165951-fa694d86fc64/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc=
google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc=
google.golang.org/genproto v0.0.0-20190911173649-1774047e7e51/go.mod h1:IbNlFCBrqXvoKpeg0TB2l7cyZUmoaFKYIwrEpbDKLA8=
google.golang.org/genproto v0.0.0-20191108220845-16a3f7862a1a/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc=
google.golang.org/genproto v0.0.0-20191115194625-c23dd37a84c9/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc=
google.golang.org/genproto v0.0.0-20191216164720-4f79533eabd1/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc=
google.golang.org/genproto v0.0.0-20191230161307-f3c370f40bfb/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc=
google.golang.org/genproto v0.0.0-20200115191322-ca5a22157cba/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc=
google.golang.org/genproto v0.0.0-20200122232147-0452cf42e150/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc=
google.golang.org/genproto v0.0.0-20200204135345-fa8e72b47b90/go.mod h1:GmwEX6Z4W5gMy59cAlVYjN9JhxgbQH6Gn+gFDQe2lzA=
google.golang.org/genproto v0.0.0-20200212174721-66ed5ce911ce/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200224152610-e50cd9704f63/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200228133532-8c2c7df3a383/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200305110556-506484158171/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200312145019-da6875a35672/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200331122359-1ee6d9798940/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200430143042-b979b6f78d84/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200511104702-f5ebc3bea380/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
google.golang.org/genproto v0.0.0-20200515170657-fc4c6c6a6587/go.mod h1:YsZOwe1myG/8QRHRsmBRE1LrgQY60beZKjly0O1fX9U=
google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo=
google.golang.org/genproto v0.0.0-20200618031413-b414f8b61790/go.mod h1:jDfRM7FcilCzHH/e9qn6dsT145K34l5v+OpcnNgKAAA=
google.golang.org/genproto v0.0.0-20200729003335-053ba62fc06f/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20200804131852-c06518451d9c/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20200825200019-8632dd797987/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20200904004341-0bd0a958aa1d/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20201109203340-2640f1f9cdfb/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20201201144952-b05cb90ed32e/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20201210142538-e3217bee35cc/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20201214200347-8c77b98c765d/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20210108203827-ffc7fda8c3d7/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/genproto v0.0.0-20210226172003-ab064af71705/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
google.golang.org/grpc v1.20.1/go.mod h1:10oTOabMzJvdu6/UiuZezV6QK5dSlG84ov/aaiqXj38=
google.golang.org/grpc v1.21.1/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM=
google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY=
google.golang.org/grpc v1.26.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
google.golang.org/grpc v1.27.1/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
google.golang.org/grpc v1.28.0/go.mod h1:rpkK4SK4GF4Ach/+MFLZUBavHOvF2JJB5uozKKal+60=
google.golang.org/grpc v1.29.1/go.mod h1:itym6AZVZYACWQqET3MqgPpjcuV5QH3BxFS3IjizoKk=
google.golang.org/grpc v1.30.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak=
google.golang.org/grpc v1.31.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak=
google.golang.org/grpc v1.31.1/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak=
google.golang.org/grpc v1.33.2/go.mod h1:JMHMWHQWaTccqQQlmk3MJZS+GWXOdAesneDmEnv2fbc=
google.golang.org/grpc v1.34.0/go.mod h1:WotjhfgOW/POjDeRt8vscBtXq+2VjORFy659qA51WJ8=
google.golang.org/grpc v1.35.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU=
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE=
google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGjtUeSXeh4=
google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
helm.sh/helm/v3 v3.15.2 h1:/3XINUFinJOBjQplGnjw92eLGpgXXp1L8chWPkCkDuw=
helm.sh/helm/v3 v3.15.2/go.mod h1:FzSIP8jDQaa6WAVg9F+OkKz7J0ZmAga4MABtTbsb9WQ=
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
0707010000017D000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001500000000helm-docs-1.14.2/pkg0707010000017E000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001E00000000helm-docs-1.14.2/pkg/document0707010000017F000081A4000000000000000000000001668BBBD2000007D7000000000000000000000000000000000000003300000000helm-docs-1.14.2/pkg/document/dependency_values.gopackage document
import (
"path/filepath"
"strings"
log "github.com/sirupsen/logrus"
"gopkg.in/yaml.v3"
"github.com/norwoodj/helm-docs/pkg/helm"
)
type DependencyValues struct {
Prefix string
ChartValues *yaml.Node
ChartValuesDescriptions map[string]helm.ChartValueDescription
}
func GetDependencyValues(root helm.ChartDocumentationInfo, allChartInfoByChartPath map[string]helm.ChartDocumentationInfo) ([]DependencyValues, error) {
return getDependencyValuesWithPrefix(root, allChartInfoByChartPath, "")
}
func getDependencyValuesWithPrefix(root helm.ChartDocumentationInfo, allChartInfoByChartPath map[string]helm.ChartDocumentationInfo, prefix string) ([]DependencyValues, error) {
if len(root.Dependencies) == 0 {
return nil, nil
}
result := make([]DependencyValues, 0, len(root.Dependencies))
for _, dep := range root.Dependencies {
searchPath := ""
if strings.HasPrefix(dep.Repository, "file://") {
searchPath = filepath.Join(root.ChartDirectory, strings.TrimPrefix(dep.Repository, "file://"))
} else if dep.Repository != "" {
log.Warnf("Chart in %q has a remote dependency %q. Dependency values will not be included.", root.ChartDirectory, dep.Name)
continue
} else {
searchPath = filepath.Join(root.ChartDirectory, "charts", dep.Name)
}
depInfo, ok := allChartInfoByChartPath[searchPath]
if !ok {
log.Warnf("Dependency with path %q was not found. Dependency values will not be included.", searchPath)
continue
}
alias := dep.Alias
if alias == "" {
alias = dep.Name
}
depPrefix := prefix + alias
result = append(result, DependencyValues{
Prefix: depPrefix,
ChartValues: depInfo.ChartValues,
ChartValuesDescriptions: depInfo.ChartValuesDescriptions,
})
children, err := getDependencyValuesWithPrefix(depInfo, allChartInfoByChartPath, depPrefix+".")
if err != nil {
return nil, err
}
result = append(result, children...)
}
return result, nil
}
07070100000180000081A4000000000000000000000001668BBBD200000D9B000000000000000000000000000000000000003800000000helm-docs-1.14.2/pkg/document/dependency_values_test.gopackage document_test
import (
"path/filepath"
"testing"
"github.com/norwoodj/helm-docs/pkg/helm"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gopkg.in/yaml.v3"
. "github.com/norwoodj/helm-docs/pkg/document"
)
func TestGetDependencyValues(t *testing.T) {
type args struct {
root helm.ChartDocumentationInfo
all []helm.ChartDocumentationInfo
}
tests := []struct {
name string
args args
want []DependencyValues
wantErr bool
}{
{
name: "zero dependencies",
},
{
name: "local dependency with name",
args: args{
root: info([]helm.ChartRequirementsItem{{Name: "sub-name"}}, "root"),
all: []helm.ChartDocumentationInfo{
info(nil, "root", "charts", "sub-name"),
},
},
want: []DependencyValues{
values("sub-name", "root", "charts", "sub-name"),
},
},
{
name: "local dependency with alias",
args: args{
root: info([]helm.ChartRequirementsItem{{Name: "sub-name", Alias: "sub-alias"}}, "root"),
all: []helm.ChartDocumentationInfo{
info(nil, "root", "charts", "sub-name"),
},
},
want: []DependencyValues{
values("sub-alias", "root", "charts", "sub-name"),
},
},
{
name: "nested dependencies",
args: args{
root: info([]helm.ChartRequirementsItem{{Name: "mid-a"}, {Name: "mid-b"}}, "root"),
all: []helm.ChartDocumentationInfo{
info([]helm.ChartRequirementsItem{{Name: "leaf-c"}, {Name: "leaf-d"}}, "root", "charts", "mid-a"),
info([]helm.ChartRequirementsItem{{Name: "leaf-e"}, {Name: "leaf-f"}}, "root", "charts", "mid-b"),
info(nil, "root", "charts", "mid-a", "charts", "leaf-c"),
info(nil, "root", "charts", "mid-a", "charts", "leaf-d"),
info(nil, "root", "charts", "mid-b", "charts", "leaf-e"),
info(nil, "root", "charts", "mid-b", "charts", "leaf-f"),
},
},
want: []DependencyValues{
values("mid-a", "root", "charts", "mid-a"),
values("mid-b", "root", "charts", "mid-b"),
values("mid-a.leaf-c", "root", "charts", "mid-a", "charts", "leaf-c"),
values("mid-a.leaf-d", "root", "charts", "mid-a", "charts", "leaf-d"),
values("mid-b.leaf-e", "root", "charts", "mid-b", "charts", "leaf-e"),
values("mid-b.leaf-f", "root", "charts", "mid-b", "charts", "leaf-f"),
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
infosByChartPath := make(map[string]helm.ChartDocumentationInfo)
for _, info := range tt.args.all {
infosByChartPath[info.ChartDirectory] = info
}
got, err := GetDependencyValues(tt.args.root, infosByChartPath)
if tt.wantErr {
require.Error(t, err)
} else {
require.NoError(t, err)
}
assert.ElementsMatch(t, tt.want, got)
})
}
}
func info(dependencies []helm.ChartRequirementsItem, dirParts ...string) helm.ChartDocumentationInfo {
dir := filepath.Join(dirParts...)
return helm.ChartDocumentationInfo{
ChartDirectory: dir,
ChartValues: &yaml.Node{Value: dir},
ChartValuesDescriptions: map[string]helm.ChartValueDescription{"value": {Description: dir}},
ChartRequirements: helm.ChartRequirements{
Dependencies: dependencies,
},
}
}
func values(prefix string, dirParts ...string) DependencyValues {
dir := filepath.Join(dirParts...)
return DependencyValues{
Prefix: prefix,
ChartValues: &yaml.Node{Value: dir},
ChartValuesDescriptions: map[string]helm.ChartValueDescription{"value": {Description: dir}},
}
}
07070100000181000081A4000000000000000000000001668BBBD200000A61000000000000000000000000000000000000002700000000helm-docs-1.14.2/pkg/document/files.gopackage document
import (
"encoding/base64"
"io/ioutil"
"os"
"path"
"path/filepath"
"strings"
"github.com/gobwas/glob"
log "github.com/sirupsen/logrus"
"gopkg.in/yaml.v3"
)
type files struct {
baseDir string
foundFiles map[string]*fileEntry
}
type fileEntry struct {
Path string
data []byte
}
func getFiles(dir string) (files, error) {
result := files{
baseDir: dir,
foundFiles: make(map[string]*fileEntry),
}
err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() {
return nil
}
result.foundFiles[path] = &fileEntry{Path: path}
return nil
})
if err != nil {
return files{}, err
}
return result, nil
}
func (f *fileEntry) GetData() []byte {
if f.data == nil {
data, err := ioutil.ReadFile(f.Path)
if err != nil {
log.Warnf("Error reading file contents for %s: %s", f.Path, err.Error())
return []byte{}
}
f.data = data
}
return f.data
}
func (f files) GetBytes(name string) []byte {
if v, ok := f.foundFiles[filepath.Join(f.baseDir, name)]; ok {
return v.GetData()
}
return []byte{}
}
func (f files) Get(name string) string {
return string(f.GetBytes(name))
}
func (f files) Glob(pattern string) files {
result := files{
baseDir: f.baseDir,
foundFiles: make(map[string]*fileEntry),
}
g, err := glob.Compile(filepath.Join(f.baseDir, pattern), filepath.Separator)
if err != nil {
log.Warnf("Error compiling Glob patten %s: %s", pattern, err.Error())
return result
}
for filePath, entry := range f.foundFiles {
if g.Match(filePath) {
result.foundFiles[filePath] = entry
}
}
return result
}
func (f files) AsConfig() string {
if len(f.foundFiles) == 0 {
return ""
}
m := make(map[string]string)
// Explicitly convert to strings, and file names
for k, v := range f.foundFiles {
m[path.Base(k)] = string(v.GetData())
}
return toYAML(m)
}
func (f files) AsSecrets() string {
if len(f.foundFiles) == 0 {
return ""
}
m := make(map[string]string)
for k, v := range f.foundFiles {
m[path.Base(k)] = base64.StdEncoding.EncodeToString(v.GetData())
}
return toYAML(m)
}
func (f files) AsMap() map[string]*fileEntry {
return f.foundFiles
}
func (f files) Lines(path string) []string {
if len(f.foundFiles) == 0 {
return []string{}
}
entry, exists := f.foundFiles[path]
if !exists {
return []string{}
}
return strings.Split(string(entry.GetData()), "\n")
}
func toYAML(v interface{}) string {
data, err := yaml.Marshal(v)
if err != nil {
// Swallow errors inside a template.
return ""
}
return strings.TrimSuffix(string(data), "\n")
}
07070100000182000081A4000000000000000000000001668BBBD200000CAF000000000000000000000000000000000000002C00000000helm-docs-1.14.2/pkg/document/files_test.gopackage document
import (
"github.com/stretchr/testify/assert"
"os"
"path"
"testing"
)
// As the interface has been kept the same as in Helm, the tests also work here.
// Tests similar to https://github.com/helm/helm/blob/main/pkg/engine/files_test.go.
var cases = []struct {
path, data string
}{
{"ship/captain.txt", "The Captain"},
{"ship/stowaway.txt", "Legatt"},
{"story/name.txt", "The Secret Sharer"},
{"story/author.txt", "Joseph Conrad"},
{"multiline/test.txt", "bar\nfoo"},
}
func getTestFiles() files {
a := files{
baseDir: "",
foundFiles: make(map[string]*fileEntry),
}
for _, c := range cases {
a.foundFiles[c.path] = &fileEntry{
Path: c.path,
data: []byte(c.data),
}
}
return a
}
func TestNewFiles(t *testing.T) {
files := getTestFiles()
if len(files.foundFiles) != len(cases) {
t.Errorf("Expected len() = %d, got %d", len(cases), len(files.foundFiles))
}
for i, f := range cases {
if got := string(files.GetBytes(f.path)); got != f.data {
t.Errorf("%d: expected %q, got %q", i, f.data, got)
}
if got := files.Get(f.path); got != f.data {
t.Errorf("%d: expected %q, got %q", i, f.data, got)
}
}
}
func TestFileGlob(t *testing.T) {
as := assert.New(t)
f := getTestFiles()
matched := f.Glob("story/**")
as.Len(matched.foundFiles, 2, "Should be two files in glob story/**")
as.Equal("Joseph Conrad", matched.Get("story/author.txt"))
}
func TestToConfig(t *testing.T) {
as := assert.New(t)
f := getTestFiles()
out := f.Glob("**/captain.txt").AsConfig()
as.Equal("captain.txt: The Captain", out)
out = f.Glob("ship/**").AsConfig()
as.Equal("captain.txt: The Captain\nstowaway.txt: Legatt", out)
}
func TestToSecret(t *testing.T) {
as := assert.New(t)
f := getTestFiles()
out := f.Glob("ship/**").AsSecrets()
as.Equal("captain.txt: VGhlIENhcHRhaW4=\nstowaway.txt: TGVnYXR0", out)
}
func TestToMap(t *testing.T) {
as := assert.New(t)
f := getTestFiles()
out := f.Glob("ship/**").AsMap()
as.Contains(out, "ship/captain.txt")
as.Contains(out, "ship/stowaway.txt")
as.NotContains(out, "story/name.txt")
}
func TestLines(t *testing.T) {
as := assert.New(t)
f := getTestFiles()
out := f.Lines("multiline/test.txt")
as.Len(out, 2)
as.Equal("bar", out[0])
}
func TestGetFiles(t *testing.T) {
chartDir, err := os.MkdirTemp("", "*-helm-docs-chart")
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() {
_ = os.RemoveAll(chartDir)
})
testFiles := getTestFiles()
for filePath, entry := range testFiles.foundFiles {
fullPath := path.Join(chartDir, filePath)
baseDir := path.Dir(fullPath)
if err = os.MkdirAll(baseDir, 0o755); err != nil {
t.Fatal(err)
}
data := entry.GetData()
if err = os.WriteFile(fullPath, data, 0o644); err != nil {
t.Fatal(err)
}
}
chartFiles, err := getFiles(chartDir)
if err != nil {
t.Fatal(err)
}
if len(chartFiles.foundFiles) != len(testFiles.foundFiles) {
t.Errorf("chart files: expected %d, got %d", len(chartFiles.foundFiles), len(testFiles.foundFiles))
}
// Sanity check the files have been read
for filePath, entry := range chartFiles.foundFiles {
data := entry.GetData()
if len(data) == 0 {
t.Errorf("%s: expected file contents, got 0 bytes", filePath)
}
}
}
07070100000183000081A4000000000000000000000001668BBBD20000097A000000000000000000000000000000000000002A00000000helm-docs-1.14.2/pkg/document/generate.gopackage document
import (
"bytes"
"os"
"path/filepath"
"regexp"
"github.com/norwoodj/helm-docs/pkg/helm"
log "github.com/sirupsen/logrus"
"github.com/spf13/viper"
)
func getOutputFile(chartDirectory string, dryRun bool) (*os.File, error) {
if dryRun {
return os.Stdout, nil
}
outputFile := viper.GetString("output-file")
f, err := os.Create(filepath.Join(chartDirectory, outputFile))
if err != nil {
return nil, err
}
return f, err
}
func PrintDocumentation(chartDocumentationInfo helm.ChartDocumentationInfo, chartSearchRoot string, templateFiles []string, dryRun bool, helmDocsVersion string, badgeStyle string, dependencyValues []DependencyValues, skipVersionFooter bool) {
log.Infof("Generating README Documentation for chart %s", chartDocumentationInfo.ChartDirectory)
chartDocumentationTemplate, err := newChartDocumentationTemplate(
chartDocumentationInfo,
chartSearchRoot,
templateFiles,
badgeStyle,
)
if err != nil {
log.Warnf("Error generating gotemplates for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
return
}
chartTemplateDataObject, err := getChartTemplateData(chartDocumentationInfo, helmDocsVersion, dependencyValues, skipVersionFooter)
if err != nil {
log.Warnf("Error generating template data for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
return
}
outputFile, err := getOutputFile(chartDocumentationInfo.ChartDirectory, dryRun)
if err != nil {
log.Warnf("Could not open chart README file %s, skipping chart", filepath.Join(chartDocumentationInfo.ChartDirectory, "README.md"))
return
}
if !dryRun {
defer outputFile.Close()
}
var output bytes.Buffer
err = chartDocumentationTemplate.Execute(&output, chartTemplateDataObject)
if err != nil {
log.Warnf("Error generating documentation for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
}
output = applyMarkDownFormat(output)
_, err = output.WriteTo(outputFile)
if err != nil {
log.Warnf("Error generating documentation file for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
}
}
func applyMarkDownFormat(output bytes.Buffer) bytes.Buffer {
outputString := output.String()
re := regexp.MustCompile(` \n`)
outputString = re.ReplaceAllString(outputString, "\n")
re = regexp.MustCompile(`\n{3,}`)
outputString = re.ReplaceAllString(outputString, "\n\n")
output.Reset()
output.WriteString(outputString)
return output
}
07070100000184000081A4000000000000000000000001668BBBD20000195C000000000000000000000000000000000000002700000000helm-docs-1.14.2/pkg/document/model.gopackage document
import (
"fmt"
"sort"
"strings"
log "github.com/sirupsen/logrus"
"github.com/spf13/viper"
"gopkg.in/yaml.v3"
"github.com/norwoodj/helm-docs/pkg/helm"
)
type valueRow struct {
Key string
Type string
NotationType string
AutoDefault string
Default string
AutoDescription string
Description string
Section string
Column int
LineNumber int
Dependency string
IsGlobal bool
}
type chartTemplateData struct {
helm.ChartDocumentationInfo
HelmDocsVersion string
Values []valueRow
Sections sections
Files files
SkipVersionFooter bool
}
type sections struct {
DefaultSection section
Sections []section
}
type section struct {
SectionName string
SectionItems []valueRow
}
func sortValueRowsByOrder(valueRows []valueRow, sortOrder string) {
sort.Slice(valueRows, func(i, j int) bool {
// Globals sort above non-globals.
if valueRows[i].IsGlobal != valueRows[j].IsGlobal {
return valueRows[i].IsGlobal
}
// Group by dependency for non-globals.
if !valueRows[i].IsGlobal && !valueRows[j].IsGlobal {
// Values for the main chart sort above values for dependencies.
if (valueRows[i].Dependency == "") != (valueRows[j].Dependency == "") {
return valueRows[i].Dependency == ""
}
// Group dependency values together.
if valueRows[i].Dependency != valueRows[j].Dependency {
return valueRows[i].Dependency < valueRows[j].Dependency
}
}
// Sort the remaining values within the same section using the configured sort order.
switch sortOrder {
case FileSortOrder:
if valueRows[i].LineNumber == valueRows[j].LineNumber {
return valueRows[i].Column < valueRows[j].Column
}
return valueRows[i].LineNumber < valueRows[j].LineNumber
case AlphaNumSortOrder:
return valueRows[i].Key < valueRows[j].Key
default:
panic("cannot get here")
}
})
}
func sortValueRows(valueRows []valueRow) {
sortOrder := viper.GetString("sort-values-order")
if sortOrder != FileSortOrder && sortOrder != AlphaNumSortOrder {
log.Warnf("Invalid sort order provided %s, defaulting to %s", sortOrder, AlphaNumSortOrder)
sortOrder = AlphaNumSortOrder
}
sortValueRowsByOrder(valueRows, sortOrder)
}
func sortSectionedValueRows(sectionedValueRows sections) {
sortOrder := viper.GetString("sort-values-order")
if sortOrder != FileSortOrder && sortOrder != AlphaNumSortOrder {
log.Warnf("Invalid sort order provided %s, defaulting to %s", sortOrder, AlphaNumSortOrder)
sortOrder = AlphaNumSortOrder
}
sortValueRowsByOrder(sectionedValueRows.DefaultSection.SectionItems, sortOrder)
for _, section := range sectionedValueRows.Sections {
sortValueRowsByOrder(section.SectionItems, sortOrder)
}
}
func getUnsortedValueRows(document *yaml.Node, descriptions map[string]helm.ChartValueDescription) ([]valueRow, error) {
// Handle empty values file case.
if document.Kind == 0 {
return nil, nil
}
if document.Kind != yaml.DocumentNode {
return nil, fmt.Errorf("invalid node kind supplied: %d", document.Kind)
}
if document.Content[0].Kind != yaml.MappingNode {
return nil, fmt.Errorf("values file must resolve to a map (was %d)", document.Content[0].Kind)
}
return createValueRowsFromField("", nil, document.Content[0], descriptions, true)
}
func getSectionedValueRows(valueRows []valueRow) sections {
var valueRowsSectionSorted sections
valueRowsSectionSorted.DefaultSection = section{
SectionName: "Other Values",
SectionItems: []valueRow{},
}
for _, row := range valueRows {
if row.Section == "" {
valueRowsSectionSorted.DefaultSection.SectionItems = append(valueRowsSectionSorted.DefaultSection.SectionItems, row)
continue
}
containsSection := false
for i, section := range valueRowsSectionSorted.Sections {
if section.SectionName == row.Section {
containsSection = true
valueRowsSectionSorted.Sections[i].SectionItems = append(valueRowsSectionSorted.Sections[i].SectionItems, row)
break
}
}
if !containsSection {
valueRowsSectionSorted.Sections = append(valueRowsSectionSorted.Sections, section{
SectionName: row.Section,
SectionItems: []valueRow{row},
})
}
}
return valueRowsSectionSorted
}
func getChartTemplateData(info helm.ChartDocumentationInfo, helmDocsVersion string, dependencyValues []DependencyValues, skipVersionFooter bool) (chartTemplateData, error) {
valuesTableRows, err := getUnsortedValueRows(info.ChartValues, info.ChartValuesDescriptions)
if err != nil {
return chartTemplateData{}, err
}
if viper.GetBool("ignore-non-descriptions") {
valuesTableRows = removeRowsWithoutDescription(valuesTableRows)
}
if len(dependencyValues) > 0 {
seenGlobalKeys := make(map[string]bool)
for i, row := range valuesTableRows {
if strings.HasPrefix(row.Key, "global.") {
valuesTableRows[i].IsGlobal = true
seenGlobalKeys[row.Key] = true
}
}
for _, dep := range dependencyValues {
depValuesTableRows, err := getUnsortedValueRows(dep.ChartValues, dep.ChartValuesDescriptions)
if err != nil {
return chartTemplateData{}, err
}
for _, row := range depValuesTableRows {
if row.Key == "global" || strings.HasPrefix(row.Key, "global.") {
if seenGlobalKeys[row.Key] {
continue
}
row.IsGlobal = true
seenGlobalKeys[row.Key] = true
} else {
row.Key = dep.Prefix + "." + row.Key
}
row.Dependency = dep.Prefix
valuesTableRows = append(valuesTableRows, row)
}
}
}
sortValueRows(valuesTableRows)
valueRowsSectionSorted := getSectionedValueRows(valuesTableRows)
sortSectionedValueRows(valueRowsSectionSorted)
files, err := getFiles(info.ChartDirectory)
if err != nil {
return chartTemplateData{}, err
}
return chartTemplateData{
ChartDocumentationInfo: info,
HelmDocsVersion: helmDocsVersion,
Values: valuesTableRows,
Sections: valueRowsSectionSorted,
Files: files,
SkipVersionFooter: skipVersionFooter,
}, nil
}
func removeRowsWithoutDescription(valuesTableRows []valueRow) []valueRow {
var valuesTableRowsWithoutDescription []valueRow
for i := range valuesTableRows {
if valuesTableRows[i].AutoDescription != "" || valuesTableRows[i].Description != "" {
valuesTableRowsWithoutDescription = append(valuesTableRowsWithoutDescription, valuesTableRows[i])
}
}
return valuesTableRowsWithoutDescription
}
07070100000185000081A4000000000000000000000001668BBBD20000435E000000000000000000000000000000000000002A00000000helm-docs-1.14.2/pkg/document/template.gopackage document
import (
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"text/template"
"github.com/norwoodj/helm-docs/pkg/util"
log "github.com/sirupsen/logrus"
"github.com/norwoodj/helm-docs/pkg/helm"
)
const defaultDocumentationTemplate = `{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
{{- if not .SkipVersionFooter }}
{{ template "helm-docs.versionFooter" . }}
{{- end }}
`
func getNameTemplate() string {
nameBuilder := strings.Builder{}
nameBuilder.WriteString(`{{ define "chart.name" }}`)
nameBuilder.WriteString("{{ .Name }}")
nameBuilder.WriteString("{{ end }}")
return nameBuilder.String()
}
func getHeaderTemplate() string {
headerTemplateBuilder := strings.Builder{}
headerTemplateBuilder.WriteString(`{{ define "chart.header" }}`)
headerTemplateBuilder.WriteString("# {{ .Name }}\n")
headerTemplateBuilder.WriteString("{{ end }}")
return headerTemplateBuilder.String()
}
func getDeprecatedTemplate() string {
deprecatedTemplateBuilder := strings.Builder{}
deprecatedTemplateBuilder.WriteString(`{{ define "chart.deprecationWarning" }}`)
deprecatedTemplateBuilder.WriteString("{{ if .Deprecated }}> **:exclamation: This Helm Chart is deprecated!**{{ end }}")
deprecatedTemplateBuilder.WriteString("{{ end }}")
return deprecatedTemplateBuilder.String()
}
func getVersionTemplates(badgeStyle string) string {
versionBuilder := strings.Builder{}
versionBuilder.WriteString(`{{ define "chart.version" }}{{ .Version }}{{ end }}\n`)
versionBuilder.WriteString(`{{ define "chart.versionBadge" }}`)
versionBuilder.WriteString(fmt.Sprintf(`![Version: {{ .Version }}](https://img.shields.io/badge/Version-{{ .Version | replace "-" "--" }}-informational?style=%s) `, badgeStyle))
versionBuilder.WriteString("{{ end }}")
return versionBuilder.String()
}
func getTypeTemplate(badgeStyle string) string {
typeBuilder := strings.Builder{}
typeBuilder.WriteString(`{{ define "chart.type" }}{{ .Type }}{{ end }}\n`)
typeBuilder.WriteString(`{{ define "chart.typeBadge" }}`)
typeBuilder.WriteString(fmt.Sprintf("{{ if .Type }} {{ end }}", badgeStyle))
typeBuilder.WriteString("{{ end }}")
return typeBuilder.String()
}
func getAppVersionTemplate(badgeStyle string) string {
appVersionBuilder := strings.Builder{}
appVersionBuilder.WriteString(`{{ define "chart.appVersion" }}{{ .AppVersion }}{{ end }}\n`)
appVersionBuilder.WriteString(`{{ define "chart.appVersionBadge" }}`)
appVersionBuilder.WriteString(fmt.Sprintf(`{{ if .AppVersion }}![AppVersion: {{ .AppVersion }}](https://img.shields.io/badge/AppVersion-{{ .AppVersion | replace "-" "--" }}-informational?style=%s) {{ end }}`, badgeStyle))
appVersionBuilder.WriteString("{{ end }}")
return appVersionBuilder.String()
}
func getBadgesTemplates() string {
badgeBuilder := strings.Builder{}
badgeBuilder.WriteString(`{{ define "chart.badgesSection" }}`)
badgeBuilder.WriteString(`{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}`)
badgeBuilder.WriteString("{{ end }}")
return badgeBuilder.String()
}
func getDescriptionTemplate() string {
descriptionBuilder := strings.Builder{}
descriptionBuilder.WriteString(`{{ define "chart.description" }}`)
descriptionBuilder.WriteString("{{ if .Description }}{{ .Description }}{{ end }}")
descriptionBuilder.WriteString("{{ end }}")
return descriptionBuilder.String()
}
func getHomepageTemplate() string {
homepageBuilder := strings.Builder{}
homepageBuilder.WriteString(`{{ define "chart.homepage" }}{{ .Home }}{{ end }}\n`)
homepageBuilder.WriteString(`{{ define "chart.homepageLine" }}`)
homepageBuilder.WriteString("{{ if .Home }}**Homepage:** <{{ .Home }}>{{ end }}")
homepageBuilder.WriteString("{{ end }}")
return homepageBuilder.String()
}
func getMaintainersTemplate() string {
maintainerBuilder := strings.Builder{}
maintainerBuilder.WriteString(`{{ define "chart.maintainersHeader" }}## Maintainers{{ end }}`)
maintainerBuilder.WriteString(`{{ define "chart.maintainersTable" }}`)
maintainerBuilder.WriteString("| Name | Email | Url |\n")
maintainerBuilder.WriteString("| ---- | ------ | --- |\n")
maintainerBuilder.WriteString(" {{- range .Maintainers }}")
maintainerBuilder.WriteString("\n| {{ .Name }} | {{ if .Email }}<{{ .Email }}>{{ end }} | {{ if .Url }}<{{ .Url }}>{{ end }} |")
maintainerBuilder.WriteString(" {{- end }}")
maintainerBuilder.WriteString("{{ end }}")
maintainerBuilder.WriteString(`{{ define "chart.maintainersSection" }}`)
maintainerBuilder.WriteString("{{ if .Maintainers }}")
maintainerBuilder.WriteString(`{{ template "chart.maintainersHeader" . }}`)
maintainerBuilder.WriteString("\n\n")
maintainerBuilder.WriteString(`{{ template "chart.maintainersTable" . }}`)
maintainerBuilder.WriteString("{{ end }}")
maintainerBuilder.WriteString("{{ end }}")
return maintainerBuilder.String()
}
func getSourceLinkTemplates() string {
sourceLinkBuilder := strings.Builder{}
sourceLinkBuilder.WriteString(`{{ define "chart.sourcesHeader" }}## Source Code{{ end}}`)
sourceLinkBuilder.WriteString(`{{ define "chart.sourcesList" }}`)
sourceLinkBuilder.WriteString("{{- range .Sources }}")
sourceLinkBuilder.WriteString("\n* <{{ . }}>")
sourceLinkBuilder.WriteString("{{- end }}")
sourceLinkBuilder.WriteString("{{ end }}")
sourceLinkBuilder.WriteString(`{{ define "chart.sourcesSection" }}`)
sourceLinkBuilder.WriteString("{{ if .Sources }}")
sourceLinkBuilder.WriteString(`{{ template "chart.sourcesHeader" . }}`)
sourceLinkBuilder.WriteString("\n")
sourceLinkBuilder.WriteString(`{{ template "chart.sourcesList" . }}`)
sourceLinkBuilder.WriteString("{{ end }}")
sourceLinkBuilder.WriteString("{{ end }}")
return sourceLinkBuilder.String()
}
func getRequirementsTableTemplates() string {
requirementsSectionBuilder := strings.Builder{}
requirementsSectionBuilder.WriteString(`{{ define "chart.requirementsHeader" }}## Requirements{{ end }}`)
requirementsSectionBuilder.WriteString(`{{ define "chart.kubeVersion" }}{{ .KubeVersion }}{{ end }}\n`)
requirementsSectionBuilder.WriteString(`{{ define "chart.kubeVersionLine" }}`)
requirementsSectionBuilder.WriteString("{{ if .KubeVersion }}Kubernetes: `{{ .KubeVersion }}`{{ end }}")
requirementsSectionBuilder.WriteString("{{ end }}")
requirementsSectionBuilder.WriteString(`{{ define "chart.requirementsTable" }}`)
requirementsSectionBuilder.WriteString("| Repository | Name | Version |\n")
requirementsSectionBuilder.WriteString("|------------|------|---------|")
requirementsSectionBuilder.WriteString(" {{- range .Dependencies }}")
requirementsSectionBuilder.WriteString(" {{- if .Alias }}")
requirementsSectionBuilder.WriteString("\n| {{ .Repository }} | {{ .Alias }}({{ .Name }}) | {{ .Version }} |")
requirementsSectionBuilder.WriteString(" {{- else }}")
requirementsSectionBuilder.WriteString("\n| {{ .Repository }} | {{ .Name }} | {{ .Version }} |")
requirementsSectionBuilder.WriteString(" {{- end }}")
requirementsSectionBuilder.WriteString(" {{- end }}")
requirementsSectionBuilder.WriteString("{{ end }}")
requirementsSectionBuilder.WriteString(`{{ define "chart.requirementsSection" }}`)
requirementsSectionBuilder.WriteString("{{ if or .Dependencies .KubeVersion }}")
requirementsSectionBuilder.WriteString(`{{ template "chart.requirementsHeader" . }}`)
requirementsSectionBuilder.WriteString("\n\n")
requirementsSectionBuilder.WriteString("{{ if .KubeVersion }}")
requirementsSectionBuilder.WriteString(`{{ template "chart.kubeVersionLine" . }}`)
requirementsSectionBuilder.WriteString("\n\n")
requirementsSectionBuilder.WriteString("{{ end }}")
requirementsSectionBuilder.WriteString("{{ if .Dependencies }}")
requirementsSectionBuilder.WriteString(`{{ template "chart.requirementsTable" . }}`)
requirementsSectionBuilder.WriteString("{{ end }}")
requirementsSectionBuilder.WriteString("{{ end }}")
requirementsSectionBuilder.WriteString("{{ end }}")
return requirementsSectionBuilder.String()
}
func getValuesTableTemplates() string {
valuesSectionBuilder := strings.Builder{}
valuesSectionBuilder.WriteString(`{{ define "chart.valuesHeader" }}## Values{{ end }}`)
valuesSectionBuilder.WriteString(`{{ define "chart.valuesTable" }}`)
valuesSectionBuilder.WriteString("{{ if .Sections.Sections }}")
valuesSectionBuilder.WriteString("{{ range .Sections.Sections }}")
valuesSectionBuilder.WriteString("\n")
valuesSectionBuilder.WriteString("\n### {{ .SectionName }}\n")
valuesSectionBuilder.WriteString("\n")
valuesSectionBuilder.WriteString("| Key | Type | Default | Description |\n")
valuesSectionBuilder.WriteString("|-----|------|---------|-------------|\n")
valuesSectionBuilder.WriteString(" {{- range .SectionItems }}")
valuesSectionBuilder.WriteString("\n| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |")
valuesSectionBuilder.WriteString(" {{- end }}")
valuesSectionBuilder.WriteString("{{- end }}")
valuesSectionBuilder.WriteString("{{ if .Sections.DefaultSection.SectionItems}}")
valuesSectionBuilder.WriteString("\n")
valuesSectionBuilder.WriteString("\n### {{ .Sections.DefaultSection.SectionName }}\n")
valuesSectionBuilder.WriteString("\n")
valuesSectionBuilder.WriteString("| Key | Type | Default | Description |\n")
valuesSectionBuilder.WriteString("|-----|------|---------|-------------|\n")
valuesSectionBuilder.WriteString(" {{- range .Sections.DefaultSection.SectionItems }}")
valuesSectionBuilder.WriteString("\n| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |")
valuesSectionBuilder.WriteString(" {{- end }}")
valuesSectionBuilder.WriteString("{{ end }}")
valuesSectionBuilder.WriteString("{{ else }}")
valuesSectionBuilder.WriteString("| Key | Type | Default | Description |\n")
valuesSectionBuilder.WriteString("|-----|------|---------|-------------|\n")
valuesSectionBuilder.WriteString(" {{- range .Values }}")
valuesSectionBuilder.WriteString("\n| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |")
valuesSectionBuilder.WriteString(" {{- end }}")
valuesSectionBuilder.WriteString("{{ end }}")
valuesSectionBuilder.WriteString("{{ end }}")
valuesSectionBuilder.WriteString(`{{ define "chart.valuesSection" }}`)
valuesSectionBuilder.WriteString("{{ if .Values }}")
valuesSectionBuilder.WriteString(`{{ template "chart.valuesHeader" . }}`)
valuesSectionBuilder.WriteString("\n\n")
valuesSectionBuilder.WriteString(`{{ template "chart.valuesTable" . }}`)
valuesSectionBuilder.WriteString("{{ end }}")
valuesSectionBuilder.WriteString("{{ end }}")
// For HTML tables
valuesSectionBuilder.WriteString(`
{{ define "chart.valueDefaultColumnRender" }}
{{- $defaultValue := (default .Default .AutoDefault) -}}
{{- $notationType := .NotationType }}
{{- if (and (hasPrefix "` + "`" + `" $defaultValue) (hasSuffix "` + "`" + `" $defaultValue) ) -}}
{{- $defaultValue = (toPrettyJson (fromJson (trimAll "` + "`" + `" (default .Default .AutoDefault) ) ) ) -}}
{{- $notationType = "json" }}
{{- end -}}
<pre lang="{{ $notationType }}">
{{- if (eq $notationType "tpl" ) }}
{{ .Key }}: |
{{- $defaultValue | nindent 2 }}
{{- else }}
{{ $defaultValue }}
{{- end }}
</pre>
{{ end }}
{{ define "chart.valuesTableHtml" }}
{{ if .Sections.Sections }}
{{- range .Sections.Sections }}
<h3>{{- .SectionName }}</h3>
<table>
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
{{- range .SectionItems }}
<tr>
<td>{{ .Key }}</td>
<td>{{ .Type }}</td>
<td>{{ template "chart.valueDefaultColumnRender" . }}</td>
<td>{{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}</td>
</tr>
{{- end }}
</tbody>
</table>
{{- end }}
{{ if .Sections.DefaultSection.SectionItems }}
<h3>{{- .Sections.DefaultSection.SectionName }}</h3>
<table>
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
{{- range .Sections.DefaultSection.SectionItems }}
<tr>
<td>{{ .Key }}</td>
<td>{{ .Type }}</td>
<td>{{ template "chart.valueDefaultColumnRender" . }}</td>
<td>{{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}</td>
</tr>
{{- end }}
</tbody>
</table>
{{ end }}
{{ else }}
<table>
<thead>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</thead>
<tbody>
{{- range .Values }}
<tr>
<td>{{ .Key }}</td>
<td>{{ .Type }}</td>
<td>{{ template "chart.valueDefaultColumnRender" . }}</td>
<td>{{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}</td>
</tr>
{{- end }}
</tbody>
</table>
{{ end }}
{{ end }}
{{ define "chart.valuesSectionHtml" }}
{{ if .Sections }}
{{ template "chart.valuesHeader" . }}
{{ template "chart.valuesTableHtml" . }}
{{ end }}
{{ end }}
`)
return valuesSectionBuilder.String()
}
func getHelmDocsVersionTemplates() string {
versionSectionBuilder := strings.Builder{}
versionSectionBuilder.WriteString(`{{ define "helm-docs.version" }}{{ if .HelmDocsVersion }}{{ .HelmDocsVersion }}{{ end }}{{ end }}`)
versionSectionBuilder.WriteString(`{{ define "helm-docs.versionFooter" }}`)
versionSectionBuilder.WriteString("{{ if .HelmDocsVersion }}\n")
versionSectionBuilder.WriteString("----------------------------------------------\n")
versionSectionBuilder.WriteString("Autogenerated from chart metadata using [helm-docs v{{ .HelmDocsVersion }}](https://github.com/norwoodj/helm-docs/releases/v{{ .HelmDocsVersion }})")
versionSectionBuilder.WriteString("{{ end }}")
versionSectionBuilder.WriteString("{{ end }}")
return versionSectionBuilder.String()
}
func getDocumentationTemplate(chartDirectory string, chartSearchRoot string, templateFiles []string) (string, error) {
templateFilesForChart := make([]string, 0)
var templateNotFound bool
for _, templateFile := range templateFiles {
var fullTemplatePath string
if util.IsRelativePath(templateFile) {
fullTemplatePath = filepath.Join(chartSearchRoot, templateFile)
} else if util.IsBaseFilename(templateFile) {
fullTemplatePath = filepath.Join(chartDirectory, templateFile)
} else {
fullTemplatePath = templateFile
}
if _, err := os.Stat(fullTemplatePath); os.IsNotExist(err) {
log.Debugf("Did not find template file %s for chart %s, using default template", templateFile, chartDirectory)
templateNotFound = true
continue
}
templateFilesForChart = append(templateFilesForChart, fullTemplatePath)
}
log.Debugf("Using template files %s for chart %s", templateFiles, chartDirectory)
allTemplateContents := make([]byte, 0)
for _, templateFileForChart := range templateFilesForChart {
templateContents, err := ioutil.ReadFile(templateFileForChart)
if err != nil {
return "", err
}
allTemplateContents = append(allTemplateContents, templateContents...)
}
if templateNotFound {
allTemplateContents = append(allTemplateContents, []byte(defaultDocumentationTemplate)...)
}
return string(allTemplateContents), nil
}
func getDocumentationTemplates(chartDirectory string, chartSearchRoot string, templateFiles []string, badgeStyle string) ([]string, error) {
documentationTemplate, err := getDocumentationTemplate(chartDirectory, chartSearchRoot, templateFiles)
if err != nil {
log.Errorf("Failed to read documentation template for chart %s: %s", chartDirectory, err)
return nil, err
}
return []string{
getNameTemplate(),
getHeaderTemplate(),
getDeprecatedTemplate(),
getAppVersionTemplate(badgeStyle),
getBadgesTemplates(),
getDescriptionTemplate(),
getVersionTemplates(badgeStyle),
getTypeTemplate(badgeStyle),
getSourceLinkTemplates(),
getRequirementsTableTemplates(),
getValuesTableTemplates(),
getHomepageTemplate(),
getMaintainersTemplate(),
getHelmDocsVersionTemplates(),
documentationTemplate,
}, nil
}
func newChartDocumentationTemplate(chartDocumentationInfo helm.ChartDocumentationInfo, chartSearchRoot string, templateFiles []string, badgeStyle string) (*template.Template, error) {
documentationTemplate := template.New(chartDocumentationInfo.ChartDirectory)
documentationTemplate.Funcs(util.FuncMap())
goTemplateList, err := getDocumentationTemplates(chartDocumentationInfo.ChartDirectory, chartSearchRoot, templateFiles, badgeStyle)
if err != nil {
return nil, err
}
for _, t := range goTemplateList {
_, err := documentationTemplate.Parse(t)
if err != nil {
return nil, err
}
}
return documentationTemplate, nil
}
07070100000186000081A4000000000000000000000001668BBBD2000002C4000000000000000000000000000000000000002F00000000helm-docs-1.14.2/pkg/document/template_test.gopackage document
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestGetDocumentationTemplate(t *testing.T) {
tpl, err := getDocumentationTemplate(".", ".", []string{"testdata/nonexistent.md.gotmpl"})
require.NoError(t, err)
assert.Equal(t, defaultDocumentationTemplate, tpl)
}
func TestGetDocumentationTemplate_LoadDefaultOnNotFound(t *testing.T) {
tpl, err := getDocumentationTemplate(".", ".", []string{
"testdata/README.md.gotmpl",
"testdata/nonexistent.md.gotmpl",
"testdata/README2.md.gotmpl",
})
const expected = "hello\nhello again\n" + defaultDocumentationTemplate
require.NoError(t, err)
assert.Equal(t, expected, tpl)
}
07070100000187000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002700000000helm-docs-1.14.2/pkg/document/testdata07070100000188000081A4000000000000000000000001668BBBD200000006000000000000000000000000000000000000003800000000helm-docs-1.14.2/pkg/document/testdata/README.md.gotmplhello
07070100000189000081A4000000000000000000000001668BBBD20000000C000000000000000000000000000000000000003900000000helm-docs-1.14.2/pkg/document/testdata/README2.md.gotmplhello again
0707010000018A000081A4000000000000000000000001668BBBD200000705000000000000000000000000000000000000002600000000helm-docs-1.14.2/pkg/document/util.gopackage document
import (
log "github.com/sirupsen/logrus"
"gopkg.in/yaml.v3"
)
const (
AlphaNumSortOrder = "alphanum"
FileSortOrder = "file"
)
// The json library can only marshal maps with string keys, and so all of our lists and maps that go into documentation
// must be converted to have only string keys before marshalling
func convertHelmValuesToJsonable(values *yaml.Node) interface{} {
switch values.Kind {
case yaml.MappingNode:
convertedMap := make(map[string]interface{})
for i := 0; i < len(values.Content); i += 2 {
k := values.Content[i]
v := values.Content[i+1]
convertedMap[k.Value] = convertHelmValuesToJsonable(v)
}
return convertedMap
case yaml.SequenceNode:
convertedList := make([]interface{}, 0)
for _, v := range values.Content {
convertedList = append(convertedList, convertHelmValuesToJsonable(v))
}
return convertedList
case yaml.AliasNode:
return convertHelmValuesToJsonable(values.Alias)
case yaml.ScalarNode:
switch values.Tag {
case nullTag:
return nil
case strTag:
fallthrough
case timestampTag:
return values.Value
case intTag:
var decodedValue int
err := values.Decode(&decodedValue)
if err != nil {
log.Errorf("Failed to decode value from yaml node value %s", values.Value)
return 0
}
return decodedValue
case floatTag:
var decodedValue float64
err := values.Decode(&decodedValue)
if err != nil {
log.Errorf("Failed to decode value from yaml node value %s", values.Value)
return 0
}
return decodedValue
case boolTag:
var decodedValue bool
err := values.Decode(&decodedValue)
if err != nil {
log.Errorf("Failed to decode value from yaml node value %s", values.Value)
return 0
}
return decodedValue
}
}
return nil
}
0707010000018B000081A4000000000000000000000001668BBBD200003757000000000000000000000000000000000000002800000000helm-docs-1.14.2/pkg/document/values.gopackage document
import (
"bytes"
"encoding/json"
"fmt"
"strings"
"github.com/norwoodj/helm-docs/pkg/helm"
"gopkg.in/yaml.v3"
)
const (
boolType = "bool"
floatType = "float"
intType = "int"
listType = "list"
objectType = "object"
stringType = "string"
yamlType = "yaml"
tplType = "tpl"
)
// Yaml tags that differentiate the type of scalar object in the node
const (
nullTag = "!!null"
boolTag = "!!bool"
strTag = "!!str"
intTag = "!!int"
floatTag = "!!float"
timestampTag = "!!timestamp"
)
func formatNextListKeyPrefix(prefix string, index int) string {
return fmt.Sprintf("%s[%d]", prefix, index)
}
func formatNextObjectKeyPrefix(prefix string, key string) string {
var escapedKey string
var nextPrefix string
if strings.Contains(key, ".") || strings.Contains(key, " ") {
escapedKey = fmt.Sprintf(`"%s"`, key)
} else {
escapedKey = key
}
if prefix != "" {
nextPrefix = fmt.Sprintf("%s.%s", prefix, escapedKey)
} else {
nextPrefix = fmt.Sprintf("%s", escapedKey)
}
return nextPrefix
}
func getTypeName(value interface{}) string {
switch value.(type) {
case bool:
return boolType
case float64:
return floatType
case int:
return intType
case string:
return stringType
case []interface{}:
return listType
case map[string]interface{}:
return objectType
}
return ""
}
func parseNilValueType(key string, description helm.ChartValueDescription, autoDescription helm.ChartValueDescription, column int, lineNumber int) valueRow {
if len(description.Description) == 0 {
description.Description = autoDescription.Description
}
var t string
if description.ValueType != "" {
t = description.ValueType
} else if autoDescription.ValueType != "" {
// Use whatever the type recognized by autoDescription parser
t = autoDescription.ValueType
} else {
t = stringType
}
// only set description.Default if no fallback (autoDescription.Default) is available
if description.Default == "" && autoDescription.Default == "" {
description.Default = "`nil`"
}
section := description.Section
if section == "" && autoDescription.Section != "" {
section = autoDescription.Section
}
return valueRow{
Key: key,
Type: t,
NotationType: autoDescription.NotationType,
AutoDefault: autoDescription.Default,
Default: description.Default,
AutoDescription: autoDescription.Description,
Description: description.Description,
Section: section,
Column: column,
LineNumber: lineNumber,
}
}
func jsonMarshalNoEscape(key string, value interface{}) (string, error) {
outputBuffer := &bytes.Buffer{}
valueEncoder := json.NewEncoder(outputBuffer)
valueEncoder.SetEscapeHTML(false)
err := valueEncoder.Encode(value)
if err != nil {
return "", fmt.Errorf("failed to marshal default value for %s to json: %s", key, err)
}
return strings.TrimRight(outputBuffer.String(), "\n"), nil
}
func getDescriptionFromNode(node *yaml.Node) helm.ChartValueDescription {
if node == nil {
return helm.ChartValueDescription{}
}
if node.HeadComment == "" {
return helm.ChartValueDescription{}
}
if !strings.Contains(node.HeadComment, helm.PrefixComment) {
return helm.ChartValueDescription{}
}
commentLines := strings.Split(node.HeadComment, "\n")
keyFromComment, c := helm.ParseComment(commentLines)
if keyFromComment != "" {
return helm.ChartValueDescription{}
}
return c
}
func createValueRow(
key string,
value interface{},
description helm.ChartValueDescription,
autoDescription helm.ChartValueDescription,
column int,
lineNumber int,
) (valueRow, error) {
if value == nil {
return parseNilValueType(key, description, autoDescription, column, lineNumber), nil
}
autoDefaultValue := autoDescription.Default
defaultValue := description.Default
notationType := autoDescription.NotationType
defaultType := getTypeName(value)
if description.ValueType != "" {
defaultType = description.ValueType
} else if autoDescription.ValueType != "" {
defaultType = autoDescription.ValueType
} else if notationType != "" {
// If nothing can be inferred then infer from notationType
defaultType = notationType
}
if defaultValue == "" && autoDefaultValue == "" && notationType == "" {
jsonEncodedValue, err := jsonMarshalNoEscape(key, value)
if err != nil {
return valueRow{}, fmt.Errorf("failed to marshal default value for %s to json: %s", key, err)
}
defaultValue = fmt.Sprintf("`%s`", jsonEncodedValue)
}
if defaultValue == "" && autoDefaultValue == "" && notationType != "" {
// We want to render custom styles for custom NotationType
// So, output a raw default value for this and let the template handle it
defaultValue = fmt.Sprintf("%s", value)
}
section := description.Section
if section == "" && autoDescription.Section != "" {
section = autoDescription.Section
}
return valueRow{
Key: key,
Type: defaultType,
NotationType: notationType,
AutoDefault: autoDescription.Default,
Default: defaultValue,
AutoDescription: autoDescription.Description,
Description: description.Description,
Section: section,
Column: column,
LineNumber: lineNumber,
}, nil
}
func createValueRowsFromList(
prefix string,
key *yaml.Node,
values *yaml.Node,
keysToDescriptions map[string]helm.ChartValueDescription,
documentLeafNodes bool,
) ([]valueRow, error) {
description, hasDescription := keysToDescriptions[prefix]
autoDescription := getDescriptionFromNode(key)
// If we encounter an empty list, it should be documented if no parent object or list had a description or if this
// list has a description
if len(values.Content) == 0 {
if !(documentLeafNodes || hasDescription || autoDescription.Description != "") {
return []valueRow{}, nil
}
emptyListRow, err := createValueRow(prefix, make([]interface{}, 0), description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
return []valueRow{emptyListRow}, nil
}
valueRows := make([]valueRow, 0)
// We have a nonempty list with a description, document it, and mark that leaf nodes underneath it should not be
// documented without descriptions
if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType == "") {
jsonableObject := convertHelmValuesToJsonable(values)
listRow, err := createValueRow(prefix, jsonableObject, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
valueRows = append(valueRows, listRow)
documentLeafNodes = false
} else if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType != "") {
// If it has NotationType described, then use that
var notationValue interface{}
var err error
var listRow valueRow
switch autoDescription.NotationType {
case yamlType:
notationValue, err = yaml.Marshal(values)
if err != nil {
return nil, err
}
listRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
default:
// Any other case means we let the template renderer to decide how to
// format the default value. But the value are stored as raw string
fallthrough
case tplType:
notationValue = values.Value
listRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
}
valueRows = append(valueRows, listRow)
documentLeafNodes = false
}
// Generate documentation rows for all list items and their potential sub-fields
for i, v := range values.Content {
nextPrefix := formatNextListKeyPrefix(prefix, i)
valueRowsForListField, err := createValueRowsFromField(nextPrefix, v, v, keysToDescriptions, documentLeafNodes)
if err != nil {
return nil, err
}
valueRows = append(valueRows, valueRowsForListField...)
}
return valueRows, nil
}
func createValueRowsFromObject(
nextPrefix string,
key *yaml.Node,
values *yaml.Node,
keysToDescriptions map[string]helm.ChartValueDescription,
documentLeafNodes bool,
) ([]valueRow, error) {
description, hasDescription := keysToDescriptions[nextPrefix]
autoDescription := getDescriptionFromNode(key)
if len(values.Content) == 0 {
// if the first level of recursion has no values, then there are no values at all, and so we return zero rows of documentation
if nextPrefix == "" {
return []valueRow{}, nil
}
// Otherwise, we have a leaf empty object node that should be documented if no object up the recursion chain had
// a description or if this object has a description
if !(documentLeafNodes || hasDescription || autoDescription.Description != "") {
return []valueRow{}, nil
}
documentedRow, err := createValueRow(nextPrefix, make(map[string]interface{}), description, autoDescription, key.Column, key.Line)
return []valueRow{documentedRow}, err
}
valueRows := make([]valueRow, 0)
// We have a nonempty object with a description, document it, and mark that leaf nodes underneath it should not be
// documented without descriptions
if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType == "") {
jsonableObject := convertHelmValuesToJsonable(values)
objectRow, err := createValueRow(nextPrefix, jsonableObject, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
valueRows = append(valueRows, objectRow)
documentLeafNodes = false
} else if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType != "") {
// If it has NotationType described, then use that
var notationValue interface{}
var err error
var objectRow valueRow
switch autoDescription.NotationType {
case yamlType:
notationValue, err = yaml.Marshal(values)
if err != nil {
return nil, err
}
objectRow, err = createValueRow(nextPrefix, notationValue, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
default:
// Any other case means we let the template renderer to decide how to
// format the default value. But the value are stored as raw string
fallthrough
case tplType:
notationValue = values.Value
objectRow, err = createValueRow(nextPrefix, notationValue, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
}
valueRows = append(valueRows, objectRow)
documentLeafNodes = false
}
for i := 0; i < len(values.Content); i += 2 {
k := values.Content[i]
v := values.Content[i+1]
nextPrefix := formatNextObjectKeyPrefix(nextPrefix, k.Value)
valueRowsForObjectField, err := createValueRowsFromField(nextPrefix, k, v, keysToDescriptions, documentLeafNodes)
if err != nil {
return nil, err
}
valueRows = append(valueRows, valueRowsForObjectField...)
}
return valueRows, nil
}
func createValueRowsFromField(
prefix string,
key *yaml.Node,
value *yaml.Node,
keysToDescriptions map[string]helm.ChartValueDescription,
documentLeafNodes bool,
) ([]valueRow, error) {
switch value.Kind {
case yaml.MappingNode:
return createValueRowsFromObject(prefix, key, value, keysToDescriptions, documentLeafNodes)
case yaml.SequenceNode:
return createValueRowsFromList(prefix, key, value, keysToDescriptions, documentLeafNodes)
case yaml.AliasNode:
return createValueRowsFromField(prefix, key, value.Alias, keysToDescriptions, documentLeafNodes)
case yaml.ScalarNode:
autoDescription := getDescriptionFromNode(key)
description, hasDescription := keysToDescriptions[prefix]
if !(documentLeafNodes || hasDescription || autoDescription.Description != "") {
return []valueRow{}, nil
}
switch value.Tag {
case nullTag:
leafValueRow, err := createValueRow(prefix, nil, description, autoDescription, key.Column, key.Line)
return []valueRow{leafValueRow}, err
case strTag:
// extra check to see if the node is a string, but @notationType was declared
if autoDescription.NotationType != "" {
var notationValue interface{}
var err error
var leafValueRow valueRow
switch autoDescription.NotationType {
case yamlType:
notationValue, err = yaml.Marshal(value)
if err != nil {
return nil, err
}
leafValueRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
return []valueRow{leafValueRow}, err
default:
// Any other case means we let the template renderer to decide how to
// format the default value. But the value are stored as raw string
fallthrough
case tplType:
notationValue = value.Value
leafValueRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)
if err != nil {
return nil, err
}
return []valueRow{leafValueRow}, err
}
}
fallthrough
case timestampTag:
leafValueRow, err := createValueRow(prefix, value.Value, description, autoDescription, key.Column, key.Line)
return []valueRow{leafValueRow}, err
case intTag:
var decodedValue int
err := value.Decode(&decodedValue)
if err != nil {
return []valueRow{}, err
}
leafValueRow, err := createValueRow(prefix, decodedValue, description, autoDescription, key.Column, key.Line)
return []valueRow{leafValueRow}, err
case floatTag:
var decodedValue float64
err := value.Decode(&decodedValue)
if err != nil {
return []valueRow{}, err
}
leafValueRow, err := createValueRow(prefix, decodedValue, description, autoDescription, key.Column, key.Line)
return []valueRow{leafValueRow}, err
case boolTag:
var decodedValue bool
err := value.Decode(&decodedValue)
if err != nil {
return []valueRow{}, err
}
leafValueRow, err := createValueRow(prefix, decodedValue, description, autoDescription, key.Column, key.Line)
return []valueRow{leafValueRow}, err
}
}
return []valueRow{}, fmt.Errorf("invalid node type %d received", value.Kind)
}
0707010000018C000081A4000000000000000000000001668BBBD20000E217000000000000000000000000000000000000002D00000000helm-docs-1.14.2/pkg/document/values_test.gopackage document
import (
"strings"
"testing"
"github.com/norwoodj/helm-docs/pkg/helm"
"github.com/stretchr/testify/assert"
"gopkg.in/yaml.v3"
)
func getSortedValuesTableRows(helmValues *yaml.Node, descriptions map[string]helm.ChartValueDescription) ([]valueRow, error) {
// Note: This getSortedValuesTableRows function was added as a shim when getSortedValuesTableRows
// was removed from the package. In the future it may make sense to rewrite the tests.
document := &yaml.Node{Kind: yaml.DocumentNode, Content: []*yaml.Node{helmValues}}
valueRows, err := getUnsortedValueRows(document, descriptions)
if err != nil {
return nil, err
}
sortValueRows(valueRows)
return valueRows, nil
}
func parseYamlValues(yamlValues string) *yaml.Node {
var chartValues yaml.Node
err := yaml.Unmarshal([]byte(strings.TrimSpace(yamlValues)), &chartValues)
if err != nil {
panic(err)
}
return chartValues.Content[0]
}
func TestEmptyValues(t *testing.T) {
helmValues := parseYamlValues(`{}`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 0)
}
func TestSimpleValues(t *testing.T) {
helmValues := parseYamlValues(`
echo: 0
foxtrot: true
hello: "world"
oscar: 3.14159
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "echo", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type, intType)
assert.Equal(t, "`0`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "foxtrot", valuesRows[1].Key)
assert.Equal(t, boolType, valuesRows[1].Type)
assert.Equal(t, "`true`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "hello", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`\"world\"`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "oscar", valuesRows[3].Key)
assert.Equal(t, floatType, valuesRows[3].Type)
assert.Equal(t, "`3.14159`", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
}
func TestSimpleValuesWithDescriptions(t *testing.T) {
helmValues := parseYamlValues(`
echo: 0
foxtrot: true
hello: "world"
oscar: 3.14159
`)
descriptions := map[string]helm.ChartValueDescription{
"echo": {Description: "echo"},
"foxtrot": {Description: "foxtrot"},
"hello": {Description: "hello"},
"oscar": {Description: "oscar"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "echo", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type, intType)
assert.Equal(t, "`0`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "echo", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "foxtrot", valuesRows[1].Key)
assert.Equal(t, boolType, valuesRows[1].Type)
assert.Equal(t, "`true`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "foxtrot", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "hello", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`\"world\"`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "hello", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "oscar", valuesRows[3].Key)
assert.Equal(t, floatType, valuesRows[3].Type)
assert.Equal(t, "`3.14159`", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "oscar", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
}
func TestSimpleValuesWithDescriptionsAndDefaults(t *testing.T) {
helmValues := parseYamlValues(`
echo: 0
foxtrot: true
hello: "world"
oscar: 3.14159
`)
descriptions := map[string]helm.ChartValueDescription{
"echo": {Description: "echo", Default: "some"},
"foxtrot": {Description: "foxtrot", Default: "explicit"},
"hello": {Description: "hello", Default: "default"},
"oscar": {Description: "oscar", Default: "values"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "echo", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type, intType)
assert.Equal(t, "some", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "echo", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "foxtrot", valuesRows[1].Key)
assert.Equal(t, boolType, valuesRows[1].Type)
assert.Equal(t, "explicit", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "foxtrot", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "hello", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "default", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "hello", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "oscar", valuesRows[3].Key)
assert.Equal(t, floatType, valuesRows[3].Type)
assert.Equal(t, "values", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "oscar", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
}
func TestRecursiveValues(t *testing.T) {
helmValues := parseYamlValues(`
recursive:
echo: cat
oscar: dog
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "oscar", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "recursive.echo", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestRecursiveValuesWithDescriptions(t *testing.T) {
helmValues := parseYamlValues(`
recursive:
echo: cat
oscar: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"recursive.echo": {Description: "echo"},
"oscar": {Description: "oscar"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "oscar", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "oscar", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "recursive.echo", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "echo", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestRecursiveValuesWithDescriptionsAndDefaults(t *testing.T) {
helmValues := parseYamlValues(`
recursive:
echo: cat
oscar: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"recursive.echo": {Description: "echo", Default: "custom"},
"oscar": {Description: "oscar", Default: "default"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "oscar", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "default", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "oscar", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "recursive.echo", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "custom", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "echo", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestEmptyObject(t *testing.T) {
helmValues := parseYamlValues(`
recursive: {}
oscar: dog
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "oscar", valuesRows[0].Key, "oscar")
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "recursive", valuesRows[1].Key)
assert.Equal(t, objectType, valuesRows[1].Type)
assert.Equal(t, "`{}`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestEmptyObjectWithDescription(t *testing.T) {
helmValues := parseYamlValues(`
recursive: {}
oscar: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"recursive": {Description: "an empty object"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "oscar", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "recursive", valuesRows[1].Key)
assert.Equal(t, objectType, valuesRows[1].Type)
assert.Equal(t, "`{}`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "an empty object", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestEmptyObjectWithDescriptionAndDefaults(t *testing.T) {
helmValues := parseYamlValues(`
recursive: {}
oscar: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"recursive": {Description: "an empty object", Default: "default"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "oscar", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "recursive", valuesRows[1].Key)
assert.Equal(t, objectType, valuesRows[1].Type)
assert.Equal(t, "default", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "an empty object", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestEmptyList(t *testing.T) {
helmValues := parseYamlValues(`
birds: []
echo: cat
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "birds", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "`[]`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "echo", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestEmptyListWithDescriptions(t *testing.T) {
helmValues := parseYamlValues(`
birds: []
echo: cat
`)
descriptions := map[string]helm.ChartValueDescription{
"birds": {Description: "birds"},
"echo": {Description: "echo"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "birds", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "`[]`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "birds", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "echo", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "echo", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestEmptyListWithDescriptionsAndDefaults(t *testing.T) {
helmValues := parseYamlValues(`
birds: []
echo: cat
`)
descriptions := map[string]helm.ChartValueDescription{
"birds": {Description: "birds", Default: "explicit"},
"echo": {Description: "echo", Default: "default value"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "birds", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "explicit", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "birds", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "echo", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "default value", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "echo", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestListOfStrings(t *testing.T) {
helmValues := parseYamlValues(`
cats: [echo, foxtrot]
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "cats[0]", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "cats[1]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestListOfStringsWithDescriptions(t *testing.T) {
helmValues := parseYamlValues(`
cats: [echo, foxtrot]
`)
descriptions := map[string]helm.ChartValueDescription{
"cats[0]": {Description: "the black one"},
"cats[1]": {Description: "the friendly one"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "cats[0]", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "the black one", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "cats[1]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "the friendly one", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestListOfStringsWithDescriptionsAndDefaults(t *testing.T) {
helmValues := parseYamlValues(`
cats: [echo, foxtrot]
`)
descriptions := map[string]helm.ChartValueDescription{
"cats[0]": {Description: "the black one", Default: "explicit"},
"cats[1]": {Description: "the friendly one", Default: "default value"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "cats[0]", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "explicit", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "the black one", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "cats[1]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "default value", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "the friendly one", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestListOfObjects(t *testing.T) {
helmValues := parseYamlValues(`
animals:
- elements: [echo, foxtrot]
type: cat
- elements: [oscar]
type: dog
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 5)
assert.Equal(t, "animals[0].elements[0]", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals[0].elements[1]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals[0].type", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`\"cat\"`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "animals[1].elements[0]", valuesRows[3].Key)
assert.Equal(t, stringType, valuesRows[3].Type)
assert.Equal(t, "`\"oscar\"`", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
assert.Equal(t, "animals[1].type", valuesRows[4].Key)
assert.Equal(t, stringType, valuesRows[4].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[4].Default)
assert.Equal(t, "", valuesRows[4].AutoDefault)
assert.Equal(t, "", valuesRows[4].Description)
assert.Equal(t, "", valuesRows[4].AutoDescription)
}
func TestListOfObjectsWithDescriptions(t *testing.T) {
helmValues := parseYamlValues(`
animals:
- elements: [echo, foxtrot]
type: cat
- elements: [oscar]
type: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"animals[0].elements[0]": {Description: "the black one"},
"animals[0].elements[1]": {Description: "the friendly one"},
"animals[1].elements[0]": {Description: "the sleepy one"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 5)
assert.Equal(t, "animals[0].elements[0]", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "the black one", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals[0].elements[1]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "the friendly one", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals[0].type", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`\"cat\"`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "animals[1].elements[0]", valuesRows[3].Key)
assert.Equal(t, stringType, valuesRows[3].Type)
assert.Equal(t, "`\"oscar\"`", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "the sleepy one", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
assert.Equal(t, "animals[1].type", valuesRows[4].Key)
assert.Equal(t, stringType, valuesRows[4].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[4].Default)
assert.Equal(t, "", valuesRows[4].AutoDefault)
assert.Equal(t, "", valuesRows[4].Description)
assert.Equal(t, "", valuesRows[4].AutoDescription)
}
func TestListOfObjectsWithDescriptionsAndDefaults(t *testing.T) {
helmValues := parseYamlValues(`
animals:
- elements: [echo, foxtrot]
type: cat
- elements: [oscar]
type: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"animals[0].elements[0]": {Description: "the black one", Default: "explicit"},
"animals[0].elements[1]": {Description: "the friendly one", Default: "default"},
"animals[1].elements[0]": {Description: "the sleepy one", Default: "value"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 5)
assert.Equal(t, "animals[0].elements[0]", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "explicit", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "the black one", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals[0].elements[1]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "default", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "the friendly one", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals[0].type", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`\"cat\"`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "animals[1].elements[0]", valuesRows[3].Key)
assert.Equal(t, stringType, valuesRows[3].Type)
assert.Equal(t, "value", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "the sleepy one", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
assert.Equal(t, "animals[1].type", valuesRows[4].Key)
assert.Equal(t, stringType, valuesRows[4].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[4].Default)
assert.Equal(t, "", valuesRows[4].AutoDefault)
assert.Equal(t, "", valuesRows[4].Description)
assert.Equal(t, "", valuesRows[4].AutoDescription)
}
func TestDescriptionOnList(t *testing.T) {
helmValues := parseYamlValues(`
animals:
- elements: [echo, foxtrot]
type: cat
- elements: [oscar]
type: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"animals": {Description: "all the animals of the house"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 1)
assert.Equal(t, "animals", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "`[{\"elements\":[\"echo\",\"foxtrot\"],\"type\":\"cat\"},{\"elements\":[\"oscar\"],\"type\":\"dog\"}]`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "all the animals of the house", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
}
func TestDescriptionAndDefaultOnList(t *testing.T) {
helmValues := parseYamlValues(`
animals:
- elements: [echo, foxtrot]
type: cat
- elements: [oscar]
type: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"animals": {Description: "all the animals of the house", Default: "cat and dog"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 1)
assert.Equal(t, "animals", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "cat and dog", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "all the animals of the house", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
}
func TestDescriptionAndDefaultOnObjectUnderList(t *testing.T) {
helmValues := parseYamlValues(`
animals:
- elements: [echo, foxtrot]
type: cat
- elements: [oscar]
type: dog
`)
descriptions := map[string]helm.ChartValueDescription{
"animals[0]": {Description: "all the cats of the house", Default: "only cats here"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 3)
assert.Equal(t, "animals[0]", valuesRows[0].Key)
assert.Equal(t, objectType, valuesRows[0].Type)
assert.Equal(t, "only cats here", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "all the cats of the house", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals[1].elements[0]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"oscar\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals[1].type", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`\"dog\"`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
}
func TestDescriptionOnObjectUnderObject(t *testing.T) {
helmValues := parseYamlValues(`
animals:
byTrait:
friendly: [foxtrot, oscar]
mean: [echo]
sleepy: [oscar]
`)
descriptions := map[string]helm.ChartValueDescription{
"animals.byTrait": {Description: "animals listed by their various characteristics"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 1)
assert.Equal(t, "animals.byTrait", valuesRows[0].Key)
assert.Equal(t, objectType, valuesRows[0].Type)
assert.Equal(t, "`{\"friendly\":[\"foxtrot\",\"oscar\"],\"mean\":[\"echo\"],\"sleepy\":[\"oscar\"]}`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "animals listed by their various characteristics", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
}
func TestDescriptionAndDefaultOnObjectUnderObject(t *testing.T) {
helmValues := parseYamlValues(`
animals:
byTrait:
friendly: [foxtrot, oscar]
mean: [echo]
sleepy: [oscar]
`)
descriptions := map[string]helm.ChartValueDescription{
"animals.byTrait": {Description: "animals listed by their various characteristics", Default: "animals, you know"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 1)
assert.Equal(t, "animals.byTrait", valuesRows[0].Key)
assert.Equal(t, objectType, valuesRows[0].Type)
assert.Equal(t, "animals, you know", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "animals listed by their various characteristics", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
}
func TestDescriptionsDownChain(t *testing.T) {
helmValues := parseYamlValues(`
animals:
byTrait:
friendly: [foxtrot, oscar]
mean: [echo]
sleepy: [oscar]
`)
descriptions := map[string]helm.ChartValueDescription{
"animals": {Description: "animal stuff"},
"animals.byTrait": {Description: "animals listed by their various characteristics"},
"animals.byTrait.friendly": {Description: "the friendly animals of the house"},
"animals.byTrait.friendly[0]": {Description: "best cat ever"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "animals", valuesRows[0].Key)
assert.Equal(t, objectType, valuesRows[0].Type)
assert.Equal(t, "`{\"byTrait\":{\"friendly\":[\"foxtrot\",\"oscar\"],\"mean\":[\"echo\"],\"sleepy\":[\"oscar\"]}}`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "animal stuff", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.byTrait", valuesRows[1].Key)
assert.Equal(t, objectType, valuesRows[1].Type)
assert.Equal(t, "`{\"friendly\":[\"foxtrot\",\"oscar\"],\"mean\":[\"echo\"],\"sleepy\":[\"oscar\"]}`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "animals listed by their various characteristics", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals.byTrait.friendly", valuesRows[2].Key)
assert.Equal(t, listType, valuesRows[2].Type)
assert.Equal(t, "`[\"foxtrot\",\"oscar\"]`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "the friendly animals of the house", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "animals.byTrait.friendly[0]", valuesRows[3].Key)
assert.Equal(t, stringType, valuesRows[3].Type)
assert.Equal(t, "`\"foxtrot\"`", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "best cat ever", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
}
func TestDescriptionsAndDefaultsDownChain(t *testing.T) {
helmValues := parseYamlValues(`
animals:
byTrait:
friendly: [foxtrot, oscar]
mean: [echo]
sleepy: [oscar]
`)
descriptions := map[string]helm.ChartValueDescription{
"animals": {Description: "animal stuff", Default: "some"},
"animals.byTrait": {Description: "animals listed by their various characteristics", Default: "explicit"},
"animals.byTrait.friendly": {Description: "the friendly animals of the house", Default: "default"},
"animals.byTrait.friendly[0]": {Description: "best cat ever", Default: "value"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "animals", valuesRows[0].Key)
assert.Equal(t, objectType, valuesRows[0].Type)
assert.Equal(t, "some", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "animal stuff", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.byTrait", valuesRows[1].Key)
assert.Equal(t, objectType, valuesRows[1].Type)
assert.Equal(t, "explicit", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "animals listed by their various characteristics", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals.byTrait.friendly", valuesRows[2].Key)
assert.Equal(t, listType, valuesRows[2].Type)
assert.Equal(t, "default", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "the friendly animals of the house", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "animals.byTrait.friendly[0]", valuesRows[3].Key)
assert.Equal(t, stringType, valuesRows[3].Type)
assert.Equal(t, "value", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "best cat ever", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
}
func TestNilValues(t *testing.T) {
helmValues := parseYamlValues(`
animals:
birds:
birdCount:
nonWeirdCats:
undescribedCount:
`)
descriptions := map[string]helm.ChartValueDescription{
"animals.birdCount": {ValueType: intType, Description: "the number of birds we have"},
"animals.birds": {ValueType: listType, Description: "the list of birds we have"},
"animals.nonWeirdCats": {Description: "the cats that we have that are not weird"},
"animals.undescribedCount": {ValueType: intType, Description: ""},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "animals.birdCount", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type)
assert.Equal(t, "`nil`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "the number of birds we have", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.birds", valuesRows[1].Key)
assert.Equal(t, listType, valuesRows[1].Type)
assert.Equal(t, "`nil`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "the list of birds we have", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals.nonWeirdCats", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`nil`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "the cats that we have that are not weird", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "animals.undescribedCount", valuesRows[3].Key)
assert.Equal(t, intType, valuesRows[3].Type)
assert.Equal(t, "`nil`", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "", valuesRows[3].Description)
assert.Equal(t, "", valuesRows[3].AutoDescription)
}
func TestNilValuesWithDefaults(t *testing.T) {
helmValues := parseYamlValues(`
animals:
birds:
birdCount:
nonWeirdCats:
`)
descriptions := map[string]helm.ChartValueDescription{
"animals.birdCount": {ValueType: intType, Description: "the number of birds we have", Default: "some"},
"animals.birds": {ValueType: listType, Description: "the list of birds we have", Default: "explicit"},
"animals.nonWeirdCats": {Description: "the cats that we have that are not weird", Default: "default"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 3)
assert.Equal(t, "animals.birdCount", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type)
assert.Equal(t, "some", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "the number of birds we have", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.birds", valuesRows[1].Key)
assert.Equal(t, listType, valuesRows[1].Type)
assert.Equal(t, "explicit", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "the list of birds we have", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
assert.Equal(t, "animals.nonWeirdCats", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "default", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "the cats that we have that are not weird", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
}
func TestKeysWithSpecialCharacters(t *testing.T) {
helmValues := parseYamlValues(`
websites:
stupidchess.jmn23.com: defunct
fullNames:
John Norwood: me
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, `fullNames."John Norwood"`, valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"me\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, `websites."stupidchess.jmn23.com"`, valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"defunct\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestKeysWithSpecialCharactersWithDescriptions(t *testing.T) {
helmValues := parseYamlValues(`
websites:
stupidchess.jmn23.com: defunct
fullNames:
John Norwood: me
`)
descriptions := map[string]helm.ChartValueDescription{
`fullNames."John Norwood"`: {Description: "who am I"},
`websites."stupidchess.jmn23.com"`: {Description: "status of the stupidchess website"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, `fullNames."John Norwood"`, valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"me\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "who am I", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, `websites."stupidchess.jmn23.com"`, valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"defunct\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "status of the stupidchess website", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestKeysWithSpecialCharactersWithDescriptionsAndDefaults(t *testing.T) {
helmValues := parseYamlValues(`
websites:
stupidchess.jmn23.com: defunct
fullNames:
John Norwood: me
`)
descriptions := map[string]helm.ChartValueDescription{
`fullNames."John Norwood"`: {Description: "who am I", Default: "default"},
`websites."stupidchess.jmn23.com"`: {Description: "status of the stupidchess website", Default: "value"},
}
valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, `fullNames."John Norwood"`, valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "default", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "who am I", valuesRows[0].Description)
assert.Equal(t, "", valuesRows[0].AutoDescription)
assert.Equal(t, `websites."stupidchess.jmn23.com"`, valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "value", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "status of the stupidchess website", valuesRows[1].Description)
assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestSimpleAutoDoc(t *testing.T) {
helmValues := parseYamlValues(`
# -- on a scale of 0 to 9 how mean is echo
echo: 8
# -- is she friendly?
foxtrot: true
# doesn't show up
hello: "world"
# -- his favorite food in number format
oscar: 3.14159
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "echo", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type, intType)
assert.Equal(t, "`8`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "on a scale of 0 to 9 how mean is echo", valuesRows[0].AutoDescription)
assert.Equal(t, "foxtrot", valuesRows[1].Key)
assert.Equal(t, boolType, valuesRows[1].Type)
assert.Equal(t, "`true`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "is she friendly?", valuesRows[1].AutoDescription)
assert.Equal(t, "hello", valuesRows[2].Key)
assert.Equal(t, stringType, valuesRows[2].Type)
assert.Equal(t, "`\"world\"`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "", valuesRows[2].AutoDescription)
assert.Equal(t, "oscar", valuesRows[3].Key)
assert.Equal(t, floatType, valuesRows[3].Type)
assert.Equal(t, "`3.14159`", valuesRows[3].Default)
assert.Equal(t, "", valuesRows[3].AutoDefault)
assert.Equal(t, "", valuesRows[3].Description)
assert.Equal(t, "his favorite food in number format", valuesRows[3].AutoDescription)
}
func TestAutoDocNested(t *testing.T) {
helmValues := parseYamlValues(`
animals:
cats:
# -- on a scale of 0 to 9 how mean is echo
echo: 8
# -- is she friendly?
foxtrot: true
dogs:
# -- his favorite food in number format
oscar: 3.14159
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 3)
assert.Equal(t, "animals.cats.echo", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type, intType)
assert.Equal(t, "`8`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "on a scale of 0 to 9 how mean is echo", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.cats.foxtrot", valuesRows[1].Key)
assert.Equal(t, boolType, valuesRows[1].Type)
assert.Equal(t, "`true`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "is she friendly?", valuesRows[1].AutoDescription)
assert.Equal(t, "animals.dogs.oscar", valuesRows[2].Key)
assert.Equal(t, floatType, valuesRows[2].Type)
assert.Equal(t, "`3.14159`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "his favorite food in number format", valuesRows[2].AutoDescription)
}
func TestAutoDocList(t *testing.T) {
helmValues := parseYamlValues(`
animals:
cats:
# -- best cat, really
- echo
# -- trash cat, really
- foxtrot
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "animals.cats[0]", valuesRows[0].Key)
assert.Equal(t, stringType, valuesRows[0].Type)
assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "best cat, really", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.cats[1]", valuesRows[1].Key)
assert.Equal(t, stringType, valuesRows[1].Type)
assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "trash cat, really", valuesRows[1].AutoDescription)
}
func TestAutoDocListOfObjects(t *testing.T) {
helmValues := parseYamlValues(`
animalLocations:
# -- place with the most cats
- place: home
cats:
- echo
- foxtrot
# -- place with the fewest cats
- place: work
cats: []
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "animalLocations[0]", valuesRows[0].Key)
assert.Equal(t, objectType, valuesRows[0].Type)
assert.Equal(t, "`{\"cats\":[\"echo\",\"foxtrot\"],\"place\":\"home\"}`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "place with the most cats", valuesRows[0].AutoDescription)
assert.Equal(t, "animalLocations[1]", valuesRows[1].Key)
assert.Equal(t, objectType, valuesRows[1].Type)
assert.Equal(t, "`{\"cats\":[],\"place\":\"work\"}`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "place with the fewest cats", valuesRows[1].AutoDescription)
}
func TestAutoMultilineDescription(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- The best kind of animal probably, allow me to list their many varied benefits.
# Cats are very funny, and quite friendly, in almost all cases
# @default -- The list of cats that _I_ own
cats:
- echo
- foxtrot
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 1)
assert.Equal(t, "animals.cats", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "The list of cats that _I_ own", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "The best kind of animal probably, allow me to list their many varied benefits. Cats are very funny, and quite friendly, in almost all cases", valuesRows[0].AutoDescription)
}
func TestAutoMultilineDescriptionWithoutValue(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- (list) I mean, dogs are quite nice too...
# @default -- The list of dogs that _I_ own
dogs:
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 1)
assert.Equal(t, "animals.dogs", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "The list of dogs that _I_ own", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Default)
assert.Equal(t, "I mean, dogs are quite nice too...", valuesRows[0].Description)
}
func TestMulticomment1(t *testing.T) {
helmValues := parseYamlValues(`
# -- before desc
before: 1
# -- commented desc
#commented:
# -- after desc
after: 3
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "before", valuesRows[1].Key)
assert.Equal(t, intType, valuesRows[1].Type, intType)
assert.Equal(t, "`1`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "before desc", valuesRows[1].AutoDescription)
assert.Equal(t, "after", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type)
assert.Equal(t, "`3`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "after desc", valuesRows[0].AutoDescription)
}
func TestMulticomment2(t *testing.T) {
helmValues := parseYamlValues(`
# -- before desc
before: 1
# -- this should show up
hasInnerComment: {}
# -- this should not
# show up
# innerField: 1
# -- after desc
after: 3
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 3)
assert.Equal(t, "before", valuesRows[1].Key)
assert.Equal(t, intType, valuesRows[1].Type, intType)
assert.Equal(t, "`1`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "before desc", valuesRows[1].AutoDescription)
assert.Equal(t, "hasInnerComment", valuesRows[2].Key)
assert.Equal(t, objectType, valuesRows[2].Type, intType)
assert.Equal(t, "`{}`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "this should show up", valuesRows[2].AutoDescription)
assert.Equal(t, "after", valuesRows[0].Key)
assert.Equal(t, intType, valuesRows[0].Type)
assert.Equal(t, "`3`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "after desc", valuesRows[0].AutoDescription)
}
func TestIgnoreCommentedFields(t *testing.T) {
helmValues := parseYamlValues(`
# -- Qux!
qux: 1
# must not appear
# must not appear too
foo:
# -- Bar!
bar: true
# -- Baz!
baz: false
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 3)
assert.Equal(t, "qux", valuesRows[2].Key)
assert.Equal(t, intType, valuesRows[2].Type)
assert.Equal(t, "`1`", valuesRows[2].Default)
assert.Equal(t, "", valuesRows[2].AutoDefault)
assert.Equal(t, "", valuesRows[2].Description)
assert.Equal(t, "Qux!", valuesRows[2].AutoDescription)
assert.Equal(t, "foo.baz", valuesRows[1].Key)
assert.Equal(t, boolType, valuesRows[1].Type)
assert.Equal(t, "`false`", valuesRows[1].Default)
assert.Equal(t, "", valuesRows[1].AutoDefault)
assert.Equal(t, "", valuesRows[1].Description)
assert.Equal(t, "Baz!", valuesRows[1].AutoDescription)
assert.Equal(t, "foo.bar", valuesRows[0].Key)
assert.Equal(t, boolType, valuesRows[0].Type)
assert.Equal(t, "`true`", valuesRows[0].Default)
assert.Equal(t, "", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Description)
assert.Equal(t, "Bar!", valuesRows[0].AutoDescription)
}
func TestMultilineRawDescription(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- (list) I mean, dogs are quite nice too...
# @raw
#
# List of default dogs:
# - Umbra
# - Penumbra
# - Somnus
#
# @default -- The list of dogs that _I_ own
dogs:
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 1)
assert.Equal(t, "animals.dogs", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, "The list of dogs that _I_ own", valuesRows[0].AutoDefault)
assert.Equal(t, "", valuesRows[0].Default)
assert.Equal(t, "I mean, dogs are quite nice too...\n\nList of default dogs:\n - Umbra\n - Penumbra\n - Somnus\n", valuesRows[0].Description)
}
func TestExtractValueNotationType(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- (list) My animals lists
# @notationType -- yaml
cats:
- mike
- ralph
# -- (list) My animal lists, but in tpl string
# @notationType -- tpl
catsInTpl: |
{{- .Values.animals.cats }}
# -- (object) Declaring object as tpl (to be cascaded with tpl function)
# @notationType -- tpl
dinosaur: |
name: hockney
dynamicVar: {{ .Values.fromOtherProperty }}
# -- (object) Declaring object as yaml
# @notationType -- yaml
fish:
name: nomoby
# -- (list) Declaring object as yaml with null value
# @notationType -- yaml
lizards:
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 5)
assert.Equal(t, "animals.cats", valuesRows[0].Key)
assert.Equal(t, listType, valuesRows[0].Type)
assert.Equal(t, yamlType, valuesRows[0].NotationType)
assert.Equal(t, "- mike\n- ralph\n", valuesRows[0].Default)
assert.Equal(t, "My animals lists", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.catsInTpl", valuesRows[1].Key)
assert.Equal(t, listType, valuesRows[1].Type)
assert.Equal(t, tplType, valuesRows[1].NotationType)
assert.Equal(t, "{{- .Values.animals.cats }}\n", valuesRows[1].Default)
assert.Equal(t, "My animal lists, but in tpl string", valuesRows[1].AutoDescription)
assert.Equal(t, "animals.dinosaur", valuesRows[2].Key)
assert.Equal(t, objectType, valuesRows[2].Type)
assert.Equal(t, tplType, valuesRows[2].NotationType)
assert.Equal(t, "name: hockney\ndynamicVar: {{ .Values.fromOtherProperty }}\n", valuesRows[2].Default)
assert.Equal(t, "Declaring object as tpl (to be cascaded with tpl function)", valuesRows[2].AutoDescription)
assert.Equal(t, "animals.fish", valuesRows[3].Key)
assert.Equal(t, objectType, valuesRows[3].Type)
assert.Equal(t, yamlType, valuesRows[3].NotationType)
assert.Equal(t, "name: nomoby\n", valuesRows[3].Default)
assert.Equal(t, "My animals lists", valuesRows[0].AutoDescription)
assert.Equal(t, "animals.lizards", valuesRows[4].Key)
assert.Equal(t, listType, valuesRows[4].Type)
assert.Equal(t, yamlType, valuesRows[4].NotationType)
}
func TestExtractCustomDeclaredType(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- (list/csv) My animals lists but annotated as csv field
cats: mike,ralph
owner:
# -- (string/email) This has to be email address
# @notationType -- email
email: "owner@home.org"
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "animals.cats", valuesRows[0].Key)
// With custom value type, we can convey to the reader that this value is a list, but in a csv format
assert.Equal(t, "list/csv", valuesRows[0].Type)
assert.Equal(t, "`\"mike,ralph\"`", valuesRows[0].Default)
assert.Equal(t, "My animals lists but annotated as csv field", valuesRows[0].AutoDescription)
assert.Equal(t, "owner.email", valuesRows[1].Key)
assert.Equal(t, "string/email", valuesRows[1].Type)
assert.Equal(t, "email", valuesRows[1].NotationType)
// In case of custom notation type, value in Default must be raw string
// So that template can handle the formatting.
// In this case, email might be reformatted as <a href="mailto:owner@home.org">owner@home.org</a>
assert.Equal(t, "owner@home.org", valuesRows[1].Default)
assert.Equal(t, "This has to be email address", valuesRows[1].AutoDescription)
}
func TestSection(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- This describes a lion
# @section -- Feline Section
lion:
# -- This describes a cat
# @section -- Feline Section
cat:
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 2)
assert.Equal(t, "animals.cat", valuesRows[0].Key)
assert.Equal(t, "This describes a cat", valuesRows[0].AutoDescription)
assert.Equal(t, "Feline Section", valuesRows[0].Section)
assert.Equal(t, "animals.lion", valuesRows[1].Key)
assert.Equal(t, "This describes a lion", valuesRows[1].AutoDescription)
assert.Equal(t, "Feline Section", valuesRows[1].Section)
}
func TestSectionWithAnnotations(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- This describes a lion
# @default -- Rawr
# @section -- Feline Section
lion:
# -- This describes a cat
# @raw
# -Rawr
# @section -- Feline Section
cat:
# -- (int) This describes a leopard
# @section -- Feline Section
leopard:
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 3)
assert.Equal(t, "animals.cat", valuesRows[0].Key)
assert.Equal(t, "This describes a cat\n-Rawr", valuesRows[0].AutoDescription)
assert.Equal(t, "Feline Section", valuesRows[0].Section)
assert.Equal(t, "animals.leopard", valuesRows[1].Key)
assert.Equal(t, "int", valuesRows[1].Type)
assert.Equal(t, "This describes a leopard", valuesRows[1].AutoDescription)
assert.Equal(t, "Feline Section", valuesRows[1].Section)
assert.Equal(t, "animals.lion", valuesRows[2].Key)
assert.Equal(t, "This describes a lion", valuesRows[2].AutoDescription)
assert.Equal(t, "Rawr", valuesRows[2].AutoDefault)
assert.Equal(t, "Feline Section", valuesRows[2].Section)
}
func TestDifferentSections(t *testing.T) {
helmValues := parseYamlValues(`
animals:
# -- This describes a lion
# @default -- Rawr
# @section -- Feline Section
lion:
# -- This describes a cow
# @raw
# - Moooe
# @section -- Cow Section
cow:
# -- (int) This describes a leopard
# @section -- Feline Section
leopard:
# -- This describes a cougar
# @section -- Feline Section
cougar:
`)
valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
assert.Nil(t, err)
assert.Len(t, valuesRows, 4)
assert.Equal(t, "animals.cougar", valuesRows[0].Key)
assert.Equal(t, "This describes a cougar", valuesRows[0].AutoDescription)
assert.Equal(t, "Feline Section", valuesRows[0].Section)
assert.Equal(t, "animals.cow", valuesRows[1].Key)
assert.Equal(t, "This describes a cow\n- Moooe", valuesRows[1].AutoDescription)
assert.Equal(t, "Cow Section", valuesRows[1].Section)
assert.Equal(t, "animals.leopard", valuesRows[2].Key)
assert.Equal(t, "int", valuesRows[2].Type)
assert.Equal(t, "This describes a leopard", valuesRows[2].AutoDescription)
assert.Equal(t, "Feline Section", valuesRows[3].Section)
assert.Equal(t, "animals.lion", valuesRows[3].Key)
assert.Equal(t, "This describes a lion", valuesRows[3].AutoDescription)
assert.Equal(t, "Rawr", valuesRows[3].AutoDefault)
assert.Equal(t, "Feline Section", valuesRows[3].Section)
}
0707010000018D000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001A00000000helm-docs-1.14.2/pkg/helm0707010000018E000081A4000000000000000000000001668BBBD200000427000000000000000000000000000000000000002A00000000helm-docs-1.14.2/pkg/helm/chart_finder.gopackage helm
import (
"os"
"path/filepath"
"github.com/norwoodj/helm-docs/pkg/util"
log "github.com/sirupsen/logrus"
"github.com/spf13/viper"
)
func FindChartDirectories(chartSearchRoot string) ([]string, error) {
ignoreFilename := viper.GetString("ignore-file")
ignoreContext := util.NewIgnoreContext(ignoreFilename)
chartDirs := make([]string, 0)
err := filepath.Walk(chartSearchRoot, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
absolutePath, _ := filepath.Abs(path)
if info.IsDir() && ignoreContext.ShouldIgnore(absolutePath, info) {
log.Debugf("Ignoring directory %s", path)
return filepath.SkipDir
}
if filepath.Base(path) == "Chart.yaml" {
if ignoreContext.ShouldIgnore(absolutePath, info) {
log.Debugf("Ignoring chart file %s", path)
return nil
}
relativeChartDir, err := filepath.Rel(chartSearchRoot, filepath.Dir(path))
if err != nil {
return err
}
chartDirs = append(chartDirs, relativeChartDir)
}
return nil
})
return chartDirs, err
}
0707010000018F000081A4000000000000000000000001668BBBD200002A4F000000000000000000000000000000000000002800000000helm-docs-1.14.2/pkg/helm/chart_info.gopackage helm
import (
"bufio"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"regexp"
"sort"
"strings"
log "github.com/sirupsen/logrus"
"github.com/spf13/viper"
"gopkg.in/yaml.v3"
)
var valuesDescriptionRegex = regexp.MustCompile("^\\s*#\\s*(.*)\\s+--\\s*(.*)$")
var rawDescriptionRegex = regexp.MustCompile("^\\s*#\\s+@raw")
var commentContinuationRegex = regexp.MustCompile("^\\s*#(\\s?)(.*)$")
var defaultValueRegex = regexp.MustCompile("^\\s*# @default -- (.*)$")
var valueTypeRegex = regexp.MustCompile("^\\((.*?)\\)\\s*(.*)$")
var valueNotationTypeRegex = regexp.MustCompile("^\\s*#\\s+@notationType\\s+--\\s+(.*)$")
var sectionRegex = regexp.MustCompile("^\\s*# @section -- (.*)$")
type ChartMetaMaintainer struct {
Email string
Name string
Url string
}
type ChartMeta struct {
ApiVersion string `yaml:"apiVersion"`
AppVersion string `yaml:"appVersion"`
KubeVersion string `yaml:"kubeVersion"`
Name string
Deprecated bool
Description string
Version string
Home string
Type string
Sources []string
Engine string
Maintainers []ChartMetaMaintainer
}
type ChartRequirementsItem struct {
Name string
Version string
Repository string
Alias string
}
type ChartRequirements struct {
Dependencies []ChartRequirementsItem
}
type ChartValueDescription struct {
Description string
Default string
Section string
ValueType string
NotationType string
}
type ChartDocumentationInfo struct {
ChartMeta
ChartRequirements
ChartDirectory string
ChartValues *yaml.Node
ChartValuesDescriptions map[string]ChartValueDescription
}
type ChartValuesDocumentationParsingConfig struct {
StrictMode bool
AllowedMissingValuePaths []string
AllowedMissingValueRegexps []*regexp.Regexp
}
func getYamlFileContents(filename string) ([]byte, error) {
if _, err := os.Stat(filename); os.IsNotExist(err) {
return nil, err
}
yamlFileContents, err := ioutil.ReadFile(filename)
if err != nil {
panic(err)
}
return []byte(strings.Replace(string(yamlFileContents), "\r\n", "\n", -1)), nil
}
func isErrorInReadingNecessaryFile(filePath string, loadError error) bool {
if loadError != nil {
if os.IsNotExist(loadError) {
log.Warnf("Required chart file %s missing. Skipping documentation for chart", filePath)
return true
} else {
log.Warnf("Error occurred in reading chart file %s. Skipping documentation for chart", filePath)
return true
}
}
return false
}
func parseChartFile(chartDirectory string) (ChartMeta, error) {
chartYamlPath := filepath.Join(chartDirectory, "Chart.yaml")
chartMeta := ChartMeta{}
yamlFileContents, err := getYamlFileContents(chartYamlPath)
if isErrorInReadingNecessaryFile(chartYamlPath, err) {
return chartMeta, err
}
err = yaml.Unmarshal(yamlFileContents, &chartMeta)
return chartMeta, err
}
func requirementKey(requirement ChartRequirementsItem) string {
return fmt.Sprintf("%s/%s", requirement.Repository, requirement.Name)
}
func parseChartRequirementsFile(chartDirectory string, apiVersion string) (ChartRequirements, error) {
var requirementsPath string
if apiVersion == "v1" {
requirementsPath = filepath.Join(chartDirectory, "requirements.yaml")
if _, err := os.Stat(requirementsPath); os.IsNotExist(err) {
return ChartRequirements{Dependencies: []ChartRequirementsItem{}}, nil
}
} else {
requirementsPath = filepath.Join(chartDirectory, "Chart.yaml")
}
chartRequirements := ChartRequirements{}
yamlFileContents, err := getYamlFileContents(requirementsPath)
if isErrorInReadingNecessaryFile(requirementsPath, err) {
return chartRequirements, err
}
err = yaml.Unmarshal(yamlFileContents, &chartRequirements)
if err != nil {
return chartRequirements, err
}
sort.Slice(chartRequirements.Dependencies[:], func(i, j int) bool {
return requirementKey(chartRequirements.Dependencies[i]) < requirementKey(chartRequirements.Dependencies[j])
})
return chartRequirements, nil
}
func removeIgnored(rootNode *yaml.Node, parentKind yaml.Kind) {
newContent := make([]*yaml.Node, 0, len(rootNode.Content))
for i := 0; i < len(rootNode.Content); i++ {
node := rootNode.Content[i]
if !strings.Contains(node.HeadComment, "@ignore") {
removeIgnored(node, node.Kind)
newContent = append(newContent, node)
} else if parentKind == yaml.MappingNode {
// for parentKind each yaml key is represented by two nodes
i++
}
}
rootNode.Content = newContent
}
func parseChartValuesFile(chartDirectory string) (yaml.Node, error) {
valuesPath := filepath.Join(chartDirectory, viper.GetString("values-file"))
yamlFileContents, err := getYamlFileContents(valuesPath)
var values yaml.Node
if isErrorInReadingNecessaryFile(valuesPath, err) {
return values, err
}
err = yaml.Unmarshal(yamlFileContents, &values)
removeIgnored(&values, values.Kind)
return values, err
}
func checkDocumentation(rootNode *yaml.Node, comments map[string]ChartValueDescription, config ChartValuesDocumentationParsingConfig) error {
if len(rootNode.Content) == 0 {
return nil
}
valuesWithoutDocs := collectValuesWithoutDoc(rootNode.Content[0], comments, make([]string, 0))
valuesWithoutDocsAfterIgnore := make([]string, 0)
for _, valueWithoutDoc := range valuesWithoutDocs {
ignored := false
for _, ignorableValuePath := range config.AllowedMissingValuePaths {
ignored = ignored || valueWithoutDoc == ignorableValuePath
}
for _, ignorableValueRegexp := range config.AllowedMissingValueRegexps {
ignored = ignored || ignorableValueRegexp.MatchString(valueWithoutDoc)
}
if !ignored {
valuesWithoutDocsAfterIgnore = append(valuesWithoutDocsAfterIgnore, valueWithoutDoc)
}
}
if len(valuesWithoutDocsAfterIgnore) > 0 {
return fmt.Errorf("values without documentation: \n%s", strings.Join(valuesWithoutDocsAfterIgnore, "\n"))
}
return nil
}
func collectValuesWithoutDoc(node *yaml.Node, comments map[string]ChartValueDescription, currentPath []string) []string {
valuesWithoutDocs := make([]string, 0)
switch node.Kind {
case yaml.MappingNode:
for i := 0; i < len(node.Content); i += 2 {
keyNode, valueNode := node.Content[i], node.Content[i+1]
currentPath = append(currentPath, keyNode.Value)
pathString := strings.Join(currentPath, ".")
if _, ok := comments[pathString]; !ok {
valuesWithoutDocs = append(valuesWithoutDocs, pathString)
}
childValuesWithoutDoc := collectValuesWithoutDoc(valueNode, comments, currentPath)
valuesWithoutDocs = append(valuesWithoutDocs, childValuesWithoutDoc...)
currentPath = currentPath[:len(currentPath)-1]
}
case yaml.SequenceNode:
for i := 0; i < len(node.Content); i++ {
valueNode := node.Content[i]
currentPath = append(currentPath, fmt.Sprintf("[%d]", i))
childValuesWithoutDoc := collectValuesWithoutDoc(valueNode, comments, currentPath)
valuesWithoutDocs = append(valuesWithoutDocs, childValuesWithoutDoc...)
currentPath = currentPath[:len(currentPath)-1]
}
}
return valuesWithoutDocs
}
func parseChartValuesFileComments(chartDirectory string, values *yaml.Node, lintingConfig ChartValuesDocumentationParsingConfig) (map[string]ChartValueDescription, error) {
valuesPath := filepath.Join(chartDirectory, viper.GetString("values-file"))
valuesFile, err := os.Open(valuesPath)
if isErrorInReadingNecessaryFile(valuesPath, err) {
return map[string]ChartValueDescription{}, err
}
defer valuesFile.Close()
keyToDescriptions := make(map[string]ChartValueDescription)
scanner := bufio.NewScanner(valuesFile)
foundValuesComment := false
commentLines := make([]string, 0)
currentLineIdx := -1
for scanner.Scan() {
currentLineIdx++
currentLine := scanner.Text()
// If we've not yet found a values comment with a key name, try and find one on each line
if !foundValuesComment {
match := valuesDescriptionRegex.FindStringSubmatch(currentLine)
if len(match) < 3 || match[1] == "" {
continue
}
foundValuesComment = true
commentLines = append(commentLines, currentLine)
continue
}
// If we've already found a values comment, on the next line try and parse a comment continuation, a custom default value, or a section comment.
// If we find continuations we can add them to the list and continue to the next line until we find a section comment or default value.
// If we find a default value, we can add it to the list and continue to the next line. In the case we don't find one, we continue looking for a section comment.
// When we eventually find a section comment, we add it to the list and conclude matching for the current key. If we don't find one, matching is also concluded.
//
// NOTE: This isn't readily enforced yet, because we can match the section comment and custom default value more than once and in another order, although this is just overwriting it.
// Values comment, possible continuation, default value once or none then section comment once or none should be the preferred order.
defaultCommentMatch := defaultValueRegex.FindStringSubmatch(currentLine)
sectionCommentMatch := sectionRegex.FindStringSubmatch(currentLine)
commentContinuationMatch := commentContinuationRegex.FindStringSubmatch(currentLine)
if len(defaultCommentMatch) > 1 || len(sectionCommentMatch) > 1 || len(commentContinuationMatch) > 1 {
commentLines = append(commentLines, currentLine)
continue
}
// If we haven't continued by this point, we didn't match any of the comment formats we want, so we need to add
// the in progress value to the map, and reset to looking for a new key
key, description := ParseComment(commentLines)
if key != "" {
keyToDescriptions[key] = description
}
commentLines = make([]string, 0)
foundValuesComment = false
}
if lintingConfig.StrictMode {
err := checkDocumentation(values, keyToDescriptions, lintingConfig)
if err != nil {
return nil, err
}
}
return keyToDescriptions, nil
}
func ParseChartInformation(chartDirectory string, documentationParsingConfig ChartValuesDocumentationParsingConfig) (ChartDocumentationInfo, error) {
var chartDocInfo ChartDocumentationInfo
var err error
chartDocInfo.ChartDirectory = chartDirectory
chartDocInfo.ChartMeta, err = parseChartFile(chartDirectory)
if err != nil {
return chartDocInfo, err
}
chartDocInfo.ChartRequirements, err = parseChartRequirementsFile(chartDirectory, chartDocInfo.ApiVersion)
if err != nil {
return chartDocInfo, err
}
chartValues, err := parseChartValuesFile(chartDirectory)
if err != nil {
return chartDocInfo, err
}
chartDocInfo.ChartValues = &chartValues
chartDocInfo.ChartValuesDescriptions, err = parseChartValuesFileComments(chartDirectory, &chartValues, documentationParsingConfig)
if err != nil {
return chartDocInfo, err
}
return chartDocInfo, nil
}
07070100000190000081A4000000000000000000000001668BBBD200000B77000000000000000000000000000000000000002D00000000helm-docs-1.14.2/pkg/helm/chart_info_test.gopackage helm_test
import (
"github.com/norwoodj/helm-docs/pkg/helm"
"github.com/spf13/viper"
"github.com/stretchr/testify/suite"
"path/filepath"
"regexp"
"testing"
)
type ChartParsingTestSuite struct {
suite.Suite
}
func (_ *ChartParsingTestSuite) SetupTest() {
viper.Set("values-file", "values.yaml")
}
func TestChartParsingTestSuite(t *testing.T) {
suite.Run(t, new(ChartParsingTestSuite))
}
func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOff() {
chartPath := filepath.Join("test-fixtures", "full-template")
_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
StrictMode: false,
})
suite.NoError(err)
}
func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOn() {
chartPath := filepath.Join("test-fixtures", "full-template")
_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
StrictMode: true,
})
expectedError := `values without documentation:
controller
controller.name
controller.image
controller.image.repository
controller.image.tag
controller.extraVolumes
controller.extraVolumes.[0].name
controller.extraVolumes.[0].configMap
controller.extraVolumes.[0].configMap.name
controller.publishService
controller.service
controller.service.annotations
controller.service.annotations.external-dns.alpha.kubernetes.io/hostname
controller.service.type`
suite.EqualError(err, expectedError)
}
func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOnIgnores() {
chartPath := filepath.Join("test-fixtures", "full-template")
_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
StrictMode: true,
AllowedMissingValuePaths: []string{
"controller",
"controller.image",
"controller.name",
"controller.image.repository",
"controller.image.tag",
"controller.extraVolumes",
"controller.extraVolumes.[0].name",
"controller.extraVolumes.[0].configMap",
"controller.extraVolumes.[0].configMap.name",
"controller.publishService",
"controller.service",
"controller.service.annotations",
"controller.service.annotations.external-dns.alpha.kubernetes.io/hostname",
"controller.service.type",
},
})
suite.NoError(err)
}
func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOnIgnoresRegexp() {
chartPath := filepath.Join("test-fixtures", "full-template")
_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
StrictMode: true,
AllowedMissingValueRegexps: []*regexp.Regexp{
regexp.MustCompile("controller.*"),
},
})
suite.NoError(err)
}
func (suite *ChartParsingTestSuite) TestFullyDocumentedChartStrictModeOn() {
chartPath := filepath.Join("test-fixtures", "fully-documented")
_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
StrictMode: true,
})
suite.NoError(err)
}
07070100000191000081A4000000000000000000000001668BBBD200000835000000000000000000000000000000000000002500000000helm-docs-1.14.2/pkg/helm/comment.gopackage helm
import (
"strings"
)
const (
PrefixComment = "# --"
)
func ParseComment(commentLines []string) (string, ChartValueDescription) {
var valueKey string
var c ChartValueDescription
var docStartIdx int
// Work around https://github.com/norwoodj/helm-docs/issues/96 by considering only
// the last "group" of comment lines starting with '# --'.
lastIndex := 0
for i, v := range commentLines {
if strings.HasPrefix(v, PrefixComment) {
lastIndex = i
}
}
if lastIndex > 0 {
// If there's a non-zero last index, consider that alone.
return ParseComment(commentLines[lastIndex:])
}
for i := range commentLines {
match := valuesDescriptionRegex.FindStringSubmatch(commentLines[i])
if len(match) < 3 {
continue
}
valueKey = match[1]
c.Description = match[2]
docStartIdx = i
break
}
valueTypeMatch := valueTypeRegex.FindStringSubmatch(c.Description)
if len(valueTypeMatch) > 0 && valueTypeMatch[1] != "" {
c.ValueType = valueTypeMatch[1]
c.Description = valueTypeMatch[2]
}
var isRaw = false
for _, line := range commentLines[docStartIdx+1:] {
rawFlagMatch := rawDescriptionRegex.FindStringSubmatch(line)
defaultCommentMatch := defaultValueRegex.FindStringSubmatch(line)
notationTypeCommentMatch := valueNotationTypeRegex.FindStringSubmatch(line)
sectionCommentMatch := sectionRegex.FindStringSubmatch(line)
if !isRaw && len(rawFlagMatch) == 1 {
isRaw = true
continue
}
if len(defaultCommentMatch) > 1 {
c.Default = defaultCommentMatch[1]
continue
}
if len(notationTypeCommentMatch) > 1 {
c.NotationType = notationTypeCommentMatch[1]
continue
}
if len(sectionCommentMatch) > 1 {
c.Section = sectionCommentMatch[1]
continue
}
commentContinuationMatch := commentContinuationRegex.FindStringSubmatch(line)
if isRaw {
if len(commentContinuationMatch) > 1 {
c.Description += "\n" + commentContinuationMatch[2]
}
continue
} else {
if len(commentContinuationMatch) > 1 {
c.Description += " " + commentContinuationMatch[2]
}
continue
}
}
return valueKey, c
}
07070100000192000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000002800000000helm-docs-1.14.2/pkg/helm/test-fixtures07070100000193000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003600000000helm-docs-1.14.2/pkg/helm/test-fixtures/full-template07070100000194000081A4000000000000000000000001668BBBD200000218000000000000000000000000000000000000004100000000helm-docs-1.14.2/pkg/helm/test-fixtures/full-template/Chart.yamlapiVersion: v2
name: full-template
deprecated: true
version: "1.0.0"
type: application
appVersion: "13.0.0"
description: A chart for showing every README-element
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"]
kubeVersion: "<=1.18"
engine: gotpl
dependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
07070100000195000081A4000000000000000000000001668BBBD2000014C5000000000000000000000000000000000000004000000000helm-docs-1.14.2/pkg/helm/test-fixtures/full-template/README.md# full-template
## `extra.flower`
```
,-.
, ,-. ,-.
/ \ ( )-( )
\ | ,.>-( )-<
\|,' ( )-( )
Y ___`-' `-'
|/__/ `-'
|
|
| -hi-
__|_____________
```
## `chart.deprecationWarning`
> **:exclamation: This Helm Chart is deprecated!**
## `chart.name`
full-template
## `chart.description`
A chart for showing every README-element
## `chart.version`
1.0.0
## `chart.versionBadge`
## `chart.type`
application
## `chart.typeBadge`
## `chart.appVersion`
13.0.0
## `chart.appVersionBadge`
## `chart.badgesSection`
  
## `chart.homepage`
https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template
## `chart.homepageLine`
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
## `chart.maintainersHeader`
## Maintainers
## `chart.maintainersTable`
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## `chart.maintainersSection`
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## `chart.sourcesHeader`
## Source Code
## `chart.sourcesList`
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
## `chart.sourcesSection`
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
## `chart.kubeVersion`
<=1.18
## `chart.kubeVersionLine`
Kubernetes: `<=1.18`
## `chart.requirementsHeader`
## Requirements
## `chart.requirementsTable`
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## `chart.requirementsSection`
## Requirements
Kubernetes: `<=1.18`
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## `chart.valuesHeader`
## Values
## `chart.valuesTable`
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
| controller.extraVolumes[0].name | string | `"config-volume"` | |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
## `chart.valuesSection`
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
| controller.extraVolumes[0].name | string | `"config-volume"` | |
| controller.image.repository | string | `"nginx-ingress-controller"` | |
| controller.image.tag | string | `"18.0831"` | |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.name | string | `"controller"` | |
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
07070100000196000081A4000000000000000000000001668BBBD200000720000000000000000000000000000000000000004700000000helm-docs-1.14.2/pkg/helm/test-fixtures/full-template/README.md.gotmpl{{ template "chart.header" . }}
## `extra.flower`
{{ template "extra.flower" . }}
## `chart.deprecationWarning`
{{ template "chart.deprecationWarning" . }}
## `chart.name`
{{ template "chart.name" . }}
## `chart.description`
{{ template "chart.description" . }}
## `chart.version`
{{ template "chart.version" . }}
## `chart.versionBadge`
{{ template "chart.versionBadge" . }}
## `chart.type`
{{ template "chart.type" . }}
## `chart.typeBadge`
{{ template "chart.typeBadge" . }}
## `chart.appVersion`
{{ template "chart.appVersion" . }}
## `chart.appVersionBadge`
{{ template "chart.appVersionBadge" . }}
## `chart.badgesSection`
{{ template "chart.badgesSection" . }}
## `chart.homepage`
{{ template "chart.homepage" . }}
## `chart.homepageLine`
{{ template "chart.homepageLine" . }}
## `chart.maintainersHeader`
{{ template "chart.maintainersHeader" . }}
## `chart.maintainersTable`
{{ template "chart.maintainersTable" . }}
## `chart.maintainersSection`
{{ template "chart.maintainersSection" . }}
## `chart.sourcesHeader`
{{ template "chart.sourcesHeader" . }}
## `chart.sourcesList`
{{ template "chart.sourcesList" . }}
## `chart.sourcesSection`
{{ template "chart.sourcesSection" . }}
## `chart.kubeVersion`
{{ template "chart.kubeVersion" . }}
## `chart.kubeVersionLine`
{{ template "chart.kubeVersionLine" . }}
## `chart.requirementsHeader`
{{ template "chart.requirementsHeader" . }}
## `chart.requirementsTable`
{{ template "chart.requirementsTable" . }}
## `chart.requirementsSection`
{{ template "chart.requirementsSection" . }}
## `chart.valuesHeader`
{{ template "chart.valuesHeader" . }}
## `chart.valuesTable`
{{ template "chart.valuesTable" . }}
## `chart.valuesSection`
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
07070100000197000081A4000000000000000000000001668BBBD2000004FD000000000000000000000000000000000000004200000000helm-docs-1.14.2/pkg/helm/test-fixtures/full-template/values.yamlcontroller:
name: controller
image:
repository: nginx-ingress-controller
tag: "18.0831"
# controller.persistentVolumeClaims -- List of persistent volume claims to create.
# For very long comments, break them into multiple lines.
# @default -- the chart will construct this list internally unless specified
persistentVolumeClaims: []
extraVolumes:
- name: config-volume
configMap:
# controller.extraVolumes[0].configMap.name -- Uses the name of the configmap created by this chart
name: nginx-ingress-config
# controller.ingressClass -- Name of the ingress class to route through this controller
ingressClass: nginx
# controller.podLabels -- The labels to be applied to instances of the controller pod
podLabels: {}
publishService:
# controller.publishService.enabled -- Whether to expose the ingress controller to the public world
enabled: false
# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
replicas:
service:
annotations:
# controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
type: LoadBalancer
07070100000198000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000003900000000helm-docs-1.14.2/pkg/helm/test-fixtures/fully-documented07070100000199000081A4000000000000000000000001668BBBD20000020C000000000000000000000000000000000000004400000000helm-docs-1.14.2/pkg/helm/test-fixtures/fully-documented/Chart.yamlapiVersion: v2
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
type: application
maintainers:
- email: norwood.john.m@gmail.com
name: John Norwood
dependencies:
- name: nginx-ingress
version: "0.22.1"
repository: "@stable"
0707010000019A000081A4000000000000000000000001668BBBD200000543000000000000000000000000000000000000004300000000helm-docs-1.14.2/pkg/helm/test-fixtures/fully-documented/README.md# nginx-ingress
 
A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> | |
## Source Code
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
## Requirements
| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller | object | `{"image":{"repository":"nginx-ingress-controller","tag":"18.0831"},"name":"controller"}` | The controller |
| controller.image | object | `{"repository":"nginx-ingress-controller","tag":"18.0831"}` | The image of the controller |
| controller.image.repository | string | `"nginx-ingress-controller"` | The repository of the controller |
| controller.image.tag | string | `"18.0831"` | The tag of the image of the controller |
| controller.name | string | `"controller"` | The name of the controller |
0707010000019B000081A4000000000000000000000001668BBBD200000174000000000000000000000000000000000000004500000000helm-docs-1.14.2/pkg/helm/test-fixtures/fully-documented/values.yaml# controller -- The controller
controller:
# controller.name -- The name of the controller
name: controller
# controller.image -- The image of the controller
image:
# controller.image.repository -- The repository of the controller
repository: nginx-ingress-controller
# controller.image.tag -- The tag of the image of the controller
tag: "18.0831"
0707010000019C000041ED000000000000000000000002668BBBD200000000000000000000000000000000000000000000001A00000000helm-docs-1.14.2/pkg/util0707010000019D000081A4000000000000000000000001668BBBD2000000E2000000000000000000000000000000000000002200000000helm-docs-1.14.2/pkg/util/file.gopackage util
import "path"
func IsRelativePath(filePath string) bool {
return (filePath[0] == '.') && path.Base(filePath) != filePath
}
func IsBaseFilename(filePath string) bool {
return path.Base(filePath) == filePath
}
0707010000019E000081A4000000000000000000000001668BBBD200000472000000000000000000000000000000000000002300000000helm-docs-1.14.2/pkg/util/funcs.gopackage util
import (
"strings"
"text/template"
"github.com/Masterminds/sprig/v3"
"gopkg.in/yaml.v3"
)
func FuncMap() template.FuncMap {
f := sprig.TxtFuncMap()
f["toYaml"] = toYAML
f["fromYaml"] = fromYAML
return f
}
// toYAML takes an interface, marshals it to yaml, and returns a string. It will
// always return a string, even on marshal error (empty string).
//
// This is designed to be called from a template.
func toYAML(v interface{}) string {
data, err := yaml.Marshal(v)
if err != nil {
// Swallow errors inside of a template.
return ""
}
return strings.TrimSuffix(string(data), "\n")
}
// fromYAML converts a YAML document into a map[string]interface{}.
//
// This is not a general-purpose YAML parser, and will not parse all valid
// YAML documents. Additionally, because its intended use is within templates
// it tolerates errors. It will insert the returned error message string into
// m["Error"] in the returned map.
func fromYAML(str string) map[string]interface{} {
m := map[string]interface{}{}
if err := yaml.Unmarshal([]byte(str), &m); err != nil {
m["Error"] = err.Error()
}
return m
}
0707010000019F000081A4000000000000000000000001668BBBD200000100000000000000000000000000000000000000002100000000helm-docs-1.14.2/pkg/util/git.gopackage util
import (
"os/exec"
"strings"
)
func FindGitRepositoryRoot() (string, error) {
path, err := exec.Command("git", "rev-parse", "--show-toplevel").Output()
if err != nil {
return "", err
}
return strings.TrimSpace(string(path)), nil
}
070701000001A0000081A4000000000000000000000001668BBBD20000087A000000000000000000000000000000000000002400000000helm-docs-1.14.2/pkg/util/ignore.gopackage util
import (
"bufio"
"fmt"
"os"
"path/filepath"
log "github.com/sirupsen/logrus"
"helm.sh/helm/v3/pkg/ignore"
)
var defaultIgnore = map[string]bool{
".git": true,
}
type IgnoreContext struct {
rules *ignore.Rules
relativeDir string
}
func parseIgnoreFilePathToRules(filename string) (*ignore.Rules, error) {
ignoreFile, err := os.Open(filename)
if os.IsNotExist(err) {
log.Debugf("No ignore file found at %s, using empty ignore rules", filename)
return ignore.Empty(), nil
}
if err != nil {
return nil, fmt.Errorf("failed to open ignore file at %s: %s", filename, err)
}
ignoreRules, err := ignore.Parse(bufio.NewReader(ignoreFile))
if err != nil {
return nil, fmt.Errorf("failed to parse ignore rules from file %s: %s", filename, err)
}
log.Debugf("Found ignore file at %s, using those ignore rules", filename)
return ignoreRules, nil
}
func NewIgnoreContext(ignoreFilename string) IgnoreContext {
gitRepositoryRoot, err := FindGitRepositoryRoot()
// If we got an error reading the repository root, then let's try for a ignore file in this directory
if err != nil {
ignoreRules, err := parseIgnoreFilePathToRules(ignoreFilename)
if err != nil {
log.Warnf("Using empty ignore rules due to error: %s", err)
return IgnoreContext{rules: ignore.Empty()}
}
absoluteWorkingDir, _ := filepath.Abs(".")
return IgnoreContext{rules: ignoreRules, relativeDir: absoluteWorkingDir}
}
// Otherwise, let's look for a ignore file at the repository root and parse it, storing that files are ignored relative
// to that directory
ignoreRules, err := parseIgnoreFilePathToRules(filepath.Join(gitRepositoryRoot, ignoreFilename))
if err != nil {
log.Warnf("Using empty ignore rules due to error: %s", err)
return IgnoreContext{rules: ignore.Empty()}
}
return IgnoreContext{rules: ignoreRules, relativeDir: gitRepositoryRoot}
}
func (i IgnoreContext) ShouldIgnore(path string, fi os.FileInfo) bool {
pathRelativeToIgnoreFile, err := filepath.Rel(i.relativeDir, path)
if err != nil {
return false
}
return i.rules.Ignore(pathRelativeToIgnoreFile, fi) || defaultIgnore[pathRelativeToIgnoreFile]
}
070701000001A1000081ED000000000000000000000001668BBBD200000203000000000000000000000000000000000000001C00000000helm-docs-1.14.2/release.sh#!/usr/bin/env bash
function main {
local release_version=${1:-}
if [[ -z "${release_version}" ]]; then
echo "Usage ${0} <release-version>"
exit 1
fi
if ! [[ "${release_version}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo "Release version must be of the form 'v1.2.3'"
exit 1
fi
git commit -am "Release ${release_version}" --allow-empty
git cliff --tag "${release_version}" -o
git commit --amend -a
git tag "${release_version}"
}
main "${@}"
07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!1127 blocks
