update kubeovn-vpc doc to document dns_server settings#976
update kubeovn-vpc doc to document dns_server settings#976ibrokethecloud wants to merge 1 commit intoharvester:mainfrom
Conversation
…via dhcpv4options Signed-off-by: Gaurav Mehta <gaurav.mehta@suse.com>
github-actions
bot
requested review from
akashraj4261,
dariavladykina and
jillian-maroket
There was a problem hiding this comment.
Pull request overview
Updates the Kube-OVN VPC documentation to describe how to configure subnet-level DHCP DNS settings so VM workloads can receive a DNS server via DHCP (instead of requiring explicit cloud-init configuration).
Changes:
- Add a note in the VPC subnet creation steps describing DHCP options usage for passing
dns_serverto VMs. - Add a new screenshot (
subnet_dhcp_options.png) referenced by the note. - Apply the doc update across unversioned docs and v1.6/v1.7 versioned docs.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| versioned_docs/version-v1.7/networking/kubeovn-vpc.md | Adds a note and screenshot reference for subnet DHCP DNS settings. |
| versioned_docs/version-v1.6/networking/kubeovn-vpc.md | Same doc note/screenshot reference for the v1.6 docs. |
| docs/networking/kubeovn-vpc.md | Same doc note/screenshot reference for current docs. |
| static/img/subnet_dhcp_options.png | Adds the screenshot used by the new note. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| :::note | ||
|
|
||
| You can use the DHCPV4Options to specify additional dhcp settings such as `dns_server` being passed to the VM workloads |
There was a problem hiding this comment.
The field name here appears incorrect/inconsistent with the rest of the docs. Elsewhere Harvester documents the subnet spec field as dhcpV4Options (for example, docs/networking/harvester-network.md mentions enableDHCP + dhcpV4Options), but this note says "DHCPV4Options". Please update the note to use the correct field name and capitalization (also capitalize "DHCP" in "dhcp settings" and add a trailing period).
| You can use the DHCPV4Options to specify additional dhcp settings such as `dns_server` being passed to the VM workloads | |
| You can use the `dhcpV4Options` field to specify additional DHCP settings, such as `dns_server`, being passed to the VM workloads. |
|
|
||
| :::note | ||
|
|
||
| You can use the DHCPV4Options to specify additional dhcp settings such as `dns_server` being passed to the VM workloads |
There was a problem hiding this comment.
The field name here appears incorrect/inconsistent with the rest of the docs. Elsewhere Harvester documents the subnet spec field as dhcpV4Options (for example, docs/networking/harvester-network.md mentions enableDHCP + dhcpV4Options), but this note says "DHCPV4Options". Please update the note to use the correct field name and capitalization (also capitalize "DHCP" in "dhcp settings" and add a trailing period).
| You can use the DHCPV4Options to specify additional dhcp settings such as `dns_server` being passed to the VM workloads | |
| You can use the dhcpV4Options to specify additional DHCP settings, such as `dns_server`, being passed to the VM workloads. |
|
|
||
| :::note | ||
|
|
||
| You can use the DHCPV4Options to specify additional dhcp settings such as `dns_server` being passed to the VM workloads |
There was a problem hiding this comment.
The field name here appears incorrect/inconsistent with the rest of the docs. Elsewhere Harvester documents the subnet spec field as dhcpV4Options (for example, docs/networking/harvester-network.md mentions enableDHCP + dhcpV4Options), but this note says "DHCPV4Options". Please update the note to use the correct field name and capitalization (also capitalize "DHCP" in "dhcp settings" and add a trailing period).
| You can use the DHCPV4Options to specify additional dhcp settings such as `dns_server` being passed to the VM workloads | |
| You can use the `dhcpV4Options` to specify additional DHCP settings such as `dns_server` being passed to the VM workloads. |
There was a problem hiding this comment.
Just a nit, we could use the same 'dhcpV4Options' field name as in the subnet parameters.
|
|
LGTM, Thanks. |
|
On a different note,The VPC document currently shows settings only through DHCP, we could add a brief section for default DHCP/IPAM which will not add default route and user should set it manually and managedtap binding is not required in this case.cc: @mingshuoqiu |
starbops
left a comment
starbops
left a comment
There was a problem hiding this comment.
I am a bit hesitant about this, but since the proposed addition note is right after the "Edit as YAML" step, would it be handy if we could also provide a YAML snippet example for the dhcpV4Options field? We can leave this as is for sure, but switching to YAML mode for editing the ensureDHCP field and jumping back to the original mode for the DHCPV4Options field feels bad in terms of UX.
WDYT?
|
i can add option for both doing this via ui option as well as the yaml method? |
Problem:
PR details how to add dns_server at the subnet level to allow VM workloads to leverage the dns server without having to explicitly specify one via cloudinit.
Solution:
Related Issue(s):
harvester/harvester#9687
Test plan:
Additional documentation or context