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

Support custom DNS configuration on auto #5258

Closed
wants to merge 1 commit into from

Conversation

agners
Copy link
Member

@agners agners commented Aug 20, 2024

Proposed change

So far, when the network setting is set to auto, we don't allow a custom DNS configuration. However, it is a perfectly valid use case to provide custom DNS configuration while using automatic IP configuration (e.g. DHCP). Especially when the DHCP server doesn't provide a DNS server. In this case, systemd-resolved (at least on Home Assistant OS) falls back to Cloudflare. This might not what the user wants. Customze the DNS setting allows to set a custom fallback DNS server or override a potential non-working DHCP provided one.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints of add-on configuration are added/changed:

Summary by CodeRabbit

  • New Features

    • Introduced automatic nameserver handling in network configuration settings.
    • Added a DNS attribute to enhance the management of DNS settings within IP configurations.
  • Bug Fixes

    • Improved the logic for populating DNS settings based on connection methods (AUTO or STATIC).
  • Documentation

    • Updated API documentation link for the NetworkSetting class to the latest version.

@agners agners added the new-feature A new feature label Aug 20, 2024
Copy link

coderabbitai bot commented Aug 20, 2024

Walkthrough

Walkthrough

The recent changes enhance network configuration capabilities by introducing automatic handling of DNS nameservers. A new attribute, nameservers_auto, has been added to the IpConfig class, allowing it to specify whether nameservers are automatically assigned. Additionally, modifications to various methods and constants ensure that DNS settings are correctly managed for both IPv4 and IPv6 configurations, improving flexibility and functionality.

Changes

Files Change Summary
supervisor/api/network.py, supervisor/const.py, supervisor/dbus/network/configuration.py, supervisor/dbus/network/setting/__init__.py, supervisor/dbus/network/setting/generate.py, supervisor/host/configuration.py Introduced ATTR_NAMESERVERS_AUTO constant and updated ipconfig_struct to handle new DNS logic. Enhanced IpProperties with a dns attribute and adjusted methods to support automatic or static DNS settings for better configuration handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NetworkManager
    participant IpConfig
    participant DNSService

    User->>NetworkManager: Request Configuration
    NetworkManager->>IpConfig: Create Instance
    IpConfig->>NetworkManager: Check DNS Settings
    alt DNS settings found
        IpConfig-->>NetworkManager: Set nameservers_auto to False
        NetworkManager->>DNSService: Configure DNS with specified nameservers
    else No DNS settings
        IpConfig-->>NetworkManager: Set nameservers_auto to True
        NetworkManager->>DNSService: Configure DNS with automatic nameservers
    end
    NetworkManager-->>User: Return Configuration
Loading

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>.
    • 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.

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.

Hello @agners,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <[email protected]>"
      
      (substituting "Author Name" and "[email protected]" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@home-assistant home-assistant bot marked this pull request as draft August 20, 2024 14:25
@home-assistant
Copy link

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.

@agners agners force-pushed the support-static-dns-configuration branch 2 times, most recently from 1cb1a5e to b780b84 Compare August 20, 2024 16:19
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.

Hello @agners,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <[email protected]>"
      
      (substituting "Author Name" and "[email protected]" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@agners agners force-pushed the support-static-dns-configuration branch from b780b84 to d265afa Compare August 20, 2024 16:20
@agners agners removed the cla-error label Aug 20, 2024
@agners agners force-pushed the support-static-dns-configuration branch 2 times, most recently from c1747ab to 3ee79b0 Compare August 20, 2024 16:26
So far, when the network setting is set to auto, we don't allow a
custom DNS configuration. However, it is a perfectly valid use case to
provide custom DNS configuration while using automatic IP configuration
(e.g. DHCP). Especially when the DHCP server doesn't provide a DNS
server. In this case, systemd-resolved (at least on Home Assistant OS)
falls back to Cloudflare. This might not what the user wants. Customze
the DNS setting allows to set a custom fallback DNS server or override
a potential non-working DHCP provided one.
@agners agners force-pushed the support-static-dns-configuration branch from 3ee79b0 to 1e9a3d7 Compare August 20, 2024 16:33
@agners
Copy link
Member Author

agners commented Aug 22, 2024

Closing this one as we took a different route with #5262.

@agners agners closed this Aug 22, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant