docs: adding crucial informations regarding Azure CNI usage with CAPZ #4238

MadJlzz · 2023-11-06T18:37:11Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adding some information regarding the usage of Azure CNI with custom images.

squashed commits
includes documentation
adds unit tests

NONE

k8s-ci-robot · 2023-11-06T18:37:22Z

Welcome @MadJlzz!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-azure 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-azure has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2023-11-06T18:37:23Z

Hi @MadJlzz. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

mboersma · 2023-11-06T19:54:41Z

@MadJlzz do we still need to document this since kubernetes-sigs/image-builder#1090 merged? That should mean all recently published CAPZ reference images already have this 15-azure-vnet.cfg, unless I'm mistaken, and users should hopefully be building custom images from a recent version of image-builder.

MadJlzz · 2023-11-06T22:34:52Z

From what I understood ; yes, the change is now included when using image-builder but we are not using it.

dtzar · 2023-11-09T18:52:50Z

docs/book/src/topics/addons.md

+
+By default, Azure's images are coming with a `cloud-init` configuration that enables automatic network discovery mechanism that interferes with the Azure CNI.
+
+In fact, it assigns secondary IP Configurations to the host os, which we do not want. The Azure CNI needs those free to allocate them to pod netns's/veth's)


It assigns secondary IP Configurations to the host OS, which causes problems because the Azure CNI needs those free to allocate them to pod netns's/veth's.

dtzar · 2023-11-09T18:53:53Z

docs/book/src/topics/addons.md

@@ -279,6 +279,22 @@ The following resources need to be updated when using `capi-quickstart.yaml` (th
                .
    ```

+### Disable Azure network discovery (if using custom images)
+
+By default, Azure's images are coming with a `cloud-init` configuration that enables automatic network discovery mechanism that interferes with the Azure CNI.


Please more clarity on what is custom image versus what is provided since the fix is baked into the default ones.

nawazkh · 2023-12-01T17:32:27Z

docs/book/src/topics/addons.md

@@ -279,6 +279,22 @@ The following resources need to be updated when using `capi-quickstart.yaml` (th
                .
    ```

+### Disable Azure network discovery (if using custom images)


If this block of section (### Disable Azure network discovery (if using custom images)) is for users not using image-builder to build their custom images (as per your comment #4238 (comment)), would it be better to specify that in the title?

Would you be able to add something like the one below? @MadJlzz

### Disable Azure network discovery (if using custom images without image-builder)

MadJlzz · 2023-12-06T18:45:35Z

I am a bit short in time atm, I am gonna tackle all reviews point this week end, after working hours. Sorry about the delay 😅

mboersma

/lgtm

@MadJlzz please squash the commits, and thanks!

k8s-ci-robot · 2023-12-12T16:50:26Z

LGTM label has been added.

Git tree hash: c2b188ab456582901a3c65156a363b1b84af7ca7

mboersma · 2023-12-12T16:51:43Z

/ok-to-test

codecov · 2023-12-12T17:07:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a2d6d45) 60.90% compared to head (1dcfdc9) 60.89%.
Report is 2 commits behind head on main.

❗ Current head 1dcfdc9 differs from pull request most recent head 849d35d. Consider uploading reports for the commit 849d35d to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4238      +/-   ##
==========================================
- Coverage   60.90%   60.89%   -0.02%     
==========================================
  Files         190      190              
  Lines       18991    18983       -8     
==========================================
- Hits        11567    11559       -8     
  Misses       6787     6787              
  Partials      637      637

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

MadJlzz · 2023-12-13T13:33:07Z

@mboersma done!

mboersma

/lgtm
/approve

k8s-ci-robot · 2023-12-13T16:05:20Z

LGTM label has been added.

Git tree hash: 7c3bf1165d46e678bfa494aaf3f3527a75f7b9dc

k8s-ci-robot · 2023-12-13T16:05:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mboersma

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mboersma]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

RenatoDinis · 2023-12-21T08:09:42Z

latm

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 6, 2023

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 6, 2023

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 6, 2023

k8s-ci-robot requested review from jackfrancis and Jont828 November 6, 2023 18:37

dtzar suggested changes Nov 9, 2023

View reviewed changes

nawazkh reviewed Dec 1, 2023

View reviewed changes

dtzar approved these changes Dec 11, 2023

View reviewed changes

mboersma reviewed Dec 12, 2023

View reviewed changes

k8s-ci-robot assigned mboersma Dec 12, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 12, 2023

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 12, 2023

docs: bringing clarity regarding Azure CNI usage with CAPZ

849d35d

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 13, 2023

k8s-ci-robot requested a review from mboersma December 13, 2023 13:32

mboersma approved these changes Dec 13, 2023

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 13, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 13, 2023

k8s-ci-robot merged commit 9f9ba35 into kubernetes-sigs:main Dec 13, 2023
10 checks passed

k8s-ci-robot added this to the v1.13 milestone Dec 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: adding crucial informations regarding Azure CNI usage with CAPZ #4238

docs: adding crucial informations regarding Azure CNI usage with CAPZ #4238

MadJlzz commented Nov 6, 2023

k8s-ci-robot commented Nov 6, 2023

k8s-ci-robot commented Nov 6, 2023

mboersma commented Nov 6, 2023

MadJlzz commented Nov 6, 2023 •

edited

Loading

dtzar Nov 9, 2023

MadJlzz Dec 11, 2023

dtzar Nov 9, 2023

MadJlzz Dec 11, 2023

nawazkh Dec 1, 2023

MadJlzz Dec 11, 2023

MadJlzz commented Dec 6, 2023 •

edited

Loading

mboersma left a comment

k8s-ci-robot commented Dec 12, 2023

mboersma commented Dec 12, 2023

codecov bot commented Dec 12, 2023 •

edited

Loading

MadJlzz commented Dec 13, 2023

mboersma left a comment

k8s-ci-robot commented Dec 13, 2023

k8s-ci-robot commented Dec 13, 2023

RenatoDinis commented Dec 21, 2023


		By default, Azure's images are coming with a `cloud-init` configuration that enables automatic network discovery mechanism that interferes with the Azure CNI.

		In fact, it assigns secondary IP Configurations to the host os, which we do not want. The Azure CNI needs those free to allocate them to pod netns's/veth's)

docs: adding crucial informations regarding Azure CNI usage with CAPZ #4238

docs: adding crucial informations regarding Azure CNI usage with CAPZ #4238

Conversation

MadJlzz commented Nov 6, 2023

k8s-ci-robot commented Nov 6, 2023

k8s-ci-robot commented Nov 6, 2023

mboersma commented Nov 6, 2023

MadJlzz commented Nov 6, 2023 • edited Loading

dtzar Nov 9, 2023

Choose a reason for hiding this comment

MadJlzz Dec 11, 2023

Choose a reason for hiding this comment

dtzar Nov 9, 2023

Choose a reason for hiding this comment

MadJlzz Dec 11, 2023

Choose a reason for hiding this comment

nawazkh Dec 1, 2023

Choose a reason for hiding this comment

MadJlzz Dec 11, 2023

Choose a reason for hiding this comment

MadJlzz commented Dec 6, 2023 • edited Loading

mboersma left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 12, 2023

mboersma commented Dec 12, 2023

codecov bot commented Dec 12, 2023 • edited Loading

Codecov Report

MadJlzz commented Dec 13, 2023

mboersma left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 13, 2023

k8s-ci-robot commented Dec 13, 2023

RenatoDinis commented Dec 21, 2023

MadJlzz commented Nov 6, 2023 •

edited

Loading

MadJlzz commented Dec 6, 2023 •

edited

Loading

codecov bot commented Dec 12, 2023 •

edited

Loading