From 5c09cf8c799ef904180b9b92bd113b81ec618971 Mon Sep 17 00:00:00 2001 From: Markus Pesch Date: Sun, 12 Oct 2025 21:11:45 +0200 Subject: [PATCH] docs(README): skip rendering of file content --- README.md | 113 +++++++++++++++++----------------------------------- values.yaml | 8 ++-- 2 files changed, 40 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index 5487deb..f3a9eac 100644 --- a/README.md +++ b/README.md @@ -183,83 +183,42 @@ annotations with the prefix `checksum`. ### Configuration -| Name | Description | Value | -| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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.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.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.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.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.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.content` | The content of the download mode file. | `downloadURL = "https://proxy.golang.org" - -mode = "async_redirect" - -# download "github.com/gomods/*" { -# mode = "sync" -# } -# -# download "golang.org/x/*" { -# mode = "none" -# } -# -# download "github.com/pkg/*" { -# mode = "redirect" -# 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` | -| `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` | -| `config.gitConfig.configMap.annotations` | Additional annotations of the config map containing the .gitconfig file. | `{}` | -| `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 -` | +| Name | Description | Value | +| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | +| `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.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.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.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.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.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.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` | +| `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` | +| `config.gitConfig.configMap.annotations` | Additional annotations of the config map containing the .gitconfig file. | `{}` | +| `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` | +| `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.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. | `{}` | ### Deployment diff --git a/values.yaml b/values.yaml index 2162688..dea5da0 100644 --- a/values.yaml +++ b/values.yaml @@ -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.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: annotations: {} 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.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: annotations: {} labels: {} @@ -173,7 +173,7 @@ config: ## @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.content The content of the .netrc file. + ## @skip config.netrc.secret.content The content of the .netrc file. secret: annotations: {} 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.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_pub The content of the public SSH ed25519 key. ## @skip config.ssh.secret.id_rsa The content of the private SSH RSA key.