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
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,33 +23,33 @@ Azure Kubernetes Service (AKS) is one of the compute services supported by Servi
23
23
24
24
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.
25
25
26
-
1.**Add the Service Connector kubernetes extension**
26
+
### Add the Service Connector kubernetes extension
27
27
28
-
A kubernetes extension named `sc-extension` is added to the cluster when the first time a service connection is created, no matter what the target service and authentication type is. Later on, the extension helps create kubernetes resources in user's cluster whenever a service connection request comes to Service Connector. You can view the extension in the Azure portal of AKS.
28
+
A kubernetes extension named `sc-extension` is added to the cluster the first time a service connection is created. Later on, the extension helps create kubernetes resources in user's cluster, whenever a service connection request comes to Service Connector. You can find the extension in your AKS cluster in the Azure portal, in the Extensions + applications menu.
29
29
30
30
:::image type="content" source="./media/aks-tutorial/sc-extension.png" alt-text="Screenshot of the Azure portal, view AKS extension.":::
31
31
32
32
The extension is also where the cluster connections metadata are stored. Uninstalling the extension makes all the connections in the cluster unavailable. The extension operator is hosted in the cluster namespace `sc-system`.
33
33
34
-
2.**Create kubernetes resources**
34
+
### Create kubernetes resources
35
35
36
-
Service Connector creates some kubernetes resources to the namespace user specified when creating a service connection. The kubernetes resources store the connection information, which is needed by user's workload definitions or application codes to talk to target services. Depending on different authentication types, different kubernetes resources are created. For `Connection String` and `Service Principal` auth types, a kubernetes secret is created. And for`Workload Identity` auth type, a kubernetes service account is also created beside a kubernetes secret.
36
+
Service Connector creates some kubernetes resources to the namespace the user specified when creating a service connection. The kubernetes resources store the connection information, which is needed by the user's workload definitions or application code to talk to target services. Depending on different authentication types, different kubernetes resources are created. For the `Connection String` and `Service Principal` auth types, a kubernetes secret is created. For the`Workload Identity` auth type, a kubernetes service account is also created in addition to a kubernetes secret.
37
37
38
-
You can view the kubernetes resources created by Service Connector for each service connection on Azure portal.
38
+
You can find the kubernetes resources created by Service Connector for each service connection on the Azure portal in your kubernetes resource, in the Service Connector menu.
39
39
40
40
:::image type="content" source="./media/aks-tutorial/kubernetes-resources.png" alt-text="Screenshot of the Azure portal, view Service Connector created kubernetes resources.":::
41
41
42
-
The kubernetes resources aren't removed even if the corresponding service connection is deleted, in case it's being used by user's workloads. However, you can remove it manually (for example, with `kubectl delete` command) from your cluster whenever necessary.
42
+
Deleting a service connection doesn't delete the associated Kubernetes resource. If necessary, remove your resource manually, using for example the kubectl delete command.
43
43
44
-
3.**Enable the `azureKeyvaultSecretsProvider` addon**
44
+
### Enable the `azureKeyvaultSecretsProvider` addon
45
45
46
-
If target service is Azure Key Vault and the Secret Store CSI Driver is enabled when creating a service connection, Service Connector enables the `azureKeyvaultSecretsProvider`addon for the cluster.
46
+
If target service is Azure Key Vault and the Secret Store CSI Driver is enabled when creating a service connection, Service Connector enables the `azureKeyvaultSecretsProvider`add-on for the cluster.
47
47
48
48
:::image type="content" source="./media/aks-tutorial/keyvault-csi.png" alt-text="Screenshot of the Azure portal, enabling CSI driver for keyvault when creating a connection.":::
49
49
50
-
Follow the [tutorial](./tutorial-python-aks-keyvault-csi-driver.md)to set up a connection to Azure Key Vault using Secret Store CSI driver.
50
+
Follow the [Connect to Azure Key Vault using CSI driver tutorial](./tutorial-python-aks-keyvault-csi-driver.md)to set up a connection to Azure Key Vault using Secret Store CSI driver.
51
51
52
-
4.**Enable workload identity and OIDC issuer**
52
+
### Enable workload identity and OpenID Connect (OIDC) issuer
53
53
54
54
If the authentication type is `Workload Identity` when creating a service connection, Service Connector enables workload identity and OIDC issuer for the cluster.
55
55
@@ -61,7 +61,7 @@ When the authentication type is `Workload Identity`, a user-assigned managed ide
61
61
62
62
Different kubernetes resources are created when the target service type and authentication type are different. The following sections show how to use the Service Connector created kubernetes resources in your cluster workloads definition and application codes.
63
63
64
-
#### kubernetes secret
64
+
#### Kubernetes secret
65
65
66
66
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 snnipet is an example.
67
67
@@ -87,9 +87,9 @@ spec:
87
87
88
88
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.
89
89
90
-
#### kubernetes service account
90
+
#### Kubernetes service account
91
91
92
-
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 snnipet is an example.
92
+
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 snipet provides an example.
93
93
94
94
```yaml
95
95
apiVersion: batch/v1
@@ -119,7 +119,7 @@ You may check the tutorial to learn [how to connect to Azure Storage using workl
119
119
120
120
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.
121
121
122
-
#### **Check Service Connector kubernetes extension**
122
+
###Check Service Connector kubernetes extension
123
123
124
124
Service Connector kubernetes extension is built on top of [Azure Arc-enabled Kubernetes cluster extensions](../azure-arc/kubernetes/extensions.md). Use the following commands to investigate if there are any errors during the extension installation or updating.
125
125
@@ -129,7 +129,7 @@ Service Connector kubernetes extension is built on top of [Azure Arc-enabled Kub
129
129
az extension add --name k8s-extension
130
130
```
131
131
132
-
2. Get the Service Connector extension status. Check the `statuses` property in the command output to see if there are any errors.
132
+
1. Get the Service Connector extension status. Check the `statuses` property in the command output to see if there are any errors.
133
133
134
134
```azurecli
135
135
az k8s-extension show \
@@ -139,9 +139,9 @@ az k8s-extension show \
139
139
--name sc-extension
140
140
```
141
141
142
-
#### Check kubernetes cluster logs
142
+
### Check kubernetes cluster logs
143
143
144
-
If there's an error during the extension installation, and the error message in the `statuses` property isn't enough showing what happened, you can further check the kubernetes logs by the followings steps.
144
+
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.
145
145
146
146
1. Connect to your AKS cluster.
147
147
@@ -150,7 +150,7 @@ If there's an error during the extension installation, and the error message in
150
150
--resource-group MyClusterResourceGroup \
151
151
--name MyCluster
152
152
```
153
-
2. Service Connector extension is installed in the namespace `sc-system` through helm chart, check the namespace and the helm release by following commands.
153
+
1. Service Connector extension is installed in the namespace `sc-system` through helm chart, check the namespace and the helm release by following commands.
154
154
155
155
- Check the namespace exists.
156
156
@@ -163,7 +163,7 @@ If there's an error during the extension installation, and the error message in
163
163
```Bash
164
164
helm list -n sc-system
165
165
```
166
-
3. During the extension installation or updating, there's a kubernetes job called `sc-job` used to create the kubernetes resources for service connection. The job execution failure usually causes the extension failure, therefore, 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. Because this job is designed to be automatically deleted after successful execution.)
166
+
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.
Copy file name to clipboardExpand all lines: articles/service-connector/quickstart-cli-aks-connection.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.custom: devx-track-azurecli
11
11
---
12
12
# Quickstart: Create a service connection in AKS cluster with the Azure CLI
13
13
14
-
This quickstart shows you how to connect AKS to other Cloud resources using Azure CLI and Service Connector. Service Connector lets you quickly connect compute services to cloud services, while managing your connection's authentication and networking settings.
14
+
This quickstart shows you how to connect Azure Kubernetes Service (AKS) to other Cloud resources using Azure CLI and Service Connector. Service Connector lets you quickly connect compute services to cloud services, while managing your connection's authentication and networking settings.
0 commit comments