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

Adds a "how to" for routed nic devices on VMs #12107

Merged
merged 4 commits into from
Aug 4, 2023

Conversation

markylaing
Copy link
Contributor

This PR adds a simple tutorial for adding a routed nic device to a virtual machine. With the default gateway configured via cloud init and netplan.

#9529 (comment)

The configuration of the parent network is to allow for proxy
ARP/NDP so the DNS subheading is a bit confusing.

Signed-off-by: Mark Laing <mark.laing@canonical.com>
@github-actions github-actions bot added the Documentation Documentation needs updating label Aug 2, 2023
@markylaing
Copy link
Contributor Author

@ru-fu I'm having a little trouble with this. Firstly make doc-lint is failing with:

doc/.sphinx/.markdownlint/doc-lint.sh
Failed!
.tmp/doc/howto/instances_routed_nic_vm.md:5: MD009 Trailing spaces

Which is a bit odd because I can't see any trailing spaces.

Secondly, the tutorial only appears in the navigation under How-to guides->Instances when I'm on the home page. Where else should I be adding this to the toctree?

@ru-fu
Copy link
Contributor

ru-fu commented Aug 2, 2023

Thanks Mark!
I'll review later today, but to quickly answer your questions:

doc/.sphinx/.markdownlint/doc-lint.sh
Failed!
.tmp/doc/howto/instances_routed_nic_vm.md:5: MD009 Trailing spaces

The line numbers can be a little off because we're doing some preprocessing on the files. Here it's actually line 4 that has a trailing space.

Secondly, the tutorial only appears in the navigation under How-to guides->Instances when I'm on the home page. Where else should I be adding this to the toctree?

That seems like the correct location, yes. We currently also maintain the "old" navigation, so please also add it to the toctree at the bottom of doc/instances.md (around line 45). Also, for the current navigation, we use alphabetic order, so the new "Add ..." should go between "Access" and "Back up". :)

Oh, and NIC always needs to be capitalised to make the spell checker happy. ;)

@markylaing markylaing force-pushed the routed-nic-vm-example branch from bc83751 to 6ad50fd Compare August 2, 2023 11:41
doc/instances.md Outdated Show resolved Hide resolved
doc/instances.md Outdated Show resolved Hide resolved
@markylaing markylaing force-pushed the routed-nic-vm-example branch from 6ad50fd to 1b3bb1a Compare August 2, 2023 13:01
@markylaing markylaing marked this pull request as ready for review August 2, 2023 13:51
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Show resolved Hide resolved
doc/reference/devices_nic.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
Copy link
Contributor

@monstermunchkin monstermunchkin left a comment

Choose a reason for hiding this comment

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

Looks good, but the doc test needs to be fixed.

Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

Thanks, looks good to me!
Just a little bit of language nitpicking. ;)

doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
@markylaing markylaing force-pushed the routed-nic-vm-example branch 2 times, most recently from 83fe421 to 2df265a Compare August 3, 2023 17:25
@markylaing markylaing force-pushed the routed-nic-vm-example branch from 2df265a to 92dea35 Compare August 3, 2023 17:43
Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

Just insisting on some hyphens. 😉

doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
doc/howto/instances_routed_nic_vm.md Outdated Show resolved Hide resolved
This is a basic example using cloud-init and netplan.

Signed-off-by: Mark Laing <mark.laing@canonical.com>
Signed-off-by: Mark Laing <mark.laing@canonical.com>
Signed-off-by: Mark Laing <mark.laing@canonical.com>
@markylaing markylaing force-pushed the routed-nic-vm-example branch from 92dea35 to 2192e0c Compare August 4, 2023 07:37
@markylaing markylaing requested a review from ru-fu August 4, 2023 07:38
Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

Thank you! :)

@tomponline tomponline merged commit a0f4ab2 into canonical:main Aug 4, 2023
@tomponline
Copy link
Member

Thanks all!

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

Successfully merging this pull request may close these issues.

5 participants