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/chaos-studio/chaos-studio-private-link-agent-service.md
+9-40Lines changed: 9 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,46 +22,15 @@ This guide explains the steps needed to configure Private Link for a Chaos Studi
22
22
> If the target resource was created using the portal, then the chaos agent VM extension will be austomatically installed on the host VM. If the target is enabled using the CLI, then follow the Chaos Studio documentation to install the VM extension first on the virtual machine. Until you complete the private endpoint setup, the VM extension will be reporting an unhealthy state. This is expected.
23
23
24
24
<br/>
25
-
26
-
3. Ensure that the `Microsoft.Resources/EUAPParticipation` feature flag is enabled for your subscription. Previous Chaos Studio users may already have the feature flag enabled if you ran your first experiment via the Azure portal in the past.
27
-
28
-
<br/>
29
-
30
-
The feature flag can be enabled using Azure CLI. Here's an example:
31
-
32
-
```AzCLI
33
-
az feature register --namespace Microsoft.Resources --name "EUAPParticipation" --subscription <subscription id>
34
-
```
35
-
36
25
## Limitations
37
26
38
27
- You'll need to use our **2023-10-27-preview REST API** to create and use private link for agent-based experiments ONLY. There's **no** support for private link for agent-based experiments in our GA-stable REST API until H1 2024.
39
28
40
29
- The entire end-to-end for this flow requires some use of the CLI. The current end-to-end experience cannot be done from the Azure portal currently.
41
30
42
31
- The **Chaos Studio Private Accesses (CSPA)** resource type has a **strict 1:1 mapping of Chaos Target:CSPA Resource (abstraction for private endpoint).**.** We only allow **5 CSPA resources to be created per Subscription** to maintain the expected experience for all of our customers.
43
-
44
-
## Step 1: Make sure you allowlist Microsoft.Network/AllowPrivateEndpoints in your subscription
45
-
46
-
The first step is to ensure that your desired subscription allows the Networking Resource Provider to operate.
47
-
48
-
Ensure that the `Microsoft.Network/AllowPrivateEndpoints` feature flag is enabled for your subscription.
49
-
50
-
<br/>
51
-
52
-
The feature flag can be enabled using Azure CLI. Here's an example:
53
-
54
-
```AzCLI
55
-
az feature register --namespace Microsoft.Network --name "AllowPrivateEndpoints" --subscription <subscription id>
56
-
```
57
-
58
-
> [!NOTE]
59
-
> If you are going to be using private endpoints using manual requests across multiple subscriptions, you'll need to ensure you register the Microsoft.Network Resource Provider (RP) in your respective tenants/subscriptions. See [Register RP](../azure-resource-manager/management/resource-providers-and-types.md) for more info about this.
60
-
>
61
-
>
62
-
> This step is not needed if you are using the same subscription across both the Chaos and Networking Resource Providers.
63
32
64
-
## Step 2: Create a Chaos Studio Private Access (CSPA) resource
33
+
## Step 1: Create a Chaos Studio Private Access (CSPA) resource
65
34
66
35
To use Private endpoints for agent-based chaos experiments, you need to create a new resource type called **Chaos Studio Private Accesses**. CSPA is the resource against which the private endpoints are created.
|resourceLocation|True|String|Location you want the resource to be hosted (must be a support region by Chaos Studio)|
101
70
102
71
103
-
## Step 3: Create your Virtual Network, Subnet, and Private Endpoint
72
+
## Step 2: Create your Virtual Network, Subnet, and Private Endpoint
104
73
105
74
[Set up your desired Virtual Network, Subnet, and Endpoint](../private-link/create-private-endpoint-portal.md) for the experiment if you haven't already.
106
75
@@ -111,7 +80,7 @@ Make sure you attach it to the same VM's VNET. Screenshots provide examples of c
111
80
[](images/resource-vnet-cspa.png#lightbox)
112
81
113
82
114
-
## Step 4: Map the agent host VM to the CSPA resource
83
+
## Step 3: Map the agent host VM to the CSPA resource
115
84
116
85
Find the Target "Resource ID" by making a GetTarget call:
> The PrivateAccessID should exactly match the "resourceID" used to create the CSPA resource in Step 2.
137
+
> The PrivateAccessID should exactly match the "resourceID" used to create the CSPA resource in Step 1.
169
138
170
-
## Step 5: Update host VM to map the communications endpoint to the private endpoint
139
+
## Step 4: Update host VM to map the communications endpoint to the private endpoint
171
140
172
141
During the Preview of this feature, customers need to update the Agent VM extensions settings to point to the communication endpoint that supports traffic over a private network. Customers need to update the host entry on the actual VM to map the communication endpoint to the private IP generated during the private endpoint creation. You can get the IP address from the "DNS Configuration" tab in the Private Endpoint resource seen in the following screenshot:
173
142
@@ -191,7 +160,7 @@ Example of what the "hosts" file should look like. The IP address and Azure regi
191
160
192
161
Save and close the file.
193
162
194
-
## Step 6: Update the communication endpoint in agentSettings and agentInstanceConfig JSON files
163
+
## Step 5: Update the communication endpoint in agentSettings and agentInstanceConfig JSON files
195
164
196
165
In this step, you need to continue to edit files on the host VM machine. You need to update the "agentSettings.json" and "agentInstanceConfig.json" files to include the communication endpoint based on the region in which the VM targets were created in the previous steps.
197
166
@@ -232,7 +201,7 @@ Example of updated agentInstanceConfig.json:
232
201
233
202
[](images/agent-instance-config-json.png#lightbox)
234
203
235
-
## Step 6.5: Disable CRL verification in agentSettings.JSON
204
+
## Step 5.5: Disable CRL verification in agentSettings.JSON
236
205
237
206
**IF** you blocked outbound access to Microsoft Certificate Revocation List (CRL) verification endpoints, then you need to update agentSettings.JSON to disable CRL verification check in the agent.
238
207
@@ -250,7 +219,7 @@ The final agentSettings.JSON should appear as shown:
250
219
251
220
If outbound access to Microsoft CRL verification endpoints is not blocked, then you can ignore this step.
252
221
253
-
## Step 7: Restart the Azure Chaos Agent service in the VM
222
+
## Step 6: Restart the Azure Chaos Agent service in the VM
254
223
255
224
After making all the required changes to the host, restart the Azure Chaos Agent Service in the VM
[](images/restart-linux-vm.png#lightbox)
270
239
271
-
## Step 8: Run your Agent-based experiment using private endpoints
240
+
## Step 7: Run your Agent-based experiment using private endpoints
272
241
273
242
After the restart, the Chaos agent should be able to communicate with the Agent Communication data plane service and the agent registration to the data plane should be successful. After successful registration, the agent will be able to heartbeat its status and you can go ahead and run the chaos agent-based experiments using private endpoints!
0 commit comments