You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/container-registry/tutorial-enable-registry-cache-auth.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ ms.date: 04/19/2022
6
6
ms.author: tejaswikolli
7
7
---
8
8
9
-
# Enable Registry Cache
9
+
# # Enable Caching for ACR with authentication - Azure portal
10
10
11
11
This article is part three of a four-part tutorial series. [Part one](tutorial-registry-cache.md) provides an overview of Caching for ACR, its features, benefits, and preview limitations. In [part two](tutorial-enable-registry-cache.md), you learn how to enable Caching for ACR feature by using the Azure portal.
12
12
@@ -16,7 +16,8 @@ This article walks you through the steps of enabling Caching for ACR with authen
16
16
17
17
* Sign in to the [Azure portal](https://ms.portal.azure.com/).
18
18
19
-
## Configure Registry Cache - Azure portal
19
+
20
+
## Configure Caching for ACR with authentication - Azure portal
20
21
21
22
Follow the steps to create cache rule in the [Azure portal](https://portal.azure.com).
22
23
@@ -42,7 +43,7 @@ Follow the steps to create cache rule in the [Azure portal](https://portal.azure
42
43
43
44
5. Enter the **Rule name**.
44
45
45
-
6. Select **Source** Registry from the dropdown menu. CurrentlyACR supports **Docker Hub** and **Microsoft Artifact Registry**.
46
+
6. Select **Source** Registry from the dropdown menu. Currently, Caching for ACR only supports **Docker Hub** and **Microsoft Artifact Registry**.
46
47
47
48
7. Enter the **Repository Path** to the artifacts you want to cache.
48
49
@@ -52,15 +53,21 @@ Follow the steps to create cache rule in the [Azure portal](https://portal.azure
52
53
53
54
10. If you have the credentials ready, **Select credentials** from the drop-down menu.
54
55
55
-
11. Under the **Destination**, Enter the name of the **New ACR repository path** to store cached artifacts.
56
+
11. Under the **Destination**, Enter the name of the **New ACR Repository Namespace** to store cached artifacts.
56
57
57
58
58
59
:::image type="content" source="./media/container-registry-registry-cache/save-cache-rule-04.png" alt-text="Screenshot to save Cache Rule.":::
59
60
60
61
61
62
12. Select on **Save**
62
63
63
-
13. Pull the image from your cache using the Docker command `docker pull myregistry.azurecr.io/hello-world`
64
+
13. Run the [az keyvault set-policy][az-keyvault-set-policy] command to assign access to the Key Vault, before pulling the image.
65
+
66
+
```azurecli-interactive
67
+
az keyvault set-policy --name myKeyVaultName --object-id myObjID --secret-permissions get
68
+
```
69
+
70
+
14. Pull the image from your cache using the Docker command `docker pull myregistry.azurecr.io/hello-world`
64
71
65
72
### Create new credentials
66
73
@@ -88,4 +95,5 @@ Follow the steps to create cache rule in the [Azure portal](https://portal.azure
88
95
* Advance to the [next article](tutorial-troubleshoot-registry-cache.md) to walk through the troubleshoot guide for Registry Cache.
Copy file name to clipboardExpand all lines: articles/container-registry/tutorial-registry-cache.md
+25-22Lines changed: 25 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,50 +19,53 @@ This article is part one in a four-part tutorial series. The tutorial covers:
19
19
20
20
## Caching for ACR
21
21
22
-
Caching for ACR enables you to cache container images from public registries.
22
+
Caching for ACR enables you to cache container images from public and private repositories.
23
23
24
24
Implementing Caching for ACR provides the following benefits:
25
25
26
26
***High-speed pull operations:*** Faster pulls of container images are achievable by caching the container images in ACR. Since Microsoft manages the Azure network, pull operations are faster by providing Geo-Replication and Availability Zone support to the customers.
27
27
28
28
***Private networks:*** Cached registries are available on private networks. Therefore, users can configure their firewall to meet compliance standards.
29
29
30
-
***Docker Rate Limit:*** Docker has updated their terms of services. The new limits allow anonymous users to 100 pull operations every six hours. Free Docker account users have 200 pull operations limit for every six hours. The Docker subscription users have 5000 pull operations limit for every 24 hours. Caching for ACR allows users to pull images from the cache. Container images pulled from the cache ***do not*** count toward Docker's pull limit. Learn more docker hub rate limit [here][docker-rate-limit].
31
-
32
-
## Preview Limitations
33
-
34
-
- Quarantine functions like signing, scanning, and manual compliance approval are on the roadmap but aren't included in this release.
35
-
36
-
- Caching will only occur after the container image is requested at least once. For every new image available, a new pull request must be made. Caching for ACR doesn't automatically pull new version of images when a new version is available. This is on the roadmap but isn't supported in this release.
37
-
38
-
- Caching for ACR only supports Docker Hub and Microsoft Artifact Registry. Multiple other registries including self-hosted registries are on the roadmap but aren't included in this release.
39
-
40
-
- Caching for ACR is only available by using the Azure portal. The Azure CLI is released in the coming weeks.
30
+
***Docker Rate Limit:*** Docker has updated their terms of services to rate limit pulls for customers. The rate limit of the pull depends on the type of account in use. Caching for ACR allows users to pull images from the cache. Container images pulled from the cache ***do not*** count toward Docker's pull limit. Learn more docker hub rate limit [here][docker-rate-limit].
41
31
32
+
42
33
## Terminology
43
34
44
35
- Cache Rule
45
-
- Cache Rules are a set of rules you can create to pull artifacts from a supported registry into your cache. A cache rule contains four parts:
36
+
- A Cache Rule is a rule you can create to pull artifacts from a supported repository into your cache. A cache rule contains four parts:
46
37
47
-
1. A Rule Name - The name of your cache rule. For example, `Hello-World-Cache`.
38
+
1. Rule Name - The name of your cache rule. For example, `Hello-World-Cache`.
48
39
49
-
2. A Source - The name of the Source Registry. Currently, we only support **Docker Hub** and **Microsoft Artifact Registry**.
40
+
2. Source - The name of the Source Registry. Currently, we only support **Docker Hub** and **Microsoft Artifact Registry**.
50
41
51
-
3. A Repository Path - The source path of the repository to find and retrieve artifacts you want to cache. For example, `docker.io/library/hello-world`.
42
+
3. Repository Path - The source path of the repository to find and retrieve artifacts you want to cache. For example, `docker.io/library/hello-world`.
52
43
53
-
4. An ACR Repository Path - The name of the new repository path to store artifacts. For example, `hello-world`. The Repository can't already exist inside the ACR instance.
44
+
4.New ACR Repository Namespace - The name of the new repository path to store artifacts. For example, `hello-world`. The Repository can't already exist inside the ACR instance.
54
45
55
-
-Credential Set
56
-
-A credential set is a username and password for the source registry. A credential set is needed if you wish to authenticate with a public or private repository. A credential set contains four parts
46
+
-Credentials
47
+
-Credentials are a set of username and password for the source registry. Credentials are needed if you wish to authenticate with a public or private repository. Credentials contains four parts
57
48
58
-
1. A Credential Set Name - The name of your credential set.
49
+
1. Credentials - The name of your credentials.
59
50
60
-
2. A Source registry Login Server - The login server of your source registry. Only `docker.io` is supported.
51
+
2. Source registry Login Server - The login server of your source registry. Only `docker.io` is supported.
61
52
62
-
3. A Source Authentication - The key vault locations to store credentials.
53
+
3. Source Authentication - The key vault locations to store credentials.
63
54
64
55
4. Username and Password secrets- The secrets containing the username and password.
65
56
57
+
## Preview Limitations
58
+
59
+
- Quarantine functions like signing, scanning, and manual compliance approval are on the roadmap but aren't included in this release.
60
+
61
+
- Caching will only occur after the container image is requested at least once. For every new image available, a new pull request must be made. Caching for ACR doesn't automatically pull new version of images when a new version is available. This is on the roadmap but isn't supported in this release.
62
+
63
+
- Caching for ACR only supports Docker Hub and Microsoft Artifact Registry. Multiple other registries including self-hosted registries are on the roadmap but aren't included in this release.
64
+
65
+
- Caching for ACR only supports 50 cache rules.
66
+
67
+
- Caching for ACR is only available by using the Azure portal. The Azure CLI is released in the coming weeks.
68
+
66
69
## Next steps
67
70
68
71
* To enable Caching for ACR using the Azure portal advance to the next article: [Enable Caching for ACR](tutorial-enable-registry-cache.md).
Copy file name to clipboardExpand all lines: articles/container-registry/tutorial-troubleshoot-registry-cache.md
+17-27Lines changed: 17 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,35 +6,25 @@ ms.date: 04/19/2022
6
6
ms.author: tejaswikolli
7
7
---
8
8
9
-
# Troubleshoot guide for Registry Cache
9
+
# Troubleshoot guide for Caching for ACR
10
10
11
11
This article is part four in a four-part tutorial series. [Part one](tutorial-registry-cache.md) provides information about the Caching for ACR feature, its limitations, and benefits of the implementation in your registry. In [part two](tutorial-enable-registry-cache.md), you learn how to enable Caching for ACR feature by using the Azure portal. In [part three](tutorial-enable-registry-cache-auth.md), you learn how to enable Caching for ACR feature with authentication by using the Azure portal.
12
12
13
13
This article helps you troubleshoot problems you might encounter when attempting to use Caching for ACR.
14
14
15
-
## Symptoms
15
+
## Symptoms and Causes
16
16
17
17
May include one or more of the following issues:
18
18
19
-
- Cached images don't appear in a live repository
20
-
21
-
- Unable to create a Credential set
19
+
- Cached images don't appear in a real repository
20
+
-[Cached images don't appear in a live repository](tutorial-troubleshoot-registry-cache.md#cached-images-dont-appear-in-a-live-repository)
@@ -47,23 +37,22 @@ If you're having an issue with cached images not showing up in your repository i
47
37
48
38
The Azure portal autofills these fields for you. However, many Docker repositories begin with `library/` in their path. For example, in-order to cache the `hello-world` repository, the correct Repository Path is `docker.io/library/hello-world`.
49
39
50
-
## Unable to create a Credential set
51
-
52
-
We recommend before creating a credential set inside the Azure portal, ensure both the Username and Password secrets are associated with a Key Vault or secret URIs.
53
-
54
-
- Credential sets can be stored using Azure Key Vault.
55
-
- When using Azure Key vault, you must have a Key Vault name and Secret for both the Username and Password secrets.
56
-
57
-
Caching for ACR allows you to cache images from private Docker Hub repositories. In-order to store the credentials needed to access the private repository. You must create a credential set.
58
-
59
40
## Unhealthy Credential Set
60
41
61
42
Credential sets are a set of Key Vault secrets that operate as a Username and Password for private repositories. Unhealthy Credential sets are often a result of these secrets no longer being valid. Inside the Azure portal you can select the credential set, to edit and apply changes.
62
43
63
44
- Verify the secrets in Azure Key Vault haven't expired.
64
45
- Verify the secrets in Azure Key Vault are valid.
46
+
- Verify the access to the Azure Key Vault is assigned.
47
+
48
+
To assign the access to Azure Key Vault:
49
+
50
+
```azurecli-interactive
51
+
az keyvault set-policy --name myKeyVaultName --object-id myObjID --secret-permissions get
52
+
```
65
53
66
54
Learn more about [Key Vaults][create-and-store-keyvault-credentials].
55
+
Learn more about [Assigning the access to Azure Key Vault][az-keyvault-set-policy].
67
56
68
57
## Unable to create a Cache rule
69
58
@@ -83,4 +72,5 @@ If you're facing issues while creating a Cache rule, we recommend verifying if y
83
72
We recommend deleting any unwanted cache rules to avoid hitting the limit.
0 commit comments