docs: use stringData in the DigitalOcean DNS01 Secret example#2159
Open
yugstar wants to merge 1 commit into
Open
docs: use stringData in the DigitalOcean DNS01 Secret example#2159yugstar wants to merge 1 commit into
yugstar wants to merge 1 commit into
Conversation
The DigitalOcean ACME DNS01 example used a base64-encoded `data` field plus separate base64 instructions, which users found confusing (cert-manager#354). Switch the example to `stringData` so the token is given in plain text, matching the Cloudflare example, and drop the now-redundant base64 encoding steps. Also fixes a malformed closing code fence. Closes cert-manager#354 Signed-off-by: Aman Raj <aman.yug@gmail.com>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Switches the DigitalOcean ACME DNS01
Secretexample to usestringDatainstead of a base64-encodeddatafield, and removes the now-redundant base64 encoding instructions. Also fixes a malformed closing code fence.Why
Issue #354 reports that the base64 instructions on this page are confusing. The reporter noted they would have done the right thing on the first try if the example had not told them to base64-encode the token. When closing the earlier PR #740, @SgtCoDFish suggested that adding a
stringDatanote would be a good improvement and invited a new PR.Using
stringDatalets users paste the token in plain text and lets Kubernetes encode it, which removes the footgun. This matches the existing Cloudflare DNS01 example, which already usesstringData.Closes #354