Skip to content

Commit

Permalink
docs: Remove duplicate Azure Identity SDK content (#1082)
Browse files Browse the repository at this point in the history
Co-authored-by: Anish Ramasekar <[email protected]>
  • Loading branch information
scottaddie and aramase committed Sep 5, 2023
1 parent cd6b64e commit c3d587a
Show file tree
Hide file tree
Showing 29 changed files with 5 additions and 1,770 deletions.
90 changes: 0 additions & 90 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,85 +54,6 @@ updates:
patterns:
- "k8s.io/*"

- package-ecosystem: docker
directory: /examples/azure-identity/dotnet
schedule:
interval: weekly
commit-message:
prefix: "chore"

- package-ecosystem: nuget
directory: /examples/azure-identity/dotnet
schedule:
interval: weekly
commit-message:
prefix: "chore"
groups:
all:
patterns:
- "*"

- package-ecosystem: docker
directory: /examples/azure-identity/go
schedule:
interval: weekly
commit-message:
prefix: "chore"

- package-ecosystem: gomod
directory: /examples/azure-identity/go
schedule:
interval: weekly
commit-message:
prefix: "chore"
groups:
all:
patterns:
- "*"

- package-ecosystem: docker
directory: /examples/azure-identity/java
schedule:
interval: weekly
commit-message:
prefix: "chore"

- package-ecosystem: docker
directory: /examples/azure-identity/node
schedule:
interval: weekly
commit-message:
prefix: "chore"

- package-ecosystem: npm
directory: /examples/azure-identity/node
schedule:
interval: weekly
commit-message:
prefix: "chore"
groups:
all:
patterns:
- "*"

- package-ecosystem: docker
directory: /examples/azure-identity/python
schedule:
interval: weekly
commit-message:
prefix: "chore"

- package-ecosystem: pip
directory: /examples/azure-identity/python
schedule:
interval: weekly
commit-message:
prefix: "chore"
groups:
all:
patterns:
- "*"

- package-ecosystem: docker
directory: /examples/msal-go
schedule:
Expand Down Expand Up @@ -212,17 +133,6 @@ updates:
patterns:
- "*"

- package-ecosystem: maven
directory: /examples/azure-identity/java
schedule:
interval: weekly
commit-message:
prefix: "chore"
groups:
all:
patterns:
- "*"

- package-ecosystem: maven
directory: /examples/msal-java
schedule:
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
- [Examples](./topics/self-managed-clusters/examples.md)
- [Kubernetes in Docker (kind)](./topics/self-managed-clusters/examples/kind.md)
- [Language-Specific Examples](./topics/language-specific-examples.md)
- [Azure Identity SDK](./topics/language-specific-examples/azure-identity-sdk.md)
- [Azure Identity client libraries](./topics/language-specific-examples/azure-identity-sdk.md)
- [Microsoft Authentication Library (MSAL)](./topics/language-specific-examples/msal.md)
- [Metrics](./topics/metrics.md)
- [Frequently Asked Questions](./faq.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ Required permissions to create/update/delete federated identity credential:

## How to migrate from `aad-pod-identity`?

You can refer to [this link](https://learn.microsoft.com/en-us/azure/aks/workload-identity-migrate-from-pod-identity) for more information.
You can refer to [this link](https://learn.microsoft.com/azure/aks/workload-identity-migrate-from-pod-identity) for more information.

tl;dr:

1. If you use DefaultAzureCredential in your workload, you can update the azure identity sdk version to the latest that supports workload identity (ref: [link](https://azure.github.io/azure-workload-identity/docs/topics/language-specific-examples/azure-identity-sdk.html)).
1. If you use `DefaultAzureCredential` in your workload, you can update the Azure Identity client library version to the latest that supports Workload Identity (ref: [link](https://azure.github.io/azure-workload-identity/docs/topics/language-specific-examples/azure-identity-sdk.html)).
2. If you still have workloads that get managed identity token from IMDS, you can annotate the pod to get a proxy sidecar injected, that'll do the token exchange with the new flow.

## Does Workload Identity work in disconnected environments?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,33 +1,3 @@
# Azure Identity SDK
# Azure Identity client libraries

In the Azure Identity client libraries, choose one of the following approaches:

- Use `DefaultAzureCredential`, which will attempt to use the `WorkloadIdentityCredential`.
- Create a `ChainedTokenCredential` instance that includes `WorkloadIdentityCredential`.
- Use `WorkloadIdentityCredential` directly.

The following client libraries are the **minimum** version required and recommended:

* `Minimum Recommended Version` - The version of the client library that is recommended for use with Workload Identity.
* This version is the minimum version that includes the `WorkloadIdentityCredential` in addition to the `DefaultAzureCredential`.
* `Minimum Version Required for Workload Identity` - The minimum version of the client library that will work with Workload Identity (i.e. the version that supports workload identity with the `DefaultAzureCredential`).

| Language | Library | Minimum Recommended Version | Minimum Version Required for Workload Identity |
| --------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| Go | [azure-sdk-for-go](https://github.com/Azure/azure-sdk-for-go) | [sdk/azidentity/v1.3.0](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/[email protected]) | [sdk/azidentity/v1.3.0](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/[email protected]) |
| C# | [azure-sdk-for-net](https://github.com/Azure/azure-sdk-for-net) | [Azure.Identity_1.9.0](https://github.com/Azure/azure-sdk-for-net/releases/tag/Azure.Identity_1.9.0) | [Azure.Identity_1.5.0](https://github.com/Azure/azure-sdk-for-net/releases/tag/Azure.Identity_1.5.0) |
| JavaScript/TypeScript | [azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js) | [@azure/identity_3.2.0](https://github.com/Azure/azure-sdk-for-js/releases/tag/@azure/identity_3.2.0) | [@azure/identity_2.0.0](https://github.com/Azure/azure-sdk-for-js/releases/tag/@azure/identity_2.0.0) |
| Python | [azure-sdk-for-python](https://github.com/Azure/azure-sdk-for-python) | [azure-identity_1.13.0](https://github.com/Azure/azure-sdk-for-python/releases/tag/azure-identity_1.13.0) | [azure-identity_1.7.0](https://github.com/Azure/azure-sdk-for-python/releases/tag/azure-identity_1.7.0) |
| Java | [azure-sdk-for-java](https://github.com/Azure/azure-sdk-for-java) | [azure-identity_1.9.0](https://github.com/Azure/azure-sdk-for-java/releases/tag/azure-identity_1.9.0) | [azure-identity_1.4.0](https://github.com/Azure/azure-sdk-for-java/releases/tag/azure-identity_1.4.0) |

## Examples

### Using `DefaultAzureCredential`

| Language | Library | Example |
| --------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| Go | [azure-sdk-for-go](https://github.com/Azure/azure-sdk-for-go) | [Link](https://github.com/Azure/azure-workload-identity/tree/main/examples/azure-identity/go) |
| Python | [azure-sdk-for-python](https://github.com/Azure/azure-sdk-for-python) | [Link](https://github.com/Azure/azure-workload-identity/tree/main/examples/azure-identity/python) |
| JavaScript/TypeScript | [azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js) | [Link](https://github.com/Azure/azure-workload-identity/tree/main/examples/azure-identity/node) |
| C# | [azure-sdk-for-net](https://github.com/Azure/azure-sdk-for-net) | [Link](https://github.com/Azure/azure-workload-identity/tree/main/examples/azure-identity/dotnet) |
| Java | [azure-sdk-for-java](https://github.com/Azure/azure-sdk-for-java) | [Link](https://github.com/Azure/azure-workload-identity/tree/main/examples/azure-identity/java) |
For details on Workload Identity support in the Azure Identity client libraries, see [Azure Identity client libraries](https://learn.microsoft.com/azure/aks/workload-identity-overview#azure-identity-client-libraries).
12 changes: 0 additions & 12 deletions examples/azure-identity/dotnet/Dockerfile

This file was deleted.

63 changes: 0 additions & 63 deletions examples/azure-identity/dotnet/Makefile

This file was deleted.

28 changes: 0 additions & 28 deletions examples/azure-identity/dotnet/Program.cs

This file was deleted.

13 changes: 0 additions & 13 deletions examples/azure-identity/dotnet/akvdotnet.csproj

This file was deleted.

29 changes: 0 additions & 29 deletions examples/azure-identity/go/Dockerfile

This file was deleted.

64 changes: 0 additions & 64 deletions examples/azure-identity/go/Makefile

This file was deleted.

Loading

0 comments on commit c3d587a

Please sign in to comment.