Skip to content

synthesized-io/tdk-on-azure

Repository files navigation

Overview

A repository for the configuration files required to deploy the Synthesized TDK offer on Azure Marketplace.

Deployment Process

Overall, the process of deployment is the following:

  • Create a CNAB bundle (docker image).
  • Update the technical configuration in the Partner Center.
  • Submit the offer in the Partner Center for review.
  • Submit the offer in the Partner Center for production.

Automated deployment

  1. Navigate to the Publish Draft version GHA workflow
  2. Run the workflow, specifying the required TDK version
  3. Verify that the workflow passes successfully.
  4. Wait for both automatic and manual validations to complete, which can take up to 48 hours.
  5. Access the Partner Center
  6. Once validation is successful, proceed to click the "Go Live" button.

You can learn more about used API here

Manual deployment

In case the automated deployment isn't feasible, the manual deployment option is available.

Creating the CNAB

Microsoft mandates packaging the product in a specific Docker image format known as CNAB bundle. Follow these steps:

docker run --rm -it -v $(pwd):/app -v /var/run/docker.sock:/var/run/docker.sock --name cpa-tool mcr.microsoft.com/container-package-app:latest bash

Inside the container:

# cd into the mounted directory
cd app
# log in to azure shell
az login
# log in docker
az acr login --name tdkk8soffer
# verify our configuration files are in order
cpa verify
# build and publish the CNAB bundle
cpa buildbundle

The repository containing these Docker images can be found here. The resulting CNAB bundle will with the tdkk8soffer.azurecr.io/com.synthesized.tdk:x.x.x tag.

Update technical configuration

Browser requirement: Chromium 119+ (does not work in Firefox for some reason).

The link to our offer: link.

Within the offer, you'll find two plans:

Select the plan you wish to update, click on "Technical Configuration" on the left panel, then "add CNAB bundle." Choose the tdkk8soffer registry, com.synthesized.tdk repository, and the required image tag. Save your changes.

Submit the offer for review

Click on the "Review and Publish" button at the top of the page. Validation may take up to 48 hours but could be faster for subsequent submissions.

Submit the offer for production

Once validation is successful, click the "Go Live" button to initiate the production deployment.