Skip to content

[Container app] az containerapp env java-component: Support new configuration parameters on java component #8320

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

Merged
zhoxing-ms merged 28 commits into from
Jan 13, 2025
Merged

[Container app] az containerapp env java-component: Support new configuration parameters on java component #8320

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
30f26d7
Support new configuration parameters on java component
Nov 26, 2024
214a192
Add test file
Nov 26, 2024
7e58d05
Add recording
Nov 27, 2024
df1c146
remove cred
Nov 27, 2024
75a20f1
test fix
Nov 27, 2024
ebf42e7
test fix
Nov 27, 2024
5000140
Fix lint
Nov 27, 2024
71f2a93
Merge remote-tracking branch 'azure/main' into wenhao/jc-env
Nov 27, 2024
262af2f
convert recording
Nov 27, 2024
de41887
Fix
Nov 27, 2024
77637d8
Update recording
Nov 27, 2024
a57cf7c
udpate recording
Nov 27, 2024
283ad3b
Update
Nov 27, 2024
4a7887d
Merge remote-tracking branch 'azure/main' into wenhao/jc-env
Nov 28, 2024
d459bd5
resolve comments
Nov 28, 2024
8a8ea15
format update
Nov 28, 2024
9283205
Update
Nov 29, 2024
a87bc57
Update
Nov 29, 2024
ea03f2a
Add --bind --unbind in gateway create/update
Dec 2, 2024
8b4f3b8
Fix error help message
Dec 2, 2024
eb76825
Update according to comments
Dec 2, 2024
b0d3f2e
Update according to comments
Dec 2, 2024
5de8280
fix typo
Dec 5, 2024
34fef84
Update
Dec 10, 2024
a0a4f5d
merge conflict
Dec 10, 2024
d5006c4
Add examples
Jan 7, 2025
15b3679
Remove duplicated examples
Jan 7, 2025
9367af3
Merge branch 'main' into wenhao/jc-env
Descatles Jan 9, 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
1 change: 1 addition & 0 deletions src/containerapp/HISTORY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Release History
upcoming
++++++
* 'az containerapp debug': Open an SSH-like interactive shell within a container app debug console.
* 'az containerapp env java-component': Support more flexible configuration updates with new parameters --set-configurations, --replace-configurations, --remove-configurations and --remove-all-configurations.

1.1.0b1
++++++
Expand Down
42 changes: 21 additions & 21 deletions src/containerapp/azext_containerapp/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1258,7 +1258,7 @@
az containerapp env java-component spring-cloud-config create -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2

@ShichaoQiu ShichaoQiu Dec 17, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we add some examples for this parameter --replace-configurations to describe how to use it?

@Descatles Descatles Jan 7, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

sure, examples added

"""

helps['containerapp env java-component spring-cloud-config delete'] = """
Expand Down Expand Up @@ -1292,13 +1292,13 @@
az containerapp env java-component spring-cloud-config update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration
--set-configurations
- name: Update a Spring Cloud Config with custom configurations.
text: |
az containerapp env java-component spring-cloud-config update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component config-server-for-spring'] = """
Expand All @@ -1315,7 +1315,7 @@
az containerapp env java-component config-server-for-spring create -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
- name: Create a Config Server for Spring with multiple replicas.
text: |
az containerapp env java-component config-server-for-spring create -g MyResourceGroup \\
Expand Down Expand Up @@ -1355,13 +1355,13 @@
az containerapp env java-component config-server-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration
--set-configurations
- name: Update a Config Server for Spring with custom configurations.
text: |
az containerapp env java-component config-server-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component spring-cloud-eureka'] = """
Expand All @@ -1384,7 +1384,7 @@
az containerapp env java-component spring-cloud-eureka create -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component spring-cloud-eureka delete'] = """
Expand Down Expand Up @@ -1418,13 +1418,13 @@
az containerapp env java-component spring-cloud-eureka update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration
--set-configurations
- name: Update a Spring Cloud Eureka with custom configurations.
text: |
az containerapp env java-component spring-cloud-eureka update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component eureka-server-for-spring'] = """
Expand All @@ -1446,7 +1446,7 @@
az containerapp env java-component eureka-server-for-spring create -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component eureka-server-for-spring delete'] = """
Expand Down Expand Up @@ -1480,13 +1480,13 @@
az containerapp env java-component eureka-server-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration
--set-configurations

@Greedygre Greedygre Dec 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same as https://github.com/Azure/azure-cli-extensions/pull/8320/files#r1865268018

@Descatles Descatles Dec 2, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

- name: Update an Eureka Server for Spring with custom configurations.
text: |
az containerapp env java-component eureka-server-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component admin-for-spring'] = """
Expand All @@ -1508,7 +1508,7 @@
az containerapp env java-component admin-for-spring create -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
- name: Create an Admin for Spring with multiple replicas.
text: |
az containerapp env java-component admin-for-spring create -g MyResourceGroup \\
Expand Down Expand Up @@ -1548,13 +1548,13 @@
az containerapp env java-component admin-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration
--set-configurations

@Greedygre Greedygre Dec 2, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does this (Delete all configurations of the Admin for Spring) work with --set-configuration?

@Greedygre Greedygre Dec 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Base on the _params, they are conflict:

Add or update Java component configuration(s). Other existing configurations are not modified. Configurations must be in format "=" "="..."

@Descatles Descatles Dec 2, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The help message is wrong, --set-configurations could not delete configration, has updated to --remove-all-configurations

- name: Update an Admin for Spring with custom configurations.
text: |
az containerapp env java-component admin-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component nacos'] = """
Expand All @@ -1576,7 +1576,7 @@
az containerapp env java-component nacos create -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component nacos delete'] = """
Expand Down Expand Up @@ -1610,13 +1610,13 @@
az containerapp env java-component nacos update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration
--set-configurations

@Greedygre Greedygre Dec 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same as above

@Descatles Descatles Dec 2, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

- name: Update an Nacos with custom configurations.
text: |
az containerapp env java-component nacos update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

helps['containerapp env java-component gateway-for-spring'] = """
Expand All @@ -1640,7 +1640,7 @@
-n MyJavaComponentName \\
--environment MyEnvironment \\
--route-yaml MyRouteYamlFilePath \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
- name: Create a Gateway for Spring with multiple replicas.
text: |
az containerapp env java-component gateway-for-spring create -g MyResourceGroup \\
Expand Down Expand Up @@ -1687,13 +1687,13 @@
az containerapp env java-component gateway-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration
--set-configurations

@Greedygre Greedygre Dec 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same as above

@Descatles Descatles Dec 2, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

- name: Update a Gateway for Spring with custom configurations.
text: |
az containerapp env java-component gateway-for-spring update -g MyResourceGroup \\
-n MyJavaComponentName \\
--environment MyEnvironment \\
--configuration PropertyName1=Value1 PropertyName2=Value2
--set-configurations PropertyName1=Value1 PropertyName2=Value2
"""

# Container Apps Telemetry Commands
Expand Down
6 changes: 5 additions & 1 deletion src/containerapp/azext_containerapp/_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,11 @@ def load_arguments(self, _):
c.argument('resource_group_name', arg_type=resource_group_name_type, id_part=None)
c.argument('service_bindings', nargs='*', options_list=['--bind'], help="Space separated list of services, bindings or other Java components to be connected to this Java Component. e.g. SVC_NAME1[:BIND_NAME1] SVC_NAME2[:BIND_NAME2]...")
c.argument('unbind_service_bindings', nargs='*', options_list=['--unbind'], help="Space separated list of services, bindings or Java components to be removed from this Java Component. e.g. BIND_NAME1...")
c.argument('configuration', nargs="*", help="Java component configuration. Configuration must be in format \"<propertyName>=<value>\" \"<propertyName>=<value>\"...")
c.argument('configuration', nargs="*", help="Java component configuration. Configuration must be in format \"<propertyName>=<value>\" \"<propertyName>=<value>\"...", deprecate_info=c.deprecate(target="--configuration"))

@allxiao allxiao Nov 28, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggest to add redirect="--[set|replace|remove|remove-all]-configurations", and probably hide=True

@Descatles Descatles Nov 28, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

sure. added

c.argument('set_configurations', nargs="*", options_list=['--set-configurations', '--set-configs'], help="Add or update Java component configuration(s). Configurations must be in format \"<propertyName>=<value>\" \"<propertyName>=<value>\"...")

@Caoxuyang Caoxuyang Nov 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I noticed that the env_vars help text for set is --set-env-vars : Add or update environment variable(s) in container. Existing environment variables are not modified.

Can we add one more similar line: Other existing configurations are not modified ?

@Descatles Descatles Nov 28, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sure, updated this message

c.argument('replace_configurations', nargs="*", options_list=['--replace-configurations', '--replace-configs'], help="Replace Java component configuration(s), Other existing configurations are removed. Configurations must be in format \"<propertyName>=<value>\" \"<propertyName>=<value>\"...")
c.argument('remove_configurations', nargs="*", options_list=['--remove-configurations', '--remove-configs'], help="Remove Java component configuration(s). Specify configuration names separated by space, in format \"<propertyName>\" \"<propertyName>\"...")
c.argument('remove_all_configurations', arg_type=get_three_state_flag(), options_list=['--remove-all-configurations', '--remove-all-configs'], help="Remove all Java component configuration(s).")
Comment on lines +377 to +378

@zhoxing-ms zhoxing-ms Jan 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

remove_configurations
remove_all_configurations

Because these two parameters are similar, can they be merged into one parameter? For example, when --remove-configurations does not specify a specific value, the all the configurations are deleted

@Descatles Descatles Jan 9, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Since az containerapp includes parameters like [--remove-all-env-vars] and [--remove-env-vars], I think we should align with that.

@zhoxing-ms zhoxing-ms Jan 13, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OK, got it~

c.argument('min_replicas', type=int, help="Minimum number of replicas to run for the Java component.")
c.argument('max_replicas', type=int, help="Maximum number of replicas to run for the Java component.")
c.argument('route_yaml', options_list=['--route-yaml', '--yaml'], help="Path to a .yaml file with the configuration of a Spring Cloud Gateway route. For an example, see https://aka.ms/gateway-for-spring-routes-yaml")
Expand Down
Loading