Skip to content

Latest commit

 

History

History
115 lines (84 loc) · 7.06 KB

quickstart-connected-registry-cli.md

File metadata and controls

115 lines (84 loc) · 7.06 KB
title description ms.topic ms.date ms.author author ms.custom ms.devlang
Quickstart - Create connected registry using the CLI
Use Azure CLI commands to create a connected Azure container registry resource that can synchronize images and other artifacts with the cloud registry.
quickstart
10/21/2021
memladen
toddysm
ignite-fall-2021, mode-api, devx-track-azurecli
azurecli

Quickstart: Create a connected registry using the Azure CLI

In this quickstart, you use the Azure CLI to create a connected registry resource in Azure. The connected registry feature of Azure Container Registry allows you to deploy a registry remotely or on your premises and synchronize images and other artifacts with the cloud registry.

Here you create two connected registry resources for a cloud registry: one connected registry allows read and write (artifact pull and push) functionality and one allows read-only functionality.

After creating a connected registry, you can follow other guides to deploy and use it on your on-premises or remote infrastructure.

[!INCLUDE Prepare Azure CLI environment]

  • Azure Container registry - If you don't already have a container registry, create one (Premium tier required) in a region that supports connected registries.

Enable the dedicated data endpoint for the cloud registry

Enable the dedicated data endpoint for the Azure container registry in the cloud by using the az acr update command. This step is needed for a connected registry to communicate with the cloud registry.

# Set the REGISTRY_NAME environment variable to identify the existing cloud registry
REGISTRY_NAME=<container-registry-name>

az acr update --name $REGISTRY_NAME \
  --data-endpoint-enabled

[!INCLUDE container-registry-connected-import-images]

Create a connected registry resource for read and write functionality

Create a connected registry using the az acr connected-registry create command. The connected registry name must start with a letter and contain only alphanumeric characters. It must be 5 to 40 characters long and unique in the hierarchy for this Azure container registry.

# Set the CONNECTED_REGISTRY_RW environment variable to provide a name for the connected registry with read/write functionality
CONNECTED_REGISTRY_RW=<connnected-registry-name>

az acr connected-registry create --registry $REGISTRY_NAME \
  --name $CONNECTED_REGISTRY_RW \
  --repository "hello-world" "acr/connected-registry" "azureiotedge-agent" "azureiotedge-hub" "azureiotedge-api-proxy"

This command creates a connected registry resource whose name is the value of $CONNECTED_REGISTRY_RW and links it to the cloud registry whose name is the value of $REGISTRY_NAME. In later quickstart guides, you learn about options to deploy the connected registry.

  • The specified repositories will be synchronized between the cloud registry and the connected registry once it is deployed.

  • Because no --mode option is specified for the connected registry, it is created in the default ReadWrite mode.

  • Because there is no synchronization schedule defined for this connected registry, the repositories will be synchronized between the cloud registry and the connected registry without interruptions.

    [!IMPORTANT] To support nested scenarios where lower layers have no Internet access, you must always allow synchronization of the acr/connected-registry repository. This repository contains the image for the connected registry runtime.

Create a connected registry resource for read-only functionality

You can also use the az acr connected-registry create command to create a connected registry with read-only functionality.

# Set the CONNECTED_REGISTRY_READ environment variable to provide a name for the connected registry with read-only functionality
CONNECTED_REGISTRY_RO=<connnected-registry-name>
az acr connected-registry create --registry $REGISTRY_NAME \
  --parent $CONNECTED_REGISTRY_RW \
  --name $CONNECTED_REGISTRY_RO \
  --repository "hello-world" "acr/connected-registry" "azureiotedge-agent" "azureiotedge-hub" "azureiotedge-api-proxy" \
  --mode ReadOnly

This command creates a connected registry resource whose name is the value of $CONNECTED_REGISTRY_RO and links it to the cloud registry named with the value of $REGISTRY_NAME.

  • The specified repositories will be synchronized between the parent registry named with the value of $CONNECTED_REGISTRY_RW and the connected registry once deployed.
  • This resource is created in the ReadOnly mode, which enables read-only (artifact pull) functionality once deployed.
  • Because there is no synchronization schedule defined for this connected registry, the repositories will be synchronized between the parent registry and the connected registry without interruptions.

Verify that the resources are created

You can use the connected registry az acr connected-registry list command to verify that the resources are created.

az acr connected-registry list \
  --registry $REGISTRY_NAME \
  --output table

You should see a response as follows. Because the connected registries are not yet deployed, the connection state of "Offline" indicates that they are currently disconnected from the cloud.

NAME                 MODE        CONNECTION STATE    PARENT               LOGIN SERVER    LAST SYNC (UTC)
-------------------  --------    ------------------  -------------------  --------------  -----------------
myconnectedregrw    ReadWrite    Offline
myconnectedregro    ReadOnly     Offline             myconnectedregrw

Next steps

In this quickstart, you used the Azure CLI to create two connected registry resources in Azure. Those new connected registry resources are tied to your cloud registry and allow synchronization of artifacts with the cloud registry.

Continue to the connected registry deployment guides to learn how to deploy and use a connected registry on your IoT Edge infrastructure.

[!div class="nextstepaction"] Quickstart: Deploy connected registry on IoT Edge