[DataBoxEdge] new command module: support for data-box-edge devices and management #16193

evelyn-ys · 2020-12-08T09:39:05Z

Description

CLI support for databoxedge
This PR covers databoxedge operations which not involving encryption flow, including:

az databoxedge list-sku|list-node|show-job
az databoxedge device create|list|show|update|delete
az databoxedge device scan-for-update|show-update-summary|download-update|install-update
az databoxedge alert list|show
az databoxedge order create|list|show|update|delete
az databoxedge bandwidth-schedule create|list|show|update|delete

Testing Guide

Commands which don't need the device to be registered

See test cases

Commands which need the device registered

Preparation: Finish tutorial on prepare, install and activate

az databoxedge device scan-for-update -n testdevice -g myresourcegroup
az databoxedge device show-update-summary -n testdevice -g myresourcegroup
az databoxedge device download-update -n testdevice -g myresourcegroup
az databoxedge device download-update -n testdevice -g myresourcegroup
az databoxedge alert list -d testdevice -g myresourcegroup
az databoxedge alert show -n xxxxxxxxx -d testdevice -g myresourcegroup
az databoxedge bandwidth-schedule create -n mybandwidth -d testdevice -g myresourcegroup --days "Sunday" "Monday" --rate-in-mbps 100 --start "0:0:0" --stop "13:59:0"
az databoxedge bandwidth-schedule list -d testdevice -g myresourcegroup
az databoxedge bandwidth-schedule update -n mybandwidth-d testdevice -g myresourcegroup --rate-in-mbps 250
az databoxedge bandwidth-schedule show -n mybandwidth -d testdevice -g myresourcegroup
az databoxedge bandwidth-schedule delete-n mybandwidth -d testdevice -g myresourcegroup
az databoxedge list-node -d testdevice -g myresourcegroup
az databoxedge show-job -n xxxxxxxxx -d testdevice -g myresourcegroup

yonzhan · 2020-12-08T10:37:33Z

Databoxedge

haroldrandom

core. LGTM.

BTW, would DataboxEdge be better?

Juliehzl · 2020-12-10T14:22:46Z

src/azure-cli-core/azure/cli/core/profiles/_shared.py

    MGMT_CONSUMPTION = ('azure.mgmt.consumption', None)
    MGMT_CONTAINERINSTANCE = ('azure.mgmt.containerinstance', None)
    MGMT_COSMOSDB = ('azure.mgmt.cosmosdb', None)
+    MGMT_DATABOXEDGE = ('azure.mgmt.databoxedge', None)


you could specify the client name here

Juliehzl · 2020-12-10T14:26:52Z

src/azure-cli/azure/cli/command_modules/databoxedge/__init__.py

+
+    def __init__(self, cli_ctx=None):
+        from azure.cli.core.commands import CliCommandType
+        from .generated._client_factory import cf_databoxedge_cl


you still want to use generated code, right?
and we should avoid to use relative import

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_client_factory.py

Juliehzl · 2020-12-10T14:29:53Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

+
+helps['databoxedge device install-update'] = """
+    type: command
+    short-summary: "Installs the updates on the Data Box Edge/Data Box Gateway device."


Installs -> Install

I have overwrite all helps under manual folder

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

Juliehzl · 2020-12-10T14:34:39Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

+helps['databoxedge'] = """
+    type: group
+    short-summary: Manage node with databoxedge
+"""


Same as above

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

Juliehzl · 2020-12-10T14:35:28Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_params.py

+        c.argument('tags', tags_type)
+        c.argument('sku', action=AddSku, nargs='+', help='The SKU type.')
+        c.argument('etag', type=str, help='The etag for the devices.')
+        c.argument('data_box_edge_device_status', options_list=['--status'], arg_type=get_enum_type(['ReadyToSetup',


could we get the enum type from sdk

I have asked @qiaozha for support, guess developing?

If there is enum definition in SDK, you could rewrite it now.
Getting from SDK could adjust with api version update.

Juliehzl · 2020-12-10T14:36:31Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

+    type: command
+    short-summary: "Downloads the updates on a Data Box Edge/Data Box Gateway device."
+    examples:
+      - name: DownloadUpdatesPost


such example name is not friendly

I have overwrite all helps under manual folder

Juliehzl · 2020-12-10T14:37:35Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

+
+helps['databoxedge device download-update'] = """
+    type: command
+    short-summary: "Downloads the updates on a Data Box Edge/Data Box Gateway device."


curious about the download-update work. which kind of updates could be downloaded?

Databoxedge device has many installed pkgs, so CX can run scan-for-update first, and then show-update-summary to check how many pkgs they can update. After download according to the summary using download-update, they can run install-update to finish updating the whole device.
So for you question, they actually download the updated pkg.

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_params.py

Juliehzl · 2020-12-10T14:40:09Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_params.py

+        c.argument('start', type=str, help='The start time of the schedule in UTC.')
+        c.argument('stop', type=str, help='The stop time of the schedule in UTC.')
+        c.argument('rate_in_mbps', type=int, help='The bandwidth rate in Mbps.')
+        c.argument('days', nargs='+', help='The days of the week when this schedule is applicable.')


why the days parameter is list array?

Users can create same bandwidth rule for several days, for example, 10mbps between 09:00:00 and 18:00:00 for both 'Saturday' and 'Sunday'

Do we have test to cover such scenario?

To test bandwidth-schedule, the device need to be registered which need a vm prepared and some manual work on web page. So it's hard to record tests. But I do test this scenario with the vm service team provided.

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_params.py

Juliehzl · 2020-12-10T14:40:58Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_params.py

+        c.argument('shipping_address_city', options_list=['--city'], type=str, help='The city name.')
+        c.argument('shipping_address_state', options_list=['--state'], type=str, help='The state name.')
+        c.argument('shipping_address_country', options_list=['--country'], type=str, help='The country name.')
+        c.argument('contact_information_contact_person', options_list=['--contact-person'], type=str, help='The '


group contact related arguments, too

Same as above

Juliehzl · 2020-12-10T14:46:14Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

+      - name: --sku
+        short-summary: "The SKU type."
+        long-summary: |
+            Usage: --sku name=XX tier=XX


consider if we could specify sku with only one property.

The sku name can be 'Gateway' or 'Edge', the tier can be 'Standard' or something else. How can we specify with only one property?

src/azure-cli/azure/cli/command_modules/databoxedge/generated/commands.py

Juliehzl · 2020-12-10T14:50:34Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/commands.py

+    databoxedge_device = CliCommandType(
+        operations_tmpl='azure.mgmt.databoxedge.operations._devices_operations#DevicesOperations.{}',
+        client_factory=cf_device)
+    with self.command_group('databoxedge device', databoxedge_device, client_factory=cf_device) as g:


Add resource type and min_api for commands or arguments to make sure unsupported commands hidden in unsupported environment

src/azure-cli/azure/cli/command_modules/databoxedge/generated/commands.py

Juliehzl · 2020-12-22T02:32:07Z

src/azure-cli/azure/cli/command_modules/databoxedge/generated/_help.py

+    short-summary: "Gets all the Data Box Edge/Data Box Gateway devices in a resource group. And Gets all the Data Box \
+Edge/Data Box Gateway devices in a subscription."
+    examples:
+      - name: DataBoxEdgeDeviceGetByResourceGroup


could we refine the example name to be more friendly?

same for all

all refined under /manual/_help.py

src/azure-cli/azure/cli/command_modules/databoxedge/tests/hybrid_2019_03_01/example_steps.py

Juliehzl · 2020-12-22T04:03:48Z

src/azure-cli/azure/cli/command_modules/databoxedge/manual/_help.py

+            Usage: --sku name=XX tier=XX
+
+            name: SKU name.
+            tier: The SKU tier. This is based on the SKU name.


For sku issue, it seems the tier is based on name. So I am thinking if we could get sku type with name only.
With current design, it is a little complicated for customer to define their sku and they have no idea for allowed value.

Juliehzl

LGTM in general. But please see https://github.com/Azure/azure-cli/pull/16193/files#r547053949

src/azure-cli-core/azure/cli/core/profiles/_shared.py

support data box edge device and management

72e36a4

evelyn-ys requested review from Juliehzl and jsntcy December 8, 2020 09:39

evelyn-ys requested review from dbradish-microsoft, fengzhou-msft, haroldrandom, houk-ms, jiasli and qwordy as code owners December 8, 2020 09:39

yonzhan assigned evelyn-ys Dec 8, 2020

yonzhan added this to the S180 milestone Dec 8, 2020

evelyn-ys added 2 commits December 9, 2020 10:24

help

99a9bc9

pylint

84f180f

evelyn-ys mentioned this pull request Dec 9, 2020

[Databoxedge] new extension: support for data-box-edge devices and management Azure/azure-cli-extensions#2732

Closed

3 tasks

haroldrandom approved these changes Dec 9, 2020

View reviewed changes

evelyn-ys changed the title ~~[Databoxedge] new command module: support for data-box-edge devices and management~~ [DataBoxEdge] new command module: support for data-box-edge devices and management Dec 9, 2020