deepgram / self-hosted-resources

Official Deepgram resources for deploying Deepgram services in a self-hosted environment
https://developers.deepgram.com
ISC License
11 stars 6 forks source link

Fix sample k8s secret command for quay credentials #41

Closed bd-g closed 2 months ago

bd-g commented 2 months ago

Proposed changes

Update sample files to fix an issue with sample files. The sample command for creating a Kubernetes Secret to store Quay credentials would fail in certain situations, most commonly on MacOS with Docker Desktop installed.

Previous command:

kubectl create secret generic dg-regcred \
  --from-file=.dockerconfigjson=$HOME/.docker/config.json \
  --type=kubernetes.io/dockerconfigjson

This previous command used --from-file with the user's Docker configuration file. When using MacOS with Docker Desktop installed, Docker Desktop will store credentials in Apple Keychain, leaving the configuration file empty. The k8s secret creation then results in an empty secret being created, as it doesn't attempt to pull the secret from Apple Keychain.

This PR changes the default command to work regardless of whether the config file is scrubbed, by directly passing the credentials.

[!NOTE] Deepgram provides this sample command for convenience, however, we still recommend using an external Secrets store provider to manage Kubernetes secrets see docs.

Types of changes

Checklist