Features: add renovate, use default api key, add docs, allow existing PVC, and more #7

Merged

jessebot merged 3 commits from features/renovate-default-api-key-docs into main

2024-11-17 14:18:43 +00:00

jessebot commented

2024-11-17 14:12:06 +00:00

(Migrated from github.com)

Changes

add docs on what's changed since the fork in README.md
add chart testing workflow for new changes (will run in PRs)
add myself as a maintainer in Chart.yaml
temporarily disable automatic Chart.yaml version bumping, since it only does minor versions. (Will add back to PR workflow with additional version capabilities later)
pin the appVersion in Chart.yaml to the current version of the libretranslate docker image
Use renovate to automatically update the libretranslate verison as it gets out of date
change appSettings.secretKeys.apiKeysecret to appSettings.secretKeys.apiKeySecret
change appSettings.secretKeys.apiKeyorigin to appSettings.secretKeys.apiKeyOrigin

allow using an existing PVC for database and models volumes with:

persistence:
  enabled: true
  db:
    existingClaim: "my-existing-db-claim"
  models:
    existingClaim: "my-existing-models-claim"

use an init container to set the default api key for the instance, if one is passed in, which you can do via this:

appSettings:
  # -- Set this to an api key secret you'd like to use, or an existing k8s Secret
  # use appSettings.existingSecret and appSettings.secretKeys.apiKeySecret. This
  # currently acts as the default API Key. Uses appConfig.reqLimit as the default
  # requests per minute. If you do not set appConfig.reqLimit (or leave it as "null"),
  # the default requests per minute is 120
  requireApiKeySecret: ""

or this:

appSettings:
  # -- use an existing Kubernetes Secret for api key origin and secret
  existingSecret: "my-existing-kubernetes-secret"
  # keys in an existing Kubernetes Secret
  secretKeys:
    # -- key in existing Kubernetes Secret for api key secret. If set,
    # ignores appSettings.requireApiKeySecret
    apiKeySecret: "secret"

# Changes - add docs on what's changed since the fork in README.md - add chart testing workflow for new changes (will run in PRs) - add myself as a maintainer in Chart.yaml - temporarily disable automatic Chart.yaml version bumping, since it only does minor versions. (Will add back to PR workflow with additional version capabilities later) - pin the appVersion in Chart.yaml to the current version of the libretranslate docker image - Use renovate to automatically update the libretranslate verison as it gets out of date - change `appSettings.secretKeys.apiKeysecret` to `appSettings.secretKeys.apiKeySecret` - change `appSettings.secretKeys.apiKeyorigin` to `appSettings.secretKeys.apiKeyOrigin` - allow using an existing PVC for database and models volumes with: ```yaml persistence: enabled: true db: existingClaim: "my-existing-db-claim" models: existingClaim: "my-existing-models-claim" ``` - use an init container to set the default api key for the instance, if one is passed in, which you can do via this: ```yaml appSettings: # -- Set this to an api key secret you'd like to use, or an existing k8s Secret # use appSettings.existingSecret and appSettings.secretKeys.apiKeySecret. This # currently acts as the default API Key. Uses appConfig.reqLimit as the default # requests per minute. If you do not set appConfig.reqLimit (or leave it as "null"), # the default requests per minute is 120 requireApiKeySecret: "" ``` or this: ```yaml appSettings: # -- use an existing Kubernetes Secret for api key origin and secret existingSecret: "my-existing-kubernetes-secret" # keys in an existing Kubernetes Secret secretKeys: # -- key in existing Kubernetes Secret for api key secret. If set, # ignores appSettings.requireApiKeySecret apiKeySecret: "secret" ```

cloudymax (Migrated from github.com) reviewed

2024-11-17 14:12:06 +00:00