docs: add note about pod identity deprecation

Signed-off-by: Anish Ramasekar <anish.ramasekar@gmail.com>
Azure · Nov 9, 2022 · 9bf4588 · 9bf4588
1 parent 384c8e7
commit 9bf4588
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 11 deletions.
diff --git a/website/content/en/configurations/identity-access-modes/_index.md b/website/content/en/configurations/identity-access-modes/_index.md
@@ -11,9 +11,9 @@ description: >
 
 Following order of access modes is recommended for Secret Store CSI driver AKV provider:
 
-| Access Option                                          | Comment                                                                                                                                                                                                        |
-| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Workload Identity (Preview) [**RECOMMENDED**]          | This is currently in preview. It's a secure way to access Key Vault based on the [Workload Identity Federation](https://docs.microsoft.com/en-us/azure/active-directory/develop/workload-identity-federation). |
-| Pod Identity                                           | This is the most secure way to get access to Azure resources (AKV in this case) as it uses the managed identity bound to the Pod.                                                                              |
-| Managed Identities (System-assigned and User-assigned) | Managed identities eliminate the need for developers to manage credentials. Managed identities provide an identity for applications to use when connecting to Azure Keyvault.                                  |
-| Service Principal                                      | This is the last option to consider while connecting to AKV as access credentials need to be created as Kubernetes Secret and stored in plain text in etcd.                                                    |
+| Access Option                                          | Comment                                                                                                                                                                                                                                                                    |
+| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Workload Identity (Preview) [**RECOMMENDED**]          | This is the most secure way to access Key Vault based on the [Workload Identity Federation](https://docs.microsoft.com/en-us/azure/active-directory/develop/workload-identity-federation).                                                                                 |
+| Pod Identity [**NOT RECOMMENDED**]                     | [AAD Pod Identity](https://github.com/Azure/aad-pod-identity) has been [DEPRECATED](https://github.com/Azure/aad-pod-identity#-announcement).<br>This provides a way to get access to Azure resources (AKV in this case) using the managed identity bound to the Pod.</br> |
+| Managed Identities (System-assigned and User-assigned) | Managed identities eliminate the need for developers to manage credentials. Managed identities provide an identity for applications to use when connecting to Azure Keyvault.                                                                                              |
+| Service Principal                                      | This is the last option to consider while connecting to AKV as access credentials need to be created as Kubernetes Secret and stored in plain text in etcd.                                                                                                                |
diff --git a/website/content/en/configurations/identity-access-modes/pod-identity-mode.md b/website/content/en/configurations/identity-access-modes/pod-identity-mode.md
@@ -2,7 +2,7 @@
 type: docs
 title: "Pod Identity"
 linkTitle: "Pod Identity"
-weight: 2
+weight: 4
 description: >
   Use Pod Identity to access Keyvault.
 ---
@@ -68,6 +68,8 @@ spec:
 
 ## Configure AAD Pod Identity to access Keyvault
 
+> NOTE: [AAD Pod Identity](https://github.com/Azure/aad-pod-identity) has been [DEPRECATED](https://github.com/Azure/aad-pod-identity#-announcement). We recommend using [Workload Identity](../workload-identity-mode) instead.
+
 **Prerequisites**
 
 💡 Make sure you have installed pod identity to your Kubernetes cluster

diff --git a/website/content/en/configurations/identity-access-modes/service-principal-mode.md b/website/content/en/configurations/identity-access-modes/service-principal-mode.md
@@ -2,7 +2,7 @@
 type: docs
 title: "Service Principal"
 linkTitle: "Service Principal"
-weight: 1
+weight: 3
 description: >
   Use a Service Principal to access Keyvault. 
 ---

diff --git a/...ite/content/en/configurations/identity-access-modes/system-assigned-msi-mode.md b/...ite/content/en/configurations/identity-access-modes/system-assigned-msi-mode.md
@@ -2,7 +2,7 @@
 type: docs
 title: "System-assigned Managed Identity"
 linkTitle: "System-assigned Managed Identity"
-weight: 4
+weight: 2
 description: >
   Use a System-assigned Managed Identity to access Keyvault.
 ---

diff --git a/website/content/en/configurations/identity-access-modes/user-assigned-msi-mode.md b/website/content/en/configurations/identity-access-modes/user-assigned-msi-mode.md
@@ -2,7 +2,7 @@
 type: docs
 title: "User-assigned Managed Identity"
 linkTitle: "User-assigned Managed Identity"
-weight: 3
+weight: 2
 description: >
   Use a User-assigned Managed Identity to access Keyvault.
 ---

diff --git a/website/content/en/configurations/identity-access-modes/workload-identity-mode.md b/website/content/en/configurations/identity-access-modes/workload-identity-mode.md
@@ -1,6 +1,6 @@
 ---
 type: docs
-title: "Workload Identity (Preview)"
+title: "Workload Identity"
 linkTitle: "Workload Identity"
 weight: 1
 description: >