volker.raschek/athens-proxy-charts
1
0
Fork 0
Code Issues Pull Requests -1 Actions Packages Projects Releases Wiki Activity

Compare commits

base: volker.raschek:1.0.0
Branches Tags
volker.raschek:master
volker.raschek:1.1.1 volker.raschek:1.1.0 volker.raschek:1.0.3 volker.raschek:1.0.2 volker.raschek:1.0.1 volker.raschek:1.0.0 volker.raschek:0.2.1 volker.raschek:0.2.0 volker.raschek:0.1.5 volker.raschek:0.1.4 volker.raschek:0.1.3 volker.raschek:0.1.2 volker.raschek:0.1.1 volker.raschek:0.1.0
..
compare: volker.raschek:1.0.1
Branches Tags
volker.raschek:master
volker.raschek:1.1.1 volker.raschek:1.1.0 volker.raschek:1.0.3 volker.raschek:1.0.2 volker.raschek:1.0.1 volker.raschek:1.0.0 volker.raschek:0.2.1 volker.raschek:0.2.0 volker.raschek:0.1.5 volker.raschek:0.1.4 volker.raschek:0.1.3 volker.raschek:0.1.2 volker.raschek:0.1.1 volker.raschek:0.1.0

3 Commits
1.0.0 ... 1.0.1

Author SHA1 Message Date
Markus Pesch
3bce806ed6 fix(deployment): mount environment variables and volumes only when enabled
All checks were successful
Helm / helm-lint (push) Successful in 7s
Details
Helm / helm-unittest (push) Successful in 15s
Details
Release / publish-chart (push) Successful in 8s
Details
2025-10-12 21:55:31 +02:00
Markus Pesch
5c09cf8c79 docs(README): skip rendering of file content
All checks were successful
Helm / helm-lint (push) Successful in 7s
Details
Helm / helm-unittest (push) Successful in 6s
Details
Generate README / generate-parameters (push) Successful in 28s
Details
Markdown linter / markdown-link-checker (push) Successful in 12s
Details
Markdown linter / markdown-lint (push) Successful in 28s
Details
2025-10-12 21:11:45 +02:00
Markus Pesch
d4b5c0c86f fix(Chart): adapt annotation 'artifacthub.io/links'
All checks were successful
Helm / helm-lint (push) Successful in 6s
Details
Helm / helm-unittest (push) Successful in 15s
Details
2025-10-12 20:54:08 +02:00
10 changed files with 92 additions and 103 deletions
Expand all files Collapse all files

2
Chart.yaml
View File

@@ -3,7 +3,7 @@ annotations:
- name: Athens proxy (binary) - name: Athens proxy (binary)
url: https://github.com/gomods/athens url: https://github.com/gomods/athens
- name: support - name: support
url: https://git.cryptic.systems/volker.raschek/athens-proxy/issues url: https://git.cryptic.systems/volker.raschek/athens-proxy-charts/issues
apiVersion: v2 apiVersion: v2
name: athens-proxy name: athens-proxy
description: Athens proxy server for golang description: Athens proxy server for golang

113
README.md
View File

@@ -183,83 +183,42 @@ annotations with the prefix `checksum`.
### Configuration ### Configuration
| Name | Description | Value | | Name | Description | Value |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| `config.env.enabled` | Enable mounting of the secret as environment variables. | `false` | | `config.env.enabled` | Enable mounting of the secret as environment variables. | `false` |
| `config.env.existingSecret.enabled` | Mount an existing secret containing the application specific environment variables. | `false` | | `config.env.existingSecret.enabled` | Mount an existing secret containing the application specific environment variables. | `false` |
| `config.env.existingSecret.secretName` | Name of the existing secret containing the application specific environment variables. | `""` | | `config.env.existingSecret.secretName` | Name of the existing secret containing the application specific environment variables. | `""` |
| `config.env.secret.annotations` | Additional annotations of the secret containing the database credentials. | `{}` | | `config.env.secret.annotations` | Additional annotations of the secret containing the database credentials. | `{}` |
| `config.env.secret.labels` | Additional labels of the secret containing the database credentials. | `{}` | | `config.env.secret.labels` | Additional labels of the secret containing the database credentials. | `{}` |
| `config.env.secret.envs` | List of environment variables stored in a secret and mounted into the container. | `{}` | | `config.env.secret.envs` | List of environment variables stored in a secret and mounted into the container. | `{}` |
| `config.downloadMode.enabled` | Enable mounting of a download mode file into the container file system. If enabled, the env `ATHENS_DOWNLOAD_MODE` will automatically be defined. | `false` | | `config.downloadMode.enabled` | Enable mounting of a download mode file into the container file system. If enabled, the env `ATHENS_DOWNLOAD_MODE` will automatically be defined. | `false` |
| `config.downloadMode.existingConfigMap.enabled` | Enable to use an external config map for mounting the download mode file. | `false` | | `config.downloadMode.existingConfigMap.enabled` | Enable to use an external config map for mounting the download mode file. | `false` |
| `config.downloadMode.existingConfigMap.configMapName` | The name of the existing config map which should be used to mount the download mode file. | `""` | | `config.downloadMode.existingConfigMap.configMapName` | The name of the existing config map which should be used to mount the download mode file. | `""` |
| `config.downloadMode.existingConfigMap.downloadModeKey` | The name of the key inside the config map where the content of the download mode file is stored. | `downloadMode` | | `config.downloadMode.existingConfigMap.downloadModeKey` | The name of the key inside the config map where the content of the download mode file is stored. | `downloadMode` |
| `config.downloadMode.configMap.annotations` | Additional annotations of the config map containing the download mode file. | `{}` | | `config.downloadMode.configMap.annotations` | Additional annotations of the config map containing the download mode file. | `{}` |
| `config.downloadMode.configMap.labels` | Additional labels of the config map containing the download mode file. | `{}` | | `config.downloadMode.configMap.labels` | Additional labels of the config map containing the download mode file. | `{}` |
| `config.downloadMode.configMap.content` | The content of the download mode file. | `downloadURL = "https://proxy.golang.org" | `config.gitConfig.enabled` | Enable mounting of a .gitconfig file into the container file system. | `false` |
| `config.gitConfig.existingConfigMap.enabled` | Enable to use an external config map for mounting the .gitconfig file. | `false` |
mode = "async_redirect" | `config.gitConfig.existingConfigMap.configMapName` | The name of the existing config map which should be used to mount the .gitconfig file. | `""` |
| `config.gitConfig.existingConfigMap.gitConfigKey` | The name of the key inside the config map where the content of the .gitconfig file is stored. | `nil` |
# download "github.com/gomods/*" { | `config.gitConfig.configMap.annotations` | Additional annotations of the config map containing the .gitconfig file. | `{}` |
# mode = "sync" | `config.gitConfig.configMap.labels` | Additional labels of the config map containing the .gitconfig file. | `{}` |
# } | `config.netrc.enabled` | Enable mounting of a .netrc file into the container file system. | `false` |
# | `config.netrc.existingSecret.enabled` | Enable to use an external secret for mounting the .netrc file. | `false` |
# download "golang.org/x/*" { | `config.netrc.existingSecret.secretName` | The name of the existing secret which should be used to mount the .netrc file. | `""` |
# mode = "none" | `config.netrc.existingSecret.netrcKey` | The name of the key inside the secret where the content of the .netrc file is stored. | `.netrc` |
# } | `config.netrc.secret.annotations` | Additional annotations of the secret containing the database credentials. | `{}` |
# | `config.netrc.secret.labels` | Additional labels of the secret containing the database credentials. | `{}` |
# download "github.com/pkg/*" { | `config.ssh.enabled` | Enable mounting of a .netrc file into the container file system. | `false` |
# mode = "redirect" | `config.ssh.existingSecret.enabled` | Enable to use an external secret for mounting the public and private SSH key files. | `false` |
# downloadURL = "https://proxy.golang.org" | `config.ssh.existingSecret.secretName` | The name of the existing secret which should be used to mount the public and private SSH key files. | `""` |
# } | `config.ssh.existingSecret.configKey` | The name of the key inside the secret where the content of the SSH client config file is stored. | `config` |
` | | `config.ssh.existingSecret.id_ed25519Key` | The name of the key inside the secret where the content of the id_ed25519 key file is stored. | `id_ed25519` |
| `config.gitConfig.enabled` | Enable mounting of a .gitconfig file into the container file system. | `false` | | `config.ssh.existingSecret.id_ed25519PubKey` | The name of the key inside the secret where the content of the id_ed25519.pub key file is stored. | `id_ed25519.pub` |
| `config.gitConfig.existingConfigMap.enabled` | Enable to use an external config map for mounting the .gitconfig file. | `false` | | `config.ssh.existingSecret.id_rsaKey` | The name of the key inside the secret where the content of the id_rsa key file is stored. | `id_rsa` |
| `config.gitConfig.existingConfigMap.configMapName` | The name of the existing config map which should be used to mount the .gitconfig file. | `""` | | `config.ssh.existingSecret.id_rsaPubKey` | The name of the key inside the secret where the content of the id_ed25519.pub key file is stored. | `id_rsa.pub` |
| `config.gitConfig.existingConfigMap.gitConfigKey` | The name of the key inside the config map where the content of the .gitconfig file is stored. | `nil` | | `config.ssh.secret.annotations` | Additional annotations of the secret containing the public and private SSH key files. | `{}` |
| `config.gitConfig.configMap.annotations` | Additional annotations of the config map containing the .gitconfig file. | `{}` | | `config.ssh.secret.labels` | Additional labels of the secret containing the public and private SSH key files. | `{}` |
| `config.gitConfig.configMap.labels` | Additional labels of the config map containing the .gitconfig file. | `{}` |
| `config.gitConfig.configMap.content` | The content of the .gitconfig file. | `# The .gitconfig file
#
# The .gitconfig file contains the user specific git configuration. It generally resides in the user's home
# directory.
#
# [url "git@github.com:"] insteadOf = https://github.com/
` |
| `config.netrc.enabled` | Enable mounting of a .netrc file into the container file system. | `false` |
| `config.netrc.existingSecret.enabled` | Enable to use an external secret for mounting the .netrc file. | `false` |
| `config.netrc.existingSecret.secretName` | The name of the existing secret which should be used to mount the .netrc file. | `""` |
| `config.netrc.existingSecret.netrcKey` | The name of the key inside the secret where the content of the .netrc file is stored. | `.netrc` |
| `config.netrc.secret.annotations` | Additional annotations of the secret containing the database credentials. | `{}` |
| `config.netrc.secret.labels` | Additional labels of the secret containing the database credentials. | `{}` |
| `config.netrc.secret.content` | The content of the .netrc file. | `# The .netrc file
#
# The .netrc file contains login and initialization information used by the auto-login process. It generally
# resides in the user's home directory, but a location outside of the home directory can be set using the
# environment variable NETRC. Both locations are overridden by the command line option -N. The selected file
# must be a regular file, or access will be denied.
#
# https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html
#
# default login [name] password [password/token]
# machine github.com [octocat] password [PAT]
# machine api.github.com [octocat] password [PAT]
` |
| `config.ssh.enabled` | Enable mounting of a .netrc file into the container file system. | `false` |
| `config.ssh.existingSecret.enabled` | Enable to use an external secret for mounting the public and private SSH key files. | `false` |
| `config.ssh.existingSecret.secretName` | The name of the existing secret which should be used to mount the public and private SSH key files. | `""` |
| `config.ssh.existingSecret.configKey` | The name of the key inside the secret where the content of the SSH client config file is stored. | `config` |
| `config.ssh.existingSecret.id_ed25519Key` | The name of the key inside the secret where the content of the id_ed25519 key file is stored. | `id_ed25519` |
| `config.ssh.existingSecret.id_ed25519PubKey` | The name of the key inside the secret where the content of the id_ed25519.pub key file is stored. | `id_ed25519.pub` |
| `config.ssh.existingSecret.id_rsaKey` | The name of the key inside the secret where the content of the id_rsa key file is stored. | `id_rsa` |
| `config.ssh.existingSecret.id_rsaPubKey` | The name of the key inside the secret where the content of the id_ed25519.pub key file is stored. | `id_rsa.pub` |
| `config.ssh.secret.annotations` | Additional annotations of the secret containing the public and private SSH key files. | `{}` |
| `config.ssh.secret.labels` | Additional labels of the secret containing the public and private SSH key files. | `{}` |
| `config.ssh.secret.config` | The content of the SSH client config file. | `# Host *
# IdentityFile ~/.ssh/id_ed25519
# IdentityFile ~/.ssh/id_rsa
` |
### Deployment ### Deployment

34
templates/_pod.tpl
View File

@@ -2,23 +2,23 @@
{{/* annotations */}} {{/* annotations */}}
{{- define "athens-proxy.pod.annotations" -}} {{- define "athens-proxy.pod.annotations" }}
{{ include "athens-proxy.annotations" . }} {{- include "athens-proxy.annotations" . }}
{{- if and .Values.config.env.enabled (not .Values.config.env.existingSecret.enabled) -}} {{- if and .Values.config.env.enabled (not .Values.config.env.existingSecret.enabled) }}
{{- printf "checksum/secret-%s: %s" (include "athens-proxy.secrets.env.name" $) (include (print $.Template.BasePath "/secretEnv.yaml") . | sha256sum) }} {{ printf "checksum/secret-%s: %s" (include "athens-proxy.secrets.env.name" $) (include (print $.Template.BasePath "/secretEnv.yaml") . | sha256sum) }}
{{- end -}} {{- end }}
{{- if and .Values.config.downloadMode.enabled (not .Values.config.downloadMode.existingConfigMap.enabled) -}} {{- if and .Values.config.downloadMode.enabled (not .Values.config.downloadMode.existingConfigMap.enabled) }}
{{- printf "checksum/config-map-%s: %s" (include "athens-proxy.configMap.downloadMode.name" $) (include (print $.Template.BasePath "/configMapDownloadMode.yaml") . | sha256sum) }} {{ printf "checksum/config-map-%s: %s" (include "athens-proxy.configMap.downloadMode.name" $) (include (print $.Template.BasePath "/configMapDownloadMode.yaml") . | sha256sum) }}
{{- end -}} {{- end }}
{{- if and .Values.config.gitConfig.enabled (not .Values.config.gitConfig.existingConfigMap.enabled) -}} {{- if and .Values.config.gitConfig.enabled (not .Values.config.gitConfig.existingConfigMap.enabled) }}
{{- printf "checksum/config-map-%s: %s" (include "athens-proxy.configMap.gitConfig.name" $) (include (print $.Template.BasePath "/configMapGitConfig.yaml") . | sha256sum) }} {{ printf "checksum/config-map-%s: %s" (include "athens-proxy.configMap.gitConfig.name" $) (include (print $.Template.BasePath "/configMapGitConfig.yaml") . | sha256sum) }}
{{- end -}} {{- end }}
{{- if and .Values.config.netrc.enabled (not .Values.config.netrc.existingSecret.enabled) -}} {{- if and .Values.config.netrc.enabled (not .Values.config.netrc.existingSecret.enabled) }}
{{- printf "checksum/secret-%s: %s" (include "athens-proxy.secrets.netrc.name" $) (include (print $.Template.BasePath "/secretNetRC.yaml") . | sha256sum) }} {{ printf "checksum/secret-%s: %s" (include "athens-proxy.secrets.netrc.name" $) (include (print $.Template.BasePath "/secretNetRC.yaml") . | sha256sum) }}
{{- end -}} {{- end }}
{{- if and .Values.config.ssh.enabled (not .Values.config.ssh.existingSecret.enabled) -}} {{- if and .Values.config.ssh.enabled (not .Values.config.ssh.existingSecret.enabled) }}
{{- printf "checksum/secret-%s: %s" (include "athens-proxy.secrets.ssh.name" $) (include (print $.Template.BasePath "/secretSSH.yaml") . | sha256sum) }} {{ printf "checksum/secret-%s: %s" (include "athens-proxy.secrets.ssh.name" $) (include (print $.Template.BasePath "/secretSSH.yaml") . | sha256sum) }}
{{- end -}} {{- end }}
{{- end }} {{- end }}

2
templates/configMapDownloadMode.yaml
View File

@@ -1,4 +1,4 @@
{{- if not .Values.config.downloadMode.existingConfigMap.enabled }} {{- if and .Values.config.downloadMode.enabled (not .Values.config.downloadMode.existingConfigMap.enabled) }}
--- ---
apiVersion: v1 apiVersion: v1
kind: ConfigMap kind: ConfigMap

2
templates/configMapGitConfig.yaml
View File

@@ -1,4 +1,4 @@
{{- if not .Values.config.gitConfig.existingConfigMap.enabled }} {{- if and .Values.config.gitConfig.enabled (not .Values.config.gitConfig.existingConfigMap.enabled) }}
--- ---
apiVersion: v1 apiVersion: v1
kind: ConfigMap kind: ConfigMap

2
templates/secretSSH.yaml
View File

@@ -1,4 +1,4 @@
{{- if not .Values.config.ssh.existingSecret.enabled }} {{- if and .Values.config.ssh.enabled (not .Values.config.ssh.existingSecret.enabled) }}
--- ---
apiVersion: v1 apiVersion: v1
kind: Secret kind: Secret

12
unittests/configMaps/downloadMode.yaml
View File

@@ -8,14 +8,22 @@ release:
templates: templates:
- templates/configMapDownloadMode.yaml - templates/configMapDownloadMode.yaml
tests: tests:
- it: Skip rending by default.
asserts:
- hasDocuments:
count: 0
- it: Skip rending by using existing config map. - it: Skip rending by using existing config map.
set: set:
config.downloadMode.enabled: true
config.downloadMode.existingConfigMap.enabled: true config.downloadMode.existingConfigMap.enabled: true
asserts: asserts:
- hasDocuments: - hasDocuments:
count: 0 count: 0
- it: Rendering by default. - it: Rendering with default values
set:
config.downloadMode.enabled: true
asserts: asserts:
- hasDocuments: - hasDocuments:
count: 1 count: 1
@@ -56,6 +64,7 @@ tests:
- it: Rendering custom annotations and labels. - it: Rendering custom annotations and labels.
set: set:
config.downloadMode.enabled: true
config.downloadMode.configMap.annotations: config.downloadMode.configMap.annotations:
foo: bar foo: bar
bar: foo bar: foo
@@ -76,6 +85,7 @@ tests:
- it: Rendering custom configuration - it: Rendering custom configuration
set: set:
config.downloadMode.enabled: true
config.downloadMode.configMap.content: | config.downloadMode.configMap.content: |
downloadURL = "https://proxy.golang.org" downloadURL = "https://proxy.golang.org"
mode = "async_redirect" mode = "async_redirect"

10
unittests/configMaps/gitConfig.yaml
View File

@@ -8,14 +8,22 @@ release:
templates: templates:
- templates/configMapGitConfig.yaml - templates/configMapGitConfig.yaml
tests: tests:
- it: Skip rending by default.
asserts:
- hasDocuments:
count: 0
- it: Skip rending by using existing config map. - it: Skip rending by using existing config map.
set: set:
config.gitConfig.enabled: true
config.gitConfig.existingConfigMap.enabled: true config.gitConfig.existingConfigMap.enabled: true
asserts: asserts:
- hasDocuments: - hasDocuments:
count: 0 count: 0
- it: Rendering by default. - it: Rendering by default.
set:
config.gitConfig.enabled: true
asserts: asserts:
- hasDocuments: - hasDocuments:
count: 1 count: 1
@@ -46,6 +54,7 @@ tests:
- it: Rendering custom annotations and labels. - it: Rendering custom annotations and labels.
set: set:
config.gitConfig.enabled: true
config.gitConfig.configMap.annotations: config.gitConfig.configMap.annotations:
foo: bar foo: bar
bar: foo bar: foo
@@ -66,6 +75,7 @@ tests:
- it: Rendering custom configuration - it: Rendering custom configuration
set: set:
config.gitConfig.enabled: true
config.gitConfig.configMap.content: | config.gitConfig.configMap.content: |
[url "git@github.com:"] [url "git@github.com:"]
insteadOf = https://github.com/ insteadOf = https://github.com/

10
unittests/secrets/ssh.yaml
View File

@@ -8,14 +8,22 @@ release:
templates: templates:
- templates/secretSSH.yaml - templates/secretSSH.yaml
tests: tests:
- it: Skip rending by default.
asserts:
- hasDocuments:
count: 0
- it: Skip rendering by using existing secret. - it: Skip rendering by using existing secret.
set: set:
config.ssh.enabled: true
config.ssh.existingSecret.enabled: true config.ssh.existingSecret.enabled: true
asserts: asserts:
- hasDocuments: - hasDocuments:
count: 0 count: 0
- it: Rendering ssh secret with default values. - it: Rendering ssh secret with default values.
set:
config.ssh.enabled: true
asserts: asserts:
- hasDocuments: - hasDocuments:
count: 1 count: 1
@@ -51,6 +59,7 @@ tests:
- it: Rendering ssh secret with custom values. - it: Rendering ssh secret with custom values.
set: set:
config.ssh.enabled: true
config.ssh.secret.config: | config.ssh.secret.config: |
Host * Host *
IdentityFile ~/.ssh/id_ed25519 IdentityFile ~/.ssh/id_ed25519
@@ -90,6 +99,7 @@ tests:
- it: Rendering custom annotations and labels. - it: Rendering custom annotations and labels.
set: set:
config.ssh.enabled: true
config.ssh.secret.annotations: config.ssh.secret.annotations:
foo: bar foo: bar
bar: foo bar: foo

8
values.yaml
View File

@@ -111,7 +111,7 @@ config:
## @param config.downloadMode.configMap.annotations Additional annotations of the config map containing the download mode file. ## @param config.downloadMode.configMap.annotations Additional annotations of the config map containing the download mode file.
## @param config.downloadMode.configMap.labels Additional labels of the config map containing the download mode file. ## @param config.downloadMode.configMap.labels Additional labels of the config map containing the download mode file.
## @param config.downloadMode.configMap.content The content of the download mode file. ## @skip config.downloadMode.configMap.content The content of the download mode file.
configMap: configMap:
annotations: {} annotations: {}
labels: {} labels: {}
@@ -147,7 +147,7 @@ config:
## @param config.gitConfig.configMap.annotations Additional annotations of the config map containing the .gitconfig file. ## @param config.gitConfig.configMap.annotations Additional annotations of the config map containing the .gitconfig file.
## @param config.gitConfig.configMap.labels Additional labels of the config map containing the .gitconfig file. ## @param config.gitConfig.configMap.labels Additional labels of the config map containing the .gitconfig file.
## @param config.gitConfig.configMap.content The content of the .gitconfig file. ## @skip config.gitConfig.configMap.content The content of the .gitconfig file.
configMap: configMap:
annotations: {} annotations: {}
labels: {} labels: {}
@@ -173,7 +173,7 @@ config:
## @param config.netrc.secret.annotations Additional annotations of the secret containing the database credentials. ## @param config.netrc.secret.annotations Additional annotations of the secret containing the database credentials.
## @param config.netrc.secret.labels Additional labels of the secret containing the database credentials. ## @param config.netrc.secret.labels Additional labels of the secret containing the database credentials.
## @param config.netrc.secret.content The content of the .netrc file. ## @skip config.netrc.secret.content The content of the .netrc file.
secret: secret:
annotations: {} annotations: {}
labels: {} labels: {}
@@ -213,7 +213,7 @@ config:
## @param config.ssh.secret.annotations Additional annotations of the secret containing the public and private SSH key files. ## @param config.ssh.secret.annotations Additional annotations of the secret containing the public and private SSH key files.
## @param config.ssh.secret.labels Additional labels of the secret containing the public and private SSH key files. ## @param config.ssh.secret.labels Additional labels of the secret containing the public and private SSH key files.
## @param config.ssh.secret.config The content of the SSH client config file. ## @skip config.ssh.secret.config The content of the SSH client config file.
## @skip config.ssh.secret.id_ed25519 The content of the private SSH ed25519 key. ## @skip config.ssh.secret.id_ed25519 The content of the private SSH ed25519 key.
## @skip config.ssh.secret.id_ed25519_pub The content of the public SSH ed25519 key. ## @skip config.ssh.secret.id_ed25519_pub The content of the public SSH ed25519 key.
## @skip config.ssh.secret.id_rsa The content of the private SSH RSA key. ## @skip config.ssh.secret.id_rsa The content of the private SSH RSA key.