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/service-connector/how-to-use-service-connector-in-aks.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
---
2
-
title: Use Service Connector in Azure Kubernetes Service (AKS)
2
+
title: How to use Service Connector in AKS
3
3
description: Learn how to use Service Connector to connect AKS to other Azure services. Learn about Service Connector operations, resource management, and troubleshooting.
4
4
author: houk-ms
5
5
ms.service: service-connector
6
-
ms.topic: conceptual
6
+
ms.topic: how-to
7
7
ms.date: 02/06/2025
8
8
ms.author: honc
9
9
---
10
10
11
-
# How to use Service Connector in Azure Kubernetes Service (AKS)
11
+
# Use Service Connector in Azure Kubernetes Service (AKS)
12
12
13
13
Azure Kubernetes Service (AKS) is one of the compute services supported by Service Connector.
14
14
This article aims to help you understand:
@@ -21,7 +21,7 @@ This article aims to help you understand:
21
21
22
22
* This guide assumes that you already know the [basic concepts of Service Connector](concept-service-connector-internals.md).
23
23
24
-
## Learn about operations performed by Service Connector on the AKS cluster
24
+
## Operations performed by Service Connector on the AKS cluster
25
25
26
26
Depending on the different target services and authentication types selected when creating a service connection, Service Connector makes different operations on the AKS cluster. The following lists the possible operations made by Service Connector.
27
27
@@ -61,11 +61,11 @@ When the authentication type is `Workload Identity`, a user-assigned managed ide
61
61
62
62
## Use the Kubernetes resources created by Service Connector
63
63
64
-
Various Kubernetes resources are created by Service Connector depending on the target service type and authentication type. The following sections show how to use the Service Connector created Kubernetes resources in your cluster workloads definition and application codes.
64
+
Various Kubernetes resources are created by Service Connector depending on the target service type and authentication type. The following sections show how to use the Kubernetes resources created by Service Connector in your cluster workloads definition and application code.
65
65
66
66
### Kubernetes secret
67
67
68
-
A Kubernetes secret is created when the authentication type is `Connection String` or `Service Principal`. Your cluster workload definition can reference the secret directly. The following snippet is an example.
68
+
A Kubernetes secret is created when the authentication type is set to either `Connection String` or `Service Principal`. Your cluster workload definition can reference the secret directly. The following snippet provides an example.
69
69
70
70
```yaml
71
71
apiVersion: batch/v1
@@ -87,11 +87,11 @@ spec:
87
87
88
88
```
89
89
90
-
Then, your application codes can consume the connection string in the secret from environment variable. You can check the [sample code](./how-to-integrate-storage-blob.md) to learn more about the environment variable names and how to use them in your application codes to authenticate to different target services.
90
+
Your application code can consume the connection string in the secret from an environment variable. Check the following [sample code](./how-to-integrate-storage-blob.md) to learn more about the environment variable names and how to use them in your application code to authenticate to different target services.
91
91
92
92
### Kubernetes service account
93
93
94
-
Both a Kubernetes service account and a secret are created when the authentication type is `Workload Identity`. Your cluster workload definition can reference the service account and secret to authenticate through workload identity. The following snippet provides an example.
94
+
A Kubernetes service account and a secret are created when the authentication type is set to`Workload Identity`. Your cluster workload definition can reference the service account and secret to authenticate through workload identity. The following snippet provides an example.
95
95
96
96
```yaml
97
97
apiVersion: batch/v1
@@ -115,23 +115,23 @@ spec:
115
115
restartPolicy: OnFailure
116
116
```
117
117
118
-
You may check the tutorial to learn [how to connect to Azure Storage using workload identity](tutorial-python-aks-storage-workload-identity.md).
118
+
Check the following tutorial to learn [how to connect to Azure Storage using workload identity](tutorial-python-aks-storage-workload-identity.md).
119
119
120
120
## Troubleshoot and view logs
121
121
122
-
If an error happens and couldn't be mitigated by retrying when creating a service connection, the following methods can help gather more information for troubleshooting.
122
+
If an error occurs and can't be resolved by retrying when creating a service connection, the following methods help gather more information for troubleshooting.
123
123
124
124
### Check Service Connector Kubernetes extension
125
125
126
-
Service Connector Kubernetes extension is built on top of [Azure Arc-enabled Kubernetes cluster extensions](/azure/azure-arc/kubernetes/extensions). Use the following commands to investigate if there are any errors during the extension installation or updating.
126
+
The Service Connector Kubernetes extension is built on top of [Azure Arc-enabled Kubernetes cluster extensions](/azure/azure-arc/kubernetes/extensions). Use the following commands to check for any errors that occurred during the extension installation or update process.
127
127
128
128
1. Install the `k8s-extension` Azure CLI extension.
129
129
130
130
```azurecli
131
131
az extension add --name k8s-extension
132
132
```
133
133
134
-
1. Get the Service Connector extension status. Check the `statuses` property in the command output to see if there are any errors.
134
+
1. Retrieve the status of the Service Connector extension. Check the `statuses` property in the command output to identify any errors.
135
135
136
136
```azurecli
137
137
az k8s-extension show \
@@ -143,7 +143,7 @@ Service Connector Kubernetes extension is built on top of [Azure Arc-enabled Kub
143
143
144
144
### Check Kubernetes cluster logs
145
145
146
-
If there's an error during the extension installation, and the error message in the `statuses` property doesn't provide enough information about what happened, you can further check the Kubernetes logs with the followings steps.
146
+
If an error occurs during the extension installation and the error message in the `statuses` property doesn't provide sufficient information, you can further investigate by checking the Kubernetes logs with the followings steps.
147
147
148
148
1. Connect to your AKS cluster.
149
149
@@ -152,7 +152,7 @@ If there's an error during the extension installation, and the error message in
152
152
--resource-group MyClusterResourceGroup \
153
153
--name MyCluster
154
154
```
155
-
1. Service Connector extension is installed in the namespace `sc-system` through helm chart, check the namespace and the helm release by following commands.
155
+
1. The Service Connector extension is installed in the `sc-system` namespace using a Helm chart. Check the namespace and the Helm release uding the following commands.
156
156
157
157
- Check the namespace exists.
158
158
@@ -165,7 +165,8 @@ If there's an error during the extension installation, and the error message in
165
165
```Bash
166
166
helm list -n sc-system
167
167
```
168
-
1. During the extension installation or updating, a Kubernetes job called `sc-job` creates the Kubernetes resources for the service connection. The job execution failure usually causes the extension failure. Check the job status by running the following commands. If `sc-job` doesn't exist in `sc-system` namespace, it should have been executed successfully. This job is designed to be automatically deleted after successful execution.
168
+
169
+
1. During the extension installation or update, a Kubernetes job called `sc-job` creates the Kubernetes resources for the service connection. A job execution failure typically causes the extension to fail. Check the job status by running the following commands. If `sc-job` doesn't exist in the `sc-system` namespace, it should have been executed successfully. This job is designed to be automatically deleted after successful execution.
169
170
170
171
- Check the job exists.
171
172
@@ -221,7 +222,7 @@ Refer to [Helm errors](/troubleshoot/azure/azure-kubernetes/extensions/cluster-e
221
222
222
223
**Reason:**
223
224
224
-
This error usually occurs when attempting to create a service connection while the Azure Kubernetes Service (AKS) cluster is in an updating state. The service connection update conflicts with the ongoing update. This error also occurs when your subscription is not registered with the `Microsoft.KubernetesConfiguration` resource provider.
225
+
This error typically occurs when attempting to create a service connection while the Azure Kubernetes Service (AKS) cluster is in an updating state. The service connection update conflicts with the ongoing update. This error also occurs when your subscription is not registered with the `Microsoft.KubernetesConfiguration` resource provider.
Copy file name to clipboardExpand all lines: articles/service-connector/quickstart-portal-aks-connection.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,16 @@
1
1
---
2
-
title: Quickstart - Create a service connection in Azure Kubernetes Service (AKS) from the Azure portal
2
+
title: Create a service connection in AKS from the Azure portal
3
3
description: Quickstart showing how to create a service connection in Azure Kubernetes Service (AKS) from the Azure portal
4
4
author: houk-ms
5
5
ms.author: honc
6
6
ms.service: service-connector
7
7
ms.topic: quickstart
8
8
ms.date: 01/28/2025
9
9
---
10
+
10
11
# Quickstart: Create a service connection in an AKS cluster from the Azure portal
11
12
12
-
Get started with Service Connector by using the Azure portal to create a new service connection in an Azure Kubernetes Service (AKS) cluster.
13
+
In this quickstart, you create a new service connection in an Azure Kubernetes Service (AKS) cluster to connect your AKS resource to other Azure services.
13
14
14
15
## Prerequisites
15
16
@@ -60,14 +61,17 @@ Sign in to the Azure portal at [https://portal.azure.com/](https://portal.azure.
60
61
---
61
62
62
63
1. Select **Next: Networking** to configure the network access to your target service and select **Configure firewall rules to enable access to your target service**.
64
+
63
65
> [!NOTE]
64
-
> Service Connector for AKS now supports only the firewall option. Private link and service endpoint options are not supported.
66
+
> Service Connector for AKS currently only supports the firewall option. Private link and service endpoint aren't supported.
67
+
65
68
1. Select **Next: Review + Create** to review the provided information. Then select **Create** to create the service connection. This operation may take a minute to complete.
66
69
67
70
## View service connections in AKS cluster
68
71
69
72
1.**Service Connector** displays existing connections in this cluster.
70
73
1. Select **Network View** to see all the service connections in a network topology view.
74
+
71
75
:::image type="content" source="./media/aks-quickstart/list-and-view.png" alt-text="Screenshot of the Azure portal, listing and viewing the connections.":::
72
76
73
77
## Update your container
@@ -86,12 +90,8 @@ Now that you created a connection between your AKS cluster and target service, y
86
90
87
91
:::image type="content" source="media/aks-quickstart/kubernetes-snippet.png" alt-text="Screenshot of the Azure portal showing the Kubernetes snippet to create a new connection in AKS.":::
88
92
89
-
## Next steps
90
-
91
-
Follow the following tutorials to start connecting to Azure services on AKS cluster with Service Connector.
92
-
93
-
> [!div class="nextstepaction"]
94
-
> [Tutorial: Connect to Azure Key Vault using CSI driver](./tutorial-python-aks-keyvault-csi-driver.md)
93
+
## Related links
95
94
96
-
> [!div class="nextstepaction"]
97
-
> [Tutorial: Connect to Azure Storage using workload identity](./tutorial-python-aks-storage-workload-identity.md)
95
+
-[Tutorial: Connect to Azure Key Vault using CSI driver](./tutorial-python-aks-keyvault-csi-driver.md)
96
+
-[Tutorial: Connect to Azure Storage using workload identity](./tutorial-python-aks-storage-workload-identity.md)
97
+
-[Use Service Connector in AKS](./how-to-use-service-connector-in-aks.md)
0 commit comments