Skip to content

Commit a065082

Browse files
Update troubleshooting steps and formatting in AKS external identity provider documentation
1 parent 201a422 commit a065082

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

support/azure/azure-kubernetes/security/troubleshoot-aks-control-plane-authentication-external-identity-providers.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This article helps you troubleshoot authentication issues when you access the Az
2323
- Azure CLI version 2.61.0 or later. To determine the version, run `az --version`. If you have to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
2424
- A tool to connect to the Kubernetes cluster, such as the `kubectl` tool. To install `kubectl` by using Azure CLI, run the [az aks install-cli](/cli/azure/aks#az-aks-install-cli) command.
2525
- The JSON Web Token (JWT) authenticator configuration file that's used for your AKS cluster.
26-
- Access to [jwt.ms][jwt-ms] or a similar JWT token decoder tool for debugging tokens.
26+
- Access to [jwt.ms](https://jwt.ms) or a similar JWT token decoder tool for debugging tokens.
2727

2828
## Troubleshooting checklist
2929

@@ -227,7 +227,7 @@ Review the AKS API server logs for authentication errors. Follow these steps:
227227

228228
The audience claim in the token doesn't match the configured audience in the JWT authenticator.
229229

230-
### Solution: Update the authenticator configuration
230+
**Solution: Update the authenticator configuration**
231231

232232
Verify the audience claim in your token, and update the JWT authenticator configuration.
233233

@@ -243,15 +243,15 @@ az aks jwtauthenticator update \
243243

244244
The issuer URL in the configuration doesn't exactly match the `iss` claim in the token.
245245

246-
### Solution: Correct the issuer URL
246+
**Solution: Correct the issuer URL**
247247

248248
Update the issuer URL in your JWT authenticator configuration file to match the exact issuer in your tokens, including the protocol (https://) and any trailing slashes.
249249

250250
**Cause 3: Identity provider misconfiguration**
251251

252252
The OAuth client or OIDC provider settings are incorrect.
253253

254-
### Solution: Verify identity provider settings
254+
**Solution: Verify identity provider settings**
255255

256256
::: zone pivot="github"
257257

@@ -274,7 +274,7 @@ The OAuth client or OIDC provider settings are incorrect.
274274

275275
CEL expressions might have syntax errors or return unexpected data types.
276276

277-
### Solution: Verify CEL expressions
277+
**Solution: Verify CEL expressions**
278278

279279
1. Review the CEL expressions in your configuration.
280280
2. Test expressions by using a CEL evaluator to make sure that they return strings for username and arrays of strings for groups.
@@ -297,7 +297,7 @@ The following code is an example of a valid CEL expression for extracting groups
297297

298298
Issues that affect network security groups, firewalls, or the DNS prevent the cluster from accessing the identity provider.
299299

300-
### Solution 1: Verify DNS resolution
300+
**Solution 1: Verify DNS resolution**
301301

302302
1. Connect to a cluster node by using `kubectl debug`:
303303

@@ -323,7 +323,7 @@ Issues that affect network security groups, firewalls, or the DNS prevent the cl
323323

324324
::: zone-end
325325

326-
### Solution 2: Update network security rules
326+
**Solution 2: Update network security rules**
327327

328328
1. Review network security group rules that are associated with your AKS cluster.
329329
2. Make sure that outbound HTTPS (port 443) traffic is allowed to your identity provider's domain.
@@ -335,7 +335,7 @@ Issues that affect network security groups, firewalls, or the DNS prevent the cl
335335

336336
To prevent conflicts with other authentication methods, all usernames and groups must be prefixed by using `aks:jwt:`.
337337

338-
### Solution: Add the required prefix
338+
**Solution: Add the required prefix**
339339

340340
Update your JWT authenticator configuration to include the `aks:jwt:` prefix. For example:
341341

@@ -420,7 +420,7 @@ For GitHub Actions OIDC, create a file that's named `jwt-config.json` that has t
420420

421421
::: zone-end
422422

423-
1. Update the authenticator:
423+
Update the authenticator:
424424

425425
```azurecli-interactive
426426
az aks jwtauthenticator update \
@@ -442,7 +442,7 @@ To get more detailed information about authentication failures:
442442

443443
### Resources
444444

445-
- [jwt.ms site](https://jwt.ms)
445+
- [jwt-ms token decoder tool](https://jwt.ms)
446446
- [Supported resource logs for Microsoft.ContainerService/managedClusters](/azure/aks/monitor-aks-reference#supported-resource-logs-for-microsoftcontainerservicemanagedclusters)
447447

448448
[!INCLUDE [Azure Help Support](~/includes/azure-help-support.md)]

0 commit comments

Comments
 (0)