Skip to content

Commit

Permalink
update docs for Azure Mint mode removal
Browse files Browse the repository at this point in the history
  • Loading branch information
akhil-rane authored and abutcher committed Mar 21, 2022
1 parent 401992d commit c4339a1
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -128,7 +128,7 @@ Pros:
Cons:
* Requires admin credential storage in a cluster kube-system secret. (however if a user has access to all secrets in your cluster, you are severely compromised regardless)

Supported clouds: AWS, GCP, Azure
Supported clouds: AWS, GCP

### 1.1 Mint Mode With Removal/Rotation Of Admin Credential

Expand Down Expand Up @@ -193,12 +193,14 @@ Future supported clouds: AWS
Cloud | Mint | Mint + Remove Admin Cred | Passthrough | Manual | Token
--- | --- | --- | --- | --- | ---
AWS | Y | 4.4+ | Y | 4.3+ | 4.6+ (expected)
Azure | Y | N | Y | unknown | N
GCP | Y | N | Y | unknown | N
Azure | N<sup>1</sup> | N | Y | unknown | N
OpenStack | N | N | Y | N | N
oVirt | N | N | Y | N | N
VMWare | N | N | Y | N | N

1 - Mint mode was previously supported, but with the sunsetting of the Azure Active Directory Graph API, Mint mode support on Azure has since been [removed](./docs/azure-mint-mode-removal.md).

# Developer Instructions

Login to a cluster with admin credentials:
Expand Down
28 changes: 28 additions & 0 deletions docs/azure-mint-mode-removal.md
@@ -0,0 +1,28 @@
# Azure Mint Mode removal

## Summary

Azure is [removing support](https://techcommunity.microsoft.com/t5/azure-active-directory-identity/update-your-applications-to-use-microsoft-authentication-library/ba-p/1257363) for the Azure Active Directory Graph API that is used to create App Registrations, Service Principals, role assignments, and credentials for supporting Mint mode in Azure. CCO will pivot existing clusters to switch away from Mint mode to Passthrough mode.

## New installations

For new cluster installations, Passthrough and Manual modes will be the only supported modes of operation.

## Upgrades

For a cluster previously installed/running in Mint mode, CCO will update existing Secrets containing the credentials of previously minted App Registrations/Service Principals with the contents of the Secret kube-system/azure-credentials (normally containing the credentials used during installation). It is required that the permissions associated with the credentials in this Secret be sufficient to be used by all in-cluster components needing to interact with Azure APIs.

CCO will also try to clean up previously minted App Registrations/Service Principals while the Azure AD Graph API is still functional. If the cluster is upgraded to a version of OpenShift that no longer supports Mint mode after the Azure AD Graph API is sunset, CCO will set a condition (type "OrphanedCloudResource" with a message like "unable to clean up App Registration / Service Principal: APP-REGISTRATION-NAME-HERE") on the associated CredentialsRequest and will not treat the error as fatal. Cleanup after the Azure AD Graph API is sunset will require manual intervention using the Azure CLI tool or the Azure web console to remove the App Registrations/Service Principals that were unable to be cleaned up. Note that even after cleaning up the resource(s) manually, the condition will persist as CCO would no longer be able to verify that the cleanup has been performed.

Example of finding and removing an orphaned App Registration:
```bash
$ az ad app list --filter "displayname eq 'APP-REGISTRATION-NAME-HERE'" --query '[].objectId'
[
"038c2538-7c40-49f5-abe5-f59c59c29244"
]
$ az ad app delete --id 038c2538-7c40-49f5-abe5-f59c59c29244
```

## Future

Rather than re-implement support for Mint mode using the new [Microsoft Graph API](https://docs.microsoft.com/en-us/graph/sdks/create-requests?tabs=Go), the intention is to support Azure federated OpenID identities along with pod/workload identity as the preferred in-cluster credentials/authentication mode if/when Azure releases support for this feature.

0 comments on commit c4339a1

Please sign in to comment.