[Spring-cloud] Add support for AppMSI #4598

jiec-msft · 2022-03-30T06:23:58Z

Note

Part of change is also extracted into another PR to help review: Pull Request: [Spring-Cloud] Switch to 2022-03-01-preview sdk for msi command groups.
And, we only need to merge current PR([Spring-cloud] Add support for AppMSI #4598).
Release date: after backend for Azure Spring Cloud has released, around 3/31 ~ 4/1

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

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?

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 PR is merged into master branch, a new PR will be created to update src/index.json automatically.
The precondition is to put your code inside this repo and upgrade the version in the PR but do not modify src/index.json.

… and re-generate the recording-test yaml files

Add helps for params in identity remove Add validators for params in identity remove Add unit test for params validator

spring-cloud app identity remove

1) Refine help info for command 2) Add parameters 3) Add validator 4) Add UT for validator

1. Add param 2. Add help info 3. Add validator 4. Add UT for validator

refactor validator

refine validator

implement and add partial recording test

add recording test for create app with user assigned managed identities

add recording test for create app with both assigned managed identities

1. add parameters 2. add validator 3. add method in help 4. add command 5. add stub implementation 6. add UT for validator

implement

add recording test for force-set

…nformation. Will add not support and obsolete warning for specific cases.

yonzhan · 2022-03-30T09:34:34Z

Spring-cloud

zhoxing-ms · 2022-03-30T10:05:00Z

src/spring-cloud/azext_spring_cloud/_help.py

+helps['spring-cloud app identity force-set'] = """
+    type: command
+    short-summary: Force set managed identities on an app.
+    examples:
+    - name: Force remove all managed identities on an app.
+      text: az spring-cloud app identity force-set -n MyApp -s MyCluster -g MyResourceGroup --system-assigned disable --user-assigned disable
+    - name: Force remove all user-assigned managed identities on an app, and enable or keep system-assigned managed identity.
+      text: az spring-cloud app identity force-set -n MyApp -s MyCluster -g MyResourceGroup --system-assigned enable --user-assigned disable
+    - name: Force remove system-assigned managed identity on an app, and assign or keep user-assigned managed identities.
+      text: az spring-cloud app identity force-set -n MyApp -s MyCluster -g MyResourceGroup --system-assigned disable --user-assigned IdentityResourceId1 IdentityResourceId2
+"""


Why do we need this command? Can its function be replaced by the spring-cloud app identity remove command?

Normally we don't need these commands. It's related to a data consistency problem among managed identity RP and my RP. There can be case when user identity is assigned to an app in my side, but deleted in managed identity RP due to data in-consistency. These commands leverage put method to reset data back with one command.

app identity remove/assign is done with patch http method, there can be case, there is no identity assigned to an app in my RP, but managed identity RP still has some identity assigned to the app.

Got it, thanks~

zhoxing-ms · 2022-03-30T10:10:34Z

src/spring-cloud/azext_spring_cloud/app_managed_identity.py

+    if _app_not_updatable(app):
+        raise CLIError("Failed to remove managed identities since app is in {} state.".format(app.properties.provisioning_state))


Could we use the specific error type instead of CLIError?

updated all 9 occurrences.

jiec-msft added 30 commits March 24, 2022 13:08

use 2022-03-01-preview sdk for app command and app identity command,…

c7cb17f

… and re-generate the recording-test yaml files

Add a temp version number

de0e5b5

Add params definition for identity remove

55c648b

Add helps for params in identity remove Add validators for params in identity remove Add unit test for params validator

refine help and example for command group

32bc31a

spring-cloud app identity remove

refine help and example for command group

1970509

spring-cloud app identity remove

refine help and example for command group

b3489f8

spring-cloud app identity remove

add support to remove user-assigned managed identities.

7ee755a

mark user-assigned as preview for identity remove

f580a8b

refine identity remove

a6887c3

For identity assign

5ef4853

1) Refine help info for command 2) Add parameters 3) Add validator 4) Add UT for validator

For identity assign: implement

65b56dc

refactor and add UT and add scenario test

f5f6ecf

refine help info for app identity

0c87272

hide role and scope from help info

ec22e89

For app create with managed identity:

9e7341d

1. Add param 2. Add help info 3. Add validator 4. Add UT for validator

For app create with managed identity:

94256b8

refactor validator

For app create with managed identity:

a0b7553

refine validator

For app create with managed identity:

29df6b3

implement and add partial recording test

For app create with managed identity:

9ba7038

add recording test for create app with user assigned managed identities

For app create with managed identity:

7a72f2d

add recording test for create app with both assigned managed identities

For app identity force-set managed identity:

310160e

1. add parameters 2. add validator 3. add method in help 4. add command 5. add stub implementation 6. add UT for validator

For app identity force-set managed identity:

6202d84

implement

For app identity force-set managed identity:

467ccf9

add recording test for force-set

remove not used import

4fc72df

fix role assignment bugs

243f0c4

refine payload for force-set identities

71e3b0e

switch app show to use 2022-03-01-preview api version

3d6d9de

update deprecation info for role param

8c0a61b

refactor code

7b2eca7

simplify force-set

6d9975a

jiec-msft added 6 commits March 29, 2022 14:16

refine help info for force-set params

06a2cb3

refine example description for command force-set

16de216

refactor _format_identity in _app_factory

37e67a2

add scope and role from deprecated back to supported status in help i…

6510f0c

…nformation. Will add not support and obsolete warning for specific cases.

add example for role assignment for system-assigned managed identity.

4906437

update version number for testing

0ff6f55

ghost added Spring Cloud Spring Cloud related issues Auto-Assign Auto assign by bot labels Mar 30, 2022

ghost requested review from zhoxing-ms, wangzelin007 and yonzhan March 30, 2022 06:24

ghost assigned zhoxing-ms Mar 30, 2022

ghost added this to the Mar 2022 (2022-04-06) milestone Mar 30, 2022

jiec-msft mentioned this pull request Mar 30, 2022

[Spring-Cloud] [Do not merge] Switch to 2022-03-01-preview sdk for msi command groups #4597

Closed

3 tasks

update version number and history.

50e7280

jiec-msft marked this pull request as ready for review March 30, 2022 06:37

zhoxing-ms added the do-not-merge label Mar 30, 2022

fix lint

5e3e36e

zhoxing-ms reviewed Mar 30, 2022

View reviewed changes

jiec-msft added 3 commits March 30, 2022 18:45

refine the CLIError, and categorize into different types

d7a9b04

refine the CLIError, and categorize into different types

30b56dd

fix lint 2

64b93ff

zhoxing-ms approved these changes Mar 31, 2022

View reviewed changes

zhoxing-ms merged commit 8f72a56 into Azure:main Mar 31, 2022

jiec-msft mentioned this pull request Apr 2, 2022

[Spring-cloud] Upgrade min version requirement of azure cli for spring-cloud #4621

Merged

3 tasks

This was referenced Apr 3, 2022

[Spring-cloud] Find min version requirement of Azure CLI #4626

Merged

[Feature request] Add compatibility validation between CLI extension and CLI Core "azext.minCliCoreVersion" #4640

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Spring-cloud] Add support for AppMSI #4598

[Spring-cloud] Add support for AppMSI #4598

jiec-msft commented Mar 30, 2022 •

edited

Loading

yonzhan commented Mar 30, 2022

zhoxing-ms Mar 30, 2022

jiec-msft Mar 30, 2022

zhoxing-ms Mar 31, 2022

zhoxing-ms Mar 30, 2022

jiec-msft Mar 30, 2022 •

edited

Loading

		if _app_not_updatable(app):
		raise CLIError("Failed to remove managed identities since app is in {} state.".format(app.properties.provisioning_state))

[Spring-cloud] Add support for AppMSI #4598

[Spring-cloud] Add support for AppMSI #4598

Conversation

jiec-msft commented Mar 30, 2022 • edited Loading

General Guidelines

About Extension Publish

yonzhan commented Mar 30, 2022

zhoxing-ms Mar 30, 2022

Choose a reason for hiding this comment

jiec-msft Mar 30, 2022

Choose a reason for hiding this comment

zhoxing-ms Mar 31, 2022

Choose a reason for hiding this comment

zhoxing-ms Mar 30, 2022

Choose a reason for hiding this comment

jiec-msft Mar 30, 2022 • edited Loading

Choose a reason for hiding this comment

jiec-msft commented Mar 30, 2022 •

edited

Loading

jiec-msft Mar 30, 2022 •

edited

Loading