Skip to content

Commit 82698df

Browse files
edits
1 parent 3b9b8ce commit 82698df

6 files changed

+57
-61
lines changed

articles/container-registry/connected-registry-glossary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,19 +116,19 @@ This glossary provides terms and definitions for the connected registry extensio
116116

117117
### Parent Registry
118118

119-
- **Description:** The primary registry that synchronizes with its child connected registries. A single parent registry can have multiple child registries connected to it. In a nested scenarios, there can be multiple layers of registries within the hierarchy.
119+
- **Description:** The primary registry that synchronizes with its child connected registries. A single parent registry can have multiple child registries connected to it. In a nested scenario, there can be multiple layers of registries within the hierarchy.
120120

121121
### Protected Settings File (--config-protected-file)
122122

123-
- **Definition:** The file containing the connection string for deploying the connected registry extension on the Kubernetes cluster. This file would also includes the Kubernetes Secret or Public Cert + Private Key values pair for BYOC scenarios.
123+
- **Definition:** The file containing the connection string for deploying the connected registry extension on the Kubernetes cluster. This file would also include the Kubernetes Secret or Public Cert + Private Key values pair for BYOC scenarios.
124124
- **Accepted Values:** Alphanumerical value
125125
- **Note:** Customer must specify.
126126

127127
### Public Certificate + Private Key
128128

129129
- **Value Type:** Alphanumerical base64-encoded
130130
- **Customer Action:** Must specify
131-
- **Description:** The public key certificate comprises of a pair of keys: a public key available to anyone for identity verification of the certificate holder, and a private key, a unique secret key.
131+
- **Description:** The public key certificate comprises a pair of keys: a public key available to anyone for identity verification of the certificate holder, and a private key, a unique secret key.
132132

133133
### Pvc.storageClassName
134134

articles/container-registry/quickstart-connected-registry-arc-cli.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Quickstart: Deploying the Connected Registry Arc Extension"
2+
title: "Quickstart: Deploying the connected registry Arc extension"
33
description: "Learn how to deploy the Connected Registry Arc Extension CLI UX with secure-by-default settings for efficient and secure container workload operations."
44
author: tejaswikolli-web
55
ms.author: tejaswikolli
@@ -11,7 +11,7 @@ ai-usage: ai-assisted
1111
#customer intent: As a user, I want to learn how to deploy the connected registry Arc extension using the CLI UX with secure-by-default settings, such as using HTTPS, Read Only, Trust Distribution, and Cert Manager service, so that I can ensure the secure and efficient operation of my container workloads."
1212
---
1313

14-
# Quickstart: Deploy the connected registry Arc extension (Preview)
14+
# Quickstart: Deploy the connected registry Arc extension (preview)
1515

1616
In this quickstart, you learn how to deploy the Connected registry Arc extension using the CLI UX with secure-by-default settings to ensure robust security and operational integrity.
1717

@@ -25,11 +25,11 @@ The connected registry is a pivotal tool for edge customers, enabling efficient
2525

2626
* Set up the firewall access and communication between the ACR and the connected registry by enabling the [dedicated data endpoints.][dedicated data endpoints]
2727

28-
* Create or use an existing Azure Kubernetes Service (AKS) cluster with the [tutorial.][tutorial-aks-cluster]
28+
* Create or use an existing Azure KubernetesService (AKS) cluster with the [tutorial.][tutorial-aks-cluster]
2929

30-
* Set up the connection between the Kubernetes cluster and Azure Arc by following the [quickstart.][quickstart-connect-cluster]
30+
* Set up the connection between the Kubernetescluster and Azure Arc by following the [quickstart.][quickstart-connect-cluster]
3131

32-
* Use the [k8s-extension][k8s-extension] command to manage Kubernetes extensions.
32+
* Use the [k8s-extension][k8s-extension] command to manage Kubernetesextensions.
3333

3434
```azurecli
3535
az extension add --name k8s-extension
@@ -52,9 +52,9 @@ The connected registry is a pivotal tool for edge customers, enabling efficient
5252
The `hello-world` repository is created in the ACR registry `myacrregistry` to synchronize with the Connected registry.
5353
5454
55-
## Deploy the Connected registry Arc extension with secure-by-default settings
55+
## Deploy the connected registry Arc extension with secure-by-default settings
5656
57-
Once the prerequisites and necessary conditions and components are in place, follow the streamlined approach to securely deploy a connected registry extension on an Arc-enabled Kubernetes cluster using the following settings. These settings define the following configuration with HTTPS, Read Only, Trust Distribution, and Cert Manager service. Follow the steps for a successful deployment:
57+
Once the prerequisites and necessary conditions and components are in place, follow the streamlined approach to securely deploy a connected registry extension on an Arc-enabled Kubernetescluster using the following settings. These settings define the following configuration with HTTPS, Read Only, Trust Distribution, and Cert Manager service. Follow the steps for a successful deployment:
5858
5959
1. [Create the connected registry.](#create-the-connected-registry-and-synchronize-with-acr)
6060
2. [Deploy the connected registry Arc extension.](#deploy-the-connected-registry-arc-extension-on-the-arc-enabled-kubernetes-cluster)
@@ -81,15 +81,15 @@ Creating the connected registry to synchronize with ACR is the foundational step
8181
- The [az acr connected-registry create][az-acr-connected-registry-create] command overwrites actions if the sync scope map named `myscopemap` exists and overwrites properties if the sync token named `mysynctoken` exists.
8282
- The [az acr connected-registry create][az-acr-connected-registry-create] command validates a dedicated data endpoint during the creation of the connected registry and provides a command to enable the dedicated data endpoint on the ACR registry.
8383
84-
### Deploy the connected registry Arc extension on the Arc-enabled kubernetes cluster
84+
### Deploy the connected registry Arc extension on the Arc-enabled Kubernetes cluster
8585
8686
By deploying the connected Registry Arc extension, you can synchronize container images and other Open Container Initiative (OCI) artifacts with your ACR registry. The deployment helps speed-up access to registry artifacts and enables the building of advanced scenarios. The extension deployment ensures secure trust distribution between the connected registry and all client nodes within the cluster, and installs the cert-manager service for Transport Layer Security (TLS) encryption.
8787
8888
1. Generate the Connection String and Protected Settings JSON File
8989
9090
For secure deployment of the connected registry extension, generate the connection string, including a new password, transport protocol, and create the `protected-settings-extension.json` file required for the extension deployment with [az acr connected-registry get-settings][az-acr-connected-registry-get-settings] command:
9191
92-
```bash
92+
```bash
9393
cat << EOF > protected-settings-extension.json
9494
{
9595
"connectionString": "$(az acr connected-registry get-settings \
@@ -100,9 +100,9 @@ By deploying the connected Registry Arc extension, you can synchronize container
100100
--query ACR_REGISTRY_CONNECTION_STRING --output tsv --yes)"
101101
}
102102
EOF
103-
```
103+
```
104104

105-
```bash
105+
```bash
106106
cat << EOF > protected-settings-extension.json
107107
{
108108
"connectionString": "$(az acr connected-registry get-settings \
@@ -113,7 +113,7 @@ By deploying the connected Registry Arc extension, you can synchronize container
113113
--query ACR_REGISTRY_CONNECTION_STRING --output tsv --yes)"
114114
}
115115
EOF
116-
```
116+
```
117117
118118
```azurepowershell
119119
echo "{\"connectionString\":\"$(az acr connected-registry get-settings \
@@ -143,14 +143,14 @@ By deploying the connected Registry Arc extension, you can synchronize container
143143
--config-protected-file protected-settings-extension.json
144144
```
145145
146-
- The [az k8s-extension create][az-k8s-extension-create] command deploys the connected registry extension on the Kubernetes cluster with the provided configuration parameters and protected settings file.
146+
- The [az k8s-extension create][az-k8s-extension-create] command deploys the connected registry extension on the Kubernetescluster with the provided configuration parameters and protected settings file.
147147
- It ensures secure trust distribution between the connected registry and all client nodes within the cluster, and installs the cert-manager service for Transport Layer Security (TLS) encryption.
148-
- The clusterIP must be from the AKS cluster subnet IP range. The `service.clusterIP` parameter specifies the IP address of the connected registry service within the cluster. It is essential to set the `service.clusterIP` within the range of valid service IPs for the Kubernetes cluster. Ensure that the IP address specified for `service.clusterIP` falls within the designated service IP range defined during the cluster's initial configuration, typically found in the cluster's networking settings. If the `service.clusterIP` is not within this range, it must be updated to an IP address that is both within the valid range and not currently in use by another service.
148+
- The clusterIP must be from the AKS cluster subnet IP range. The `service.clusterIP` parameter specifies the IP address of the connected registry service within the cluster. It is essential to set the `service.clusterIP` within the range of valid service IPs for the Kubernetescluster. Ensure that the IP address specified for `service.clusterIP` falls within the designated service IP range defined during the cluster's initial configuration, typically found in the cluster's networking settings. If the `service.clusterIP` is not within this range, it must be updated to an IP address that is both within the valid range and not currently in use by another service.
149149
150150
151151
### Verify the connected registry extension deployment
152152
153-
To verify the deployment of the connected registry extension on the Arc-enabled Kubernetes cluster, follow the steps:
153+
To verify the deployment of the connected registry extension on the Arc-enabled Kubernetescluster, follow the steps:
154154
155155
1. Verify the deployment status
156156

articles/container-registry/troubleshoot-connected-registry-arc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ az k8s-extension update \
154154
--config-protected-file protected-settings-extension.json
155155
```
156156

157-
### Issue: Extension created, but connected registry is not an “Online” state**
157+
### Issue: Extension created, but connected registry is not an “Online” state
158158

159159
**Possibility 1:** Previous connected registry has not been deactivated
160160

@@ -184,7 +184,7 @@ az acr connected-registry deactivate -n <myconnectedregistry> -r <mycontainerreg
184184

185185
After a few minutes, the connected registry pod should be recreated, and the error should disappear.
186186

187-
## Enable Logging
187+
## Enable logging
188188

189189
- Run the [az acr connected-registry update] command to update the connected registry extension with the debug log level:
190190

articles/container-registry/tutorial-connected-registry-arc.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Secure and deploy Connected registry Arc extension"
2+
title: "Secure and deploy connected registry Arc extension"
33
description: "Learn to secure the connected registry Arc extension deployment with HTTPS, TLS, optional no TLS, BYOC certificate, and trust distribution."
44
author: tejaswikolli-web
55
ms.author: tejaswikolli
@@ -11,7 +11,7 @@ ms.date: 06/17/2024
1111

1212
---
1313

14-
# Tutorial: Secure deployment methods for the connected registry extension
14+
# Tutorial: Secure deployment methods for the connected registry extension
1515

1616
These tutorials cover various deployment scenarios for the connected registry extension in an Arc-enabled Kubernetes cluster. Once the connected registry extension is installed, you can synchronize images from your cloud registry to on-premises or remote locations.
1717

@@ -25,7 +25,7 @@ The connected registry cert manager is a service that manages TLS certificates f
2525

2626
[Cert-Manager][cert-manager] is an open-source Kubernetes add-on that automates the management and issuance of TLS certificates from various sources. It manages the lifecycle of certificates issued by CA pools created using CA Service, ensuring they are valid and renewed before they expire.
2727

28-
### What is Trust Distribution?
28+
### What is trust distribution?
2929

3030
Connected registry trust distribution refers to the process of securely distributing trust between the connected registry service and Kubernetes clients within a cluster. This is achieved by using a Certificate Authority (CA), such as cert-manager, to sign TLS certificates, which are then distributed to both the registry service and the clients. This ensures that all entities can securely authenticate each other, maintaining a secure and trusted environment within the Kubernetes cluster.
3131

@@ -34,7 +34,7 @@ In this tutorial, you:
3434
> [!div class="checklist"]
3535
> - [Deploy Connected registry extension using preinstalled cert-manager.](#deploy-connected-registry-extension-using-your-preinstalled-cert-manager)
3636
> - [Deploy Connected registry extension using Bring Your Own Certificate (BYOC).](#deploy-connected-registry-extension-using-bring-your-own-certificate-byoc)
37-
> - [Deploy Connected registry with kubernetes secret management.](#deploy-connected-registry-with-kubernetes-secret-management)
37+
> - [Deploy Connected registry with Kubernetes secret management.](#deploy-connected-registry-with-Kubernetes-secret-management)
3838
> - [Deploy the Connected registry Arc extension with inherent trust distribution or reject Connected registry trust distribution.](#deploy-the-connected-registry-using-your-own-trust-distribution-and-disable-the-connected-registrys-default-trust-distribution)
3939
4040
## Prerequisites
@@ -47,7 +47,7 @@ To complete this tutorial, you need:
4747

4848
In this tutorial, we demonstrate how to use a preinstalled cert-manager service on the cluster. This setup gives you control over certificate management, enabling you to deploy the connected registry extension with encryption by following the steps provided:
4949

50-
1. Run the [az-k8s-extension-create][az-k8s-extension-create] command in the [quickstart][quickstart] and set the `cert-manager.enabled=true` and `cert-manager.install=false` parameters to determine the cert-manager service is installed and enabled:
50+
Run the [az-k8s-extension-create][az-k8s-extension-create] command in the [quickstart][quickstart] and set the `cert-manager.enabled=true` and `cert-manager.install=false` parameters to determine the cert-manager service is installed and enabled:
5151

5252
```azurecli
5353
az k8s-extension create --cluster-name myarck8scluster \
@@ -60,7 +60,7 @@ In this tutorial, we demonstrate how to use a preinstalled cert-manager service
6060
--config-protected-file protected-settings-extension.json
6161
```
6262

63-
## Deploy Connected registry extension using Bring Your Own Certificate (BYOC)
63+
## Deploy connected registry extension using bring your own certificate (BYOC)
6464

6565
In this tutorial, we demonstrate how to use your own certificate (BYOC) on the cluster. BYOC allows you to use your own public certificate and private key pair, giving you control over certificate management. This setup enables you to deploy the connected registry extension with encryption by following the provided steps:
6666

@@ -100,9 +100,9 @@ export TLS_KEY=$(cat mycert.key | base64 -w0)
100100
}
101101
```
102102

103-
2. Now, you can deploy the Connected registry extension with HTTPS (TLS encryption) using the public certificate and private key pair management by configuring variables set to `cert-manager.enabled=false` and `cert-manager.install=false`. With these parameters, the cert-manager isn't installed or enabled since the public certificate and private key pair is used instead for encryption.
103+
4. Now, you can deploy the Connected registry extension with HTTPS (TLS encryption) using the public certificate and private key pair management by configuring variables set to `cert-manager.enabled=false` and `cert-manager.install=false`. With these parameters, the cert-manager isn't installed or enabled since the public certificate and private key pair is used instead for encryption.
104104

105-
3. Run the [az-k8s-extension-create][az-k8s-extension-create] command for deployment after protected settings file is edited:
105+
5. Run the [az-k8s-extension-create][az-k8s-extension-create] command for deployment after protected settings file is edited:
106106

107107
```azurecli
108108
az k8s-extension create --cluster-name myarck8scluster \
@@ -164,7 +164,7 @@ EOF
164164
}
165165
```
166166

167-
Now, you can deploy the Connected registry extension with HTTPS (TLS encryption) using the kubernetes secret management by configuring variables set to `cert-manager.enabled=false` and `cert-manager.install=false`. With these parameters, the cert-manager isn't installed or enabled since the kubernetes secret is used instead for encryption.
167+
Now, you can deploy the Connected registry extension with HTTPS (TLS encryption) using the Kubernetes secret management by configuring variables set to `cert-manager.enabled=false` and `cert-manager.install=false`. With these parameters, the cert-manager isn't installed or enabled since the Kubernetes secret is used instead for encryption.
168168

169169
5. Run the [az-k8s-extension-create][az-k8s-extension-create] command for deployment after protected settings file is edited:
170170

@@ -226,15 +226,13 @@ By deleting the deployed Connected registry extension, you remove the correspond
226226

227227
By deleting the Connected registry extension and the Connected registry, you remove all the associated resources and configurations.
228228

229-
## Next steps -or- Related content
230-
231-
> [!div class="nextstepaction"]
229+
## Next steps
232230

233-
> [Enable Connected registry with Azure arc CLI][quickstart]
234-
> [Upgrade Connected registry with Azure arc](tutorial-connected-registry-upgrade.md)
235-
> [Sync Connected registry with Azure arc in Scheduled window](tutorial-connected-registry-sync.md)
236-
> [Troubleshoot Connected registry with Azure arc](troubleshoot-connected-registry-arc.md)
237-
> [Glossary of terms](connected-registry-glossary.md)
231+
-[Enable Connected registry with Azure arc CLI][quickstart]
232+
-[Upgrade Connected registry with Azure arc](tutorial-connected-registry-upgrade.md)
233+
-[Sync Connected registry with Azure arc in Scheduled window](tutorial-connected-registry-sync.md)
234+
-[Troubleshoot Connected registry with Azure arc](troubleshoot-connected-registry-arc.md)
235+
-[Glossary of terms](connected-registry-glossary.md)
238236

239237
<!-- LINKS - internal -->
240238
[create-acr]: container-registry-get-started-azure-cli.md

0 commit comments

Comments
 (0)