-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6536e94
commit e049e57
Showing
3 changed files
with
107 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{{- define "colearendt.install" }} | ||
{{- $repoName := "colearendt" }} | ||
{{- $repoUrl := "https://colearendt.github.io/helm" }} | ||
|
||
## Installing the Chart | ||
|
||
To install the chart with the release name `my-release` at version {{ template "chart.version" . }}: | ||
|
||
```bash | ||
helm repo add {{ $repoName }} {{ $repoUrl }} | ||
helm install {{- if (regexMatch "[0-9]+\\.[0-9]+\\.[0-9]+-[a-zA-Z\\.0-9]+" .Version) }} --devel{{ end }} my-release {{ $repoName }}/{{ template "chart.name" . }} --version={{ template "chart.version" . }} | ||
``` | ||
|
||
{{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# regcred | ||
|
||
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square) | ||
|
||
## Installing the Chart | ||
|
||
To install the chart with the release name `my-release` at version 0.1.0: | ||
|
||
```bash | ||
helm repo add colearendt https://colearendt.github.io/helm | ||
helm install my-release colearendt/regcred --version=0.1.0 | ||
``` | ||
|
||
#### Description | ||
|
||
This chart simplifies the creation | ||
of ["Registry Credentials"](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) for | ||
use authenticating a Kubernetes cluster to a Container Registry for pulling images. | ||
|
||
This is very important for (1) private images and (2) DockerHub, because of their unfortunate rate limit. | ||
|
||
Each helm deployment only creates a single secret, but that secret can have multiple credentials within it. | ||
|
||
Use this chart to automate away the annoying parts of registry credentials. | ||
|
||
#### Examples | ||
|
||
`ghcr.io` | ||
```yaml | ||
registryCredentials: | ||
- url: ghcr.io | ||
username: 'colearendt' | ||
password: 'my-github-pat' | ||
``` | ||
`docker.io` (DockerHub) | ||
```yaml | ||
registryCredentials: | ||
- url: docker.io | ||
username: 'colearendt' | ||
password: 'my-password-or-token' | ||
``` | ||
|
||
## Values | ||
|
||
| Key | Type | Default | Description | | ||
|-----|------|---------|-------------| | ||
| extraLabels | object | `{}` | | | ||
| fullnameOverride | string | `""` | | | ||
| nameOverride | string | `""` | | | ||
| registryCredentials | list | `[]` | | | ||
|
||
---------------------------------------------- | ||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{{ template "chart.header" . }} | ||
|
||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} | ||
|
||
{{ template "colearendt.install" . }} | ||
|
||
#### Description | ||
|
||
This chart simplifies the creation | ||
of ["Registry Credentials"](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) for | ||
use authenticating a Kubernetes cluster to a Container Registry for pulling images. | ||
|
||
This is very important for (1) private images and (2) DockerHub, because of their unfortunate rate limit. | ||
|
||
Each helm deployment only creates a single secret, but that secret can have multiple credentials within it. | ||
|
||
Use this chart to automate away the annoying parts of registry credentials. | ||
|
||
#### Examples | ||
|
||
`ghcr.io` | ||
```yaml | ||
registryCredentials: | ||
- url: ghcr.io | ||
username: 'colearendt' | ||
password: 'my-github-pat' | ||
``` | ||
|
||
`docker.io` (DockerHub) | ||
```yaml | ||
registryCredentials: | ||
- url: docker.io | ||
username: 'colearendt' | ||
password: 'my-password-or-token' | ||
``` | ||
|
||
{{ template "chart.valuesSection" . }} | ||
|
||
{{ template "helm-docs.versionFooter" . }} |