First implementation of az aks prepared-image-specification

Author: Jim Minter

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
 +++++++
+
+21.0.0b5
++++++++
+* `az aks prepared-image-specification`: Add new command.
 * `az aks upgrade`: Fix `--node-image-only` to skip Machines mode agent pools, which do not support node image version upgrade.
 
 21.0.0b4

src/aks-preview/azext_aks_preview/__init__.py

@@ -9,7 +9,7 @@
 
 # pylint: disable=unused-import
 import azext_aks_preview._help
-from azext_aks_preview._client_factory import CUSTOM_MGMT_AKS_PREVIEW
+from azext_aks_preview._client_factory import CUSTOM_MGMT_AKS_PREVIEW, CUSTOM_MGMT_AKS_PIS_PREVIEW
 
 
 def register_aks_preview_resource_type():
@@ -19,6 +19,12 @@ def register_aks_preview_resource_type():
         None,
     )
 
+    register_resource_type(
+        "latest",
+        CUSTOM_MGMT_AKS_PIS_PREVIEW,
+        None,
+    )
+
 
 class ContainerServiceCommandsLoader(AzCommandsLoader):
 

src/aks-preview/azext_aks_preview/_client_factory.py

@@ -13,6 +13,9 @@
 CUSTOM_MGMT_AKS_PREVIEW = CustomResourceType('azext_aks_preview.vendored_sdks.azure_mgmt_preview_aks',
                                              'ContainerServiceClient')
 
+CUSTOM_MGMT_AKS_PIS_PREVIEW = CustomResourceType('azext_aks_preview.vendored_sdks.azure_mgmt_preview_aks_pis',
+                                                 'ContainerServiceClient')
+
 # Note: cf_xxx, as the client_factory option value of a command group at command declaration, it should ignore
 # parameters other than cli_ctx; get_xxx_client is used as the client of other services in the command implementation,
 # and usually accepts subscription_id as a parameter to reconfigure the subscription when sending the request
@@ -23,6 +26,10 @@ def get_container_service_client(cli_ctx, subscription_id=None):
     return get_mgmt_service_client(cli_ctx, CUSTOM_MGMT_AKS_PREVIEW, subscription_id=subscription_id)
 
 
+def get_container_service_pis_client(cli_ctx, subscription_id=None):
+    return get_mgmt_service_client(cli_ctx, CUSTOM_MGMT_AKS_PIS_PREVIEW, subscription_id=subscription_id)
+
+
 def cf_container_services(cli_ctx, *_):
     return get_container_service_client(cli_ctx).container_services
 
@@ -159,3 +166,7 @@ def cf_jwt_authenticators(cli_ctx, *_):
 
 def cf_vm_skus(cli_ctx, *_):
     return get_container_service_client(cli_ctx).vm_skus
+
+
+def cf_prepared_image_specifications(cli_ctx, *_, subscription_id=None):
+    return get_container_service_pis_client(cli_ctx, subscription_id=subscription_id).prepared_image_specifications

src/aks-preview/azext_aks_preview/_help.py

@@ -4708,3 +4708,62 @@
         - name: Show a specific JWT authenticator configuration
           text: az aks jwtauthenticator show -g MyResourceGroup --cluster-name MyCluster --name myjwt
 """
+
+helps['aks prepared-image-specification'] = """
+    type: group
+    short-summary: Commands to manage prepared image specifications.
+"""
+
+helps['aks prepared-image-specification create'] = """
+    type: command
+    short-summary: Create a new prepared image specification.
+    examples:
+        - name: Create a new prepared image specification specifying a container image.
+          text: az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --container-images myacr.azurecr.io/myimage:latest
+        - name: Create a new prepared image specification specifying a customization script.
+          text: az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --customization-scripts '[{"name":"myscript","script":"/bin/true","scriptType":"Bash","executionPoint":"NodeImageBuildTime"}]'
+        - name: Create a new prepared image specification specifying a managed identity.
+          text: az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --assign-identity /subscriptions/MySubscription/resourceGroups/AnotherResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity
+        - name: Create a new prepared image specification specifying tags.
+          text: az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --tags k1=v1 k2=v2
+"""
+
+helps['aks prepared-image-specification update'] = """
+    type: command
+    short-summary: Update a prepared image specification.
+"""
+
+helps['aks prepared-image-specification delete'] = """
+    type: command
+    short-summary: Delete a prepared image specification.
+"""
+
+helps['aks prepared-image-specification list'] = """
+    type: command
+    short-summary: List prepared image specifications.
+"""
+
+helps['aks prepared-image-specification show'] = """
+    type: command
+    short-summary: Show a prepared image specification.
+"""
+
+helps['aks prepared-image-specification version'] = """
+    type: group
+    short-summary: Commands to manage prepared image specification versions.
+"""
+
+helps['aks prepared-image-specification version delete'] = """
+    type: command
+    short-summary: Delete a prepared image specification version.
+"""
+
+helps['aks prepared-image-specification version list'] = """
+    type: command
+    short-summary: List prepared image specification versions.
+"""
+
+helps['aks prepared-image-specification version show'] = """
+    type: command
+    short-summary: Show a prepared image specification version.
+"""

src/aks-preview/azext_aks_preview/_params.py

@@ -33,6 +33,7 @@
     tags_type,
     zones_type,
 )
+from azure.cli.core.commands.validators import validate_file_or_dict
 from azext_aks_preview._validators import (
     validate_nat_gateway_managed_outbound_ipv6_count,
     validate_nat_gateway_v2_params,
@@ -251,6 +252,7 @@
     validate_drain_batch_size,
     validate_resource_group_parameter,
     validate_location_resource_group_cluster_parameters,
+    validate_prepared_image_specification_id,
 )
 from azext_aks_preview.azurecontainerstorage._consts import (
     CONST_ACSTOR_ALL,
@@ -1298,6 +1300,15 @@ def load_arguments(self, _):
             is_preview=True,
             help="Enable continuous control plane and addon monitor for the cluster.",
         )
+        # prepared image specification
+        c.argument(
+            'prepared_image_specification_id',
+            options_list=["--prepared-image-specification-id", "--pis-id"],
+            is_preview=True,
+            validator=validate_prepared_image_specification_id,
+            help='The resource ID of the prepared image specification to use for provisioning nodes in the default '
+                 'node pool.'
+        )
 
     with self.argument_context("aks update") as c:
         # managed cluster paramerters
@@ -2260,6 +2271,14 @@ def load_arguments(self, _):
                  'Example: \'[{"type":"Standard","vnetSubnetId":"/subscriptions/.../subnets/mysubnet"}]\'',
             is_preview=True,
         )
+        # prepared image specification
+        c.argument(
+            'prepared_image_specification_id',
+            options_list=["--prepared-image-specification-id", "--pis-id"],
+            is_preview=True,
+            validator=validate_prepared_image_specification_id,
+            help='The resource ID of the prepared image specification to use for provisioning nodes in the node pool.'
+        )
 
     with self.argument_context("aks nodepool update") as c:
         c.argument(
@@ -2384,6 +2403,14 @@ def load_arguments(self, _):
             is_preview=True,
             help="Specify the GPU Multi-Instance GPU (MIG) strategy. Allowed values: Single, Mixed.",
         )
+        # prepared image specification
+        c.argument(
+            'prepared_image_specification_id',
+            options_list=["--prepared-image-specification-id", "--pis-id"],
+            is_preview=True,
+            validator=validate_prepared_image_specification_id,
+            help='The resource ID of the prepared image specification to use for provisioning nodes in the node pool.'
+        )
 
     with self.argument_context("aks nodepool upgrade") as c:
         # upgrade strategy
@@ -3450,6 +3477,91 @@ def load_arguments(self, _):
             help="Show all VM SKU information including those not available for the current subscription.",
         )
 
+    with self.argument_context("aks prepared-image-specification create") as c:
+        c.argument(
+            "name",
+            options_list=["--name", "-n"],
+            required=True,
+            help="The prepared image specification name.",
+        )
+        c.argument(
+            "container_images",
+            nargs="+",
+            help="Container images.",
+        )
+        c.argument(
+            "customization_scripts",
+            type=validate_file_or_dict,
+            help="Customization scripts. Expected value: json-string/@json-file.",
+        )
+        c.argument(
+            "assign_identity",
+            validator=validate_assign_identity,
+            help="Specify an existing user assigned identity.",
+        )
+        c.argument(
+            "version",
+            required=True,
+            help="The prepared image specification version.",
+        )
+
+    with self.argument_context("aks prepared-image-specification update") as c:
+        c.argument(
+            "name",
+            options_list=["--name", "-n"],
+            required=True,
+            help="The prepared image specification name.",
+        )
+
+    with self.argument_context("aks prepared-image-specification delete") as c:
+        c.argument(
+            "name",
+            options_list=["--name", "-n"],
+            required=True,
+            help="The prepared image specification name.",
+        )
+
+    with self.argument_context("aks prepared-image-specification show") as c:
+        c.argument(
+            "name",
+            options_list=["--name", "-n"],
+            required=True,
+            help="The prepared image specification name.",
+        )
+
+    with self.argument_context("aks prepared-image-specification version delete") as c:
+        c.argument(
+            "pis_name",
+            required=True,
+            help="The prepared image specification name.",
+        )
+        c.argument(
+            "name",
+            options_list=["--name", "-n"],
+            required=True,
+            help="The version name.",
+        )
+
+    with self.argument_context("aks prepared-image-specification version list") as c:
+        c.argument(
+            "pis_name",
+            required=True,
+            help="The prepared image specification name.",
+        )
+
+    with self.argument_context("aks prepared-image-specification version show") as c:
+        c.argument(
+            "pis_name",
+            required=True,
+            help="The prepared image specification name.",
+        )
+        c.argument(
+            "name",
+            options_list=["--name", "-n"],
+            required=True,
+            help="The version name.",
+        )
+
 
 def _get_default_install_location(exe_name):
     system = platform.system()

src/aks-preview/azext_aks_preview/_validators.py

@@ -1230,3 +1230,20 @@ def validate_nat_gateway_v2_params(namespace):
                 "--nat-gateway-outbound-ip-prefixes are only "
                 "valid with --outbound-type managedNATGatewayV2."
             )
+
+
+def validate_prepared_image_specification_id(namespace):
+    if namespace.prepared_image_specification_id:
+        if not is_valid_resource_id(namespace.prepared_image_specification_id):
+            raise InvalidArgumentValueError(
+                "--prepared-image-specification-id is not a valid Azure resource ID."
+            )
+        parsed = parse_resource_id(namespace.prepared_image_specification_id)
+        resource_type = (parsed.get("type", "") + "/" + parsed.get("resource_type", "")).lower()
+        resource_namespace = parsed.get("namespace", "").lower()
+        if resource_namespace != "microsoft.containerservice" or \
+                resource_type != "preparedimagespecifications/versions":
+            raise InvalidArgumentValueError(
+                "--prepared-image-specification-id must be a resource ID of type "
+                "Microsoft.ContainerService/preparedImageSpecifications/versions."
+            )

src/aks-preview/azext_aks_preview/agentpool_decorator.py

@@ -905,6 +905,12 @@ def get_if_none_match(self) -> str:
         """
         return self.raw_param.get("if_none_match")
 
+    def get_prepared_image_specification_id(self) -> Union[str, None]:
+        """Obtain the value of prepared_image_specification_id.
+        :return: str or None
+        """
+        return self.raw_param.get('prepared_image_specification_id')
+
     def get_gateway_prefix_size(self) -> Union[int, None]:
         """Obtain the value of gateway_prefix_size.
         :return: int or None
@@ -1660,6 +1666,18 @@ def set_up_localdns_profile(self, agentpool: AgentPool) -> AgentPool:
         self._ensure_agentpool(agentpool)
         return self.context.build_localdns_profile(agentpool)
 
+    def set_up_prepared_image_specification(self, agentpool: AgentPool) -> AgentPool:
+        """Set up prepared image specification profile for the AgentPool object."""
+        self._ensure_agentpool(agentpool)
+
+        prepared_image_specification_id = self.context.get_prepared_image_specification_id()
+        if prepared_image_specification_id is not None:
+            agentpool.prepared_image_specification_profile = self.models.PreparedImageSpecificationProfile(  # pylint: disable=no-member
+                prepared_image_specification_id=prepared_image_specification_id,
+            )
+
+        return agentpool
+
     def construct_agentpool_profile_preview(self) -> AgentPool:
         """The overall controller used to construct the preview AgentPool profile.
 
@@ -1723,6 +1741,8 @@ def construct_agentpool_profile_preview(self) -> AgentPool:
         agentpool = self.set_up_upgrade_strategy(agentpool)
         # set up blue green upgrade settings
         agentpool = self.set_up_blue_green_upgrade_settings(agentpool)
+        # set up prepared image specification
+        agentpool = self.set_up_prepared_image_specification(agentpool)
         # DO NOT MOVE: keep this at the bottom, restore defaults
         agentpool = self._restore_defaults_in_agentpool(agentpool)
         return agentpool
@@ -2071,6 +2091,21 @@ def update_upgrade_strategy(self, agentpool: AgentPool) -> AgentPool:
 
         return agentpool
 
+    def update_prepared_image_specification(self, agentpool: AgentPool) -> AgentPool:
+        """Update prepared image specification profile for the AgentPool object."""
+        self._ensure_agentpool(agentpool)
+
+        prepared_image_specification_id = self.context.get_prepared_image_specification_id()
+        if prepared_image_specification_id is not None:
+            if prepared_image_specification_id == "":
+                prepared_image_specification_id = None
+
+            agentpool.prepared_image_specification_profile = self.models.PreparedImageSpecificationProfile(  # pylint: disable=no-member
+                prepared_image_specification_id=prepared_image_specification_id,
+            )
+
+        return agentpool
+
     def update_agentpool_profile_preview(self, agentpools: List[AgentPool] = None) -> AgentPool:
         """The overall controller used to update the preview AgentPool profile.
 
@@ -2139,6 +2174,9 @@ def update_agentpool_profile_preview(self, agentpools: List[AgentPool] = None) -
         # update crg id
         agentpool = self.update_crg(agentpool)
 
+        # update prepared image specification
+        agentpool = self.update_prepared_image_specification(agentpool)
+
         return agentpool
 
     def update_auto_scaler_properties(self, agentpool: AgentPool) -> AgentPool: