Merge pull request #261296 from tejaswikolli-web/artifactstreaming

Artifact streaming

Author: Court72

.openpublishing.redirection.json

@@ -1001,6 +1001,26 @@
             "redirect_url": "/azure/container-registry/container-registry-configure-conditional-access.md",
             "redirect_document_id": false 
         },
+        {
+            "source_path": "articles/container-registry/tutorial-artifact-streaming.md",
+            "redirect_url": "/azure/container-registry/container-registry-artifact-streaming",
+            "redirect_document_id": false
+        },
+        {
+            "source_path": "articles/container-registry/tutorial-artifact-streaming-cli.md",
+            "redirect_url": "/azure/container-registry/container-registry-artifact-streaming",
+            "redirect_document_id": false
+        },
+        {
+            "source_path": "articles/container-registry/tutorial-artifact-streaming-portal.md",
+            "redirect_url": "/azure/container-registry/container-registry-artifact-streaming",
+            "redirect_document_id": false
+        },
+        {
+            "source_path": "articles/container-registry/tutorial-artifact-streaming-troubleshoot.md",
+            "redirect_url": "/azure/container-registry/troubleshoot-artifact-streaming",
+            "redirect_document_id": false
+        },
         {
             "source_path": "articles/site-recovery/vmware-physical-secondary-disaster-recovery.md",
             "redirect_url": "/azure/site-recovery/vmware-physical-secondary-architecture",

articles/container-registry/TOC.yml

@@ -64,16 +64,6 @@
         href: tutorial-enable-artifact-cache-auth-cli.md
       - name: Troubleshoot 
         href: tutorial-troubleshoot-artifact-cache.md
-    - name: Artifact Streaming
-      items:
-      - name: Artifact Streaming - Overview
-        href: tutorial-artifact-streaming.md
-      - name: Enable Artifact Streaming - Azure portal
-        href: tutorial-artifact-streaming-portal.md
-      - name: Enable Artifact Streaming - Azure CLI
-        href: tutorial-artifact-streaming-cli.md
-      - name: Troubleshoot
-        href: tutorial-artifact-streaming-troubleshoot.md
   - name: Samples
     items:
     - name: Azure Resource Graph queries
@@ -98,6 +88,8 @@
       href: container-registry-image-formats.md
     - name: Tag and version images
       href: container-registry-image-tag-version.md
+    - name: Artifact streaming
+      href: container-registry-artifact-streaming.md
     - name: Geo-replication
       href: container-registry-geo-replication.md
     - name: Zone redundancy
@@ -110,6 +102,7 @@
       displayName: multi-architecture
     - name: Manage public images
       href: buffer-gate-public-content.md
+   
   - name: How-to guides
     expanded: false
     items:
@@ -372,6 +365,8 @@
     href: container-registry-faq.yml
   - name: API Deprecation
     href: container-registry-api-deprecation.md
+  - name: Troubleshoot Artifact streaming
+    href: troubleshoot-artifact-streaming.md
 - name: Resources
   expanded: false
   items:

articles/container-registry/container-registry-artifact-streaming.md

@@ -0,0 +1,203 @@
+---
+title: "Artifact streaming in Azure Container Registry (Preview)"
+description: "Artifact streaming is a feature in Azure Container Registry to enhance and supercharge managing, scaling, and deploying artifacts through containerized platforms."
+author: tejaswikolli-web
+ms.author: tejaswikolli
+ms.service: container-registry
+ms.topic: conceptual #Don't change
+ms.date: 12/14/2023
+
+#customer intent: As a developer, I want artifact streaming capabilities so that I can efficiently deliver and serve containerized applications to end-users in real-time.
+---
+
+# Artifact streaming in Azure Container Registry (Preview)
+
+Artifact streaming is a feature in Azure Container Registry that allows you to store container images within a single registry, manage, and stream the container images to Azure Kubernetes Service (AKS) clusters in multiple regions. This feature is designed to accelerate containerized workloads for Azure customers using AKS. With artifact streaming, you can easily scale workloads without having to wait for slow pull times for your node.
+
+## Use cases
+
+Here are few scenarios to use artifact streaming:
+
+**Deploying containerized applications to multiple regions**: With artifact streaming, you can store container images within a single registry and manage and stream container images to AKS clusters in multiple regions. artifact streaming deploys container applications to multiple regions without consuming time and resources.
+
+**Reducing image pull latency**: Artifact streaming can reduce time to pod readiness by over 15%, depending on the size of the image, and it works best for images < 30GB. This feature reduces image pull latency and fast container startup, which is beneficial for software developers and system architects.
+
+**Effective scaling of containerized applications**:  Artifact streaming provides the opportunity to design, build, and deploy containerized applications at a high scale.
+
+## Artifact streaming aspects
+
+Here are some brief aspects of artifact streaming:
+
+* Customers with new and existing registries can start artifact streaming for specific repositories or tags.
+
+* Once artifact streaming is started, the original and the streaming artifact will be stored in the customer’s ACR.
+
+* If the user decides to turn off artifact streaming for repositories or artifacts, the streaming and the original artifact will still be present.
+
+* If a customer deletes a repository or artifact with artifact streaming and Soft Delete enabled, then both the original and artifact streaming versions will be deleted. However, only the original version will be available on the soft delete blade.
+
+## Availability and pricing information
+
+Artifact streaming is only available in the **Premium** SKU [service tiers](container-registry-skus.md). Please note that artifact streaming may increase the overall registry storage consumption and customers may be subjected to additional storage charges as outlined in our [pricing](https://azure.microsoft.com/pricing/details/container-registry/) if the consumption exceeds the included 500 GiB Premium SKU threshold.
+
+## Preview limitations
+
+Artifact streaming is currently in preview. The following limitations apply:
+
+* Only images with Linux AMD64 architecture are supported in the preview release.
+* The preview release doesn't support Windows-based container images, and ARM64 images.
+* The preview release partially support multi-architecture images, only the AMD64 architecture is supported.
+* For creating Ubuntu based node pool in AKS, choose Ubuntu version 20.04 or higher.
+* For Kubernetes, use Kubernetes version 1.26 or higher or Kubernetes version > 1.25. 
+* Only premium SKU registries support generating streaming artifacts in the preview release. The non-premium SKU registries do not offer this functionality during the preview.
+* The CMK (Customer-Managed Keys) registries are NOT supported in the preview release.
+* Kubernetes regcred is currently NOT supported.
+
+## Prerequisites
+
+* You can use the [Azure Cloud Shell][Azure Cloud Shell] or a local installation of the Azure CLI to run the command examples in this article. If you'd like to use it locally, version 2.54.0 or later is required. Run `az --version` to find the version. If you need to install or upgrade, see [Install Azure CLI][Install Azure CLI].
+
+* Sign in to the [Azure portal](https://ms.portal.azure.com/). 
+
+## Start artifact streaming 
+
+Start artifact streaming with a series with Azure CLI commands and Azure portal for pushing, importing, and generating streaming artifacts for container images in an Azure Container Registry (ACR). These instructions outline the process for creating a *Premium* [SKU](container-registry-skus.md) ACR, importing an image, generating a streaming artifact, and managing the artifact streaming operation. Make sure to replace the placeholders with your actual values where necessary.
+
+### Push/Import the image and generate the streaming artifact  - Azure CLI
+
+Artifact streaming is available in the **Premium** container registry service tier. To start Artifact streaming, update a registry using the Azure CLI (version 2.54.0 or above). To install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
+
+Start artifact streaming, by following these general steps:
+
+>[!NOTE]
+> If you already have a premium container registry, you can skip this step. If the user is on Basic of Standard SKUs, the following commands will fail. 
+> The code is written in Azure CLI and can be executed in an interactive mode. 
+> Please note that the placeholders should be replaced with actual values before executing the command.
+
+1. Create a new Azure Container Registry (ACR) using the premium SKU through:
+
+    For example, run the [az group create][az-group-create] command to create an Azure Resource Group with name `my-streaming-test` in the West US region and then run the [az acr create][az-acr-create] command to create a premium Azure Container Registry with name `mystreamingtest` in that resource group.
+
+    ```azurecli-interactive
+    az group create -n my-streaming-test -l westus
+    az acr create -n mystreamingtest -g my-streaming-test -l westus --sku premium
+    ```
+
+2. Push or import an image to the registry through:
+
+    For example, run the [az configure] command to configure the default ACR and [az acr import][az-acr-import] command to import a Jupyter Notebook image from Docker Hub into the `mystreamingtest` ACR.
+
+    ```azurecli-interactive
+    az configure --defaults acr="mystreamingtest"
+    az acr import -source docker.io/jupyter/all-spark-notebook:latest -t jupyter/all-spark-notebook:latest
+    ```
+
+3. Create an artifact streaming from the Image
+    
+    Initiates the creation of a streaming artifact from the specified image.
+    
+    For example, run the [az acr artifact-streaming create][az-acr-artifact-streaming-create] commands to create a streaming artifact from the `jupyter/all-spark-notebook:latest` image in the `mystreamingtest` ACR.
+
+    ```azurecli-interactive
+    az acr artifact-streaming create --image jupyter/all-spark-notebook:latest
+    ```
+
+>[!NOTE]
+> An operation ID is generated during the process for future reference to verify the status of the operation.
+
+4. Verify the generated artifact streaming in the Azure CLI.
+
+    For example, run the [az acr manifest list-referrers][az-acr-manifest-list-referrers] command to list the streaming artifacts for the `jupyter/all-spark-notebook:latest` image in the `mystreamingtest` ACR.
+    
+    ```azurecli-interactive
+    az acr manifest list-referrers -n jupyter/all-spark-notebook:latest
+    ```
+
+5. Cancel the artifact streaming creation (if needed)
+
+    Cancel the streaming artifact creation if the conversion is not finished yet. It will stop the operation.
+    
+    For example, run the [az acr artifact-streaming operation cancel][az-acr-artifact-streaming-operation-cancel] command to cancel the conversion operation for the `jupyter/all-spark-notebook:latest` image in the `mystreamingtest` ACR.
+
+    ```azurecli-interactive
+    az acr artifact-streaming operation cancel --repository jupyter/all-spark-notebook --id c015067a-7463-4a5a-9168-3b17dbe42ca3
+    ```
+
+6. Start auto-conversion on the repository
+
+    Start auto-conversion in the repository for newly pushed or imported images. When started, new images pushed into that repository will trigger the generation of streaming artifacts.
+
+    >[!NOTE]
+    > Auto-conversion does not apply to existing images. Existing images can be manually converted.
+    
+    For example, run the [az acr artifact-streaming update][az-acr-artifact-streaming-update] command to start auto-conversion for the `jupyter/all-spark-notebook` repository in the `mystreamingtest` ACR.
+
+    ```azurecli-interactive
+    az acr artifact-streaming update --repository jupyter/all-spark-notebook --enable-streaming true
+    ```
+
+7. Verify the streaming conversion progress, after pushing a new image `jupyter/all-spark-notebook:newtag` to the above repository.
+
+    For example, run the [az acr artifact-streaming operation show][az-acr-artifact-streaming-operation-show] command to check the status of the conversion operation for the `jupyter/all-spark-notebook:newtag` image in the `mystreamingtest` ACR.
+
+    ```azurecli-interactive
+    az acr artifact-streaming operation show --image jupyter/all-spark-notebook:newtag
+    ```
+
+>[!NOTE]
+> Artifact streaming can work across regions, regardless of whether geo-replication is started or not.
+> Artifact streaming can work through a private endpoint and attach to it.
+
+### Push/Import the image and generate the streaming artifact - Azure portal
+
+Artifact streaming is available in the *premium* [SKU](container-registry-skus.md) Azure Container Registry. To start artifact streaming, update a registry using the Azure portal.
+
+Follow the steps to create artifact streaming in the [Azure portal](https://portal.azure.com). 
+
+1. Navigate to your Azure Container Registry. 
+
+2. In the side **Menu**, under the **Services**, select **Repositories**.
+
+3. Select the latest imported image.
+
+4. Convert the image and create artifact streaming in Azure portal.
+
+   > [!div class="mx-imgBorder"]
+   > [![A screenshot of Azure portal with the create streaming artifact button highlighted.](./media/container-registry-artifact-streaming/01-create-artifact-streaming-inline.png)](./media/container-registry-artifact-streaming/01-create-artifact-streaming-expanded.png#lightbox)
+
+
+5. Check the streaming artifact generated from the image in Referrers tab.     
+   
+   > [!div class="mx-imgBorder"]
+   > [![A screenshot of Azure portal with the streaming artifact highlighted.](./media/container-registry-artifact-streaming/02-artifact-streaming-generated-inline.png)](./media/container-registry-artifact-streaming/02-artifact-streaming-generated-expanded.png#lightbox)
+
+6. You can also delete the artifact streaming from the repository blade. 
+
+   > [!div class="mx-imgBorder"]
+   > [![A screenshot of Azure portal with the delete artifact streaming button highlighted.](./media/container-registry-artifact-streaming/04-delete-artifact-streaming-inline.png)](./media/container-registry-artifact-streaming/04-delete-artifact-streaming-expanded.png#lightbox)
+
+7. You can also enable auto-conversion on the repository blade. Active means auto-conversion is enabled on the repository. Inactive means auto-conversion is disabled on the repository. 
+    
+   > [!div class="mx-imgBorder"]
+   > [![A screenshot of Azure portal with the start artifact streaming button highlighted.](./media/container-registry-artifact-streaming/03-start-artifact-streaming-inline.png)](./media/container-registry-artifact-streaming/03-start-artifact-streaming-expanded.png#lightbox)
+
+> [!NOTE]
+> The state of artifact streaming in a repository (inactive or active) determines whether newly pushed compatible images will be automatically converted. By default, all repositories are in an inactive state for artifact streaming. This means that when new compatible images are pushed to the repository, artifact streaming will not be triggered, and the images will not be automatically converted. If you want to start automatic conversion of newly pushed images, you need to set the repository's artifact streaming to the active state. Once the repository is in the active state, any new compatible container images that are pushed to the repository will trigger artifact streaming. This will start the automatic conversion of those images.
+
+## Next steps
+
+> [!div class="nextstepaction"]
+> [Troubleshoot artifact streaming](troubleshoot-artifact-streaming.md)
+
+<!-- LINKS - External -->
+[Install Azure CLI]: /cli/azure/install-azure-cli
+[Azure Cloud Shell]: /azure/cloud-shell/quickstart
+[az-group-create]: /cli/azure/group#az-group-create
+[az-acr-import]: /cli/azure/acr#az-acr-import
+[az-acr-artifact-streaming-create]: /cli/azure/acr/artifact-streaming#az-acr-artifact-streaming-create
+[az-acr-manifest-list-referrers]: /cli/azure/acr/manifest#az-acr-manifest-list-referrers
+[az-acr-create]: /cli/azure/acr#az-acr-create
+[az-acr-artifact-streaming-operation-cancel]: /cli/azure/acr/artifact-streaming/operation#az-acr-artifact-streaming-operation-cancel
+[az-acr-artifact-streaming-operation-show]: /cli/azure/acr/artifact-streaming/operation#az-acr-artifact-streaming-operation-show
+[az-acr-artifact-streaming-update]: /cli/azure/acr/artifact-streaming#az-acr-artifact-streaming-update
+