microsoft/aks-postgre-keyrotation

This example project demonstrates how to handle secret rotation from a web application running in Azure Kubernetes Service, stores the secrets into KeyVault and then uses those secrets to access an Azure PostgreSQL instance.

page_type	languages	products	description
sample	csharp	azure azure-key-vault azure-kubernetes-service	This example project demonstrates how to handle secret rotation from a web application running in Azure Kubernetes Service. The example stores the secrets in Azure KeyVault and then uses those secrets to access an Azure PostgreSQL instance.

Blue / Green Secret Rotation with Azure KeyVault and AKS

General

This example project demonstrates how to handle secret rotation from a web application running in Azure Kubernetes Service. The example stores the secrets in Azure KeyVault and then uses those secrets to access an Azure PostgreSQL instance.

This generally requires changes to be done for the source application, the ability to store the secret in a secure vault and updates on the destination application. This is really tricky to do in a way that requires zero down time.

The reason why we are attempting to accomplish this with zero downtime is to remove the friction and high cost of deploying changes to an environment so we can more frequently rotate secrets.

Please see Getting Started for information on how to run the code.

To utilize this example effectively, we recommend creating a fork of this repository into your own GitHub account and then referencing that to make changes to the repository.

Blue / Green Deployment

One approach to handling the source application updates when using Azure Kubernetes Service is to utilize Azure Application Gateway and handle Blue / Green deployments using helm and the Ingress controller that comes with Azure Application Gateway.

In this diagram we are showing how Azure Pipelines can be used to orchestrate each stage of the overall key rotation process.

Steps and Process

1. Application is Live in Production
2. User will run the KeyRotation pipeline
   1. The pipeline generates a new secret.
   2. The pipeline then updates Azure PostgreSQL by activating the secondary role and changing that role's password.
   3. The pipeline then updates KeyVault's definition of that second password.
   4. The pipeline will then update the source application, in our case it's just rotating one slot with the other slot.
   5. Then integration testing runs to ensure basic end to end functionality.
3. Once everything runs the user deploying the key rotation will manually validate that production is setup properly.
4. Once that validation is done, then the user can run another pipeline to delete the old production pod.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

aks-postgre-keyrotation's Issues

Docs do not provide introductions for tech stack

For each tech stack choice (Helm, Azure Pipelines, AKS, etc) we do not provide good docs around how to use those technologies for folks who have never used it before.

Getting Started link is relative and not working from other doc pages

When I look at this content from https://docs.microsoft.com/en-us/samples/microsoft/aks-postgre-keyrotation/blue--green-secret-rotation-with-azure-keyvault-and-aks/, the Getting Started link is broken, it's relative on this page and won't load correctly from the sample page
https://github.com/microsoft/aks-postgre-keyrotation/blob/master/docs/getting-started.md