Add Istio egress CLI commands #8524

nshankar13 · 2025-03-03T21:38:46Z

This PR adds the CLI commands to az aks mesh for enable-egress-gateway and disable-egress-gateway. It also vendors the python Kubernetes client under src/aks-preview/azext_aks_preview/vendored_sdks/kubernetes. The Kubernetes client is used to create a StaticGatewayConfiguration custom resource prior to enabling the egress gateway for the live tests, as this is required on the RP side to enable an Istio egress gateway.

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

az aks mesh enable egress gateway

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
My extension version conforms to the Extension version schema

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

Signed-off-by: nshankar <nshankar@microsoft.com>

azure-client-tools-bot-prd · 2025-03-03T21:38:49Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️aks-preview

rule cmd_name rule_message suggest_message

⚠️ 1001 - CmdAdd aks mesh disable-egress-gateway cmd aks mesh disable-egress-gateway added

⚠️ 1001 - CmdAdd aks mesh enable-egress-gateway cmd aks mesh enable-egress-gateway added

azure-client-tools-bot-prd · 2025-03-03T21:38:52Z

Hi @nshankar13,
Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

yonzhan · 2025-03-03T21:39:01Z

Thank you for your contribution! We will review the pull request and get back to you soon.

github-actions · 2025-03-03T21:39:03Z

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

Signed-off-by: nshankar <nshankar@microsoft.com>

github-actions · 2025-03-03T22:10:19Z

For more info about extension versioning, please refer to Extension version schema

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang

the change generally looks good to me, please fix failed checks

/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/_params.py:2228:1: W293 blank line contains whitespace
/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/_validators.py:857:1: E302 expected 2 blank lines, found 1
/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/_validators.py:861:5: F841 local variable 'asm_egress_name_regex' is assigned to but never used
/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/_validators.py:862:13: F821 undefined name 'asm_revision_regex'
/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/_validators.py:864:56: F821 undefined name 'revision'
/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/_validators.py:866:1: E302 expected 2 blank lines, found 1
/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/custom.py:3144:1: E302 expected 2 blank lines, found 1
/mnt/vss/_work/1/s/src/aks-preview/azext_aks_preview/managed_cluster_decorator.py:2413:1: W293 blank line contains whitespace

FAIL - HIGH severity: missing_parameter_help
Parameter: aks mesh disable-egress-gateway, egress_gateway_name - Missing help
Parameter: aks mesh disable-egress-gateway, egress_gateway_namespace - Missing help
Parameter: aks mesh enable-egress-gateway, egress_gateway_name - Missing help
Parameter: aks mesh enable-egress-gateway, egress_gateway_namespace - Missing help

bypass in src/aks-preview/linter_exclusions.yml

FAIL - HIGH severity: option_length_too_long
Parameter: aks mesh disable-egress-gateway, egress_gateway_namespace - The lengths of all options ['--egress-gateway-namespace'] are longer than threshold 22. Argument egress_gateway_namespace must have a short abbreviation.
Parameter: aks mesh enable-egress-gateway, egress_gateway_namespace - The lengths of all options ['--egress-gateway-namespace'] are longer than threshold 22. Argument egress_gateway_namespace must have a short abbreviation.
Parameter: aks mesh enable-egress-gateway, gateway_configuration_name - The lengths of all options ['--gateway-configuration-name'] are longer than threshold 22. Argument gateway_configuration_name must have a short abbreviation.

FumingZhang · 2025-03-04T03:57:13Z

src/aks-preview/HISTORY.rst

+13.0.0b9
+++++++
+* Add `enable-egress-gateway` and `disable-egress-gateway` to the `az aks mesh` command.


Please include the notes under section Pending (several lines above).

Should I include under pending and 13.0.0b9 or just pending?

see the comment below

FumingZhang · 2025-03-04T04:04:26Z

src/aks-preview/azext_aks_preview/tests/latest/test_aks_commands.py

@@ -12542,6 +12542,174 @@ def test_aks_azure_service_mesh_enable_disable(
            ],
        )

+    @AllowLargeResponse()
+    @AKSCustomResourceGroupPreparer(


Queued live test to validate the change. Please commit the corresponding recording file (find from pipeline artifact) to src/aks-preview/azext_aks_preview/tests/latest/recordings if the test passed.

Requeued test https://dev.azure.com/msazure/CloudNativeCompute/_build/results?buildId=116945915&view=results

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang · 2025-03-04T23:05:31Z

src/aks-preview/HISTORY.rst

 +++++++
 * Vendor new SDK and bump API version to 2024-10-02-preview.

+13.0.0b9
+++++++
+* Add `enable-egress-gateway` and `disable-egress-gateway` to the `az aks mesh` command.


Suggested change

+++++++

* Vendor new SDK and bump API version to 2024-10-02-preview.

13.0.0b9

+++++++

* Add `enable-egress-gateway` and `disable-egress-gateway` to the `az aks mesh` command.

+++++++

13.0.0b9

+++++++

* Vendor new SDK and bump API version to 2024-10-02-preview.

* Add `enable-egress-gateway` and `disable-egress-gateway` to the `az aks mesh` command.

I meant something like this

FumingZhang · 2025-03-04T23:05:57Z

src/aks-preview/HISTORY.rst

+13.0.0b9
+++++++
+* Add `enable-egress-gateway` and `disable-egress-gateway` to the `az aks mesh` command.


see the comment below

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang · 2025-03-05T23:08:02Z

src/aks-preview/azext_aks_preview/_params.py

+            "istio_egressgateway_name",
+            validator=validate_asm_egress_name,
+            required=True,
+            options_list=["--istio-eg-gtw-name"]


FAIL - HIGH severity: faulty_help_example_parameters_rule
Help-Entry: aks mesh disable-egress-gateway -
There is a violation:
"az aks mesh disable-egress-gateway --resource-group MyResourceGroup --name MyManagedCluster --istio-egressgateway-name my-istio-egress-1 --istio-egressgateway-namespace my-namespace-1" is not a valid command.
the following arguments are required: --istio-eg-gtw-name.

FAIL - HIGH severity: unrecognized_help_parameter_rule
Help-Entry: aks mesh disable-egress-gateway - The following parameter help names are invalid: --istio-eg-gtw-name --istio-egressgateway-name | --istio-eg-gtw-ns --istio-egressgateway-namespace

missing the other option form (--istio-egressgateway-name) here?

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang · 2025-03-09T23:19:52Z

src/aks-preview/azext_aks_preview/vendored_sdks/kubernetes/.gitlab-ci.yml

@@ -0,0 +1,33 @@
+# ref: https://docs.gitlab.com/ee/ci/README.html


I would say it's not necessary to include the sample, doc, test, ci related things in this vendored SDK.

Signed-off-by: nshankar <nshankar@microsoft.com>

Add Istio egress CLI tests

7355358

Signed-off-by: nshankar <nshankar@microsoft.com>

nshankar13 requested review from andyliuliming and FumingZhang as code owners March 3, 2025 21:38

azure-client-tools-bot-prd bot added this to the April 2025 (2025-04-01) milestone Mar 3, 2025

microsoft-github-policy-service bot requested review from zhoxing-ms, yanzhudd and yonzhan March 3, 2025 21:39

microsoft-github-policy-service bot assigned yanzhudd and zhoxing-ms Mar 3, 2025

microsoft-github-policy-service bot added Auto-Assign Auto assign by bot AKS labels Mar 3, 2025

Fix if condition

a441882

Signed-off-by: nshankar <nshankar@microsoft.com>

nshankar13 added 2 commits March 3, 2025 17:33

update params

f693080

Signed-off-by: nshankar <nshankar@microsoft.com>

Update CLI changes

e41287d

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang reviewed Mar 4, 2025

View reviewed changes

Resolve comments and fix live tests

26ba8bc

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang reviewed Mar 4, 2025

View reviewed changes

nshankar13 added 7 commits March 4, 2025 19:15

Update test

22d2719

Signed-off-by: nshankar <nshankar@microsoft.com>

Update test

30c8d53

Signed-off-by: nshankar <nshankar@microsoft.com>

update commands

0192d38

Signed-off-by: nshankar <nshankar@microsoft.com>

Update param names

f770e47

Signed-off-by: nshankar <nshankar@microsoft.com>

Update function params

0f5c10c

Signed-off-by: nshankar <nshankar@microsoft.com>

Update required ns

472b605

Signed-off-by: nshankar <nshankar@microsoft.com>

Fix help commands

0722ec7

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang reviewed Mar 5, 2025

View reviewed changes

nshankar13 added 3 commits March 7, 2025 23:27

Add dynamic client to live test

7b3c804

Signed-off-by: nshankar <nshankar@microsoft.com>

remove files

5c26cad

Signed-off-by: nshankar <nshankar@microsoft.com>

Update live tests

32e4cae

Signed-off-by: nshankar <nshankar@microsoft.com>

FumingZhang reviewed Mar 9, 2025

View reviewed changes

nshankar13 added 4 commits March 12, 2025 09:14

Remove dirs

d4905f2

Signed-off-by: nshankar <nshankar@microsoft.com>

Fix py lint

cab63c9

Signed-off-by: nshankar <nshankar@microsoft.com>

update k8s package

2b98c91

Signed-off-by: nshankar <nshankar@microsoft.com>

Update import

5d97d0e

Signed-off-by: nshankar <nshankar@microsoft.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Istio egress CLI commands #8524

Add Istio egress CLI commands #8524

nshankar13 commented Mar 3, 2025 •

edited

Loading

azure-client-tools-bot-prd bot commented Mar 3, 2025 •

edited

Loading

azure-client-tools-bot-prd bot commented Mar 3, 2025

yonzhan commented Mar 3, 2025

github-actions bot commented Mar 3, 2025

github-actions bot commented Mar 3, 2025

FumingZhang left a comment

FumingZhang Mar 4, 2025

nshankar13 Mar 4, 2025

FumingZhang Mar 4, 2025

FumingZhang Mar 4, 2025

FumingZhang Mar 4, 2025

FumingZhang Mar 4, 2025

FumingZhang Mar 4, 2025

FumingZhang Mar 5, 2025

FumingZhang Mar 9, 2025

		@@ -0,0 +1,33 @@
		# ref: https://docs.gitlab.com/ee/ci/README.html

Add Istio egress CLI commands #8524

Are you sure you want to change the base?

Add Istio egress CLI commands #8524

Conversation

nshankar13 commented Mar 3, 2025 • edited Loading

Related command

General Guidelines

About Extension Publish

azure-client-tools-bot-prd bot commented Mar 3, 2025 • edited Loading

azure-client-tools-bot-prd bot commented Mar 3, 2025

yonzhan commented Mar 3, 2025

github-actions bot commented Mar 3, 2025

github-actions bot commented Mar 3, 2025

FumingZhang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nshankar13 commented Mar 3, 2025 •

edited

Loading

azure-client-tools-bot-prd bot commented Mar 3, 2025 •

edited

Loading