Skip to content

Commit 39772ae

Browse files
authored
Merge pull request #110127 from ScarlettFalls/prod-checklist
Updated service principal guidance for container registries
2 parents ab45b61 + ea51dad commit 39772ae

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

articles/iot-edge/production-checklist.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,25 +129,28 @@ When moving from test scenarios to production scenarios, remember to remove debu
129129
* Manage access to your container registry
130130
* Use tags to manage versions
131131

132-
### Manage access to your container registry with a service principal
132+
### Manage access to your container registry
133133

134134
Before you deploy modules to production IoT Edge devices, ensure that you control access to your container registry so that outsiders can't access or make changes to your container images. Use a private, not public, container registry to manage container images.
135135

136-
In the tutorials and other documentation, we instruct you to use the same container registry credentials on your IoT Edge device as you use on your development machine. These instructions are only intended to help you set up testing and development environments more easily, and should not be followed in a production scenario. Azure Container Registry recommends [authenticating with service principals](../container-registry/container-registry-auth-service-principal.md) when applications or services pull container images in an automated or otherwise unattended manner (headless), as IoT Edge devices do.
136+
In the tutorials and other documentation, we instruct you to use the same container registry credentials on your IoT Edge device as you use on your development machine. These instructions are only intended to help you set up testing and development environments more easily, and should not be followed in a production scenario.
137137

138-
To create a service principal, run the two scripts as described in [create a service principal](../container-registry/container-registry-auth-aci.md#create-a-service-principal). These scripts do the following tasks:
138+
For a more secured access to your registry, you have a choice of [authentication options](../container-registry/container-registry-authentication.md). A popular and recommended authentication is to use an Active Directory service principal that's well suited for applications or services to pull container images in an automated or otherwise unattended (headless) manner, as IoT Edge devices do.
139+
140+
To create a service principal, run the two scripts as described in [create a service principal](../container-registry/container-registry-auth-service-principal.md#create-a-service-principal). These scripts do the following tasks:
139141

140142
* The first script creates the service principal. It outputs the Service principal ID and the Service principal password. Store these values securely in your records.
141143

142-
* The second script creates role assignments to grant to the service principal, which can be run subsequently if needed. We recommend applying the **acrPull** user role for the `role` parameter. For a list of roles, see [Azure Container Registry roles and permissions](../container-registry/container-registry-roles.md)
144+
* The second script creates role assignments to grant to the service principal, which can be run subsequently if needed. We recommend applying the **acrPull** user role for the `role` parameter. For a list of roles, see [Azure Container Registry roles and permissions](../container-registry/container-registry-roles.md).
143145

144-
To authenticate using a service principal, provide the service principal ID and password that you obtained from the first script.
146+
To authenticate using a service principal, provide the service principal ID and password that you obtained from the first script. Specify these credentials in the deployment manifest.
145147

146148
* For the username or client ID, specify the service principal ID.
147149

148150
* For the password or client secret, specify the service principal password.
149151

150-
For an example of launching a container instance with Azure CLI, see [Authenticate using the service principal](../container-registry/container-registry-auth-aci.md#authenticate-using-the-service-principal).
152+
> [!NOTE]
153+
> After implementing an enhanced security authentication, disable the **Admin user** setting so that the default username/password access is no longer available. In your container registry in the Azure portal, from the left pane menu under **Settings**, select **Access Keys**.
151154
152155
### Use tags to manage versions
153156

0 commit comments

Comments
 (0)