API Key Secret

Deploying groundcover using an API Key Secret ensures that only authorized entities can access the API's functionalities. It is relatively straightforward compared to other authentication mechanisms, which can be beneficial for rapid deployment and integration.

You can inject the API Key using a custom secret by following these steps:

  • Either manually, or using a secret manager, create a secret in the following structure

apiVersion: v1
kind: Secret
  name: groundcover-api-key
  namespace: groundcover
  API_KEY: <apikey>
type: Opaque
  • Create/Update helm overrides file, with the following override

    secretKey: API_KEY
    secretName: groundcover-api-key

Last updated