Skip to content

Commit 3fbd205

Browse files
committed
Fix merge conflict
2 parents 12eeb15 + ba106ef commit 3fbd205

22 files changed

+523
-613
lines changed

AKS-Arc/TOC.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,21 @@
199199
href: connectivity-troubleshoot.md
200200
- name: Cluster status stuck during upgrade
201201
href: cluster-upgrade-status.md
202+
- name: Security
203+
items:
204+
- name: Security book - recommendations and best practices
205+
href: /azure/azure-arc/kubernetes/conceptual-security-book?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json
206+
displayName: security, best practices, recommendations
207+
- name: Securing your platform
208+
href: /azure/azure-arc/kubernetes/conceptual-secure-your-platform?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json
209+
- name: Securing your workloads
210+
href: /azure/azure-arc/kubernetes/conceptual-secure-your-workloads?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json
211+
- name: Securing your operations
212+
href: /azure/azure-arc/kubernetes/conceptual-secure-your-operations?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json
213+
- name: Securing your data
214+
href: /azure/azure-arc/kubernetes/conceptual-secure-your-data?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json
215+
- name: Securing your network
216+
href: /azure/azure-arc/kubernetes/conceptual-secure-your-network?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json
202217
- name: Reference
203218
items:
204219
- name: Azure CLI

AKS-Arc/aksarc.yml

Lines changed: 168 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,30 @@ directCommands:
116116
- name: --vnet-ids
117117
summary: |-
118118
Azure Resource Manager resource ID(s) of the VNets.
119+
globalParameters:
120+
- name: --debug
121+
summary: |-
122+
Increase logging verbosity to show all debug logs.
123+
- name: --help -h
124+
summary: |-
125+
Show this help message and exit.
126+
- name: --only-show-errors
127+
summary: |-
128+
Only show errors, suppressing warnings.
129+
- name: --output -o
130+
defaultValue: "json"
131+
acceptedValues: "json, jsonc, none, table, tsv, yaml, yamlc"
132+
summary: |-
133+
Output format.
134+
- name: --query
135+
summary: |-
136+
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
137+
- name: --subscription
138+
summary: |-
139+
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
140+
- name: --verbose
141+
summary: |-
142+
Increase logging verbosity. Use --debug for full debug logs.
119143
- uid: az_aksarc_delete
120144
name: az aksarc delete
121145
summary: |-
@@ -151,6 +175,30 @@ directCommands:
151175
defaultValue: "False"
152176
summary: |-
153177
Do not prompt for confirmation.
178+
globalParameters:
179+
- name: --debug
180+
summary: |-
181+
Increase logging verbosity to show all debug logs.
182+
- name: --help -h
183+
summary: |-
184+
Show this help message and exit.
185+
- name: --only-show-errors
186+
summary: |-
187+
Only show errors, suppressing warnings.
188+
- name: --output -o
189+
defaultValue: "json"
190+
acceptedValues: "json, jsonc, none, table, tsv, yaml, yamlc"
191+
summary: |-
192+
Output format.
193+
- name: --query
194+
summary: |-
195+
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
196+
- name: --subscription
197+
summary: |-
198+
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
199+
- name: --verbose
200+
summary: |-
201+
Increase logging verbosity. Use --debug for full debug logs.
154202
- uid: az_aksarc_get-credentials
155203
name: az aksarc get-credentials
156204
summary: |-
@@ -198,6 +246,30 @@ directCommands:
198246
defaultValue: "False"
199247
summary: |-
200248
Overwrites any existing cluster entry with the same name.
249+
globalParameters:
250+
- name: --debug
251+
summary: |-
252+
Increase logging verbosity to show all debug logs.
253+
- name: --help -h
254+
summary: |-
255+
Show this help message and exit.
256+
- name: --only-show-errors
257+
summary: |-
258+
Only show errors, suppressing warnings.
259+
- name: --output -o
260+
defaultValue: "json"
261+
acceptedValues: "json, jsonc, none, table, tsv, yaml, yamlc"
262+
summary: |-
263+
Output format.
264+
- name: --query
265+
summary: |-
266+
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
267+
- name: --subscription
268+
summary: |-
269+
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
270+
- name: --verbose
271+
summary: |-
272+
Increase logging verbosity. Use --debug for full debug logs.
201273
- uid: az_aksarc_list
202274
name: az aksarc list
203275
summary: |-
@@ -218,6 +290,30 @@ directCommands:
218290
- name: --resource-group -g
219291
summary: |-
220292
Name of the resource group. You can configure the default group using `az configure --defaults group=<name>`.
293+
globalParameters:
294+
- name: --debug
295+
summary: |-
296+
Increase logging verbosity to show all debug logs.
297+
- name: --help -h
298+
summary: |-
299+
Show this help message and exit.
300+
- name: --only-show-errors
301+
summary: |-
302+
Only show errors, suppressing warnings.
303+
- name: --output -o
304+
defaultValue: "json"
305+
acceptedValues: "json, jsonc, none, table, tsv, yaml, yamlc"
306+
summary: |-
307+
Output format.
308+
- name: --query
309+
summary: |-
310+
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
311+
- name: --subscription
312+
summary: |-
313+
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
314+
- name: --verbose
315+
summary: |-
316+
Increase logging verbosity. Use --debug for full debug logs.
221317
- uid: az_aksarc_notice
222318
name: az aksarc notice
223319
summary: |-
@@ -236,6 +332,30 @@ directCommands:
236332
name: --output-filepath
237333
summary: |-
238334
Outputs filepath for NOTICE file.
335+
globalParameters:
336+
- name: --debug
337+
summary: |-
338+
Increase logging verbosity to show all debug logs.
339+
- name: --help -h
340+
summary: |-
341+
Show this help message and exit.
342+
- name: --only-show-errors
343+
summary: |-
344+
Only show errors, suppressing warnings.
345+
- name: --output -o
346+
defaultValue: "json"
347+
acceptedValues: "json, jsonc, none, table, tsv, yaml, yamlc"
348+
summary: |-
349+
Output format.
350+
- name: --query
351+
summary: |-
352+
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
353+
- name: --subscription
354+
summary: |-
355+
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
356+
- name: --verbose
357+
summary: |-
358+
Increase logging verbosity. Use --debug for full debug logs.
239359
- uid: az_aksarc_show
240360
name: az aksarc show
241361
summary: |-
@@ -260,6 +380,30 @@ directCommands:
260380
name: --resource-group -g
261381
summary: |-
262382
Name of the resource group. You can configure the default group using `az configure --defaults group=<name>`.
383+
globalParameters:
384+
- name: --debug
385+
summary: |-
386+
Increase logging verbosity to show all debug logs.
387+
- name: --help -h
388+
summary: |-
389+
Show this help message and exit.
390+
- name: --only-show-errors
391+
summary: |-
392+
Only show errors, suppressing warnings.
393+
- name: --output -o
394+
defaultValue: "json"
395+
acceptedValues: "json, jsonc, none, table, tsv, yaml, yamlc"
396+
summary: |-
397+
Output format.
398+
- name: --query
399+
summary: |-
400+
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
401+
- name: --subscription
402+
summary: |-
403+
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
404+
- name: --verbose
405+
summary: |-
406+
Increase logging verbosity. Use --debug for full debug logs.
263407
- uid: az_aksarc_update
264408
name: az aksarc update
265409
summary: |-
@@ -316,6 +460,30 @@ directCommands:
316460
- name: --tags
317461
summary: |-
318462
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.commands:
463+
globalParameters:
464+
- name: --debug
465+
summary: |-
466+
Increase logging verbosity to show all debug logs.
467+
- name: --help -h
468+
summary: |-
469+
Show this help message and exit.
470+
- name: --only-show-errors
471+
summary: |-
472+
Only show errors, suppressing warnings.
473+
- name: --output -o
474+
defaultValue: "json"
475+
acceptedValues: "json, jsonc, none, table, tsv, yaml, yamlc"
476+
summary: |-
477+
Output format.
478+
- name: --query
479+
summary: |-
480+
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
481+
- name: --subscription
482+
summary: |-
483+
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
484+
- name: --verbose
485+
summary: |-
486+
Increase logging verbosity. Use --debug for full debug logs.
319487
commands:
320488
- az_aksarc_create
321489
- az_aksarc_delete
@@ -339,29 +507,5 @@ commands:
339507
- az_aksarc_vnet_delete
340508
- az_aksarc_vnet_list
341509
- az_aksarc_vnet_show
342-
globalParameters:
343-
- name: --debug
344-
summary: |-
345-
Increase logging verbosity to show all debug logs.
346-
- name: --help -h
347-
summary: |-
348-
Show this help message and exit.
349-
- name: --only-show-errors
350-
summary: |-
351-
Only show errors, suppressing warnings.
352-
- name: --output -o
353-
defaultValue: "json"
354-
parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
355-
summary: |-
356-
Output format.
357-
- name: --query
358-
summary: |-
359-
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
360-
- name: --subscription
361-
summary: |-
362-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
363-
- name: --verbose
364-
summary: |-
365-
Increase logging verbosity. Use --debug for full debug logs.
366510
metadata:
367511
description: Manage provisioned clusters.

AKS-Arc/arc-gateway-aks-arc.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,24 @@
22
title: Simplify network configuration requirements with Azure Arc gateway (preview)
33
description: Learn how to enable Arc gateway on AKS Arc clusters to simplify network configuration requirements
44
ms.topic: how-to
5-
ms.date: 11/18/2024
5+
ms.date: 07/15/2025
66
author: sethmanheim
7-
ms.author: sethm
8-
ms.reviewer: abha
9-
ms.lastreviewed: 11/18/2024
10-
7+
ms.author: sethm
8+
ms.reviewer: srikantsarwa
9+
ms.lastreviewed: 07/15/2025
1110
---
1211

1312
# Simplify network configuration requirements with Azure Arc gateway (preview)
1413

1514
If you use enterprise proxies to manage outbound traffic, Azure Arc gateway can help simplify the process of enabling connectivity.
1615

17-
The Azure Arc gateway (currently in preview) lets you:
16+
The AKS Arc gateway (currently in preview) lets you:
1817

1918
- Connect to Azure Arc by opening public network access to only seven fully qualified domain names (FQDNs).
2019
- View and audit all traffic that the Arc agents send to Azure via the Arc gateway.
2120

2221
> [!IMPORTANT]
23-
> Azure Arc gateway is currently in preview.
22+
> AKS Arc gateway is currently in preview.
2423
>
2524
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
2625
@@ -29,7 +28,7 @@ The Azure Arc gateway (currently in preview) lets you:
2928
The Arc gateway works by introducing two new components:
3029

3130
- The **Arc gateway resource** is an Azure resource that serves as a common front end for Azure traffic. The gateway resource is served on a specific domain/URL. You must create this resource by following the steps described in this article. After you successfully create the gateway resource, this domain/URL is included in the success response.
32-
- The **Arc Proxy** is a new component that runs as its own pod (called *Azure Arc Proxy*). This component acts as a forward proxy used by Azure Arc agents and extensions. There is no configuration required on your part for the Azure Arc Proxy.
31+
- The **Arc Proxy** is a new component that runs as its own pod (called _Azure Arc Proxy_). This component acts as a forward proxy used by Azure Arc agents and extensions. There is no configuration required on your part for the Azure Arc Proxy.
3332

3433
For more information, see [how the Azure Arc gateway works](/azure/azure-arc/kubernetes/arc-gateway-simplify-networking?tabs=azure-cli).
3534

@@ -52,36 +51,36 @@ For more information, see [how the Azure Arc gateway works](/azure/azure-arc/kub
5251

5352
## Confirm access to required URLs
5453

55-
Ensure your Arc gateway URL and all of the URLs below are allowed through your enterprise firewall:
54+
Ensure your Arc gateway URL and all of the following URLs are allowed through your enterprise firewall:
5655

57-
|URL |Purpose |
58-
|---------|---------|
59-
|`[Your URL prefix].gw.arc.azure.com`| Your gateway URL. You can obtain this URL by running `az arcgateway list` after you create the resource. |
60-
|`management.azure.com` |Azure Resource Manager endpoint, required for the Azure Resource Manager control channel. |
61-
|`<region>.obo.arc.azure.com` |Required when `az connectedk8s proxy` is used. |
62-
|`login.microsoftonline.com`, `<region>.login.microsoft.com` | Microsoft Entra ID endpoint, used for acquiring identity access tokens. |
63-
|`gbl.his.arc.azure.com`, `<region>.his.arc.azure.com` |The cloud service endpoint for communicating with Arc Agents. Uses short names; for example `eus` for East US. |
64-
|`mcr.microsoft.com`, `*.data.mcr.microsoft.com` |Required to pull container images for Azure Arc agents. |
56+
| URL | Purpose |
57+
| ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
58+
| `[Your URL prefix].gw.arc.azure.com` | Your gateway URL. You can obtain this URL by running `az arcgateway list` after you create the resource. |
59+
| `management.azure.com` | Azure Resource Manager endpoint, required for the Azure Resource Manager control channel. |
60+
| `<region>.obo.arc.azure.com` | Required when `az connectedk8s proxy` is used. |
61+
| `login.microsoftonline.com`, `<region>.login.microsoft.com` | Microsoft Entra ID endpoint, used for acquiring identity access tokens. |
62+
| `gbl.his.arc.azure.com`, `<region>.his.arc.azure.com` | The cloud service endpoint for communicating with Arc Agents. Uses short names; for example, `eus` for East US. |
63+
| `mcr.microsoft.com`, `*.data.mcr.microsoft.com` | Required to pull container images for Azure Arc agents. |
6564

66-
## Create an AKS Arc cluster with Arc gateway enabled
65+
## Create an AKS Arc cluster with AKS Arc gateway enabled
6766

68-
Run the following command to create an AKS Arc cluster with the Arc gateway enabled:
67+
Run the following command to create an AKS Arc cluster with the AKS Arc gateway enabled:
6968

7069
```azurecli
7170
az aksarc create -n $clusterName -g $resourceGroup --custom-location $customlocationID --vnet-ids $arcVmLogNetId --aad-admin-group-object-ids $aadGroupID --gateway-id $gatewayId --generate-ssh-keys
7271
```
7372

74-
## Update an AKS Arc cluster and enable Arc gateway
73+
## Update an AKS Arc cluster and enable the AKS Arc gateway
7574

76-
Run the following command to update an AKS Arc cluster to enable Arc gateway:
75+
Run the following command to update an AKS Arc cluster to enable the AKS Arc gateway:
7776

7877
```azurecli
7978
az aksarc update -n $clusterName -g $resourceGroup --gateway-id $gatewayId
8079
```
8180

82-
## Disable Arc gateway on an AKS Arc cluster
81+
## Disable the AKS Arc gateway on an AKS Arc cluster
8382

84-
Run the following command to disable Arc gateway:
83+
Run the following command to disable the AKS Arc gateway:
8584

8685
```azurecli
8786
az aksarc update -n $clusterName -g $resourceGroup --disable-gateway
@@ -92,7 +91,7 @@ az aksarc update -n $clusterName -g $resourceGroup --disable-gateway
9291
To audit your gateway traffic, view the gateway router logs:
9392

9493
1. Run `kubectl get pods -n azure-arc`.
95-
1. Identify the Arc Proxy pod (its name will begin with `arc-proxy-`).
94+
1. Identify the Arc Proxy pod (its name begins with `arc-proxy-`).
9695
1. Run `kubectl logs -n azure-arc <Arc Proxy pod name>`.
9796

9897
## Other scenarios

AKS-Arc/azure-rbac-local.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,3 +222,4 @@ az role definition delete -n "AKS Arc Deployment Reader"
222222
- [Access and identity options](concepts-security-access-identity.md) for AKS enabled by Azure Arc
223223
- [Create an Azure service principal with Azure CLI](/cli/azure/azure-cli-sp-tutorial-1)
224224
- Available Azure permissions for [Hybrid + Multicloud](/azure/role-based-access-control/resource-provider-operations#microsoftkubernetes)
225+
- Help to protect your cluster in other ways by following the guidance in the [security book for AKS enabled by Azure Arc](/azure/azure-arc/kubernetes/conceptual-security-book?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json).

AKS-Arc/concepts-security-access-identity.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,4 @@ The following table contains a summary of how users can authenticate to Kubernet
154154

155155
- To get started with Kubernetes RBAC for Kubernetes authorization, see [Control access using Microsoft Entra ID and Kubernetes RBAC](kubernetes-rbac-local.md)
156156
- To get started with Azure RBAC for Kubernetes authorization, see [Use Azure RBAC for Kubernetes Authorization](azure-rbac-local.md)
157+
- Help to protect your cluster in other ways by following the guidance in the [security book for AKS enabled by Azure Arc](/azure/azure-arc/kubernetes/conceptual-security-book?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json).

AKS-Arc/configure-ssh-keys.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,4 @@ For information about error messages that can occur when you create and deploy a
8080
- [Connect to Windows or Linux worker nodes with SSH](ssh-connect-to-windows-and-linux-worker-nodes.md)
8181
- [Restrict SSH access to specific IP addresses](restrict-ssh-access.md)
8282
- [Get on-demand logs for troubleshooting](get-on-demand-logs.md)
83+
- Help to protect your cluster in other ways by following the guidance in the [security book for AKS enabled by Azure Arc](/azure/azure-arc/kubernetes/conceptual-security-book?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json).

AKS-Arc/enable-authentication-microsoft-entra-id.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,4 @@ Enable Microsoft Entra authentication on your existing Kubernetes cluster using
7575
- [Access and identity options for AKS enabled by Azure Arc](concepts-security-access-identity.md)
7676
- [Microsoft Entra integration with Kubernetes RBAC](kubernetes-rbac-local.md)
7777
- [Use Azure role-based access control (RBAC) for Kubernetes authorization](azure-rbac-local.md)
78+
- Help to protect your cluster in other ways by following the guidance in the [security book for AKS enabled by Azure Arc](/azure/azure-arc/kubernetes/conceptual-security-book?toc=/azure/aks/aksarc/toc.json&bc=/azure/aks/aksarc/breadcrumb/toc.json).

0 commit comments

Comments
 (0)