Initial commit of k8s-extension

src/k8s-extension/HISTORY.rst

@@ -0,0 +1,83 @@
+.. :changelog:
+
+Release History
+===============
+
+0.1.0
+++++++++++++++++++
+* Initial release.
+
+0.1.1
+++++++++++++++++++
+* Add support for microsoft-azure-defender extension type
+
+0.1.2
+++++++++++++++++++
+
+* Add support for Arc Appliance cluster type
+
+0.1.3
+++++++++++++++++++
+
+* Customization for microsoft.openservicemesh
+
+0.1PP.4
+++++++++++++++++++
+
+* Refactor for clear separation of extension-type specific customizations
+* Introduce new versioning scheme to allow Preview releases by Partners
+
+0.1PP.5
+++++++++++++++++++
+
+* OpenServiceMesh customization.
+* If Version is passed in, accept None for AutoUpgradeMinorVersion, and not require it to be False.
+
+0.1PP.6
+++++++++++++++++++
+
+* OpenServiceMesh customization.
+* Scope is always cluster.  Version is mandatory for staging and pilot release-trains.
+
+0.1PP.7
+++++++++++++++++++
+
+* Fix clusterType of Microsoft.ResourceConnector resource
+
+0.1PP.8
+++++++++++++++++++
+
+* Update clusterType validation to allow 'appliances'
+* Update identity creation to use the appropriate parent resource's type and api-version
+* Throw error if cluster type is not one of the 3 supported types
+
+0.1PP.9
+++++++++++++++++++
+
+* Rename azuremonitor-containers extension type to microsoft.azuremonitor.containers
+
+0.1PP.10
+++++++++++++++++++
+
+* Add azuremonitor-containers back with alternative microsoft.azuremonitor.containers
+
+0.1PP.11
+++++++++++++++++++
+
+* Add shorter aliases for long parameter names
+
+0.1PP.12
+++++++++++++++++++
+
+* Remove support for azuremonitor-containers extension type naming
+
+0.1PP.13
+++++++++++++++++++
+
+* Move CLI errors to non-deprecated error types
+* Remove support for update
+
+0.1PP.14
+++++++++++++++++++
+
+* Update help text, group CLI arguments

src/k8s-extension/README.rst

@@ -0,0 +1,5 @@
+Microsoft Azure CLI 'k8s-extension' Extension
+=============================================
+
+This package is for the 'k8s-extension' extension.
+i.e. 'az k8s-extension'

src/k8s-extension/azext_k8s_extension/__init__.py

@@ -0,0 +1,32 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core import AzCommandsLoader
+
+from azext_k8s_extension._help import helps  # pylint: disable=unused-import
+
+
+class K8sExtensionCommandsLoader(AzCommandsLoader):
+
+    def __init__(self, cli_ctx=None):
+        from azure.cli.core.commands import CliCommandType
+        from azext_k8s_extension._client_factory import cf_k8s_extension
+        k8s_extension_custom = CliCommandType(
+            operations_tmpl='azext_k8s_extension.custom#{}',
+            client_factory=cf_k8s_extension)
+        super(K8sExtensionCommandsLoader, self).__init__(cli_ctx=cli_ctx,
+                                                         custom_command_type=k8s_extension_custom)
+
+    def load_command_table(self, args):
+        from azext_k8s_extension.commands import load_command_table
+        load_command_table(self, args)
+        return self.command_table
+
+    def load_arguments(self, command):
+        from azext_k8s_extension._params import load_arguments
+        load_arguments(self, command)
+
+
+COMMAND_LOADER_CLS = K8sExtensionCommandsLoader

src/k8s-extension/azext_k8s_extension/_client_factory.py

@@ -0,0 +1,31 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core.commands.client_factory import get_mgmt_service_client
+from azure.cli.core.profiles import ResourceType
+
+
+def cf_k8s_extension(cli_ctx, *_):
+    from azext_k8s_extension.vendored_sdks import K8sExtensionClient
+    return get_mgmt_service_client(cli_ctx, K8sExtensionClient)
+
+
+def cf_k8s_extension_operation(cli_ctx, _):
+    return cf_k8s_extension(cli_ctx).k8s_extensions
+
+
+def cf_resource_groups(cli_ctx, subscription_id=None):
+    return get_mgmt_service_client(cli_ctx, ResourceType.MGMT_RESOURCE_RESOURCES,
+                                   subscription_id=subscription_id).resource_groups
+
+
+def cf_resources(cli_ctx, subscription_id=None):
+    return get_mgmt_service_client(cli_ctx, ResourceType.MGMT_RESOURCE_RESOURCES,
+                                   subscription_id=subscription_id).resources
+
+
+def cf_log_analytics(cli_ctx, subscription_id=None):
+    from azure.mgmt.loganalytics import LogAnalyticsManagementClient  # pylint: disable=no-name-in-module
+    return get_mgmt_service_client(cli_ctx, LogAnalyticsManagementClient, subscription_id=subscription_id)

src/k8s-extension/azext_k8s_extension/_help.py

@@ -0,0 +1,38 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from knack.help_files import helps  # pylint: disable=unused-import
+
+
+helps['k8s-extension'] = """
+    type: group
+    short-summary: Commands to manage K8s-extensions.
+"""
+
+helps['k8s-extension create'] = """
+    type: command
+    short-summary: Create a K8s-extension.
+"""
+
+helps['k8s-extension list'] = """
+    type: command
+    short-summary: List K8s-extensions.
+"""
+
+helps['k8s-extension delete'] = """
+    type: command
+    short-summary: Delete a K8s-extension.
+"""
+
+helps['k8s-extension show'] = """
+    type: command
+    short-summary: Show details of a K8s-extension.
+"""
+
+helps['k8s-extension update'] = """
+    type: command
+    short-summary: Update a K8s-extension.
+"""

src/k8s-extension/azext_k8s_extension/_params.py

@@ -0,0 +1,73 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core.commands.parameters import (
+    get_enum_type,
+    get_three_state_flag,
+    tags_type
+)
+from azure.cli.core.commands.validators import get_default_location_from_resource_group
+
+from azext_k8s_extension.action import (
+    AddConfigurationSettings,
+    AddConfigurationProtectedSettings
+)
+
+
+def load_arguments(self, _):
+    with self.argument_context('k8s-extension') as c:
+        c.argument('tags', tags_type)
+        c.argument('location',
+                   validator=get_default_location_from_resource_group)
+        c.argument('name',
+                   options_list=['--name', '-n'],
+                   help='Name of the extension instance')
+        c.argument('extension_type',
+                   help='Name of the extension type.')
+        c.argument('cluster_name',
+                   options_list=['--cluster-name', '-c'],
+                   help='Name of the Kubernetes cluster')
+        c.argument('cluster_type',
+                   arg_type=get_enum_type(['connectedClusters', 'managedClusters', 'appliances']),
+                   help='Specify Arc clusters or AKS managed clusters or Arc appliances.')
+        c.argument('scope',
+                   arg_type=get_enum_type(['cluster', 'namespace']),
+                   help='Specify the extension scope.')
+        c.argument('auto_upgrade_minor_version',
+                   arg_group="Version",
+                   options_list=['--auto-upgrade-minor-version', '--auto-upgrade'],
+                   arg_type=get_three_state_flag(),
+                   help='Automatically upgrade minor version of the extension instance.')
+        c.argument('version',
+                   arg_group="Version",
+                   help='Specify the version to install for the extension instance if'
+                   ' --auto-upgrade-minor-version is not enabled.')
+        c.argument('configuration_settings',
+                   arg_group="Configuration",
+                   options_list=['--configuration-settings', '--config'],
+                   action=AddConfigurationSettings,
+                   nargs='+',
+                   help='Configuration Settings as key=value pair.  Repeat parameter for each setting')
+        c.argument('configuration_protected_settings',
+                   arg_group="Configuration",
+                   options_list=['--configuration-protected-settings', '--config-protected'],
+                   action=AddConfigurationProtectedSettings,
+                   nargs='+',
+                   help='Configuration Protected Settings as key=value pair.  Repeat parameter for each setting')
+        c.argument('configuration_settings_file',
+                   arg_group="Configuration",
+                   options_list=['--configuration-settings-file', '--config-file'],
+                   help='JSON file path for configuration-settings')
+        c.argument('configuration_protected_settings_file',
+                   arg_group="Configuration",
+                   options_list=['--configuration-protected-settings-file', '--config-protected-file'],
+                   help='JSON file path for configuration-protected-settings')
+        c.argument('release_namespace',
+                   help='Specify the namespace to install the extension release.')
+        c.argument('release_train',
+                   help='Specify the release train for the extension type.')
+        c.argument('target_namespace',
+                   help='Specify the target namespace to install to for the extension instance. This'
+                   ' parameter is required if extension scope is set to \'namespace\'')

src/k8s-extension/azext_k8s_extension/_validators.py

@@ -0,0 +1,21 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+
+def example_name_or_id_validator(cmd, namespace):
+    # Example of a storage account name or ID validator.
+    # See: https://github.com/Azure/azure-cli/blob/dev/doc/authoring_command_modules/authoring_commands.md#supporting-name-or-id-parameters  # pylint: disable=line-too-long
+
+    from azure.cli.core.commands.client_factory import get_subscription_id
+    from msrestazure.tools import is_valid_resource_id, resource_id
+    if namespace.storage_account:
+        if not is_valid_resource_id(namespace.RESOURCE):
+            namespace.storage_account = resource_id(
+                subscription=get_subscription_id(cmd.cli_ctx),
+                resource_group=namespace.resource_group_name,
+                namespace='Microsoft.Storage',
+                type='storageAccounts',
+                name=namespace.storage_account
+            )

src/k8s-extension/azext_k8s_extension/action.py

@@ -0,0 +1,37 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+import argparse
+from azure.cli.core.azclierror import ArgumentUsageError
+
+
+# pylint: disable=protected-access, too-few-public-methods
+class AddConfigurationSettings(argparse._AppendAction):
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        settings = {}
+        for item in values:
+            try:
+                key, value = item.split('=', 1)
+                settings[key] = value
+            except ValueError:
+                raise ArgumentUsageError('Usage error: {} configuration_setting_key=configuration_setting_value'.
+                                         format(option_string))
+        super(AddConfigurationSettings, self).__call__(parser, namespace, settings, option_string)
+
+
+# pylint: disable=protected-access, too-few-public-methods
+class AddConfigurationProtectedSettings(argparse._AppendAction):
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        prot_settings = {}
+        for item in values:
+            try:
+                key, value = item.split('=', 1)
+                prot_settings[key] = value
+            except ValueError:
+                raise ArgumentUsageError('Usage error: {} configuration_protected_setting_key='
+                                         'configuration_protected_setting_value'.format(option_string))
+        super(AddConfigurationProtectedSettings, self).__call__(parser, namespace, prot_settings, option_string)

src/k8s-extension/azext_k8s_extension/azext_metadata.json

@@ -0,0 +1,4 @@
+{
+    "azext.isPreview": true,
+    "azext.minCliCoreVersion": "2.15.0"
+}

src/k8s-extension/azext_k8s_extension/commands.py

@@ -0,0 +1,24 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# pylint: disable=line-too-long
+from azure.cli.core.commands import CliCommandType
+from azext_k8s_extension._client_factory import (cf_k8s_extension, cf_k8s_extension_operation)
+
+
+def load_command_table(self, _):
+
+    k8s_extension_sdk = CliCommandType(
+        operations_tmpl='azext_k8s_extension.vendored_sdks.operations#K8sExtensionsOperations.{}',
+        client_factory=cf_k8s_extension)
+
+    with self.command_group('k8s-extension', k8s_extension_sdk, client_factory=cf_k8s_extension_operation,
+                            is_preview=True) \
+            as g:
+        g.custom_command('create', 'create_k8s_extension')
+        g.custom_command('update', 'update_k8s_extension')
+        g.custom_command('delete', 'delete_k8s_extension', confirmation=True)
+        g.custom_command('list', 'list_k8s_extension')
+        g.custom_show_command('show', 'show_k8s_extension')