Add BYO CNI cluster automation to hack/aks/Makefile #3846

Copilot · 2025-07-18T20:06:58Z

This PR adds comprehensive automation for creating BYO (Bring Your Own) CNI clusters with Azure CNS deployment to the existing hack/aks/Makefile, addressing the need for streamlined cluster setup workflows.

Overview

The implementation adds new make targets that orchestrate the complete 3-step workflow:

Cluster Creation: Uses existing overlay-byocni-nokubeproxy-up target
CNS Deployment: Leverages root makefile test-load target with CNS-specific parameters
CNI Deployment: Deploys Cilium using manifests from test/integration/manifests/cilium/ with template substitution

New Make Targets

byocni-cluster-up: Main orchestrator that automates complete cluster setup
deploy-cns: Deploy CNS using sudo -E env "PATH=$PATH" make test-load CNS_ONLY=true ...
deploy-cilium: Deploy Cilium using manifests with envsubst template substitution
byocni-cluster-vars: Display all configuration variables with examples
validate-cni-type: Validate CNI type before cluster creation

Configuration Variables

All parameters are configurable with sensible defaults:

CNI_TYPE: cilium (default), extensible for future CNI types
CNS_VERSION: v1.5.38 (default)
AZURE_IPAM_VERSION: v0.3.0 (default)
CNS_IMAGE_REPO: MCR (default)
CILIUM_DIR: 1.14 (default), supports 1.12, 1.13, 1.14, 1.16, 1.17
CILIUM_VERSION_TAG: v1.14.8 (default)
CILIUM_IMAGE_REGISTRY: acnpublic.azurecr.io (default)
IPV6_HP_BPF_VERSION: v0.0.3 (default)
DUALSTACK: false (default), enables dual-stack Cilium configuration

Usage Examples

Basic usage:

make byocni-cluster-up CLUSTER=my-cluster SUB=<subscription-id>

Custom configuration:

make byocni-cluster-up \
    CLUSTER=my-cilium-cluster \
    SUB=<subscription-id> \
    CNS_VERSION=v1.6.0 \
    CILIUM_DIR=1.16 \
    CILIUM_VERSION_TAG=v1.16.5 \
    DUALSTACK=true

View configuration:

make byocni-cluster-vars

Key Features

✅ Comprehensive error handling and validation
✅ Support for all available Cilium versions (v1.12-v1.17)
✅ Dual-stack configuration support
✅ Extensible design for future CNI types
✅ Template substitution using envsubst
✅ Individual step execution capability
✅ Input validation before cluster creation
✅ Path validation for manifests
✅ Detailed documentation and examples

Implementation Approach

This implementation follows the feedback to update the existing Makefile rather than creating a new script, providing:

Reusability: Leverages existing cluster creation targets
Configurability: All parameters are overrideable via environment variables
Extensibility: Design supports adding other CNI types in the future
Validation: Comprehensive error checking before expensive cluster operations
Documentation: Updated README with usage examples and configuration details

Files Modified

hack/aks/Makefile: Added new targets and configuration variables
hack/aks/README.md: Updated documentation with usage examples and configuration details

Fixes #3773.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: vipul-21 <[email protected]>

tamilmani1989 · 2025-07-18T22:41:46Z

hack/aks/README.md

+    CNS_VERSION=v1.6.0 \
+    CILIUM_DIR=1.16 \
+    CILIUM_VERSION_TAG=v1.16.5 \
+    CILIUM_IMAGE_REGISTRY=mcr.microsoft.com/containernetworking


add node vm sku as parameter

Added VM_SIZE as a configurable parameter for BYO CNI cluster automation. It's now documented in the configuration section and included in the customization examples. Commit 7269168

tamilmani1989 · 2025-07-18T22:42:33Z

hack/aks/README.md

+
+### Available Configuration
+
+- `CNI_TYPE`: cilium (default) - Future CNI types can be added


add option for azurecni. if azurecni specified, network-plugin should be azure and should remove network-dataplane cilium field

Added azurecni as a supported CNI_TYPE option. When azurecni is specified, the automation uses overlay-up target which creates clusters with --network-plugin azure (without the cilium dataplane). Updated validation logic and documentation with examples. Commit 7269168

tamilmani1989 · 2025-07-18T22:43:36Z

hack/aks/README.md

+- `CNI_TYPE`: cilium (default) - Future CNI types can be added
+- `CNS_VERSION`: CNS version to deploy (default: v1.5.38)
+- `AZURE_IPAM_VERSION`: Azure IPAM version (default: v0.3.0)
+- `CNS_IMAGE_REPO`: CNS image repository - MCR or ACR (default: MCR)


based on image repo, can cns/cilium image path be constructed

Enhanced documentation to clarify the relationship between image repositories and image paths. Added examples showing different registry configurations (MCR vs ACR vs custom) and improved the variable display to show how CNS_IMAGE_REPO affects CNS image paths while CILIUM_IMAGE_REGISTRY controls Cilium images. Commit 7269168

…documentation Co-authored-by: tamilmani1989 <[email protected]>

Copilot

Pull Request Overview

This PR adds comprehensive automation for creating BYO (Bring Your Own) CNI clusters with Azure CNS deployment to the existing hack/aks/Makefile. The implementation provides a streamlined workflow for setting up complete clusters with either Cilium or Azure CNI configurations.

Key changes include:

New orchestrator target byocni-cluster-up that automates the complete 3-step workflow
Comprehensive configuration variables with sensible defaults for CNS and Cilium deployment
Support for both Cilium and Azure CNI deployment paths with validation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
hack/aks/Makefile	Adds new make targets for BYO CNI cluster automation with configuration variables and deployment logic
hack/aks/README.md	Updated documentation with usage examples, configuration options, and workflow descriptions

Copilot · 2025-07-29T19:53:43Z

hack/aks/Makefile

+else
+	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-config/cilium-config.yaml
+endif
+	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files


The path 'cilium-operator/files' appears to be a directory being applied as a file. This should likely be 'cilium-operator/files/' with trailing slash or use '-f' with '--recursive' flag, or specify individual YAML files.

Suggested change

kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files

kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files/

Copilot · 2025-07-29T19:53:43Z

hack/aks/Makefile

+	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files
+	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-agent/files


The path 'cilium-agent/files' appears to be a directory being applied as a file. This should likely be 'cilium-agent/files/' with trailing slash or use '-f' with '--recursive' flag, or specify individual YAML files.

Suggested change

kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files

kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-agent/files

kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files --recursive

kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-agent/files --recursive

Copilot · 2025-07-29T19:53:44Z

hack/aks/Makefile

+endif
+	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files
+	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-agent/files
+	@export CILIUM_VERSION_TAG=$(CILIUM_VERSION_TAG) && \


[nitpick] The complex multi-line export and envsubst command should be broken into separate variables or a shell script for better readability and maintainability. Consider defining the environment variables at the target level or using a helper script.

Copilot · 2025-07-29T19:53:44Z

hack/aks/README.md

+Create a BYO CNI cluster with Azure CNI:
+```bash
+make byocni-cluster-up CLUSTER=my-cluster SUB=<subscription-id> CNI_TYPE=azurecni


The example for Azure CNI deployment is misleading. Based on the Makefile logic, Azure CNI uses the 'overlay-up' target which creates a cluster with Azure CNI pre-configured, but the example suggests it's a BYO CNI setup like Cilium.

Suggested change

Create a BYO CNI cluster with Azure CNI:

```bash

make byocni-cluster-up CLUSTER=my-cluster SUB=<subscription-id> CNI_TYPE=azurecni

Create a cluster with Azure CNI pre-configured:

```bash

make overlay-up CLUSTER=my-cluster SUB=<subscription-id>

Initial plan

3c52106

Copilot AI assigned Copilot and vipul-21 Jul 18, 2025

Copilot started work on behalf of vipul-21 July 18, 2025 20:07 View session

Copilot AI and others added 2 commits July 18, 2025 20:17

Add BYO CNI cluster automation to hack/aks/Makefile

b771da8

Co-authored-by: vipul-21 <[email protected]>

Add dual-stack support and comprehensive testing for BYO CNI automation

7a08a48

Co-authored-by: vipul-21 <[email protected]>

Copilot AI changed the title ~~[WIP] Update the Makefile to the BYO cluster with CNS + CNI~~ Add BYO CNI cluster automation to hack/aks/Makefile Jul 18, 2025

Copilot AI requested a review from vipul-21 July 18, 2025 20:23

Copilot finished work on behalf of vipul-21 July 18, 2025 20:23

vipul-21 added the ci Infra or tooling. label Jul 18, 2025

tamilmani1989 reviewed Jul 18, 2025

View reviewed changes

Copilot started work on behalf of tamilmani1989 July 18, 2025 22:43 View session

Add VM SKU parameter, Azure CNI support, and improved image registry …

7269168

…documentation Co-authored-by: tamilmani1989 <[email protected]>

Copilot AI requested a review from tamilmani1989 July 18, 2025 22:51

Copilot finished work on behalf of tamilmani1989 July 18, 2025 22:51

vipul-21 marked this pull request as ready for review July 29, 2025 19:52

Copilot AI review requested due to automatic review settings July 29, 2025 19:52

vipul-21 requested a review from a team as a code owner July 29, 2025 19:52

Copilot AI reviewed Jul 29, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add BYO CNI cluster automation to hack/aks/Makefile #3846

Add BYO CNI cluster automation to hack/aks/Makefile #3846

Uh oh!

Copilot AI commented Jul 18, 2025 •

edited

Loading

Uh oh!

tamilmani1989 Jul 18, 2025

Uh oh!

Copilot AI Jul 18, 2025

Uh oh!

tamilmani1989 Jul 18, 2025

Uh oh!

Copilot AI Jul 18, 2025

Uh oh!

tamilmani1989 Jul 18, 2025

Uh oh!

Copilot AI Jul 18, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 29, 2025

Uh oh!

Copilot AI Jul 29, 2025

Uh oh!

Copilot AI Jul 29, 2025

Uh oh!

Copilot AI Jul 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		### Available Configuration

		- `CNI_TYPE`: cilium (default) - Future CNI types can be added

	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files
	kubectl apply -f $(REPO_ROOT)/test/integration/manifests/cilium/v$(CILIUM_DIR)/cilium-operator/files/

Add BYO CNI cluster automation to hack/aks/Makefile #3846

Are you sure you want to change the base?

Add BYO CNI cluster automation to hack/aks/Makefile #3846

Uh oh!

Conversation

Copilot AI commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

New Make Targets

Configuration Variables

Usage Examples

Key Features

Implementation Approach

Files Modified

Uh oh!

tamilmani1989 Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

tamilmani1989 Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

tamilmani1989 Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jul 18, 2025 •

edited

Loading