0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-27 22:59:51 -05:00

chore (docs): Update Uplinks/K8s doc to reference secretEnvVars (#3142)

* Chore: Update Uplinks/K8s doc to reference `secretEnvVars`

* Update Uplinks Documentation to refer to the Helm Chart's new
  `secretEnvVars` value
* Update Kubernetes Documentation with the new `secretEnvVars` helm
  value

* k8s doc wording
This commit is contained in:
Robert Blaine 2022-04-25 20:51:50 +02:00 committed by GitHub
parent 23fb97b2e1
commit a11f8aa0d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 0 deletions

View file

@ -102,6 +102,19 @@ use:
helm install npm --set existingConfigMap=verdaccio-config verdaccio/verdaccio
```
### Authenticate with private upstreams using Helm
As of version `4.8.0` of the helm chart, a new `secretEnvVars` field has been added.
This allows you to inject sensitive values to the container via a [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/).
1. Update your Verdaccio config according to the [Uplinks](./uplinks.md#auth-property) documentation
2. Pass the secret environment variable to your values file or via `--set secretEnvVars.FOO_TOKEN=superSecretBarToken`
```yaml
# values.yaml
secretEnvVars:
FOO_TOKEN: superSecretBarToken
```
#### NGINX proxy body-size limit {#nginx-proxy-body-size-limit}
The standard k8s NGINX ingress proxy allows for 1MB for body-size which can be increased

View file

@ -84,3 +84,4 @@ uplinks:
* Setting `cache` to false will help to save space in your hard drive. This will avoid store `tarballs` but [it will keep metadata in folders](https://github.com/verdaccio/verdaccio/issues/391).
* Exceed with multiple uplinks might slow down the lookup of your packages due for each request a npm client does, verdaccio does 1 call for each uplink.
* The (timeout, maxage and fail_timeout) format follow the [NGINX measurement units](http://nginx.org/en/docs/syntax.html)
* When using the [Helm Chart](https://github.com/verdaccio/charts), you can use `secretEnvVars` to inject sensitive environment variables, which can be used to configure private uplink auth.