Skip to content

SJAD Development Guide

Xiaolu Dai edited this page Dec 16, 2024 · 3 revisions

This documentation is the development guide of the project - Simplying Java on Azure Deployment (SJAD).

See also https://aka.ms/sjad.

Feature branch

The source code of SJAD is on the azure-javaee/azure-dev:feature/sjad branch. This branch will periodically merge the Azure/azure-dev:main branch to sync the latest change from upstream.

Target scenarios

Scenario Sample Project Supported Status
Application + MySQL https://github.com/rujche/spring-petclinic/tree/azd-enhancement-for-mysql
Application + PostgreSQL https://github.com/rujche/spring-petclinic/tree/azd-enhancement-for-postgresql
Application + MongoDB https://github.com/rujche/todo-java-mongo-aca/tree/azd-enhancement-for-mongo
Application + CosmosDB https://github.com/rujche/samples/tree/azd-enhancement-for-cosmos-db
Application + Redis https://github.com/rujche/samples/tree/azd-enhancement-for-redis
Application + Event Hubs + Spring Cloud Stream https://github.com/rujche/samples/tree/azd-enhancement-for-eventhubs
Application + Service Bus + Spring Cloud Stream https://github.com/rujche/ASA-Samples-Event-Driven-Application/tree/azd-enhancement-for-service-bus
Application + Service Bus + JMS https://github.com/saragluna/todo-java-mongo-aca/tree/xiada/sample-email
Application + Kafka + Spring Cloud Stream https://github.com/haoozhang/Spring-Cloud-Stream-Kafka-Application
Frontend + Backend https://github.com/rujche/todo-java-mongo-aca/tree/azd-enhancement-for-mongo
Spring Petclinic Microservices https://github.com/azure-javaee/spring-petclinic-microservices/tree/sjad

How to deliver the azd command and VSCode plugin

We will use this PR (https://github.com/Azure/azure-dev/pull/4473) as our base, and the pipeline will build the azd command as well as the VS Code extension, like the following:

image image

How to contribute code

Please create PR targeting the feature/sjad branch. And make sure the changes are covered by proper test cases.

Backlogs

User story Milestone Merged to feature branch Merged to azd upstream
Java Analyzer + Maven Project private preview
Java Analyzer + Spring Project private preview
Project Analyzer + Dockerfile private preview
AVM Support private preview
azure.yaml new format output private preview
Monolithic web application + PostgreSQL + Password private preview
Monolithic web application + PostgreSQL + Passwordless private preview
Monolithic web application + MySQL + Password private preview
Monolithic web application + MySQL + Passwordless private preview
Monolithic web application + MongoDB + Password private preview
Monolithic web application + Redis + Password private preview
Monolithic web application + Redis + Passwordless private preview
Event-driven application + Service Bus + Spring Cloud Stream + Connection String private preview
Event-driven application + Service Bus + Spring Cloud Stream + AAD private preview
Event-driven application + Service Bus + Spring JMS private preview
Event-driven application + Event Hubs + Spring Cloud Stream + Connection String private preview
Event-driven application + Event Hubs + Spring Cloud Stream + AAD private preview
Event-driven application + Kafka + Spring Cloud Stream private preview
Microservice application + Service Discovery (Spring Petclinic Microservices) private preview
Blogpost for installation, instructions, and guide private preview

Clone this wiki locally