-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Eurodns DNS support #3912
Add Eurodns DNS support #3912
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
📝 WalkthroughWalkthroughThe changes integrate EuroDNS as a new DNS provider for the Letsencrypt add-on. Documentation is updated with a dedicated section and sample YAML for EuroDNS configuration, while configuration files are enhanced with new optional fields and an updated version number. The build files now include a new argument for specifying the Certbot EuroDNS plugin version, and both the file-structure and run service scripts add logic to handle EuroDNS credentials and processing during DNS challenges. Changes
Sequence Diagram(s)sequenceDiagram
participant Operator as User/Operator
participant Script as Run Script
participant Config as Config Files
participant EuroDNS as EuroDNS Provider
Operator->>Script: Initiate certificate request
Script->>Config: Load DNS configuration settings
alt DNS provider = dns-eurodns
Script->>Script: Check for EuroDNS credentials (applicationId & apiKey)
Script->>EuroDNS: Send DNS challenge request with EuroDNS credentials
else Other DNS providers
Script->>Script: Process as usual for selected DNS provider
end
EuroDNS-->>Script: Return DNS challenge response
Script-->>Operator: Continue certificate issuance process
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh hi there @chwdt 👋
A wild merge conflict appeared on this PR 🙈
Could you maybe take a look and resolve it?
Thanks! 👍
../Frenck
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
letsencrypt/DOCS.md (1)
982-1001
: Addition of Eurodns DNS challenge documentation section
The new details block for the Eurodns DNS challenge is well structured and consistent with the other DNS provider sections. The example YAML clearly demonstrates how to configure Eurodns with the required fields (eurodns_applicationId and eurodns_apiKey). Consider converting the bare URL (https://my.eurodns.com/apiusers) into a markdown link to meet documentation best practices.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
985-985: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
letsencrypt/DOCS.md
(4 hunks)letsencrypt/Dockerfile
(2 hunks)letsencrypt/build.yaml
(1 hunks)letsencrypt/config.yaml
(2 hunks)letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
(1 hunks)letsencrypt/rootfs/etc/services.d/lets-encrypt/run
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
- letsencrypt/build.yaml
- letsencrypt/config.yaml
- letsencrypt/rootfs/etc/services.d/lets-encrypt/run
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...
*/**(html|markdown|md)
: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
letsencrypt/Dockerfile
letsencrypt/DOCS.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...
*/**(html|markdown|md)
: - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
letsencrypt/Dockerfile
letsencrypt/DOCS.md
`*/**(html|markdown|md)`: - Be brief in your replies and don...
*/**(html|markdown|md)
: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
letsencrypt/Dockerfile
letsencrypt/DOCS.md
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...
*/**(html|markdown|md)
: - Use sentence-style capitalization also in headings.
letsencrypt/Dockerfile
letsencrypt/DOCS.md
`*/**(html|markdown|md)`: do not comment on HTML used for ic...
*/**(html|markdown|md)
: do not comment on HTML used for icons
letsencrypt/Dockerfile
letsencrypt/DOCS.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...
*/**(html|markdown|md)
: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
letsencrypt/Dockerfile
letsencrypt/DOCS.md
🪛 markdownlint-cli2 (0.17.2)
letsencrypt/DOCS.md
985-985: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (2)
letsencrypt/Dockerfile (2)
17-17
: New build argument for Eurodns support added
The build argument CERTBOT_DNS_EURODNS_VERSION is inserted correctly into the multi-line ARG list. Verify that this variable is defined in your build configuration (for example, in build.yaml) to ensure proper version substitution during the Docker build.
68-68
: Eurodns plugin installation command included correctly
The pip3 install command now installs certbot-dns-eurodns using the specified version via${CERTBOT_DNS_EURODNS_VERSION}
. Confirm that the provided version in the build configuration matches the expected plugin version to avoid any runtime discrepancies.
Hi @frenck, the merge conflict should be resolved, I removed all changes to version strings in my PR. /chwdt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The slightly older PR #3902 which updates Certboot just made it in, so this PR needs a rebase. Sorry about that!
Make sure to also bump the version in config.yaml
and add a log entry in README.md
.
This commit add support for Eurodns DNS challenges using the certbot plugin provided by Eurodns.
See https://eurodns.com and https://pypi.org/project/certbot-dns-eurodns for further info
Summary by CodeRabbit