Skip to content

Add link_to_subnet and link_to_pod_subnet for aks deployments #1184

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add link_to_subnet and link_to_pod_subnet for aks deployments #1184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3820589
Add link_to_subnet and link_to_pod_subnet for aks deployments
dariccia Feb 3, 2025
93be678
linting
dariccia Feb 3, 2025
3ff9ce9
tests and release notes
dariccia Feb 3, 2025
685a407
Fix release notes versioning and content
ninjarobot Feb 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ Release Notes
=============

## 1.9.12
* VMSS overprovisioning controls
* VM Scale Sets: overprovisioning controls
* AKS Cluster: Added link_to_subnet and link_to_pod_subnet to agent pool config

## 1.9.11
* VM extensions: support for auto-upgrades and initial version
Expand Down
2 changes: 2 additions & 0 deletions docs/content/api-overview/resources/aks-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ The Agent Pool builder (`agentPool`) constructs agent pools in the AKS cluster.
| os_type | Sets the OS type of the VM's in the agent pool. |
| pod_subnet | Sets the name of a virtual network subnet where this AKS cluster should be attached. |
| subnet | Sets the name of a virtual network subnet where this AKS cluster should be attached. |
| link_to_subnet | Specify an existing subnet this AKS cluster should be attached. |
| link_to_pod_subnet | Specify an existing subnet this AKS cluster should be attached. |
| vm_size | Sets the size of the VM's in the agent pool. |
| add_availability_zones | Sets the Azure availability zones for the VM's in the agent pool. |
| vnet | Sets the name of a virtual network in the same region where this AKS cluster should be attached. |
Expand Down
22 changes: 20 additions & 2 deletions src/Farmer/Arm/ContainerService.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,8 @@ type ManagedCluster = {
AvailabilityZones: string list
VirtualNetworkName: ResourceName option
SubnetName: ResourceName option
Copy link
Collaborator

@ninjarobot ninjarobot Feb 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

You should replace the existing SubnetName and PodSubnetName with these new properties rather than duplicating them. Otherwise both can be set and it's not clear from the record what will be happen (people will have to reverse engineer the code to see SubnetName takes precedence over Subnet).

Subnet: LinkedResource option
PodSubnet: LinkedResource option
PodSubnetName: ResourceName option
AutoscaleSetting: FeatureFlag option
ScaleDownMode: ScaleDownMode option
Expand Down Expand Up @@ -240,6 +242,16 @@ type ManagedCluster = {
let dependencies =
[
this.AgentPoolProfiles
|> List.choose (fun pool ->
match pool.PodSubnet with
| Some(Managed podSubnet) -> Some podSubnet
| _ -> None)
this.AgentPoolProfiles
|> List.choose (fun pool ->
match pool.Subnet with
| Some(Managed subnet) -> Some subnet
| _ -> None)
this.AgentPoolProfiles
|> List.choose (fun pool -> pool.VirtualNetworkName)
|> List.map virtualNetworks.resourceId
this.Identity.Dependencies
Expand Down Expand Up @@ -300,11 +312,17 @@ type ManagedCluster = {
vnetSubnetID =
match agent.VirtualNetworkName, agent.SubnetName with
| Some vnet, Some subnet -> subnets.resourceId(vnet, subnet).Eval()
| _ -> null
| _ ->
match agent.Subnet with
| Some subnet -> subnet.ResourceId.Eval()
| _ -> null
podSubnetID =
match agent.VirtualNetworkName, agent.PodSubnetName with
| Some vnet, Some pod_subnet -> subnets.resourceId(vnet, pod_subnet).Eval()
| _ -> null
| _ ->
match agent.PodSubnet with
| Some podSubnet -> podSubnet.ResourceId.Eval()
| _ -> null
enableAutoScaling = agent.AutoscaleSetting |> Option.mapBoxed _.AsBoolean
scaleDownMode =
match agent.ScaleDownMode with
Expand Down
21 changes: 21 additions & 0 deletions src/Farmer/Builders/Builders.ContainerService.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ type AgentPoolConfig = {
VirtualNetworkName: ResourceName option
SubnetName: ResourceName option
PodSubnetName: ResourceName option
Subnet: LinkedResource option
PodSubnet: LinkedResource option
AutoscaleSetting: FeatureFlag option
ScaleDownMode: ScaleDownMode option
MinCount: int option
Expand All @@ -42,6 +44,8 @@ type AgentPoolConfig = {
VirtualNetworkName = None
SubnetName = None
PodSubnetName = None
PodSubnet = None
Subnet = None
VmSize = Standard_DS2_v2
AvailabilityZones = []
AutoscaleSetting = None
Expand Down Expand Up @@ -186,6 +190,8 @@ type AksConfig = {
OsType = agentPool.OsType
SubnetName = agentPool.SubnetName
PodSubnetName = agentPool.PodSubnetName
Subnet = agentPool.Subnet
PodSubnet = agentPool.PodSubnet
VmSize = agentPool.VmSize
AvailabilityZones = agentPool.AvailabilityZones
VirtualNetworkName = agentPool.VirtualNetworkName
Expand Down Expand Up @@ -270,6 +276,21 @@ type AgentPoolBuilder() =
[<CustomOperation "user_mode">]
member _.UserMode(state: AgentPoolConfig) = { state with Mode = AgentPoolMode.User }


/// Sets the name of a virtual network where this agent pool should be attached.
[<CustomOperation "link_to_subnet">]
member _.LinkToSubnetId(state: AgentPoolConfig, subnetId: ResourceId) = {
state with
Subnet = Some(Unmanaged subnetId)
}

/// Sets the name of a virtual network where this agent pool should be attached.
[<CustomOperation "link_to_pod_subnet">]
member _.LinkToPodSubnetId(state: AgentPoolConfig, subnetId: ResourceId) = {
state with
PodSubnet = Some(Unmanaged subnetId)
}

/// Sets the disk size for the VM's in the agent pool.
[<CustomOperation "disk_size">]
member _.DiskSizeGB(state: AgentPoolConfig, size) = { state with OsDiskSize = size }
Expand Down
56 changes: 56 additions & 0 deletions src/Tests/ContainerService.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,62 @@ let tests =
Expect.hasLength aks.AgentPoolProfiles 1 ""
Expect.equal aks.AgentPoolProfiles.[0].Name "linuxpool" ""
}
test "AKS cluster on linked VNet" {
let myAks = aks {
name "private-k8s-cluster"
dns_prefix "testprivateaks"

add_agent_pools [
agentPool {
name "linuxPool"
count 3

link_to_subnet (
Arm.Network.subnets.resourceId (ResourceName "aks-rg", ResourceName "vnet-subnet")
)

link_to_pod_subnet (
Arm.Network.subnets.resourceId (ResourceName "aks-rg", ResourceName "vnet-pod")
)
}
]

network_profile (azureCniNetworkProfile { service_cidr "10.250.0.0/16" })
linux_profile "aksuser" "public-key-here"
service_principal_client_id "some-spn-client-id"
}

let template = arm {
location Location.EastUS
add_resource myAks
output "oidcUrl" myAks.OidcIssuerUrl
}

let json = template.Template |> Writer.toJson
let jobj = JObject.Parse(json)

let podSubnetId =
jobj.SelectToken(
"resources[?(@.name=='private-k8s-cluster')].properties.agentPoolProfiles[0].podSubnetID"
)
|> string

let subnetId =
jobj.SelectToken(
"resources[?(@.name=='private-k8s-cluster')].properties.agentPoolProfiles[0].vnetSubnetID"
)
|> string

Expect.equal
podSubnetId
"[resourceId('Microsoft.Network/virtualNetworks/subnets', 'aks-rg', 'vnet-pod')]"
"pod subnet not enabled on agent pool"

Expect.equal
subnetId
"[resourceId('Microsoft.Network/virtualNetworks/subnets', 'aks-rg', 'vnet-subnet')]"
"subnet not enabled on agent pool"
}
test "AKS with private API must use a standard load balancer." {
Expect.throws
(fun () ->
Expand Down