AKS: Implement support to perform Azure container storage operations

src/aks-preview/HISTORY.rst

@@ -11,6 +11,10 @@ To release a new version, please select a new version number (usually plus 1 to
 
 Pending
 +++++++
+0.5.162
++++++++
+* Add option `--enable-azure-container-storage` and supporting options `--storage-pool-name`, `--storage-pool-type`, `--storage-pool-sku`, `--storage-pool-size` for `az aks create` and `az aks update`. `az aks update` also supports `--azure-container-storage-nodepools` option.
+* Add option `--disable-azure-container-storage` to `az aks create` and `az aks update`.
 
 0.5.161
 +++++++

src/aks-preview/azext_aks_preview/_params.py

@@ -170,7 +170,21 @@
     tags_type,
     zones_type,
 )
-from azure.cli.core.profiles import ResourceType
+from azext_aks_preview.azurecontainerstorage._consts import (
+    CONST_STORAGE_POOL_TYPE_AZURE_DISK,
+    CONST_STORAGE_POOL_TYPE_EPHEMERAL_DISK,
+    CONST_STORAGE_POOL_TYPE_ELASTIC_SAN,
+    CONST_STORAGE_POOL_SKU_PREMIUM_LRS,
+    CONST_STORAGE_POOL_SKU_STANDARD_LRS,
+    CONST_STORAGE_POOL_SKU_STANDARDSSD_LRS,
+    CONST_STORAGE_POOL_SKU_ULTRASSD_LRS,
+    CONST_STORAGE_POOL_SKU_PREMIUM_ZRS,
+    CONST_STORAGE_POOL_SKU_PREMIUMV2_ZRS,
+    CONST_STORAGE_POOL_SKU_STANDARDSSD_ZRS,
+    CONST_STORAGE_POOL_OPTION_NVME,
+    CONST_STORAGE_POOL_OPTION_TEMP,
+    CONST_STORAGE_POOL_DEFAULT_SIZE,
+)
 from knack.arguments import CLIArgumentType
 
 # candidates for enumeration
@@ -257,6 +271,29 @@
     CONST_AZURE_SERVICE_MESH_INGRESS_MODE_INTERNAL,
 ]
 
+# azure container storage
+
+storage_pool_types = [
+    CONST_STORAGE_POOL_TYPE_AZURE_DISK,
+    CONST_STORAGE_POOL_TYPE_EPHEMERAL_DISK,
+    CONST_STORAGE_POOL_TYPE_ELASTIC_SAN,
+]
+
+storage_pool_skus = [
+    CONST_STORAGE_POOL_SKU_PREMIUM_LRS,
+    CONST_STORAGE_POOL_SKU_STANDARD_LRS,
+    CONST_STORAGE_POOL_SKU_STANDARDSSD_LRS,
+    CONST_STORAGE_POOL_SKU_ULTRASSD_LRS,
+    CONST_STORAGE_POOL_SKU_PREMIUM_ZRS,
+    CONST_STORAGE_POOL_SKU_PREMIUMV2_ZRS,
+    CONST_STORAGE_POOL_SKU_STANDARDSSD_ZRS,
+]
+
+storage_pool_options = [
+    CONST_STORAGE_POOL_OPTION_NVME,
+    CONST_STORAGE_POOL_OPTION_TEMP,
+]
+
 
 def load_arguments(self, _):
 
@@ -456,6 +493,16 @@ def load_arguments(self, _):
         c.argument('grafana_resource_id', validator=validate_grafanaresourceid)
         c.argument('enable_windows_recording_rules', action='store_true')
         c.argument('enable_cost_analysis', is_preview=True, action='store_true')
+        # azure container storage
+        c.argument('enable_azure_container_storage', action='store_true',
+                   help='Flag to enable azure container storage')
+        c.argument('storage_pool_type', arg_type=get_enum_type(storage_pool_types),
+                   help='set storage pool type for azure container storage')
+        c.argument('storage_pool_size', type=str, help='set storage pool size for azure container storage')
+        c.argument('storage_pool_sku', arg_type=get_enum_type(storage_pool_skus),
+                   help='set azure disk type storage pool sku for azure container storage')
+        c.argument('storage_pool_option', arg_type=get_enum_type(storage_pool_options),
+                   help='set ephemeral disk storage pool option for azure container storage')
 
     with self.argument_context('aks update') as c:
         # managed cluster paramerters
@@ -584,6 +631,20 @@ def load_arguments(self, _):
         c.argument('enable_network_observability', action='store_true', is_preview=True, help="enable network observability for cluster")
         c.argument('enable_cost_analysis', is_preview=True, action='store_true')
         c.argument('disable_cost_analysis', is_preview=True, action='store_true')
+        # azure container storage
+        c.argument('enable_azure_container_storage', action='store_true',
+                   help='Flag to enable azure container storage')
+        c.argument('disable_azure_container_storage', action='store_true',
+                   help='Flag to disable azure container storage')
+        c.argument('storage_pool_type', arg_type=get_enum_type(storage_pool_types),
+                   help='set storage pool type for azure container storage')
+        c.argument('storage_pool_size', type=str, help='set storage pool size for azure container storage')
+        c.argument('storage_pool_sku', arg_type=get_enum_type(storage_pool_skus),
+                   help='set azure disk type storage pool sku for azure container storage')
+        c.argument('storage_pool_option', arg_type=get_enum_type(storage_pool_options),
+                   help='set ephemeral disk storage pool option for azure container storage')
+        c.argument('azure_container_storage_nodepools', default='nodepool1',
+                   help='define the comma separated nodepool list to install azure container storage')
 
     with self.argument_context('aks upgrade') as c:
         c.argument('kubernetes_version', completer=get_k8s_upgrades_completion_list)

src/aks-preview/azext_aks_preview/azurecontainerstorage/_consts.py

@@ -0,0 +1,27 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+CONST_STORAGE_POOL_TYPE_AZURE_DISK = "azureDisk"
+CONST_STORAGE_POOL_TYPE_EPHEMERAL_DISK = "ephemeralDisk"
+CONST_STORAGE_POOL_TYPE_ELASTIC_SAN = "elasticSan"
+CONST_STORAGE_POOL_SKU_PREMIUM_LRS = "Premium_LRS"
+CONST_STORAGE_POOL_SKU_STANDARD_LRS = "Standard_LRS"
+CONST_STORAGE_POOL_SKU_STANDARDSSD_LRS = "StandardSSD_LRS"
+CONST_STORAGE_POOL_SKU_ULTRASSD_LRS = "UltraSSD_LRS"
+CONST_STORAGE_POOL_SKU_PREMIUM_ZRS = "Premium_ZRS"
+CONST_STORAGE_POOL_SKU_PREMIUMV2_ZRS = "PremiumV2_LRS"
+CONST_STORAGE_POOL_SKU_STANDARDSSD_ZRS = "StandardSSD_ZRS"
+CONST_STORAGE_POOL_OPTION_NVME = "LsV2"
+CONST_STORAGE_POOL_OPTION_TEMP = "temp"
+CONST_STORAGE_POOL_NAME_PREFIX = "mypool-"
+CONST_STORAGE_POOL_DEFAULT_SIZE = "512Gi"
+CONST_EXT_INSTALLATION_NAME = "azurecontainerstorage"
+CONST_ACSTOR_K8S_EXTENSION_NAME = "microsoft.azstor"
+
+CONST_K8S_EXTENSION_NAME = "k8s-extension"
+CONST_K8S_EXTENSION_CLIENT_FACTORY_MOD_NAME = "azext_k8s_extension._client_factory"
+CONST_K8S_EXTENSION_CUSTOM_MOD_NAME = "azext_k8s_extension.custom"
+
+CONST_STORAGE_POOL_RANDOM_LENGTH = 7

src/aks-preview/azext_aks_preview/azurecontainerstorage/_validators.py

@@ -0,0 +1,123 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azext_aks_preview.azurecontainerstorage._consts import (
+    CONST_STORAGE_POOL_TYPE_AZURE_DISK,
+    CONST_STORAGE_POOL_TYPE_EPHEMERAL_DISK,
+)
+
+from azure.cli.core.azclierror import (
+    ArgumentUsageError,
+    InvalidArgumentValueError,
+    MutuallyExclusiveArgumentError,
+)
+
+import re
+
+
+def validate_azure_container_storage_params(
+    enable_azure_container_storage,
+    disable_azure_container_storage,
+    storage_pool_name,
+    storage_pool_type,
+    storage_pool_sku,
+    storage_pool_option,
+    storage_pool_size,
+):
+    if enable_azure_container_storage and disable_azure_container_storage:
+        raise MutuallyExclusiveArgumentError(
+            'Conflicting flags. Cannot set --enable-azure-container-storage '
+            'and --disable-azure-container-storage together.'
+        )
+
+    if disable_azure_container_storage:
+        _validate_disable_azure_container_storage_params(
+            storage_pool_name,
+            storage_pool_type,
+            storage_pool_sku,
+            storage_pool_option,
+            storage_pool_size,
+        )
+
+    elif enable_azure_container_storage:
+        _validate_enable_azure_container_storage_params(
+            storage_pool_name,
+            storage_pool_type,
+            storage_pool_sku,
+            storage_pool_option,
+            storage_pool_size,
+        )
+
+
+def _validate_disable_azure_container_storage_params(
+    storage_pool_name,
+    storage_pool_type,
+    storage_pool_sku,
+    storage_pool_option,
+    storage_pool_size,
+):
+    if storage_pool_name is not None:
+        raise MutuallyExclusiveArgumentError(
+            'Conflicting flags. Cannot define --storage-pool-name value '
+            'when --disable-azure-container-storage is set.'
+        )
+
+    if storage_pool_type is not None:
+        raise MutuallyExclusiveArgumentError(
+            'Conflicting flags. Cannot define --storage-pool-type value '
+            'when --disable-azure-container-storage is set.'
+        )
+
+    if storage_pool_sku is not None:
+        raise MutuallyExclusiveArgumentError(
+            'Conflicting flags. Cannot define --storage-pool-sku value '
+            'when --disable-azure-container-storage is set.'
+        )
+
+    if storage_pool_size is not None:
+        raise MutuallyExclusiveArgumentError(
+            'Conflicting flags. Cannot define --storage-pool-size value '
+            'when --disable-azure-container-storage is set.'
+        )
+
+    if storage_pool_option is not None:
+        raise MutuallyExclusiveArgumentError(
+            'Conflicting flags. Cannot define --storage-pool-option value '
+            'when --disable-azure-container-storage is set.'
+        )
+
+
+def _validate_enable_azure_container_storage_params(
+    storage_pool_name,
+    storage_pool_type,
+    storage_pool_sku,
+    storage_pool_option,
+    storage_pool_size,
+):
+    if storage_pool_name is not None:
+        pattern = r'[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*'
+        is_pool_name_valid = re.fullmatch(pattern, storage_pool_name)
+        if not is_pool_name_valid:
+            raise InvalidArgumentValueError(
+                "Invalid --storage-pool-name values. "
+                "Accepted values are lowercase alphanumeric characters, "
+                "'-' or '.', and must start and end with an alphanumeric character.")
+
+    if storage_pool_type != CONST_STORAGE_POOL_TYPE_AZURE_DISK and \
+       storage_pool_sku is not None:
+        raise ArgumentUsageError('Cannot set --storage-pool-sku when --storage-pool-type is not azureDisk')
+
+    if storage_pool_type != CONST_STORAGE_POOL_TYPE_EPHEMERAL_DISK and \
+       storage_pool_option is not None:
+        raise ArgumentUsageError('Cannot set --storage-pool-option when --storage-pool-type is not ephemeralDisk')
+
+    if storage_pool_size is not None:
+        pattern = r'^\d+(?:Gi|Ti)$'
+        match = re.match(pattern, storage_pool_size)
+        if match is None:
+            raise ArgumentUsageError(
+                'Value for --storage-pool-size should be defined '
+                'with size followed by Gi or Ti. e.g. 512Gi or 2Ti'
+            )