Skip to content
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 support for mijn.host DNS challenge #3749

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

shubhamku044
Copy link

@shubhamku044 shubhamku044 commented Sep 5, 2024

Summary by CodeRabbit

  • New Features

    • Added support for the "mijn.host" DNS service, enhancing DNS challenge configuration options.
    • Introduced a new optional field for the Mijn Host API key in the configuration.
  • Bug Fixes

    • Improved configuration handling for the new DNS provider to ensure proper API key integration.
  • Documentation

    • Expanded the changelog to include version updates and support details for "mijn.host".
  • Chores

    • Updated configuration files to support the new DNS provider functionality.

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @shubhamku044

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

home-assistant bot commented Sep 5, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@shubhamku044
Copy link
Author

Add support for mijn.host dns challenge

@shubhamku044 shubhamku044 marked this pull request as ready for review September 5, 2024 06:16
Copy link
Contributor

coderabbitai bot commented Sep 5, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes include the addition of support for the "mijn.host" DNS service in the Let's Encrypt project. This update encompasses modifications across multiple files, including the changelog, build configuration, and settings files. The updates introduce new variables, configuration options, and instructions to facilitate the integration of the new DNS provider, enhancing the overall functionality of the system.

Changes

Files Change Summary
letsencrypt/CHANGELOG.md Updated to include version 5.2.1 with support for "mijn.host" DNS service; previous entries noted earlier support and removal of Google Domains support.
letsencrypt/build.yaml Added CERTBOT_DNS_MIJN_HOST_VERSION: 0.0.3 to support the new DNS provider.
letsencrypt/config.yaml Introduced mijn_host_api_key and updated the provider field to include dns-mijn-host and dns-google-domains.

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Outside diff range, codebase verification and nitpick comments (1)
letsencrypt/config.yaml (1)

79-79: New Configuration Field Approved

The addition of the mijn_host_api_key field is correctly implemented. It's crucial to ensure that documentation is updated to guide users on how to obtain and use this API key.

@agners
Copy link
Member

agners commented Sep 5, 2024

This needs a newer ACME version. Let's update Certbot first before adding more DNS challenge options.

@shubhamku044
Copy link
Author

okay, I have raised PR in certbot repo, waiting for the maintainers to merge it.

@agners agners marked this pull request as draft September 5, 2024 07:21
@agners
Copy link
Member

agners commented Sep 5, 2024

Maybe I was a bit unclear: mijn certbot plug-in requires ACME 2.11.0, but we ship with 2.7.4 currently:

31.83     certbot-dns-mijn-host 0.0.3 depends on acme==2.11.0

Maybe you could ask certbot-dns-mijn-host to loosen that restriction, but I rather prefer to actually update the add-on to use the latest ACME 2.11.0. I am preparing a PR, hold on.

@shubhamku044
Copy link
Author

thanks, I saw you new PR where you upgrade the acme version

@shubhamku044
Copy link
Author

by when can you merge this pr @agners

@shubhamku044 shubhamku044 marked this pull request as ready for review September 16, 2024 07:27
@agners
Copy link
Member

agners commented Sep 26, 2024

@shubhamku044 with #3751 merged, you can now rebase/merge this PR and move forward.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

🧹 Outside diff range and nitpick comments (1)
letsencrypt/config.yaml (1)

103-104: LGTM: New DNS providers added correctly.

The addition of dns-mijn-host and dns-google-domains to the provider list is correct and aligns with the PR objective. However, consider maintaining alphabetical order for better readability:

dns-gandi|dns-gehirn|dns-godaddy|dns-google|dns-google-domains|\
dns-hetzner|dns-infomaniak|dns-joker|dns-linode|dns-luadns|dns-mijn-host|dns-namecheap|dns-netcup|dns-njalla|dns-nsone|\
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a80da70 and cffcc3d.

📒 Files selected for processing (3)
  • letsencrypt/CHANGELOG.md (1 hunks)
  • letsencrypt/build.yaml (1 hunks)
  • letsencrypt/config.yaml (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
letsencrypt/CHANGELOG.md (6)

Pattern */**(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'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

letsencrypt/build.yaml (6)

Pattern */**(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'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

letsencrypt/config.yaml (6)

Pattern */**(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'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🔇 Additional comments (3)
letsencrypt/build.yaml (1)

27-27: LGTM! Verify consistency with PR objectives.

The addition of CERTBOT_DNS_MIJN_HOST_VERSION: 0.0.3 is consistent with the existing structure and aligns with the PR objective of adding support for the mijn.host DNS challenge.

To ensure this change is properly integrated, please run the following verification:

This script will help verify the proper integration of the mijn.host DNS challenge support and identify any potential conflicts or missing configurations.

letsencrypt/config.yaml (1)

77-77: LGTM: New API key field for mijn.host added correctly.

The addition of the mijn_host_api_key field is consistent with the PR objective and follows the existing pattern for DNS provider configurations.

letsencrypt/CHANGELOG.md (1)

3-6: Changelog entry looks good.

The new entry for version 5.2.1 is correctly formatted, follows the versioning convention, and clearly describes the added feature. It aligns well with the PR objectives of adding support for the mijn.host DNS challenge.

Copy link
Member

@agners agners left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM, thanks!

@@ -99,8 +100,8 @@ schema:
propagation_seconds: int(60,3600)?
provider: "list(dns-azure|dns-cloudflare|dns-cloudns|dns-desec|\
dns-digitalocean|dns-directadmin|dns-dnsimple|dns-dnsmadeeasy|\
dns-duckdns|dns-dynu|dns-gehirn|dns-godaddy|dns-google|\
dns-hetzner|dns-infomaniak|dns-joker|dns-linode|dns-luadns|dns-njalla|dns-nsone|\
dns-duckdns|dns-dynu|dns-gehirn|dns-godaddy|dns-google|dns-google-domains|\
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That got dropped with #3750. This probably came in through a merge conflict:

Suggested change
dns-duckdns|dns-dynu|dns-gehirn|dns-godaddy|dns-google|dns-google-domains|\
dns-duckdns|dns-dynu|dns-gehirn|dns-godaddy|dns-google|\

@home-assistant home-assistant bot marked this pull request as draft September 26, 2024 16:34
@agners
Copy link
Member

agners commented Sep 26, 2024

Hm, seems there is still a merge conflict:

 #7 35.42 The conflict is caused by:
#7 35.42     The user requested cryptography==43.0.1
#7 35.42     certbot 2.11.0 depends on cryptography>=3.2.1
#7 35.42     certbot-dns-mijn-host 0.0.3 depends on cryptography==43.0.0

I guess the bump now bumped cryptography too high (to 43.0.1 🙈 ). Can the plug-in maybe loosen that restriction 🤔

@shubhamku044
Copy link
Author

sure, I will make the necessary changes

@agners
Copy link
Member

agners commented Sep 27, 2024

FWIW, PR #3776 reverts Cryptography to 42 also for another reason, so you can rebase on this instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants