letsencrypt: Add digitalocean

[peakascendr]

adding digitalocean for propagation-seconds support as 'all others' logic doesn't

Summary by CodeRabbit

• New Features
  • Introduced support for DigitalOcean DNS challenge authentication for Let's Encrypt.
  • Added the ability to specify propagation delays when using DigitalOcean's DNS services.

[home-assistant]

Hi @peakascendr

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]

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.

[coderabbitai]

Walkthrough

Walkthrough

The introduced changes enhance the Let's Encrypt service by adding support for DigitalOcean DNS challenge authentication. The script now checks if the CHALLENGE environment variable is set to "dns" and if the DNS_PROVIDER is "dns-digitalocean." If these conditions are met, it requires a DigitalOcean API token, sets necessary provider arguments, and applies propagation settings, expanding the service's capabilities for DNS verification.

Changes

File Path	Change Summary
letsencrypt/.../lets-encrypt/run	Added support for DigitalOcean DNS challenge authentication, including conditional logic for dns-digitalocean and requirements for API token and provider arguments.
letsencrypt/CHANGELOG.md	Updated to version 5.0.25 to reflect DigitalOcean's propagation-seconds feature and note previous fixes for Gandi DNS support.
letsencrypt/config.yaml	Incremented version from 5.0.24 to 5.0.25, indicating enhancements or bug fixes without changes to other fields.

Sequence Diagrams

DigitalOcean DNS Challenge Authentication Flow

sequenceDiagram
    actor User
    participant Script
    participant DigitalOcean

    User->>Script: Set `CHALLENGE` to "dns" and `DNS_PROVIDER` to "dns-digitalocean"
    Script->>Script: Verify `CHALLENGE` and `DNS_PROVIDER` conditions
    Script->>Script: Require `dns.digitalocean_token`
    Script->>Script: Set provider arguments for DigitalOcean
    Script->>DigitalOcean: Authenticate using API token
    DigitalOcean-->>Script: Provide DNS challenge response
    Script-->>User: Successful DigitalOcean DNS challenge authentication

Loading

This diagram illustrates the process of handling DigitalOcean DNS challenge authentication, highlighting the script's checks for conditions, requirement of the API token, setting up provider arguments, and the interaction with DigitalOcean to complete the DNS challenge.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5c20ab7 and dd478e9.

Files selected for processing (3)

• letsencrypt/CHANGELOG.md (1 hunks)
• letsencrypt/config.yaml (1 hunks)
• letsencrypt/rootfs/etc/services.d/lets-encrypt/run (1 hunks)

Files skipped from review due to trivial changes (1)

• letsencrypt/config.yaml

Additional context used

Path-based instructions (1)

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.

Additional comments not posted (2)

letsencrypt/CHANGELOG.md (1)

3-5: Correct and consistent changelog entry.

The new entry for version 5.0.25 is clear and follows the existing format.

letsencrypt/rootfs/etc/services.d/lets-encrypt/run (1)

95-99: Correct integration of DigitalOcean DNS provider.

The new conditional block for the DigitalOcean DNS provider is correctly integrated and follows the existing pattern for other DNS providers.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[agners]

@peakascendr thanks for your PR!

This needs a bump of the version in config.yaml and an update in the CHANGELOG.md so it will lead to a new add-on release.

Stale

[agners]

This needs a bump of the version in config.yaml and an update in the CHANGELOG.md so it will lead to a new add-on release.

I went ahead and made the change, so we can close this one.

[frenck]

Thanks both! 👍

../Frenck