Deploy Unique SDK Modules GitHub Action

This GitHub Action is designed to automate the deployment of Python modules developed with the Unique SDK to Azure Container Apps. It encapsulates the process of checking module requirements, setting up Azure CLI, logging into Azure Container Registry (ACR), building and pushing Docker images, and deploying the container app with specified scaling settings.

Upgrading

Tip

As this action is yet immature, it is subject to frequent changes. Please check CHANGELOG on how to upgrade.

Inputs

The action requires the following inputs:

• module: Name of the module to deploy. (Required)
• environment: Name of the environment to deploy the module to. (Required)
• resource_group_name: Name of the resource group to deploy the module to. (Required)
• acr_login_server: Azure Container Registry login server. (Required)
• azure_client_id: Azure client ID. (Required)
• azure_tenant_id: Azure tenant ID. (Required)
• azure_subscription_id: Azure subscription ID. (Required)
• acr_username: Azure Container Registry username. (Required)
• acr_password: Azure Container Registry password. (Required)
• age_private_key: Age private key. (Required)
• azure_storage_account_id: Azure Storage Account ID to store logs. (Required)

The action also supports the following optional inputs:

• app_name: Name of the Flask app (and file). Don't confuse it with the name of the container that is deployed. The container name is automatically defined. Default: app
• encrypted_env_file: Name of the encrypted environment file. Default: .env.enc
• dockerfile: Dockerfile for the container app. Default: ./Dockerfile
• sops_version: Version of sops to use. Default: 3.8.1
• poetry_version: Version of poetry to use. Default: 1.7.1
• min_replicas: Minimum number of replicas for the container app. Default: 1
• max_replicas: Maximum number of replicas for the container app. Default: 1
• location: Location of the Azure Container Apps environment. Default: switzerlandnorth
• cache_tag: Tag to use for caching the docker build. Default: dockercache
• cpu: CPUs to allocate for the container app cores. Defaults to 0.5.
• memory: Required memory, will be converted to *Gi and Gi must not be supplied. Defaults to 1(Gi).

Tip

If you run into an error, the available cpu/memory combinations can be seen in the error log.

Outputs

The action provides the following outputs:

• fqdn: Fully Qualified Domain Name of the deployed Container App.
• app_name: Name of the deployed Container App.
• location: Azure Location of the deployed Container App.
• environment: GitHub Environment of the deployed Container App.
• resource_group_name: Azure Resource Group of the deployed Container App.

Usage

To use this GitHub Action in your workflow, add the following step:

- name: Deploy Unique SDK Module
  uses: Unique-AG/sdk-deploy-action@v2
  with:
    module: 'your-module-name'
    environment: 'your-environment-name'
    resource_group_name: 'your-resource-group-name'
    acr_login_server: 'your-acr-login-server'
    azure_client_id: ${{ secrets.AZURE_CLIENT_ID }}
    azure_tenant_id: ${{ secrets.AZURE_TENANT_ID }}
    azure_subscription_id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
    acr_username: ${{ secrets.ACR_USERNAME }}
    acr_password: ${{ secrets.ACR_PASSWORD }}
    age_private_key: ${{ secrets.AGE_PRIVATE_KEY }}
    azure_storage_account_id: ${{ secrets.AZURE_STORAGE_ACCOUNT_ID }}
    # Optional inputs can be omitted if defaults are suitable

Ensure you fill in the required inputs with your specific details.

Prerequisites

Before using this action, ensure:

• You have an Azure account and have created an Azure Container Registry.
• The required secrets (AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_SUBSCRIPTION_ID, ACR_USERNAME, ACR_PASSWORD, AGE_PRIVATE_KEY) are set in your GitHub repository.
• Your Python module follows the Unique SDK specifications and includes a pyproject.toml file with dependencies on gunicorn and python-dotenv.

This GitHub Action streamlines the deployment process, making it easier to deploy Unique SDK modules to Azure Container Apps with minimal setup.