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.
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
[x] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation update or tests (if none of the other choices apply)
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:
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.
Types of changes
Checklist