Container Registry:Load resources of a container image on demand

Usage limits

• If your container runtime is Containerd, you can use custom domain names for repositories of accelerated images. You cannot use custom domain names for repositories of docker accelerated images. For more information, see Use a custom domain name to access a Container Registry Enterprise Edition instance.

• Multi-arch images cannot be converted to accelerated images.

Region limits

The on-demand image loading feature is not supported in regions of Alibaba Finance Cloud and Alibaba Gov Cloud.

Enable image acceleration

1. Log on to the Container Registry console.

2. In the top navigation bar, select a region.

3. In the left-side navigation pane, click Instances.

4. On the Instances page, click the Enterprise Edition instance that you want to manage.

5. In the left-side navigation pane of the management page of the Container Registry Enterprise Edition instance, choose Repository > Repositories.

6. On the Repositories page, find the repository for which you want to enable image acceleration. Click the name of the repository or click Manage in the Actions column.

7. On the page that appears, click Edit in the upper-left corner.

8. In the Modify Settings dialog box, turn on Enable image acceleration and click Confirm.

Install the aliyun-acr-acceleration-suite component

To start a container by using an accelerated image, you must install the aliyun-acr-acceleration-suite component on the worker nodes in the ACK cluster.

1. Attach the image acceleration label to nodes.

   When you create worker nodes, you can attach the alibabacloud.com/image-accelerate-enabled: true label to the nodes to enable image acceleration when the nodes are initialized. After the image acceleration label is attached, the aliyun-acr-acceleration-suite component is automatically installed when the nodes are initialized.

   Note

   • Accelerated containers must run on accelerated nodes. Accelerated nodes support both common containers and accelerated containers.

   • If you attach the label to existing worker nodes, image acceleration does not take effect.

   • If you attach the label to the virtual-kubelet virtual node, image acceleration immediately takes effect.

   • Attach the image acceleration label when you create the cluster.

     You can set the Label parameter to alibabacloud.com/image-accelerate-enabled: true when you create the cluster. For more information, see Create an ACK managed cluster.

   • Attach an image acceleration label to the node when you scale out a node.

     You can set the Node Label parameter to alibabacloud.com/image-accelerate-enabled: true when you scale out nodes. This way, newly scaled out nodes in the node pool are attached with the alibabacloud.com/image-accelerate-enabled: true label. For more information, see Create a node pool.

     Note

     You can create a separate node pool to manage the nodes that support accelerated images.

   • Attach the image acceleration label when existing nodes are added.

     You can set the Label parameter to alibabacloud.com/image-accelerate-enabled: true when you add existing nodes. For more information, see Add existing ECS instances to an ACK cluster.

2. Install the aliyun-acr-acceleration-suite component.

   1. Log on to the ACK console.

   2. In the left-side navigation pane of the ACK console, click Clusters.

   3. On the Clusters page, click the name of the cluster that you want to manage and choose Operations > Add-ons in the left-side navigation pane.

   4. In the Others section of the Add-ons page, find aliyun-acr-acceleration-suite and click Install.

   5. In the Install aliyun-acr-acceleration-suite message, click OK.

      • In the left-side navigation pane of the Cluster Management page, choose Workloads > DaemonSets. On the DaemonSets page, view the installation details of the daemons of the component.

      • In the left-side navigation pane of the Cluster Management page, choose Workloads > Deployments. On the Deployments page, view the installation details of the deployments of the component.

      If all pods of the component are started, the installation of the component is complete.

Uninstall the aliyun-acr-acceleration-suite component

1. Log on to the ACK console.

2. On the Clusters page, find the cluster that you want to manage and click the name of the cluster or click Details in the Actions column. The details page of the cluster appears.

3. In the left-side navigation pane of the cluster management page, choose Operations > Add-ons.

4. In the Others section of the Add-ons page, find aliyun-acr-acceleration-suite and click Uninstall.

5. In the Uninstall aliyun-acr-acceleration-suite message, click OK.

Deploy an accelerated image

1. Configure access to the repository where the accelerated image resides.

   • Configure access to the repository by using the aliyun-acr-credential-helper component that allows you to access an image repository without using secrets.

     • If the aliyun-acr-credential-helper component has been configured for the ACK cluster and the specified information about the Container Registry Enterprise Edition is correct, you can skip this step.

     • If the aliyun-acr-credential-helper component has not been configured for the ACK cluster, you can configure the component for the cluster. For more information, see Use the aliyun-acr-credential-helper component to pull images without using a secret.

   • Create a secret on the command line.

     Warning

     Make sure that the principle of least privilege is followed when you configure the secret that is used to pull images and only the permissions that are required to pull the business images for the current cluster are granted. For more information, see Attach a custom policy to a RAM user.

     Run the following command to create a secret whose type is kubernetes.io/dockerconfigjson and whose name starts with acr-credential-:

     kubectl create secret docker-registry acr-credential-test --docker-server=RegistryVpcDomain --docker-username=UserName --docker-password=Password

2. Attach the image acceleration label.

   You can attach the image acceleration label to workloads such as pods and Deployments. You can also attach an image acceleration label to a namespace of the ACK cluster or ACK Serverless cluster. All workloads in the namespace that meet acceleration conditions can load resources of a container image on demand. This way, you do not need to edit the YAML file for each workload. You can use the following methods to attach the image acceleration label to a specific workload or all workloads in a namespace:

   Note

   The name of the label is k8s.aliyun.com/image-accelerate-mode and the value of the label is on-demand.

   • Attach the image acceleration label to a workload.

     The following examples show how to attach the image acceleration label to pods. Run the following command to attach the image acceleration label to the pods that are managed by a Deployment:

     kubectl edit deployment <Name of the Deployment> -n  <Namespace in which the Deployment resides> 

     Add the k8s.aliyun.com/image-accelerate-mode: on-demand label to the YAML file of the Deployment.

     apiVersion: apps/v1
     kind: Deployment
     metadata:
       name: nginx-deployment
       labels:
         app: nginx
     spec:
       replicas: 1
       selector:
         matchLabels:
           app: nginx
       template:
         metadata:
           labels:
             app: nginx
             # enable on-demand mode
             k8s.aliyun.com/image-accelerate-mode: on-demand
         spec:
           containers:
            # your ACR instacne image
            - image: test-registry-vpc.cn-hangzhou.cr.aliyuncs.com/test/nginx:latest
              name: test
              command: ["sleep", "3600"]

   • Attach the image acceleration label to a namespace.

     • Attach the image acceleration label by using the console.

       1. Log on to the ACK console.

       2. In the left-side navigation pane of the ACK console, click Clusters.

       3. On the Clusters page, find the cluster to whose namespace you want to attach the image acceleration label and click the name of the cluster or click Details in the Actions column corresponding to the cluster.

       4. In the left-side navigation pane of the details page, click Namespaces and Quotas.

       5. On the Namespace page, find the namespace that you want to configure and click Edit in the Actions column.

       6. In the Label section of the Edit Namespace dialog box, set Variable Key to k8s.aliyun.com/image-accelerate-mode and Variable Value to on-demand, and click OK.

     • Attach the image acceleration label on the command line.

       kubectl label namespaces <YOUR-NAMESPACE> k8s.aliyun.com/image-accelerate-mode=on-demand

   Assume that an image is converted to an accelerated image after you configure the image acceleration label. When you create or update a pod in the namespace, the acceleration component automatically replaces the address of the original image of the pod with the address of the accelerated image. The acceleration component adds nodeSelector and schedules the pod to the accelerated nodes.