Add Maintenance Config Support #8190

p-bouchon · 2024-10-23T23:11:28Z

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

Related command

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.

azure-client-tools-bot-prd · 2024-10-23T23:11:31Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️containerapp

rule cmd_name rule_message suggest_message

⚠️ 1011 - SubgroupAdd containerapp env maintenance-config sub group containerapp env maintenance-config added

azure-client-tools-bot-prd · 2024-10-23T23:11:34Z

Hi @p-bouchon,
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 · 2024-10-23T23:11:43Z

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

github-actions · 2024-10-23T23:12:38Z

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

github-actions · 2024-10-23T23:15:22Z

Hi @p-bouchon

Release Suggestions

Module: containerapp

Update VERSION to 1.0.0b4 in src/containerapp/setup.py

Notes

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

src/containerapp/azext_containerapp/commands.py

src/containerapp/azext_containerapp/containerapp_maintenanceconfig_decorator.py

src/containerapp/azext_containerapp/tests/latest/test_containerapp_maintenance_config.py

src/containerapp/azext_containerapp/_params.py

src/containerapp/azext_containerapp/custom.py

src/containerapp/azext_containerapp/containerapp_maintenanceconfig_decorator.py

src/containerapp/azext_containerapp/custom.py

src/containerapp/azext_containerapp/_params.py

jijohn14 · 2024-10-25T18:00:56Z

src/containerapp/HISTORY.rst

@@ -8,6 +8,7 @@ upcoming
 * 'az containerapp containerapp create/up': `--registry-server` and `--source` use managed identity for image pull by default
 * 'az containerapp containerapp create': `--registry-server` use managed identity for image pull by default. `--no-wait` will not take effect with system registry identity.
 * 'az containerapp env java-component gateway-for-spring': Support create/update/show/delete Gateway for spring.
+* 'az containerapp env maintenance-config': Support Add, Update, Show, Delete


Could you get ack from PMs with maintenance-config change since doc has different values

jijohn14 · 2024-10-25T18:14:19Z

src/containerapp/azext_containerapp/_clients.py

+
+        if no_wait:
+            return r.json()
+        elif r.status_code == 201:


JFYI - There is no impact. PUT for this resource only returns 200. Refer https://dev.azure.com/msazure/One/_git/AAPT-Antares-Containerapps?path=/src/Microsoft.ContainerApps/Microsoft.ContainerApps.WebApi/Controllers/Version20241002preview/MaintenanceConfigurationApiController.cs&version=GBmain&line=77&lineEnd=77&lineStartColumn=132&lineEndColumn=143&lineStyle=plain&_a=contents

jijohn14 · 2024-10-25T18:28:57Z

src/containerapp/azext_containerapp/_clients.py

+
+        if no_wait:
+            return  # API doesn't return JSON (it returns no content)
+        elif r.status_code in [200, 201, 202, 204]:


201 polling is not handled and also invalid for delete operations. Refer https://github.com/cloud-and-ai-microsoft/resource-provider-contract/blob/master/v1.0/async-api-reference.md#delete-resource-asynchronously

For this api, we only return 200. Still future proofing is good.

jijohn14 · 2024-10-25T18:30:53Z

src/containerapp/azext_containerapp/_help.py

+# Maintenance Config Commands
+helps['containerapp env maintenance-config add'] = """
+    type: command
+    short-summary: Add a Maintenance Configuration to a Container App Environment


May need to update description based PM final decision. Example:

Suggested change

short-summary: Add a Maintenance Configuration to a Container App Environment

short-summary: Add a Scheduled Maintenance to a Container App Environment

jijohn14 · 2024-10-25T18:32:08Z

src/containerapp/azext_containerapp/_help.py

+    type: command
+    short-summary: Add a Maintenance Configuration to a Container App Environment
+    examples:
+    - name: Configure an Env to use a maintenance config


nit: To have full name for descriptions. PM can contribute here

Suggested change

- name: Configure an Env to use a maintenance config

- name: Configure a Container App Environment to use a maintenance configuration

jijohn14 · 2024-10-25T18:34:06Z

src/containerapp/azext_containerapp/_params.py

+    with self.argument_context('containerapp env maintenance-config') as c:
+        c.argument('weekday', options_list=['--weekday', '-w'], arg_type=get_enum_type(["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ]), help="The weekday to schedule the maintenance configuration.")
+        c.argument('start_hour_utc', options_list=['--start-hour-utc', '-s'], help="The hour to start the maintenance configuration.")
+        c.argument('duration', options_list=['--duration', '-d'], help="The duration in hours of the maintenance configuration.")


Since, you have it in validation

Suggested change

c.argument('duration', options_list=['--duration', '-d'], help="The duration in hours of the maintenance configuration.")

c.argument('duration', options_list=['--duration', '-d'], help="The duration in hours of the maintenance configuration. Minimum value: 8")

jijohn14 · 2024-10-25T18:36:49Z

src/containerapp/azext_containerapp/_params.py

@@ -370,6 +370,11 @@ def load_arguments(self, _):
        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")

+    with self.argument_context('containerapp env maintenance-config') as c:
+        c.argument('weekday', options_list=['--weekday', '-w'], arg_type=get_enum_type(["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ]), help="The weekday to schedule the maintenance configuration.")
+        c.argument('start_hour_utc', options_list=['--start-hour-utc', '-s'], help="The hour to start the maintenance configuration.")


Suggested change

c.argument('start_hour_utc', options_list=['--start-hour-utc', '-s'], help="The hour to start the maintenance configuration.")

c.argument('start_hour_utc', options_list=['--start-hour-utc', '-s'], help="The hour to start the maintenance configuration. Valid value from 0 to 23")

Patrick Bouchon added 2 commits October 23, 2024 17:55

add maintenance config

14feb57

update lint

197987b

azure-client-tools-bot-prd bot added this to the October 2024 (2024-11-05) milestone Oct 23, 2024

remove scheduled entries

b0d2b8b

yonzhan requested review from kairu-ms and jsntcy October 23, 2024 23:57

yonzhan assigned kairu-ms Oct 23, 2024

yonzhan requested review from zhoxing-ms and yanzhudd and removed request for jsntcy and kairu-ms October 23, 2024 23:58

yonzhan assigned zhoxing-ms and unassigned kairu-ms Oct 23, 2024