[containerapp] Add support to initialize Dapr components #6857

shubham1172 · 2023-10-12T14:02:37Z

This PR adds support to initialize dapr-components in a containerapps environment for development purpose, and introduces a new command - az containerapp env dapr-component init.

Sample code to try out this feature: https://github.com/shubham1172/aca-dapr-example

Behaviour overview:

If user runs dapr-component init (DCI) on a fresh ContainerApps environment, it creates the dev service and Dapr component with a binding to the dev service.
If user runs DCI when a Dapr component with the same name already exists -
1. If the component was created by DCI, overwrite the component.
2. Otherwise throw an error (users should not lose their component with an overwrite).
If the user runs DCI when a dev service already exists, skip its creation.

Screenshots

Help text:

Running the command on a fresh containerapps:

Running the command, a second time:

Running the command when a Dapr component already exists (user created):

Statestore component definition, created by init command:

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

Related command

az containerapp env dapr-component

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)

FYI to run azdev test, had to do the following:

export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
azdev test test_containerapp_env_dapr_components --live

For new extensions:

[N/A] 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.

azure-client-tools-bot-prd · 2023-10-12T14:02:40Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️containerapp

rule cmd_name rule_message suggest_message

⚠️ 1001 - CmdAdd containerapp env dapr-component init cmd containerapp env dapr-component init added

azure-client-tools-bot-prd · 2023-10-12T14:02:43Z

Hi @shubham1172,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

yonzhan · 2023-10-12T14:09:42Z

containerapp

yonzhan · 2023-10-19T14:55:16Z

Please fix CI issues.

shubham1172 · 2023-10-19T17:22:48Z

Thanks @yonzhan, done!

Signed-off-by: Shubham Sharma <[email protected]>

src/containerapp/azext_containerapp/_params.py

Signed-off-by: Shubham Sharma <[email protected]>

; Signed-off-by: Shubham Sharma <[email protected]>

src/containerapp/azext_containerapp/_dapr_utils.py

g Signed-off-by: Shubham Sharma <[email protected]>

src/containerapp/azext_containerapp/_dapr_utils.py

Signed-off-by: Shubham Sharma <[email protected]>

Greedygre

LGTM @Juliehzl Could you help to review this PR?

wangzelin007 · 2023-11-01T07:50:57Z

/azp run

azure-pipelines · 2023-11-01T07:51:08Z

Azure Pipelines successfully started running 2 pipeline(s).

Signed-off-by: Shubham Sharma <[email protected]>

src/containerapp/HISTORY.rst

Signed-off-by: Shubham Sharma <[email protected]>

zhoxing-ms · 2023-11-07T09:14:52Z

@shubham1172 Please resolve the conflict

Signed-off-by: Shubham Sharma <[email protected]>

Juliehzl · 2023-11-07T11:45:32Z

src/containerapp/azext_containerapp/_help.py

@@ -389,6 +389,18 @@
          az containerapp env certificate delete -g MyResourceGroup --name MyEnvironment --thumbprint MyCertificateThumbprint
 """

+helps['containerapp env dapr-component init'] = """
+    type: command
+    short-summary: Initializes Dapr components and dev services for an environment.


Initializes -> Initialize
to align with other commands

Juliehzl · 2023-11-07T11:51:27Z

src/containerapp/azext_containerapp/_params.py

@@ -66,6 +66,10 @@ def load_arguments(self, _):
        c.argument('managed_certificates_only', options_list=['--managed-certificates-only', '-m'], help='List managed certificates only.')
        c.argument('private_key_certificates_only', options_list=['--private-key-certificates-only', '-p'], help='List private-key certificates only.')

+    with self.argument_context('containerapp env dapr-component init') as c:
+        c.argument('statestore', help="The state store component and dev service to create.")


could you use argument --state-store which will be easy to view for customer like what we do for most arguments? For arguments with multiple words should be separated with -

Hi, for users coming from the Dapr world, they will be more familiar with statestore and pubsub. Also please check #6857 (comment)

Juliehzl · 2023-11-07T11:53:05Z

src/containerapp/azext_containerapp/_params.py

@@ -66,6 +66,10 @@ def load_arguments(self, _):
        c.argument('managed_certificates_only', options_list=['--managed-certificates-only', '-m'], help='List managed certificates only.')
        c.argument('private_key_certificates_only', options_list=['--private-key-certificates-only', '-p'], help='List private-key certificates only.')

+    with self.argument_context('containerapp env dapr-component init') as c:
+        c.argument('statestore', help="The state store component and dev service to create.")
+        c.argument('pubsub', help="The pubsub component and dev service to create.")


should --pub-sub be easy to understand for customer?

Same as above

azure-client-tools-bot-prd bot added this to the October 2023 (2023-11-15) milestone Oct 12, 2023

microsoft-github-policy-service bot requested review from yonzhan, wangzelin007, yanzhudd, zhoxing-ms, jsntcy, ruslany, sanchitmehta, ebencarek, JennyLawrance, howang-ms, vinisoto, chinadragon0515, vturecek, torosent, pagariyaalok, Juliehzl, jijohn14 and Greedygre October 12, 2023 14:02

microsoft-github-policy-service bot added the Auto-Assign Auto assign by bot label Oct 12, 2023

microsoft-github-policy-service bot assigned zhoxing-ms Oct 12, 2023

microsoft-github-policy-service bot added the ContainerApp label Oct 12, 2023

shubham1172 changed the title ~~[WIP][containerapp] Add support to initialize Dapr components~~ [containerapp] Add support to initialize Dapr components Oct 19, 2023

shubham1172 marked this pull request as ready for review October 19, 2023 13:37

shubham1172 changed the title ~~[containerapp] Add support to initialize Dapr components~~ [WIP][containerapp] Add support to initialize Dapr components Oct 23, 2023

Use ContainerAppPreviewClient

b11c20b

Signed-off-by: Shubham Sharma <[email protected]>

Greedygre reviewed Oct 30, 2023

View reviewed changes

src/containerapp/azext_containerapp/_params.py Show resolved Hide resolved

Greedygre reviewed Oct 30, 2023

View reviewed changes

src/containerapp/azext_containerapp/_params.py Show resolved Hide resolved

shubham1172 added 2 commits October 30, 2023 12:41

Add is_preview to params

d2ad257

Signed-off-by: Shubham Sharma <[email protected]>

Lint

6087715

; Signed-off-by: Shubham Sharma <[email protected]>

anthonychu approved these changes Oct 30, 2023

View reviewed changes

Greedygre reviewed Oct 31, 2023

View reviewed changes

src/containerapp/azext_containerapp/_dapr_utils.py Outdated Show resolved Hide resolved

Greedygre reviewed Oct 31, 2023

View reviewed changes

src/containerapp/azext_containerapp/_dapr_utils.py Outdated Show resolved Hide resolved

Handle 404 exception

4e94922

g Signed-off-by: Shubham Sharma <[email protected]>

Greedygre reviewed Oct 31, 2023

View reviewed changes

src/containerapp/azext_containerapp/_dapr_utils.py Outdated Show resolved Hide resolved

shubham1172 added 2 commits October 31, 2023 12:12

Merge with main

38d7b54

Signed-off-by: Shubham Sharma <[email protected]>

safeget import

e64bacd

Signed-off-by: Shubham Sharma <[email protected]>

Greedygre approved these changes Oct 31, 2023

View reviewed changes

ahmelsayed approved these changes Nov 1, 2023

View reviewed changes

shubham1172 added 2 commits November 3, 2023 10:04

Merge with main

fdd649c

Signed-off-by: Shubham Sharma <[email protected]>

Merge with main

c68bbb7

Signed-off-by: Shubham Sharma <[email protected]>

Greedygre reviewed Nov 7, 2023

View reviewed changes

src/containerapp/HISTORY.rst Outdated Show resolved Hide resolved

shubham1172 added 2 commits November 7, 2023 13:58

Merge branch 'main' into shubham1172/containerapp-init-dev-2

6016fbf

Update History.rst

253162d

Signed-off-by: Shubham Sharma <[email protected]>

Greedygre approved these changes Nov 7, 2023

View reviewed changes

Merge with main

f5914ac

Signed-off-by: Shubham Sharma <[email protected]>

wangzelin007 approved these changes Nov 7, 2023

View reviewed changes

wangzelin007 merged commit 4565b96 into Azure:main Nov 7, 2023
14 checks passed

Juliehzl reviewed Nov 7, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[containerapp] Add support to initialize Dapr components #6857

[containerapp] Add support to initialize Dapr components #6857

shubham1172 commented Oct 12, 2023 •

edited

Loading

azure-client-tools-bot-prd bot commented Oct 12, 2023 •

edited

Loading

azure-client-tools-bot-prd bot commented Oct 12, 2023

yonzhan commented Oct 12, 2023

yonzhan commented Oct 19, 2023

shubham1172 commented Oct 19, 2023

Greedygre left a comment

wangzelin007 commented Nov 1, 2023

azure-pipelines bot commented Nov 1, 2023

zhoxing-ms commented Nov 7, 2023

Juliehzl Nov 7, 2023

Juliehzl Nov 7, 2023

shubham1172 Nov 7, 2023

Juliehzl Nov 7, 2023

shubham1172 Nov 7, 2023

[containerapp] Add support to initialize Dapr components #6857

[containerapp] Add support to initialize Dapr components #6857

Conversation

shubham1172 commented Oct 12, 2023 • edited Loading

Screenshots

Related command

General Guidelines

About Extension Publish

azure-client-tools-bot-prd bot commented Oct 12, 2023 • edited Loading

azure-client-tools-bot-prd bot commented Oct 12, 2023

yonzhan commented Oct 12, 2023

yonzhan commented Oct 19, 2023

shubham1172 commented Oct 19, 2023

Greedygre left a comment

Choose a reason for hiding this comment

wangzelin007 commented Nov 1, 2023

azure-pipelines bot commented Nov 1, 2023

zhoxing-ms commented Nov 7, 2023

Juliehzl Nov 7, 2023

Choose a reason for hiding this comment

Juliehzl Nov 7, 2023

Choose a reason for hiding this comment

shubham1172 Nov 7, 2023

Choose a reason for hiding this comment

Juliehzl Nov 7, 2023

Choose a reason for hiding this comment

shubham1172 Nov 7, 2023

Choose a reason for hiding this comment

shubham1172 commented Oct 12, 2023 •

edited

Loading

azure-client-tools-bot-prd bot commented Oct 12, 2023 •

edited

Loading