You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/aks-preview/azext_aks_preview/_help.py
+116Lines changed: 116 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -3260,3 +3260,119 @@
3260
3260
type: string
3261
3261
short-summary: Additional endpoint(s) to perform the connectivity check, separated by comma.
3262
3262
"""
3263
+
3264
+
helps['aks loadbalancer'] ="""
3265
+
type: group
3266
+
short-summary: Commands to manage load balancer configurations in a managed Kubernetes cluster.
3267
+
long-summary: These commands enable the feature of multiple standard load balancers for Azure Kubernetes Service clusters.
3268
+
"""
3269
+
3270
+
helps['aks loadbalancer add'] ="""
3271
+
type: command
3272
+
short-summary: Add a load balancer configuration to a managed Kubernetes cluster.
3273
+
parameters:
3274
+
- name: --name -n
3275
+
type: string
3276
+
short-summary: Name of the load balancer configuration.
3277
+
long-summary: Load balancer name used for identification. There must be a configuration named "kubernetes" in the cluster.
3278
+
- name: --primary-agent-pool-name -p
3279
+
type: string
3280
+
short-summary: Name of the primary agent pool for this load balancer.
3281
+
long-summary: Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer.
3282
+
- name: --allow-service-placement -a
3283
+
type: bool
3284
+
short-summary: Whether to automatically place services on the load balancer.
3285
+
long-summary: If not supplied, the default value is true. If set to false manually, both the external and internal load balancer will not be selected for services unless they explicitly target it.
3286
+
- name: --service-label-selector -l
3287
+
type: string
3288
+
short-summary: Label selector for services that can be placed on this load balancer.
3289
+
long-summary: Only services that match this selector can be placed on this load balancer. Format as comma-separated key=value pairs or expressions like "key In value1,value2".
3290
+
- name: --service-namespace-selector -s
3291
+
type: string
3292
+
short-summary: Namespace label selector for services that can be placed on this load balancer.
3293
+
long-summary: Services created in namespaces that match the selector can be placed on this load balancer. Format as comma-separated key=value pairs.
3294
+
- name: --node-selector -d
3295
+
type: string
3296
+
short-summary: Node label selector for nodes that can be members of this load balancer.
3297
+
long-summary: Nodes that match this selector will be possible members of this load balancer. Format as comma-separated key=value pairs.
3298
+
examples:
3299
+
- name: Add a load balancer configuration with a specific primary agent pool
3300
+
text: az aks loadbalancer add -g MyResourceGroup -n secondary --cluster-name MyManagedCluster --primary-agent-pool-name nodepool1
3301
+
- name: Add a load balancer configuration with service label selector
3302
+
text: az aks loadbalancer add -g MyResourceGroup -n app-lb --cluster-name MyManagedCluster --primary-agent-pool-name nodepool2 --service-label-selector app=frontend
3303
+
- name: Add a load balancer configuration that doesn't automatically place services
3304
+
text: az aks loadbalancer add -g MyResourceGroup -n restricted-lb --cluster-name MyManagedCluster --primary-agent-pool-name nodepool3 --allow-service-placement false
3305
+
"""
3306
+
3307
+
helps['aks loadbalancer update'] ="""
3308
+
type: command
3309
+
short-summary: Update a load balancer configuration in a managed Kubernetes cluster.
3310
+
parameters:
3311
+
- name: --name -n
3312
+
type: string
3313
+
short-summary: Name of the load balancer configuration to update.
3314
+
- name: --primary-agent-pool-name -p
3315
+
type: string
3316
+
short-summary: Name of the primary agent pool for this load balancer.
3317
+
long-summary: A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer.
3318
+
- name: --allow-service-placement -a
3319
+
type: bool
3320
+
short-summary: Whether to automatically place services on the load balancer.
3321
+
long-summary: If set to false, both the external and internal load balancer will not be selected for services unless they explicitly target it.
3322
+
- name: --service-label-selector -l
3323
+
type: string
3324
+
short-summary: Label selector for services that can be placed on this load balancer.
3325
+
long-summary: Only services that match this selector can be placed on this load balancer. Format as comma-separated key=value pairs or expressions like "key In value1,value2".
3326
+
- name: --service-namespace-selector -s
3327
+
type: string
3328
+
short-summary: Namespace label selector for services that can be placed on this load balancer.
3329
+
long-summary: Services created in namespaces that match the selector can be placed on this load balancer. Format as comma-separated key=value pairs.
3330
+
- name: --node-selector -d
3331
+
type: string
3332
+
short-summary: Node label selector for nodes that can be members of this load balancer.
3333
+
long-summary: Nodes that match this selector will be possible members of this load balancer. Format as comma-separated key=value pairs.
3334
+
examples:
3335
+
- name: Update a load balancer configuration's primary agent pool
3336
+
text: az aks loadbalancer update -g MyResourceGroup -n secondary --cluster-name MyManagedCluster --primary-agent-pool-name nodepool2
3337
+
- name: Update a load balancer configuration to disable automatic service placement
3338
+
text: az aks loadbalancer update -g MyResourceGroup -n app-lb --cluster-name MyManagedCluster --allow-service-placement false
3339
+
- name: Update a load balancer configuration with new service selector
3340
+
text: az aks loadbalancer update -g MyResourceGroup -n app-lb --cluster-name MyManagedCluster --service-label-selector tier=frontend,environment=production
3341
+
"""
3342
+
3343
+
helps['aks loadbalancer delete'] ="""
3344
+
type: command
3345
+
short-summary: Delete a load balancer configuration from a managed Kubernetes cluster.
3346
+
parameters:
3347
+
- name: --name -n
3348
+
type: string
3349
+
short-summary: Name of the load balancer configuration to delete.
3350
+
long-summary: The "kubernetes" load balancer cannot be deleted as it's required for cluster operation.
3351
+
examples:
3352
+
- name: Delete a load balancer configuration
3353
+
text: az aks loadbalancer delete -g MyResourceGroup -n secondary --cluster-name MyManagedCluster
3354
+
"""
3355
+
3356
+
helps['aks loadbalancer list'] ="""
3357
+
type: command
3358
+
short-summary: List all load balancer configurations in a managed Kubernetes cluster.
3359
+
examples:
3360
+
- name: List all load balancer configurations
3361
+
text: az aks loadbalancer list -g MyResourceGroup --cluster-name MyManagedCluster
3362
+
- name: List all load balancer configurations in table format
3363
+
text: az aks loadbalancer list -g MyResourceGroup --cluster-name MyManagedCluster -o table
3364
+
"""
3365
+
3366
+
helps['aks loadbalancer show'] ="""
3367
+
type: command
3368
+
short-summary: Show details of a specific load balancer configuration in a managed Kubernetes cluster.
3369
+
parameters:
3370
+
- name: --name -n
3371
+
type: string
3372
+
short-summary: Name of the load balancer configuration to show.
3373
+
examples:
3374
+
- name: Show details of a specific load balancer configuration
3375
+
text: az aks loadbalancer show -g MyResourceGroup -n secondary --cluster-name MyManagedCluster
3376
+
- name: Show details of a load balancer configuration in table format
3377
+
text: az aks loadbalancer show -g MyResourceGroup -n kubernetes --cluster-name MyManagedCluster -o table
0 commit comments