Merge pull request #542 from toddysm/toddysm-connected-registry

Updated documentation for connected registry
This commit is contained in:
Toddy Mladenov 2021-05-13 17:04:42 -07:00 коммит произвёл GitHub
Родитель 14cd1931d3 ffcb018d71
Коммит 26235268e9
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 18 добавлений и 44 удалений

Просмотреть файл

@ -31,7 +31,6 @@ The stamp name is one of the aliases returned by the above command. Currently, c
Here is a list of known limitations for the connected registry functionality in limited preview:
- Nested connected registry mode is still under development and requires additional testing. Currently nested registries are blocked and will be released in a few weeks.
- Number of tokens and scopemaps is limited to 20K for a single ACR. This indirectly limits the number of connected registries for an ACR registry because every connected registry needs a sync and client token.
- Number of repository permissions in a scope map is limited to 500.
- Number of clients for the connected registry is currently limited to 20.
@ -58,6 +57,7 @@ In limited preview, the connected registry targets IoT scenarios. Below are link
- [Using connected registry with Azure IoT Edge](./overview-connected-registry-and-iot-edge.md)
- [Quickstart: Create a connected registry using Azure Container Registry CLI commands](./quickstart-connected-registry-cli.md)
- [Quickstart: Deploy a connected registry to an IoT Edge device](./quickstart-deploy-connected-registry-iot-edge-cli.md)
- [Quickstart: Deploy a connected registry to an nested IoT Edge device](./quickstart-deploy-connected-quickstart-deploy-connected-registry-nested-iot-edge-cli.md)
- [Quickstart: Pull images from a connected registry](./quickstart-pull-images-from-connected-registry.md)
## Troubleshooting

Просмотреть файл

@ -56,7 +56,10 @@ This and subsequent quickstart guides use two repositories:
The easiest way to populate those repositories is to use the `az acr import` command as follows:
```azurecli
az acr import -n mycontainerregistry001 --source mcr.microsoft.com/acr/connected-registry:0.1.0
az acr import -n mycontainerregistry001 --source mcr.microsoft.com/acr/connected-registry:0.2.0
az acr import -n mycontainerregistry001 --source mcr.microsoft.com/azureiotedge-agent:1.2
az acr import -n mycontainerregistry001 --source mcr.microsoft.com/azureiotedge-hub:1.2
az acr import -n mycontainerregistry001 --source mcr.microsoft.com/azureiotedge-api-proxy:latest
az acr import -n mycontainerregistry001 --source mcr.microsoft.com/hello-world:latest
```
@ -67,7 +70,7 @@ Create a connected registry using the [az acr connected-registry create][az-acr-
```azurecli
az acr connected-registry create --registry mycontainerregistry001 \
--name myconnectedregistry \
--repository "hello-world" "acr/connected-registry"
--repository "hello-world" "acr/connected-registry" "azureiotedge-agent" "azureiotedge-hub" "azureiotedge-api-proxy"
```
The above command will create a connected registry resource in Azure and link it to the *mycontainerregistry001* cloud ACR. The *hello-world* and *acr/connected-registry* repositories will be synchronized between the cloud ACR and the registry on premises. Because no `--mode` option is specified for the connected registry, it will allow _pull_ and _push_ functionality by default. Because there is no synchronization schedule defined for this connected registry, both repositories will be synchronized between the cloud registry and the connected registry without interruptions.
@ -81,8 +84,9 @@ You can use the connected registry [az acr connected-registry create][az-acr-con
```azurecli
az acr connected-registry create --registry mycontainerregistry001 \
--parent myconnectedregistry \
--name myconnectedmirror \
--repository "hello-world" "acr/connected-registry" \
--repository "hello-world" "acr/connected-registry" "azureiotedge-agent" "azureiotedge-hub" "azureiotedge-api-proxy" \
--mode mirror
```

Просмотреть файл

@ -35,7 +35,7 @@ agent:
type: "docker"
env: {}
config:
image: "mcr.microsoft.com/azureiotedge-agent:1.2.0"
image: "mcr.microsoft.com/azureiotedge-agent:1.2"
auth: {}
```
@ -119,23 +119,12 @@ az acr connected-registry install renew-credentials \
--name myconnectedregistry \
```
This will return the configuration for the connected registry including the newly generated passwords.
This will return the connection string for the connected registry including the newly generated passwords.
```json
{
"ACR_PARENT_GATEWAY_ENDPOINT": "mycontainerregistry001.westus2.data.azurecr.io",
"ACR_PARENT_LOGIN_SERVER": "mycontainerregistry001.azurecr.io",
"ACR_PARENT_PROTOCOL": "https",
"ACR_REGISTRY_CERTIFICATE_VOLUME": "<myvolume>",
"ACR_REGISTRY_DATA_VOLUME": "<myvolume>",
"ACR_REGISTRY_LOGIN_SERVER": "<myloginservername>",
"ACR_REGISTRY_NAME": "myconnectedregistry",
"ACR_SYNC_TOKEN_NAME": "myconnectedregistry-sync-token",
"ACR_SYNC_TOKEN_PASSWORD": {
"password1": "s0meCoMPL3xP4$$W0rd001!@#",
"password2": "an0TH3rCoMPL3xP4ssW0rd002!"
},
"ACR_SYNC_TOKEN_USERNAME": "myconnectedregistry-sync-token"
"ACR_REGISTRY_CONNECTION_STRING": "ConnectedRegistryName=myconnectedregistry;SyncTokenName=myconnectedregistry-sync-token;SyncTokenPassword=s0meCoMPL3xP4$$W0rd001!@#;ParentGatewayEndpoint=mycontainerregistry001.westus2.data.azurecr.io;ParentEndpointProtocol=https",
"ACR_REGISTRY_LOGIN_SERVER": "<Optional: connected registry login server. More info at https://aka.ms/acr/connected-registry>"
}
```
@ -168,26 +157,8 @@ To deploy the connected registry module using the Azure CLI, save the following
},
"type": "docker",
"env": {
"ACR_REGISTRY_NAME": {
"value": "myconnectedregistry"
},
"ACR_PARENT_GATEWAY_ENDPOINT": {
"value": "mycontainerregistry001.westus2.data.azurecr.io"
},
"ACR_SYNC_TOKEN_NAME": {
"value": "myconnectedregistry-sync-token"
},
"ACR_SYNC_TOKEN_PASSWORD": {
"value": "s0meCoMPL3xP4$$W0rd001!@#"
},
"ACR_REGISTRY_LOGIN_SERVER": {
"value": "<use_the_ip_address_of_the_iot_edge_device>"
},
"ACR_PARENT_PROTOCOL": {
"value": "https"
},
"ACR_PARENT_LOGIN_SERVER": {
"value": "mycontainerregistry001.azurecr.io"
"ACR_REGISTRY_CONNECTION_STRING": {
"value": "ConnectedRegistryName=myconnectedregistry;SyncTokenName=myconnectedregistry-sync-token;SyncTokenPassword=s0meCoMPL3xP4$$W0rd001!@#;ParentGatewayEndpoint=mycontainerregistry001.westus2.data.azurecr.io;ParentEndpointProtocol=https"
}
},
"status": "running",
@ -224,7 +195,7 @@ To deploy the connected registry module using the Azure CLI, save the following
},
"edgeHub": {
"settings": {
"image": "mcr.microsoft.com/azureiotedge-hub:1.0",
"image": "mcr.microsoft.com/azureiotedge-hub:1.2",
"createOptions": "{\"HostConfig\":{\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}"
},
"type": "docker",
@ -408,7 +379,7 @@ In this quickstart, you learned how to deploy a connected registry to an IoT Edg
> [Quickstart: Pull images from a connected registry][quickstart-pull-images-from-connected-registry]
> [Quickstart: Deploy connected registry on nested IoT Edge device][quickstart-pull-images-from-connected-registry]
> [Quickstart: Deploy connected registry on nested IoT Edge device][quickstart-connected-registry-nested]
<!-- LINKS - internal -->
[az-acr-connected-registry-install]: https://docs.microsoft.com/cli/azure/acr/connected-registry/install?view=azure-cli-latest

Просмотреть файл

@ -124,7 +124,7 @@ To deploy the connected registry module using the Azure CLI, save the following
"systemModules": {
"edgeAgent": {
"settings": {
"image": "10.16.7.4/azureiotedge-agent:1.0",
"image": "10.16.7.4/azureiotedge-agent:1.2",
"createOptions": ""
},
"type": "docker",
@ -136,7 +136,7 @@ To deploy the connected registry module using the Azure CLI, save the following
},
"edgeHub": {
"settings": {
"image": "10.16.7.4/azureiotedge-hub:1.0",
"image": "10.16.7.4/azureiotedge-hub:1.2",
"createOptions": "{\"HostConfig\":{\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}"
},
"type": "docker",
@ -202,7 +202,6 @@ connectionState: Online
In this quickstart, you learned how to deploy a connected registry to an IoT Edge device. Continue to the next guide to learn how to pull images from the newly deployed connected registry.
> [!div class="nextstepaction"]
> [Quickstart: Pull images from a connected registry][quickstart-pull-images-from-connected-registry]
<!-- LINKS - internal -->