Skip to content

Commit 27f4457

Browse files
committed
update syntax and links
1 parent dc8f2f6 commit 27f4457

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

articles/service-connector/how-to-use-service-connector-in-aks.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Use Service Connector in Azure Kubernetes Service (AKS)
2+
title: How to use Service Connector in AKS
33
description: Learn how to use Service Connector to connect AKS to other Azure services. Learn about Service Connector operations, resource management, and troubleshooting.
44
author: houk-ms
55
ms.service: service-connector
6-
ms.topic: conceptual
6+
ms.topic: how-to
77
ms.date: 02/06/2025
88
ms.author: honc
99
---
1010

11-
# How to use Service Connector in Azure Kubernetes Service (AKS)
11+
# Use Service Connector in Azure Kubernetes Service (AKS)
1212

1313
Azure Kubernetes Service (AKS) is one of the compute services supported by Service Connector.
1414
This article aims to help you understand:
@@ -21,7 +21,7 @@ This article aims to help you understand:
2121

2222
* This guide assumes that you already know the [basic concepts of Service Connector](concept-service-connector-internals.md).
2323

24-
## Learn about operations performed by Service Connector on the AKS cluster
24+
## Operations performed by Service Connector on the AKS cluster
2525

2626
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.
2727

@@ -61,11 +61,11 @@ When the authentication type is `Workload Identity`, a user-assigned managed ide
6161

6262
## Use the Kubernetes resources created by Service Connector
6363

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.
6565

6666
### Kubernetes secret
6767

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.
6969

7070
```yaml
7171
apiVersion: batch/v1
@@ -87,11 +87,11 @@ spec:
8787

8888
```
8989

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.
9191

9292
### Kubernetes service account
9393

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.
9595

9696
```yaml
9797
apiVersion: batch/v1
@@ -115,23 +115,23 @@ spec:
115115
restartPolicy: OnFailure
116116
```
117117
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).
119119
120120
## Troubleshoot and view logs
121121
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.
123123
124124
### Check Service Connector Kubernetes extension
125125
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.
127127
128128
1. Install the `k8s-extension` Azure CLI extension.
129129

130130
```azurecli
131131
az extension add --name k8s-extension
132132
```
133133

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.
135135

136136
```azurecli
137137
az k8s-extension show \
@@ -143,7 +143,7 @@ Service Connector Kubernetes extension is built on top of [Azure Arc-enabled Kub
143143

144144
### Check Kubernetes cluster logs
145145

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.
147147

148148
1. Connect to your AKS cluster.
149149

@@ -152,7 +152,7 @@ If there's an error during the extension installation, and the error message in
152152
--resource-group MyClusterResourceGroup \
153153
--name MyCluster
154154
```
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.
156156

157157
- Check the namespace exists.
158158

@@ -165,7 +165,8 @@ If there's an error during the extension installation, and the error message in
165165
```Bash
166166
helm list -n sc-system
167167
```
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.
169170

170171
- Check the job exists.
171172

@@ -221,7 +222,7 @@ Refer to [Helm errors](/troubleshoot/azure/azure-kubernetes/extensions/cluster-e
221222

222223
**Reason:**
223224

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.
225226

226227
**Mitigation:**
227228

articles/service-connector/quickstart-portal-aks-connection.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
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
33
description: Quickstart showing how to create a service connection in Azure Kubernetes Service (AKS) from the Azure portal
44
author: houk-ms
55
ms.author: honc
66
ms.service: service-connector
77
ms.topic: quickstart
88
ms.date: 01/28/2025
99
---
10+
1011
# Quickstart: Create a service connection in an AKS cluster from the Azure portal
1112

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.
1314

1415
## Prerequisites
1516

@@ -60,14 +61,17 @@ Sign in to the Azure portal at [https://portal.azure.com/](https://portal.azure.
6061
---
6162

6263
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+
6365
> [!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+
6568
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.
6669

6770
## View service connections in AKS cluster
6871

6972
1. **Service Connector** displays existing connections in this cluster.
7073
1. Select **Network View** to see all the service connections in a network topology view.
74+
7175
:::image type="content" source="./media/aks-quickstart/list-and-view.png" alt-text="Screenshot of the Azure portal, listing and viewing the connections.":::
7276

7377
## Update your container
@@ -86,12 +90,8 @@ Now that you created a connection between your AKS cluster and target service, y
8690

8791
:::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.":::
8892

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
9594

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

Comments
 (0)