snowdrop / godaddy-webhook

Cert Manager Godaddy Webhook performing ACME challenge using DNS record
Apache License 2.0
72 stars 62 forks source link

Documentation Godaddy API and Secret clarification #22

Closed mike-prog-lab closed 11 months ago

mike-prog-lab commented 1 year ago

Hi team! Thank you for the webhook you created.

I have a question/suggestion to project documentation.

Problem

The explanation for Kubernetes Secret containing Godaddy credentials tells to concatenate API and Secret and place the value into token field. So I decided that it's an environment API endpoint that webhook application should use to fetch the records, either https://api.godaddy.com/ or https://api.ote-godaddy.com/. But after concatenation (result value in token field: https://api.godaddy.com/:someapisecret) I was getting 401 from Godaddy.

README.md (main branch)

...
52 | In order to communicate with Godaddy DNS provider, we will create a Kubernetes Secret
53 | to store the Godaddy `API` and `GoDaddy Secret`. 
...

Resolved Solution

After replacing API endpoint with API Key (result value in token field: someapikey:someapisecret) all is working as expected.

Question

  1. Is it actually the issue or such convention is used for Godaddy's credentials?
  2. Is the explanation in note mentioned in Problem section is planned or is it an artefact from previous versions?
  3. Would it be appropriate to clarify the variables' description used in Kubernetes Secret to match Godaddy's naming convention?

Suggestion

If you consider the changes relevant I could make a PR if required. Writing here some thoughts for changes:

README.md (main branch source)

...
52 | In order to communicate with Godaddy DNS provider, we will create a Kubernetes Secret
53 | to store the Godaddy API's `Key` and `Secret` from **production** or **OTE**.
...
68 | token: <GODADDY_API_KEY:GODADDY_API_SECRET>
...
cmoulliard commented 11 months ago

I updated the documentation to clarify the values to set for the token which corresponds to: GODADDY_API_KEY:GODADDY_SECRET_KEY