Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjkp/deno-azd-template
Template for creating a Deno application in Azure Container Apps using the Azure Developer CLI
https://github.com/sjkp/deno-azd-template
azd-templates deno
Last synced: 8 days ago
JSON representation
Template for creating a Deno application in Azure Container Apps using the Azure Developer CLI
- Host: GitHub
- URL: https://github.com/sjkp/deno-azd-template
- Owner: sjkp
- Created: 2022-10-09T18:33:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-08T17:29:37.000Z (about 1 year ago)
- Last Synced: 2024-07-29T17:04:35.476Z (4 months ago)
- Topics: azd-templates, deno
- Language: Bicep
- Homepage:
- Size: 87.9 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Template for Creating Deno Apps on Azure Container Apps
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/sjkp/deno-azd-template)
A simple Deno app template using with fresh, that can be deployed to Azure Container Apps using the Azure Developer CLI. You can use the template as staring point if you want to run Deno apps on Azure.
### Prerequisites
The following prerequisites are required to use this application. Please ensure that you have them all installed locally.
- [Azure Developer CLI](https://aka.ms/azure-dev/install)
- Windows:
```powershell
powershell -ex AllSigned -c "Invoke-RestMethod 'https://aka.ms/install-azd.ps1' | Invoke-Expression"
```
- Linux/MacOS:
```
curl -fsSL https://aka.ms/install-azd.sh | bash
```
- [Azure CLI (2.38.0+)](https://docs.microsoft.com/cli/azure/install-azure-cli)
- [deno 1.26.1](https://deno.land/#installation)
- [Docker](https://docs.docker.com/get-docker/)
- [Git (2.36.1+)](https://git-scm.com/)
### Quickstart
The fastest way for you to get this application up and running on Azure is to use the `azd up` command. This single command will create and configure all necessary Azure resources - including access policies and roles for your account and service-to-service communication with Managed Identities.
1. Open a terminal, create a new empty folder, and change into it.
2. Create a new [Python virtual environment](https://docs.python.org/3/library/venv.html).
3. Run the following command to initialize the project.
```bash
azd init --template https://github.com/sjkp/deno-azd-template.git
```
This command will clone the code to your current folder and prompt you for the following information:
- `Environment Name`: This will be used as a prefix for the resource group that will be created to hold all Azure resources. This name should be unique within your Azure subscription.
4. Run the following command to package a deployable copy of your application, provision the template's infrastructure to Azure and also deploy the application code to those newly provisioned resources.
```bash
azd up
```
This command will prompt you for the following information:
- `Azure Location`: The Azure location where your resources will be deployed.
> NOTE: This template may only be used with the following Azure locations:
>
> - Australia East
> - Brazil South
> - Canada Central
> - Central US
> - East Asia
> - East US
> - East US 2
> - Germany West Central
> - Japan East
> - Korea Central
> - North Central US
> - North Europe
> - South Central US
> - UK South
> - West Europe
> - West US
>
> If you attempt to use the template with an unsupported region, the provision step will fail.
- `Azure Subscription`: The Azure Subscription where your resources will be deployed.
> NOTE: This may take a while to complete as it executes three commands: `azd package` (packages a deployable copy of your application), `azd provision` (provisions Azure resources), and `azd deploy` (deploys application code). You will see a progress indicator as it packages, provisions and deploys your application.
When `azd up` is complete it will output the following URLs:
- Azure Portal link to view resources
- Deno application frontend
Click the web application URL to launch the Deno app. Create a new collection and add some items. This will create monitoring activity in the application that you will be able to see later when you run `azd monitor`.
> NOTE:
>
> - The `azd up` command will create Azure resources that will incur costs to your Azure subscription. You can clean up those resources manually via the Azure portal or with the `azd down` command.
> - You can call `azd up` as many times as you like to both provision and deploy your solution.
> - You can always create a new environment with `azd env new`.
### Application Architecture
This application utilizes the following Azure resources:
- [**Azure Container Apps**](https://docs.microsoft.com/azure/container-apps/) to host the Web frontend and API backend
- [**Azure Monitor**](https://docs.microsoft.com/azure/azure-monitor/) for monitoring and logging
- [**Azure Key Vault**](https://docs.microsoft.com/azure/key-vault/) for securing secrets
> This template provisions resources to an Azure subscription that you will select upon provisioning them. Please refer to the [Pricing calculator for Microsoft Azure](https://azure.microsoft.com/pricing/calculator/) and, if needed, update the included Azure resource definitions found in `infra/main.bicep` to suit your needs.
### Application Code
The repo is structured to follow the [Azure Developer CLI](https://aka.ms/azure-dev/overview) conventions including:
- **Source Code**: All application source code is located in the `src` folder.
- **Infrastructure as Code**: All application "infrastructure as code" files are located in the `infra` folder.
- **Azure Developer Configuration**: An `azure.yaml` file located in the root that ties the application source code to the Azure services defined in your "infrastructure as code" files.
- **GitHub Actions**: A sample GitHub action file is located in the `.github/workflows` folder.
- **VS Code Configuration**: All VS Code configuration to run and debug the application is located in the `.vscode` folder.
### Azure Subscription
This template will create infrastructure and deploy code to Azure. If you don't have an Azure Subscription, you can sign up for a [free account here](https://azure.microsoft.com/free/).
### Azure Developer CLI - VS Code Extension
The Azure Developer experience includes an Azure Developer CLI VS Code Extension that mirrors all of the Azure Developer CLI commands into the `azure.yaml` context menu and command palette options. If you are a VS Code user, then we highly recommend installing this extension for the best experience.
Here's how to install it:
#### VS Code
1. Click on the "Extensions" tab in VS Code
1. Search for "Azure Developer CLI" - authored by Microsoft
1. Click "Install"
#### Marketplace
1. Go to the [Azure Developer CLI - VS Code Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.azure-dev) page
1. Click "Install"
Once the extension is installed, you can press `F1`, and type "Azure Developer CLI" to see all of your available options. You can also right click on your project's `azure.yaml` file for a list of commands.
### Next Steps
At this point, you have a complete application deployed on Azure. But there is much more that the Azure Developer CLI can do. These next steps will introduce you to additional commands that will make creating applications on Azure much easier. Using the Azure Developer CLI, you can setup your pipelines, monitor your application, test and debug locally.
#### Set up a pipeline using `azd pipeline`
This template includes a GitHub Actions pipeline configuration file that will deploy your application whenever code is pushed to the main branch. You can find that pipeline file here: `.github/workflows`.
Setting up this pipeline requires you to give GitHub permission to deploy to Azure on your behalf, which is done via a Service Principal stored in a GitHub secret named `AZURE_CREDENTIALS`. The `azd pipeline config` command will automatically create a service principal for you. The command also helps to create a private GitHub repository and pushes code to the newly created repo.
Before you call the `azd pipeline config` command, you'll need to install the following:
- [GitHub CLI (2.3+)](https://github.com/cli/cli)
Run the following command to set up a GitHub Action:
```bash
azd pipeline config
```
> Support for Azure DevOps Pipelines is coming soon to `azd pipeline config`. In the meantime, you can follow the instructions found here: [.azdo/pipelines/README.md](./.azdo/pipelines/README.md) to set it up manually.
#### Monitor the application using `azd monitor`
To help with monitoring applications, the Azure Dev CLI provides a `monitor` command to help you get to the various Application Insights dashboards.
- Run the following command to open the "Overview" dashboard:
```bash
azd monitor --overview
```
- Live Metrics Dashboard
Run the following command to open the "Live Metrics" dashboard:
```bash
azd monitor --live
```
- Logs Dashboard
Run the following command to open the "Logs" dashboard:
```bash
azd monitor --logs
```
#### Run and Debug Locally
The easiest way to run and debug is to leverage the Azure Developer CLI Visual Studio Code Extension. Refer to this [walk-through](https://aka.ms/azure-dev/vscode) for more details.
#### Clean up resources
When you are done, you can delete all the Azure resources created with this template by running the following command:
```bash
azd down
```
### Additional azd commands
The Azure Developer CLI includes many other commands to help with your Azure development experience. You can view these commands at the terminal by running `azd help`. You can also view the full list of commands on our [Azure Developer CLI command](https://aka.ms/azure-dev/ref) page.
## Troubleshooting/Known issues
Sometimes, things go awry. If you happen to run into issues, then please review our ["Known Issues"](https://aka.ms/azure-dev/knownissues) page for help. If you continue to have issues, then please file an issue in our main [Azure Dev](https://aka.ms/azure-dev/issues) repository.
## Security
### Roles
This template creates a [managed identity](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview) for your app inside your Azure Active Directory tenant, and it is used to authenticate your app with Azure and other services that support Azure AD authentication like Key Vault via access policies. You will see principalId referenced in the infrastructure as code files, that refers to the id of the currently logged in Azure CLI user, which will be granted access policies and permissions to run the application locally. To view your managed identity in the Azure Portal, follow these [steps](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-view-managed-identity-service-principal-portal).
### Key Vault
This template uses [Azure Key Vault](https://docs.microsoft.com/azure/key-vault/general/overview) to securely store your Cosmos DB connection string for the provisioned Cosmos DB account. Key Vault is a cloud service for securely storing and accessing secrets (API keys, passwords, certificates, cryptographic keys) and makes it simple to give other Azure services access to them. As you continue developing your solution, you may add as many secrets to your Key Vault as you require.
## Uninstall
To uninstall the Azure Developer CLI:
Windows:
```
powershell -ex AllSigned -c "Invoke-RestMethod 'https://aka.ms/uninstall-azd.ps1' | Invoke-Expression"
```
Linux/MacOS:
```
curl -fsSL https://aka.ms/uninstall-azd.sh | bash
```