letsencrypt: Add transip global_key parameter #3835
Conversation
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
There was a problem hiding this comment.
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!
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
home-assistant
bot
added
cla-recheck
cla-signed
and removed
cla-recheck
cla-needed
labels
|
Warning Rate limit exceeded@nathansamson has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 52 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 Walkthrough📝 WalkthroughWalkthroughThe Changes
Assessment against linked issues
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
letsencrypt/rootfs/etc/cont-init.d/file-structure.sh (1)
64-64: Consider using a more secure method for writing credentials.While the file permissions are correctly set to 600, writing credentials using
echocould potentially expose them in process listings. Consider using a more secure method likeprintfwith a heredoc or writing directly to the file descriptor.Here's a suggested pattern for writing credentials more securely:
- echo -e "dns_transip_global_key = $(bashio::config 'dns.transip_global_key')\n" \ + printf '%s\n' "dns_transip_global_key = $(bashio::config 'dns.transip_global_key')" \This approach reduces the risk of credential exposure in process listings while maintaining the same functionality.
| @@ -61,6 +61,7 @@ echo -e "dns_desec_token = $(bashio::config 'dns.desec_token')\n" \ | |||
| "dns_sakuracloud_api_token = $(bashio::config 'dns.sakuracloud_api_token')\n" \ | |||
| "dns_sakuracloud_api_secret = $(bashio::config 'dns.sakuracloud_api_secret')\n" \ | |||
| "dns_transip_username = $(bashio::config 'dns.transip_username')\n" \ | |||
| "dns_transip_global_key = $(bashio::config 'dns.transip_global_key')\n" \ | |||
There was a problem hiding this comment.
💡 Codebase verification
Documentation needs to be updated for TransIP global key
The new dns.transip_global_key parameter is added to the configuration but not documented in DOCS.md. The documentation only mentions the username and API key authentication method.
- Update
letsencrypt/DOCS.mdto include:- Documentation for the new
transip_global_keyparameter - Example configuration showing the global key authentication method
- Any specific requirements or limitations for using the global key
- Documentation for the new
🔗 Analysis chain
LGTM! Verify TransIP global key integration.
The new parameter is correctly integrated alongside existing TransIP configurations and follows the established naming convention.
Let's verify the TransIP configuration handling:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify TransIP configuration handling and documentation
# Check if TransIP configuration is documented
rg -l "transip_global_key" --type md
# Check for any existing TransIP key handling patterns
rg "transip.*key" --type bash
Length of output: 97
Script:
#!/bin/bash
# Let's try different approaches to verify TransIP configuration
# Check documentation files for TransIP global key
rg -l "transip.*global.*key" --type-add 'docs:*.{md,txt,rst}' -tdocs
# Check shell scripts for TransIP key handling (using .sh extension)
fd -e sh -x rg -l "transip.*key" {}
# Look for TransIP configuration patterns in shell scripts
fd -e sh -x rg "dns.transip" {}
# Check for any documentation about TransIP DNS configuration
rg -l "transip" --type-add 'docs:*.{md,txt,rst}' -tdocs
Length of output: 603
Script:
#!/bin/bash
# Let's check the documentation content and related configuration
# Check the content of DOCS.md for TransIP documentation
rg -A 5 -B 5 "transip" letsencrypt/DOCS.md
# Look for any configuration schema that might define these parameters
fd -e json -x rg -l "transip" {}
fd -e json -x cat {} | grep -i "transip" -A 5 -B 5
Length of output: 1253
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
letsencrypt/DOCS.md (1)
650-651: Improve URL formatting and parameter documentation
- Format the URL using markdown link syntax instead of a bare URL
- Specify the exact value to use for the parameter
Apply this diff to improve the documentation:
-If you can't use IP whitelisting, use the `transip_global_key` and set it to yes. (https://github.com/hsmade/certbot-dns-transip/blob/master/USAGE.rst#ip-whitelistsing) +If you can't use IP whitelisting, set the `transip_global_key` parameter to `'yes'`. See [TransIP DNS plugin documentation](https://github.com/hsmade/certbot-dns-transip/blob/master/USAGE.rst#ip-whitelistsing) for more details.🧰 Tools
🪛 Markdownlint (0.35.0)
650-650: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
letsencrypt/DOCS.md(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
letsencrypt/DOCS.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.
🪛 Markdownlint (0.35.0)
letsencrypt/DOCS.md
650-650: null
Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (1)
letsencrypt/DOCS.md (1)
149-149: LGTM!
The new configuration parameter is correctly added to the DNS provider configuration list.
|
Thanks for your contribution! This requires at least a patch version bump in |
agners
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
letsencrypt/DOCS.md (1)
682-683: Format the URL as a proper markdown linkThe bare URL should be formatted as a proper markdown link for better readability and consistency.
Apply this change:
-If you can't use IP whitelisting, use the `transip_global_key` and set it to yes. (https://github.com/hsmade/certbot-dns-transip/blob/master/USAGE.rst#ip-whitelistsing) +If you can't use IP whitelisting, use the `transip_global_key` and set it to yes. See [IP whitelisting documentation](https://github.com/hsmade/certbot-dns-transip/blob/master/USAGE.rst#ip-whitelistsing).🧰 Tools
🪛 Markdownlint (0.35.0)
682-682: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
letsencrypt/DOCS.md(2 hunks)letsencrypt/rootfs/etc/cont-init.d/file-structure.sh(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
🧰 Additional context used
📓 Path-based instructions (1)
letsencrypt/DOCS.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.
🪛 Markdownlint (0.35.0)
letsencrypt/DOCS.md
682-682: null
Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (1)
letsencrypt/DOCS.md (1)
154-154: LGTM: New TransIP configuration parameter added correctly
The transip_global_key parameter has been properly added to the DNS provider configuration section, maintaining consistency with other parameters.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
letsencrypt/CHANGELOG.md (1)
5-5: Enhance the changelog entry to be more descriptive.While concise, the current entry could better explain the purpose and impact of this change.
Consider expanding it to:
- Add transip global_key parameter + Add transip global_key parameter to support authentication without IP whitelist requirements
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
letsencrypt/CHANGELOG.md(1 hunks)letsencrypt/DOCS.md(2 hunks)letsencrypt/config.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- letsencrypt/config.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
- letsencrypt/DOCS.md
🧰 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 (1)
letsencrypt/CHANGELOG.md (1)
3-4: LGTM! Version bump is appropriate.
The patch version increment from 5.2.7 to 5.2.8 is correct for adding a new configuration parameter.
I've done so. It feels weird to choose a new version number though I would expect to add an entry to the changelog under Unreleased, and then let the release maintainer fill in the version number... If I did it wrong, let me know |
There was a problem hiding this comment.
I've done so. It feels weird to choose a new version number though
I would expect to add an entry to the changelog under Unreleased, and then let the release maintainer fill in the version number...
I get your point, but currently merging to master immediately deploys the add-on to the add-on repository. If it were supposed to work as you suggest, it would need a two-stage process where the PRs first go to a different branch and are merged/deployed later. So far there hasn't been pressure for changing this process but never say never :)
Otherwise, LGTM!
|
This still doesn't seem to work, getting the following error: Encountered exception during recovery: ValueError: dns_transip_global_key should have either 'yes' or 'no' as value |
How does your config file look (please exclude any secrets) |
|
Same issue here. When i add single qoute homeassistant change this to double qoute. as shown below. |
|
@agners @nathansamson I dont know if the update today should fix the issue? but this did not fix the Quote issue. still the samen error message in the logging.
|
Yesterday's update was somethign different. This just got fixed with #3855 today, 5.2.10. |
You need in the dns section, not add dns_ in front. |
Fixes: #3606
Summary by CodeRabbit
Summary by CodeRabbit
New Features
transip_global_keyfield in the DNS challenge section for improved user guidance.transip global_keyparameter.Bug Fixes