├── .github
    ├── CODEOWNERS
    ├── ISSUE_TEMPLATE
    │   ├── bug_report.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    └── workflows
    │   ├── lint-test.yaml
    │   ├── linter.yml
    │   ├── release.yaml
    │   └── sync-readme.yaml
├── CHART-README.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── REPO-README.md
├── _config.yml
└── ct.yaml


/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | # https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
2 | 
3 | /charts/<name-of-chart> @maintainer
4 | 
5 | ## changes to CODEOWNERS should be reviewed by repository admins
6 | /CODEOWNERS @helm-charts-admins
7 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | title: 'issue title'
 5 | labels: 'bug'
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | <!-- Thanks for filing an issue!
11 | Before hitting the button, please answer these questions.
12 | It's helpful to search the existing GitHub issues first.
13 | It's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware o. 
14 | 
15 | Fill in as much of the template below as you can.
16 | The more information we have the better we can help you.
17 | 
18 | Be ready for followup questions, and please respond in a timely manner.
19 | If we can't reproduce a bug or think a feature already exists, we might close your issue.
20 | If we're wrong, PLEASE feel free to reopen it and explain why.
21 | -->
22 | 
23 | **Describe the bug**
24 | A clear and concise description of what the bug is.
25 | 
26 | **Version of Helm and Kubernetes**:
27 | 
28 | Helm Version:
29 | 
30 | ```console
31 | $ helm version
32 | please put the output of it here
33 | ```
34 | 
35 | Kubernetes Version:
36 | 
37 | ```console
38 | $ kubectl version
39 | please put the output of it here
40 | ```
41 | 
42 | 
43 | **Which version of the chart**:
44 | 
45 | 
46 | **What happened**:
47 | 
48 | 
49 | **What you expected to happen**:
50 | 
51 | 
52 | **How to reproduce it** (as minimally and precisely as possible):
53 | 
54 | <~--
55 | This could be something like:
56 | 
57 | values.yaml (only put values which differ from the defaults)
58 | 
59 | ```
60 | key: value
61 | ```
62 | 
63 | ```
64 | helm install my-release {{ .GitHubOrg }}/name-of-chart --version version --values values.yaml
65 | ```
66 | 
67 | -->
68 | 
69 | 
70 | **Anything else we need to know**:
71 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | title: 'issue title'
 5 | labels: 'enhancement'
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | <!--
11 | Thanks for filing an issue!
12 | Before hitting the button, please answer these questions.
13 | It's helpful to search the existing GitHub issues first.
14 | It's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of.
15 | 
16 | Describe *in detail* the feature/behavior/change you'd like to see.
17 | 
18 | Be ready for followup questions, and please respond in a timely manner.
19 | If we can't reproduce a bug or think a feature already exists, we might close your issue.
20 | If we're wrong, PLEASE feel free to reopen it and explain why.
21 | -->
22 | 
23 | **Is your feature request related to a problem? Please describe.**
24 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
25 | 
26 | **Describe the solution you'd like**
27 | A clear and concise description of what you want to happen.
28 | 
29 | **Describe alternatives you've considered**
30 | A clear and concise description of any alternative solutions or features you've considered.
31 | 
32 | **Additional context**
33 | Add any other context or screenshots about the feature request here.
34 | 


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | <!--
 2 | Thank you for contributing!
 3 | Before you submit this PR we'd like to make sure you are aware of our technical requirements and best practices:
 4 | 
 5 | * https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md#technical-requirements
 6 | * https://helm.sh/docs/chart_best_practices/
 7 | 
 8 | For a quick overview across what we will look at reviewing your PR, please read our review guidelines:
 9 | 
10 | * https://github.com/helm/charts/blob/master/REVIEW_GUIDELINES.md
11 | 
12 | Following our best practices right from the start will accelerate the review process and help get your PR merged quicker.
13 | 
14 | When updates to your PR are requested, please add new commits and do not squash the history.
15 | This will make it easier to identify new changes.
16 | The PR will be squashed anyways when it is merged.
17 | Thanks.
18 | 
19 | For fast feedback, please @-mention maintainers that are listed in the Chart.yaml file.
20 | 
21 | Please make sure you test your changes before you push them.
22 | Once pushed, GitHub Actions will run across your changes and do some initial checks and linting.
23 | These checks run very quickly.
24 | Please check the results.
25 | We would like these checks to pass before we even continue reviewing your changes.
26 | -->
27 | 
28 | # What this PR does / why we need it
29 | 
30 | # Which issue this PR fixes
31 | 
32 | *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*
33 | 
34 | - fixes #
35 | 
36 | # Special notes for your reviewer
37 | 
38 | # Checklist
39 | <!-- [Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->
40 | - [ ] [DCO](https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md#sign-off-your-work) signed
41 | - [ ] Chart Version bumped
42 | 


--------------------------------------------------------------------------------
/.github/workflows/lint-test.yaml:
--------------------------------------------------------------------------------
 1 | name: Lint and Test Charts
 2 | 
 3 | on: pull_request
 4 | 
 5 | jobs:
 6 |   lint-test:
 7 |     runs-on: ubuntu-latest
 8 |     steps:
 9 |       - name: Checkout
10 |         uses: actions/checkout@v2
11 | 
12 |       - name: Fetch history
13 |         run: git fetch --prune --unshallow
14 | 
15 |       - name: Run chart-testing (lint)
16 |         id: lint
17 |         uses: helm/chart-testing-action@v1.0.0
18 |         with:
19 |           command: lint
20 |           config: ct.yaml
21 | 
22 |       - name: Create kind cluster
23 |         uses: helm/kind-action@v1.0.0
24 |         if: steps.lint.outputs.changed == 'true'
25 | 
26 |       - name: Run chart-testing (install)
27 |         uses: helm/chart-testing-action@v1.0.0
28 |         with:
29 |           command: install
30 |           config: ct.yaml
31 | 


--------------------------------------------------------------------------------
/.github/workflows/linter.yml:
--------------------------------------------------------------------------------
 1 | name: Lint Code Base
 2 | 
 3 | # Documentation:
 4 | # https://help.github.com/en/articles/workflow-syntax-for-github-actions
 5 | 
 6 | on: pull_request
 7 | 
 8 | jobs:
 9 |   build:
10 |     name: Lint Code Base
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - name: Checkout Code
14 |         uses: actions/checkout@v2
15 |       - name: Lint Code Base
16 |         uses: github/super-linter@v3
17 |         env:
18 |           VALIDATE_ALL_CODEBASE: false
19 |           VALIDATE_YAML: false
20 |           DEFAULT_BRANCH: main
21 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22 | 


--------------------------------------------------------------------------------
/.github/workflows/release.yaml:
--------------------------------------------------------------------------------
 1 | name: Release Charts
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 | 
 8 | jobs:
 9 |   release:
10 |     runs-on: ubuntu-latest
11 |     steps:
12 |       - name: Checkout
13 |         uses: actions/checkout@v2
14 | 
15 |       - name: Fetch history
16 |         run: git fetch --prune --unshallow
17 | 
18 |       - name: Configure Git
19 |         run: |
20 |           git config user.name "$GITHUB_ACTOR"
21 |           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
22 | 
23 |       # See https://github.com/helm/chart-releaser-action/issues/6
24 |       - name: Install Helm
25 |         run: |
26 |           curl -fsSLo get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
27 |           chmod 700 get_helm.sh
28 |           ./get_helm.sh
29 | 
30 |       - name: Run chart-releaser
31 |         uses: helm/chart-releaser-action@v1.0.0
32 |         env:
33 |           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
34 | 


--------------------------------------------------------------------------------
/.github/workflows/sync-readme.yaml:
--------------------------------------------------------------------------------
 1 | on:
 2 |   push:
 3 |     branches:
 4 |       - 'main'
 5 |     paths:
 6 |       - 'README.md'
 7 | jobs:
 8 |   build:
 9 |     runs-on: ubuntu-latest
10 |     steps:
11 |       - uses: actions/checkout@v2
12 |       - run: |
13 |           cp -f README.md ${{ runner.temp }}/README.md
14 |       - uses: actions/checkout@v2
15 |         with:
16 |           ref: gh-pages
17 |       - run: |
18 |           cp -f ${{ runner.temp }}/README.md .
19 |           git config user.name "$GITHUB_ACTOR"
20 |           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
21 |           git add README.md
22 |           git commit --signoff -m "Sync README from main"
23 |           git push
24 | 


--------------------------------------------------------------------------------
/CHART-README.md:
--------------------------------------------------------------------------------
  1 | # {{.Chart.Name}}
  2 | 
  3 | <!-- Simple description of application the chart is installing, with a link to the upstream app.-->
  4 | {{.App.Description}}
  5 | 
  6 | {{if .Prerequisites}}
  7 | ## Prerequisites
  8 | 
  9 | {{range .Prerequisites}}{{printf "- %s\n" .}}{{end}}
 10 | {{end}}
 11 | 
 12 | ## Get Repo Info
 13 | 
 14 | ```console
 15 | helm repo add {{Repo.Name}} {{Repo.URL}}
 16 | {{range $d := .Chart.Dependencies}}
 17 | <-- To-do: get preferred repo shortname from Artifact Hub API (example: bitnami).-->
 18 | helm repo add {{$d.ShortName}} {{$d.Repository}}
 19 | {{end}}
 20 | helm repo update
 21 | ```
 22 | 
 23 | _See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._
 24 | 
 25 | ## Install Chart
 26 | 
 27 | ```console
 28 | # Helm 3
 29 | $ helm install [RELEASE_NAME] {{Repo.Name}}/{{.Chart.Name}} [flags]
 30 | 
 31 | # Helm 2
 32 | $ helm install --name [RELEASE_NAME] {{Repo.Name}}/{{.Chart.Name}} [flags]
 33 | ```
 34 | 
 35 | _See [configuration](#configuration) below._
 36 | 
 37 | _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
 38 | 
 39 | {{if .Chart.Dependencies}}
 40 | ## Dependencies
 41 | 
 42 | By default this chart installs additional, dependent charts:
 43 | 
 44 | {{range $d := .Chart.Dependencies}}
 45 | <!-- Example:
 46 | - [bitnami/kube-state-metrics](https://artifacthub.io/packages/helm/bitnami/kube-state-metrics)
 47 | -->
 48 | <!-- To-do: get link to dependency via Artifact Hub API -->
 49 | - [{{$d.ShortName}} {{$d.Repository}}]({{$d.HubURL}})
 50 | {{end}}
 51 | 
 52 | <!-- Example:
 53 | To disable the dependency during installation, set `kubeStateMetrics.enabled` to `false`.
 54 | -->
 55 | <!-- To-do: fix this pseudocode lol -->
 56 | <!-- Requires `Join()` func
 57 | tmpl.Funcs(template.FuncMap{"StringsJoin": strings.Join}) -->
 58 | {{range $d := .Chart.Dependencies}}
 59 | {{define "depEnabledKeys"}}
 60 | {{default $d.Name $d.alias}}.enabled
 61 | {{end}}
 62 | {{end}}
 63 | To disable the dependency during installation, set {{StringsJoin .depEnabledKeys ", "}} to `false`.
 64 | 
 65 | _See [helm dependency](https://helm.sh/docs/helm/helm_dependency/) for command documentation._
 66 | {{end}}
 67 | 
 68 | ## Uninstall Chart
 69 | 
 70 | ```console
 71 | # Helm 3
 72 | $ helm uninstall [RELEASE_NAME]
 73 | 
 74 | # Helm 2
 75 | # helm delete --purge [RELEASE_NAME]
 76 | ```
 77 | 
 78 | This removes all the Kubernetes components associated with the chart and deletes the release.
 79 | 
 80 | _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
 81 | 
 82 | ## Upgrading Chart
 83 | 
 84 | ```console
 85 | # Helm 3 or 2
 86 | $ helm upgrade [RELEASE_NAME] {{Repo.Name}}/{{.Chart.Name}} [flags]
 87 | ```
 88 | 
 89 | _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
 90 | 
 91 | <!-- If major version bumps, under H3 explain breaking changes justifying bump and manual steps required. Examples below: -->
 92 | ### Major Version Upgrades
 93 | 
 94 | Chart release versions follow [semver](../../CONTRIBUTING.md#versioning), where a MAJOR version change (example `1.0.0` -> `2.0.0`) indicates an incompatible breaking change needing manual actions.
 95 | 
 96 | ### To v2.0.0
 97 | Example manual steps.
 98 | 
 99 | ### To v1.0.0
100 | Example manual steps.
101 | 
102 | ## Configuration
103 | 
104 | See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
105 | 
106 | ```console
107 | # Helm 2
108 | $ helm inspect values prometheus-community/prometheus
109 | 
110 | # Helm 3
111 | $ helm show values prometheus-community/prometheus
112 | ```
113 | 
114 | You may similarly use the above configuration commands on each chart [dependency](#dependencies) to see it's configurations.
115 | 
116 | <!-- If Specific configuration categories need explaining, explain under H3. Examples below: -->
117 | ### Configuration Type A
118 | 
119 | Example config steps:
120 | 1. Create secret with `shell command`
121 | 1. [Install](#install-chart) chart with setting `foo.bar` to `[SECRET_NAME]`, and `baz.qux.quux` to `true`
122 | 
123 | ### Configuration Type B
124 | 
125 | In order to X, you must set `quuz.corge` to `false` and `quuz.grault` to `garply`.
126 | 


--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Community Code of Conduct
2 | 
3 | This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
4 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing Guidelines
 2 | 
 3 | Contributions are welcome via GitHub pull requests. This document outlines the process to help get your contribution accepted.
 4 | 
 5 | ## Sign off Your Work
 6 | 
 7 | The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.
 8 | Here is the full text of the [DCO](http://developercertificate.org/).
 9 | Contributors must sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages.
10 | 
11 | ```text
12 | This is my commit message
13 | 
14 | Signed-off-by: Random J Developer <random@developer.example.org>
15 | ```
16 | 
17 | See `git help commit`:
18 | 
19 | ```text
20 | -s, --signoff
21 |     Add Signed-off-by line by the committer at the end of the commit log
22 |     message. The meaning of a signoff depends on the project, but it typically
23 |     certifies that committer has the rights to submit this work under the same
24 |     license and agrees to a Developer Certificate of Origin (see
25 |     http://developercertificate.org/ for more information).
26 | ```
27 | 
28 | ## How to Contribute
29 | 
30 | 1. Fork this repository, develop, and test your changes
31 | 1. Remember to sign off your commits as described above
32 | 1. Submit a pull request
33 | 
34 | ***NOTE***: In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs.
35 | 
36 | ### Technical Requirements
37 | 
38 | * Must pass [DCO check](#sign-off-your-work)
39 | * Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/)
40 | * Must pass CI jobs for linting and installing changed charts with the [chart-testing](https://github.com/helm/chart-testing) tool
41 | * Any change to a chart requires a version bump following [semver](https://semver.org/) principles. See [Immutability](#immutability) and [Versioning](#versioning) below
42 | 
43 | Once changes have been merged, the release job will automatically run to package and release changed charts.
44 | 
45 | ### Immutability
46 | 
47 | Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation.
48 | 
49 | ### Versioning
50 | 
51 | The chart `version` should follow [semver](https://semver.org/).
52 | 
53 | Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to a chart should:
54 | 
55 | 1. Bump the MAJOR version
56 | 2. In the README, under a section called "Upgrading", describe the manual steps necessary to upgrade to the new (specified) MAJOR version
57 | 
58 | ### Community Requirements
59 | 
60 | This project is released with a [Contributor Covenant](https://www.contributor-covenant.org).
61 | By participating in this project you agree to abide by its terms.
62 | See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
63 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Helm Chart hosting on GitHub
  2 | 
  3 | This repository contains templates which can be used to host your own [Helm](https://helm.sh/) chart repository on GitHub.
  4 | 
  5 | Hosting your own charts on GitHub has become very easy as there are many GitHub Actions which can be used to set everything up.
  6 | 
  7 | This repository contains ready to use Github Workflows to
  8 | 
  9 | - [Lint all files](.github/workflows/linter.yml) for pull requests via [Super-Linter](https://github.com/github/super-linter)
 10 | - [Lint and Test](.github/workflows/lint-test.yaml) Helm charts for pull request via [chart-testing](https://github.com/helm/chart-testing-action) and [Kubernetes IN Docker](https://github.com/helm/kind-action)
 11 | - [Release Charts](.github/workflows/release.yaml) using GitHub Releases and GitHub Pages via [chart-releaser](https://github.com/helm/chart-releaser-action)
 12 | - [Sync Repository README](.github/workflows/sync-readme.yaml) to GitHub pages
 13 |     so that any updates there also visible to GitHub pages
 14 | 
 15 | The only assumption is that your default branch is called `main`.
 16 | If you are using something else then you should search for occurrences of `main` and replace it with the you default branch name.
 17 | 
 18 | ## Chart Migration
 19 | 
 20 | Do you want to migrate an existing chart from one git repository to a new
 21 | one, but want to get rid of all files which do not belong to the chart and at
 22 | the same time preserver the chart history?
 23 | Then this section is for you!
 24 | 
 25 | Typical use cases:
 26 | 
 27 | - migration of a chart from stable or incubator repository to a new location as
 28 |     those repositories have been deprecated
 29 | - migration from one chart from a repository which contained next to the chart
 30 |     also application source code to a reppository, which should only host the
 31 |     chart
 32 | 
 33 | This is basically a summary of helm chart migrations which already took place:
 34 | 
 35 | 1. `stable/prometheus-*` to <https://github.com/prometheus-community/helm-charts>
 36 |    Thanks to [Scott Rigby](https://github.com/scottrigby) who was the primary of driver of that migration,
 37 |    which included 17 prometheus related charts.
 38 |    The whole migration was tracked in <https://github.com/prometheus-community/helm-charts/projects/1> and <https://github.com/prometheus-community/helm-charts/projects/2>.
 39 |    That's where many of the code snippets, templates and inspirations came from!
 40 | 1. `stable/jenkins` to <https://github.com/jenkinsci/helm-charts>
 41 | 1. `stable/grafana` to <https://github.com/grafana/helm-charts>
 42 |    That migration was done in about a day.
 43 |    <https://github.com/grafana/helm-charts/issues/3> was used to document the executed steps.
 44 |    That's helped to write this.
 45 | 
 46 | ### Prerequisites
 47 | 
 48 | - [git](https://git-scm.com/) is installed on you machine
 49 | 
 50 |   ```shell
 51 |   brew install git
 52 |   ```
 53 | 
 54 | - [git-filter-repo](https://github.com/newren/git-filter-repo) is installed
 55 | 
 56 |   ```shell
 57 |   brew install git-filter-repo
 58 |   ```
 59 | 
 60 | - an empty repository in GitHub where the chart should be migrated to
 61 | 
 62 | ### Migration Steps
 63 | 
 64 | 1. Clone the original repository
 65 | 
 66 |    ```shell
 67 |    git clone <SOURCE_REPO_URL> temp-repo
 68 |    ```
 69 | 
 70 | 1. Filter the history
 71 |    The command below filters the history and also renames the directory so that the chart is afterwards in a directory called `charts/`
 72 | 
 73 |    ```shell
 74 |    cd temp-repo
 75 |    git filter-repo --path-glob '<CHART-DIRECTORY>/*' --path-rename
 76 |    <CHART-PARENT-DIRECTORY>/:charts/
 77 |    ```
 78 | 
 79 |    This was used to filter grafana chart's history from stable repository
 80 |   
 81 |    ```shell
 82 |    git filter-repo --path-glob 'stable/grafana/*' --path-rename stable/:charts/
 83 |    ```
 84 | 
 85 | 1. Push the repository to it's new location
 86 |   
 87 |    ```shell
 88 |    git checkout -b main
 89 |    git remote add origin <NEW_REPO_URL>
 90 |    git push origin main
 91 |    ```
 92 | 
 93 | 1. Create an empty GitHub Pages branch
 94 | 
 95 |    This branch will be used to publish the `index.yaml` which is the index of the chart repository.
 96 | 
 97 |    ```shell
 98 |    git checkout --orphan gh-pages
 99 |    git rm -rf .
100 |    git commit --allow-empty -m "root commit"
101 |    git push origin gh-pages
102 |    ```
103 | 
104 | 1. Configure branch protection rules
105 | 
106 |    We have two important branches in our repository `main` and `gh-pages`.
107 |    It's worth to protect both from accidental force pushes etc.
108 |    These settings have proven useful:
109 |    - `main` brach
110 |      - Require pull request reviews before merging
111 |      - Dismiss stale pull request approvals when new commits are pushed
112 |      - Require review from Code Owners
113 |        This is not strictly required, but quite useful if you host multiple
114 |        charts in the same repository as it allows you to define who has to
115 |        approve changes in which chart.
116 |      - Require status checks to pass before merging
117 |        Once the first PR pipeline was run you should come back here and
118 |        activate:
119 |        - DCO
120 |        - Lint Code Base
121 |        - lint-test
122 |    - `gh-pages` branch
123 |      The whole configuration can be empty.
124 |      It's only purpose is to prevent force push and prevent delections.
125 |      PR approvals are not useful here as the release pipeline want's to push here directly.
126 | 
127 | 1. Copy template files to the new repository
128 | 
129 |    You should copy the following files to your new repository.
130 |    Don't worry about the content for now we will get to that in a moment.
131 | 
132 |    ```text
133 |    LICENSE
134 |    ct.yaml
135 |    CODE_OF_CONDUCT.md
136 |    .github/CODEOWNERS
137 |    .github/workflows/lint-test.yaml
138 |    .github/workflows/linter.yml
139 |    .github/workflows/release.yaml
140 |    .github/workflows/sync-readme.yaml
141 |    CHART-README.md
142 |    CONTRIBUTING.md
143 |    REPO-README.md
144 |    ```
145 | 
146 | 1. Decide which License to use
147 | 
148 |    The template contains Apache 2.0 License.
149 |    If you want something different then replace that file.
150 | 
151 | 1. Update Contributing Guidelines
152 | 
153 |    CONTRIBUTING.md is a standard contribution template.
154 |    That should serve as a starting point.
155 |    If you want to enforce DCO check then [DCO](https://github.com/apps/dco) GitHub App could be used for that.
156 |    If you don't want DCO then also remove it from contributing guidelines.
157 | 
158 | 1. Code of Conduct
159 | 
160 |    The template points to the CNCF Code of Conduct.
161 | 
162 | 1. Repository README
163 | 
164 |    You can rename `REPO-README.md` to `README.md`.
165 |    The file contains some placeholders, which need to be replaced.
166 | 
167 | 1. GitHub issue and pull request templates
168 | 
169 |    - [bug report](./ISSUE_TEMPLATE/bug_report.md)
170 |    - [feature request](./ISSUE_TEMPLATE/feature_request.md)
171 |    - [pull request](./PULL_REQUEST_TEMPLATE.md)
172 | 
173 | 1. GitHub Workflows
174 | 
175 |    These are the files in `.github/workflows/`.
176 |    In case you chart depends on other charts you need to add this to `release.yaml`workflow directly after installation of helm
177 | 
178 |    ```yaml
179 |          - name: Add dependency chart repos
180 |            run: |
181 |              helm repo add stable https://kubernetes-charts.storage.googleapis.com/
182 |              helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
183 |    ```
184 | 
185 | 1. Run linter on all files
186 | 
187 |    The workflow for super linter just checks modified files.
188 |    To provide a good contributor experience you should check all files for
189 |    errors now and fix them.
190 |    That way you don't put that burdon on the first one who changes a file with
191 |    errors.
192 | 
193 |    ```shell
194 |    docker run -e RUN_LOCAL=true -e VALIDATE_YAML=false -v $(pwd):/tmp/lint github/super-linter
195 |    ```
196 | 
197 |    Note: VALIDATE_YAML is also disabled in the workflow as helm templates are golang templates and not valid yaml files.
198 | 
199 | 1. Chart README
200 | 
201 |    `CHART-README.md`, which was copied from <https://gist.github.com/scottrigby/8117c4a4a10a33e597ca98f6aca95e8a> is a great template for a Helm Chart README.
202 |    You can use that structure to adapt the existing README if you like.
203 |    In any case you should update the installation instructions as at least the chart repository was changed.
204 | 
205 | 1. Release first version of the Chart
206 | 
207 |    Together with the README changes you should increase the Chart version in `Chart.yaml`.
208 |    I suggest to increase at the minor version.
209 | 
210 | 1. Commit all changes and create a pull request for it
211 | 
212 |    Now you are ready to go to create your first pull request for your new repository.
213 |    You should see the Github checks running (and hopefully passing).
214 |    That's a good time to revisit you branch protection settings and activate the status checks,
215 |    which should be required to pass before a pull request can be merged.
216 |    If everything it ok, you can go ahead and merge your PR.
217 | 
218 |    Congratulations!
219 |    The first version of the chart should be released in your new repository!
220 | 
221 | 1. Test the new repository
222 | 
223 |    Follow your updated installation instructions of you chart and check if everything is working.
224 | 
225 | 1. Deprecate the old chart
226 | 
227 |    Now that everything is migrated you should go ahead and deprecate your old chart.
228 |    For this you need to
229 |    - prefix the description with "DEPRECATED - ",
230 |    - add `deprecated: true`
231 |    - add a comment above the deprecation flag where the chart was moved to
232 |    - remove all maintainers as deprecated charts should not have maintainers
233 |    - release the chart
234 | 
235 | 1. List your new chart in <https://artifacthub.io/>
236 | 


--------------------------------------------------------------------------------
/REPO-README.md:
--------------------------------------------------------------------------------
 1 | # {{ .Chart.Name }} Community Kubernetes Helm Charts
 2 | 
 3 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 4 | 
 5 | This functionality is in beta and is subject to change. The code is provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
 6 | 
 7 | ## Usage
 8 | 
 9 | [Helm](https://helm.sh) must be installed to use the charts.
10 | Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
11 | 
12 | Once Helm is set up properly, add the repo as follows:
13 | 
14 | ```console
15 | helm repo add {{ .GitHubOrg }} https://{{ .GitHubOrg }}.github.io/helm-charts
16 | ```
17 | 
18 | You can then run `helm search repo {{ .GitHubOrg }}` to see the charts.
19 | 
20 | ## Contributing
21 | 
22 | <!-- Keep full URL links to repo files because this README syncs from main to gh-pages.  -->
23 | We'd love to have you contribute! Please refer to our [contribution guidelines](<https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md>) for details.
24 | 
25 | ## License
26 | 
27 | <!-- Keep full URL links to repo files because this README syncs from main to gh-pages.  -->
28 | [Apache 2.0 License](<https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/LICENSE>).
29 | 


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-slate
2 | include: [.github]
3 | 


--------------------------------------------------------------------------------
/ct.yaml:
--------------------------------------------------------------------------------
1 | # See https://github.com/helm/chart-testing#configuration
2 | remote: origin
3 | target-branch: main
4 | chart-dirs:
5 |   - charts
6 | helm-extra-args: --timeout 600s
7 | 


--------------------------------------------------------------------------------