docs
docs copied to clipboard
Make instructions for private registry cred request more generic
The current set of instructions is not really detailed enough to help a customer provide the necessary information that the support agent needs to complete the request. Ideally, once a request comes in, the support agent will provide the full set of instructions for creating and sending the credentials.
I am not opposed to providing the full instructions on the docs site. The only concern is that the instructions may be too detailed and may bloat the page.
Here are the full set of instructions.
Please follow these instructions to obtain the necessary information for creating a Kubernetes Secret to contain the credential to the private registry.
- Generate the private registry credentials
- Choose the name of the Kubernetes Secret
- Obtain the Name and ID of the Deployment where the private registry credentials will be used
To retrieve the private registry credentials, follow the Kubernetes documentation to get the contents of ~/.docker/config.json. If the file does not contain credentials similar to the examples below, you will need to create the credentials manually.
To create the credential:
Retrieve the username and password used to authenticate to the private registry
Replace the values in echo -n '<username>:<password>' | base64 and run the command to generate the auth key, which is a base64 encoded string of the user and password.
Replace the value for the private registry server and auth key in the below credential template.
{
"auths": {
"<private-registry-server>": {
"auth": "<auth_key>"
}
}
}
You should have something like this.
{
"auths": {
"https://index.docker.io/v1/": {
"auth": "c3R...zE2"
}
}
}
Next, store the credential in a secure location to share with the support agent. Astronomer recommends sharing the value through secrets.procore.
To conclude, you should now present the following information to the support agent for us to complete your request.
- Link for the support agent to access the private registry credentials
- Name of the Kubernetes Secret
- Name and ID of the Deployment where the private registry credentials will be used