Skip to main content

Simply deployment of Django on Azure with Pulumi

Project description

Pulumi Django Deployment

This project aims to make a simple Django deployment on Azure easier.

To have a proper and secure environment, we need these components:

  • Storage account for media and static files
  • CDN endpoint in front with a domain name of our choosing
  • PostgreSQL server
  • Webapp with multiple custom host names and managed SSL for the website itself
  • Webapp running pgAdmin

Deployment steps

  1. Deploy without custom hosts (for CDN and websites)
  2. Configure the PostgreSQL server (create and grant permissions to role for your websites)
  3. Retrieve the deployment SSH key and configure your remote GIT repository with it
  4. Configure your CDN host (add the CNAME record)
  5. Configure your custom website domains (add CNAME/A record and TXT validation records)
  6. Re-deploy with custom hosts
  7. Re-deploy once more to enable HTTPS on website domains
  8. Manually activate HTTPS on the CDN host

Custom domain name for CDN

When deploying the first time, you will get a cdn_cname output. You need to create a CNAME to this domain before the deployment of the custom domain will succeed.

You can safely deploy with the failing CustomDomain to get the CNAME, create the record and then deploy again.

To enable HTTPS, you need to do this manually in the console. This is because of a limitation in the Azure API: https://github.com/Azure/azure-rest-api-specs/issues/17498

Custom domain names for web application

Because of a circular dependency in custom domain name bindings and certificates that is out of our control, you need to deploy the stack twice.

The first time will create the bindings without a certificate. The second deployment will then create the certificate for the domain (which is only possible if the binding exists), but also set the fingerprint of that certificate on the binding.

To make the certificate work, you need to create a TXT record named asuid point to the output of {your_app}_site_domain_verification_id. For example:

asuid.mywebsite.com.      TXT  "A1B2C3D4E5..."
asuid.www.mywebsite.com.  TXT  "A1B2C3D4E5..."

Database authentication

The PostgreSQL uses Entra ID authentication only, no passwords.

Administrator login

If you want to log in to the database yourself, you can add yourself as an administrator with the add_database_administrator function. Your username is your e-mailaddress, a temporary password can be obtained using az account get-access-token.

You can use this method to log in to pgAdmin.

Application

Refer to this documentation: https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-manage-azure-ad-users#create-a-role-using-microsoft-entra-object-identifier

In short, run something like this in the postgres database:

SELECT * FROM pgaadauth_create_principal_with_oid('web_managed_identity', 'c8b25b85-d060-4cfc-bad4-b8581cfdf946', 'service', false, false);

Replace the GUID of course with the managed identity our web app gets.

The name of the role is outputted by {your_app}_site_db_user

Be sure to grant this role the correct permissions too.

pgAdmin specifics

pgAdmin will be created with a default login:

Best practice is to log in right away, create a user for yourself and delete this default user.

Automate deployments

When using a service like GitLab, you can configure a Webhook to fire upon a push to your branch.

You need to download the deployment profile to obtain the deployment username and password, and then you can construct a URL like this:

https://{user}:{pass}@{appname}.scm.azurewebsites.net/deploy

https://{appname}.scm.azurewebsites.net/api/sshkey?ensurePublicKey=1

Be sure to configure the SSH key that Azure will use on GitLab side. You can obtain it using:

This would then trigger a redeploy everytime you make a commit to your live branch.

Change requests

I created this for internal use but since it took me a while to puzzle all the things together I decided to share it. Therefore this project is not super generic, but tailored to my needs. I am however open to pull or change requests to improve this project or to make it more usable for others.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi-django-azure-1.0.0.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

pulumi_django_azure-1.0.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file pulumi-django-azure-1.0.0.tar.gz.

File metadata

  • Download URL: pulumi-django-azure-1.0.0.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for pulumi-django-azure-1.0.0.tar.gz
Algorithm Hash digest
SHA256 2fd08bc7d1eae6874d9e5e8c9e02d0e0a7083e0f444f2bdf0fca2cf382762adb
MD5 29180f7221690bbfb5c4bb2f1a25059d
BLAKE2b-256 163d2e7df43059a8999756ab24e3bd1a1f797347c5643148172953de84631d3c

See more details on using hashes here.

File details

Details for the file pulumi_django_azure-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_django_azure-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a114f493ee47780f860b965d9c97bb90725a008c2f563ddf67961fa08e56300
MD5 8d69550fde6541abb184fbff960365da
BLAKE2b-256 93dd9fed323af3d85b997120d309d66cd9d8c1ed7372537aadbd00036600c13a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page