[containerapp] suspend/resume a container apps job #8270

bgashirabake · 2024-11-13T11:12:34Z

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-11-13T11:12:38Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️containerapp

rule cmd_name rule_message suggest_message

⚠️ 1001 - CmdAdd containerapp job resume cmd containerapp job resume added

⚠️ 1001 - CmdAdd containerapp job suspend cmd containerapp job suspend added

azure-client-tools-bot-prd · 2024-11-13T11:12:41Z

Hi @bgashirabake,
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.

azure-client-tools-bot-prd · 2024-11-13T11:12:44Z

Hi @bgashirabake,
Since the current milestone time is less than 7 days, this pr may not catch up with this release.

yonzhan · 2024-11-13T11:12:52Z

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

microsoft-github-policy-service · 2024-11-13T11:13:19Z

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

github-actions · 2024-11-13T11:13:42Z

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-11-13T11:16:35Z

Hi @bgashirabake

Release Suggestions

Module: containerapp

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

Notes

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

bgashirabake · 2024-11-13T11:21:23Z

@Greedygre can you help with initial reviews for this PR?

i'll get someone from my team to validate the logic too :)

anandanthony · 2024-11-14T22:40:00Z

src/containerapp/azext_containerapp/_clients.py

+
+        r = send_raw_request(cmd.cli_ctx, "POST", request_url)
+        if r.status_code == 202:
+            return


handle other response codes as well. For example, if Job is not found, then we would return 404 from the RP, but in this case we would not return the correct information.

In the send_raw_request(cmd.cli_ctx, "POST", request_url) it throw error when return 4xx. So not need to handle it here specifically.
We need to have test to cover this case and check the error message.

anandanthony · 2024-11-14T22:41:48Z

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

+            JMESPathCheck('name', job),
+            JMESPathCheck("properties.provisioningState", "Succeeded"),
+            JMESPathCheck('properties.runningStatus', "Suspended", case_sensitive=False),
+        ])


Add an additional command here to try and start the suspended job which should return the message that the Job in suspended state.

Greedygre · 2024-11-22T23:42:25Z

src/containerapp/azext_containerapp/custom.py

+    )
+    containerapp_job_decorator.validate_subscription_registered(CONTAINER_APPS_RP)
+
+    return ContainerAppsJobPreviewClient.suspend(cmd=cmd, resource_group_name=resource_group_name, name=name)


Please use the containerapp_job_suspend_decorator to execute containerapp_job_suspend_decorator.suspend()
You can refer : class ContainerAppPreviewListDecorator(BaseContainerAppDecorator) to create
class ContainerAppJobSuspendDecorator(ContainerAppJobDecorator)

Greedygre · 2024-11-22T23:42:40Z

src/containerapp/azext_containerapp/custom.py

+
+    containerapp_job_decorator.validate_subscription_registered(CONTAINER_APPS_RP)
+
+    return ContainerAppsJobPreviewClient.resume(cmd=cmd, resource_group_name=resource_group_name, name=name)


same as above.

Greedygre · 2024-11-22T23:49:10Z

src/containerapp/azext_containerapp/_sdk_models.py

@@ -8389,6 +8393,7 @@ class ContainerAppsJob(TrackedResource):  # pylint: disable=too-many-instance-at
        "extended_location": {"key": "extendedLocation", "type": "ExtendedLocation"},
        "identity": {"key": "identity", "type": "ManagedServiceIdentity"},
        "provisioning_state": {"key": "properties.provisioningState", "type": "str"},
+        "running_status": {"key": "properties.runningStatus", "type": "str"},


Please add YAML test to cover it. And rerun all tests relate to az containerapp job create/update --yaml

It is a readonly property, we cannot update it with az containerapp job create/update --yaml, right?

Why you need to update this class?
In fact az containerapp job create/update --yaml is using class Job, not this one. I think you don't need to update this file.

Greedygre · 2024-11-23T00:26:17Z

src/containerapp/azext_containerapp/commands.py

@@ -43,6 +43,8 @@ def load_command_table(self, args):
        g.custom_command('create', 'create_containerappsjob', supports_no_wait=True, exception_handler=ex_handler_factory(), transform=transform_sensitive_values)
        g.custom_command('update', 'update_containerappsjob', supports_no_wait=True, exception_handler=ex_handler_factory(), transform=transform_sensitive_values)
        g.custom_command('delete', 'delete_containerappsjob', supports_no_wait=True, confirmation=True, exception_handler=ex_handler_factory())
+        g.custom_command('suspend', 'suspend_containerappsjob', supports_no_wait=True, exception_handler=ex_handler_factory())


It would better to ask the customer to confirm action like az containerapp job delete?
Recommedn to add confirmation=True

Greedygre · 2024-11-23T00:30:53Z

src/containerapp/azext_containerapp/_params.py

+    with self.argument_context('containerapp job suspend') as c:
+        c.argument('name', name_type, id_part=None, help="The name of the Containerapp job.")
+        c.argument('resource_group_name', arg_type=resource_group_name_type, id_part=None)
+
+    with self.argument_context('containerapp job resume') as c:
+        c.argument('name', name_type, id_part=None, help="The name of the Containerapp job.")
+        c.argument('resource_group_name', arg_type=resource_group_name_type, id_part=None)


I think you don't need to add these params, because they can inherit the params from az containerapp job

[email protected] added 2 commits November 13, 2024 03:02

suspend/resume jobs support

932f7bc

linter

1e6b84d

azure-client-tools-bot-prd bot added this to the November 2024 (2024-11-19)❗ Breaking change release ❗ milestone Nov 13, 2024

microsoft-github-policy-service bot requested review from yonzhan, wangzelin007, yanzhudd, zhoxing-ms and jsntcy November 13, 2024 11:12

bgashirabake changed the title ~~[container app] suspend/resume a container apps job~~ [containerapp] suspend/resume a container apps job Nov 13, 2024

microsoft-github-policy-service bot requested review from ruslany, sanchitmehta, ebencarek, JennyLawrance, howang-ms, vinisoto, chinadragon0515, vturecek, torosent, pagariyaalok, Juliehzl, jijohn14 and Greedygre November 13, 2024 11:13

microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 13, 2024

microsoft-github-policy-service bot added the Auto-Assign Auto assign by bot label Nov 13, 2024

microsoft-github-policy-service bot assigned zhoxing-ms Nov 13, 2024

microsoft-github-policy-service bot added the ContainerApp label Nov 13, 2024

anandanthony reviewed Nov 14, 2024

View reviewed changes

Greedygre reviewed Nov 22, 2024

View reviewed changes

Greedygre reviewed Nov 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[containerapp] suspend/resume a container apps job #8270

[containerapp] suspend/resume a container apps job #8270

bgashirabake commented Nov 13, 2024

azure-client-tools-bot-prd bot commented Nov 13, 2024 •

edited

Loading

azure-client-tools-bot-prd bot commented Nov 13, 2024

azure-client-tools-bot-prd bot commented Nov 13, 2024

yonzhan commented Nov 13, 2024

microsoft-github-policy-service bot commented Nov 13, 2024

github-actions bot commented Nov 13, 2024

github-actions bot commented Nov 13, 2024

bgashirabake commented Nov 13, 2024

anandanthony Nov 14, 2024

bgashirabake Nov 21, 2024

Greedygre Nov 22, 2024

anandanthony Nov 14, 2024

Greedygre Nov 22, 2024 •

edited

Loading

Greedygre Nov 22, 2024

Greedygre Nov 22, 2024

Greedygre Nov 23, 2024

Greedygre Nov 23, 2024

Greedygre Nov 23, 2024

Greedygre Nov 23, 2024


		containerapp_job_decorator.validate_subscription_registered(CONTAINER_APPS_RP)

		return ContainerAppsJobPreviewClient.resume(cmd=cmd, resource_group_name=resource_group_name, name=name)

[containerapp] suspend/resume a container apps job #8270

Are you sure you want to change the base?

[containerapp] suspend/resume a container apps job #8270

Conversation

bgashirabake commented Nov 13, 2024

Related command

General Guidelines

About Extension Publish

azure-client-tools-bot-prd bot commented Nov 13, 2024 • edited Loading

azure-client-tools-bot-prd bot commented Nov 13, 2024

azure-client-tools-bot-prd bot commented Nov 13, 2024

yonzhan commented Nov 13, 2024

microsoft-github-policy-service bot commented Nov 13, 2024

github-actions bot commented Nov 13, 2024

CodeGen Tools Feedback Collection

github-actions bot commented Nov 13, 2024

Release Suggestions

Module: containerapp

Notes

bgashirabake commented Nov 13, 2024

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

Greedygre Nov 22, 2024 • edited Loading

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

azure-client-tools-bot-prd bot commented Nov 13, 2024 •

edited

Loading

Greedygre Nov 22, 2024 •

edited

Loading