Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azure/modern-web-app-pattern-java
The Modern Web App Pattern is a set of objectives to help you apply an iterative change to modernize a cloud deployed monolith. This content builds on the Reliable Web App. This repo contains a reference implementation of a Modern Web App for Java.
https://github.com/azure/modern-web-app-pattern-java
architecture azd-templates azure azure-app-configuration azure-app-service azure-application-insights azure-cache-redis azure-container-apps azure-container-registry azure-front-door azure-keyvault azure-postgres azure-service-bus java microsoft reference-implementation terraform
Last synced: 3 days ago
JSON representation
The Modern Web App Pattern is a set of objectives to help you apply an iterative change to modernize a cloud deployed monolith. This content builds on the Reliable Web App. This repo contains a reference implementation of a Modern Web App for Java.
- Host: GitHub
- URL: https://github.com/azure/modern-web-app-pattern-java
- Owner: Azure
- License: mit
- Created: 2024-03-14T13:15:06.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T17:33:32.000Z (about 2 months ago)
- Last Synced: 2024-12-31T02:17:54.245Z (3 days ago)
- Topics: architecture, azd-templates, azure, azure-app-configuration, azure-app-service, azure-application-insights, azure-cache-redis, azure-container-apps, azure-container-registry, azure-front-door, azure-keyvault, azure-postgres, azure-service-bus, java, microsoft, reference-implementation, terraform
- Language: CSS
- Homepage: https://aka.ms/eap/mwa/java/doc
- Size: 13.6 MB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Modern Java Web App Patterns
## Introduction
This repository provides a "real-world" application that implements the best practices and design patterns discussed in [Modern Web App pattern for Java](https://aka.ms/eap/mwa/java/doc). The patterns are designed to be used with the [Spring Framework](https://spring.io/) and [Azure](https://azure.microsoft.com/), but can be adapted to other frameworks and cloud providers.
This project has [a companion article in the Azure Architecture Center](https://aka.ms/eap/mwa/java/doc) that describes design patterns and best practices. Here's an outline of the contents in this readme:
- [Architecture](#architecture)
- [Workflow](#workflow)
- [Steps to deploy the reference implementation](#steps-to-deploy-the-reference-implementation)
- [Changes from Reliable Web App](./CHANGES.md)
- [Additional links](#additional-links)
- [Data Collection](#data-collection)
## Architecture
Contoso Fiber aligned to a hub and spoke network topology in the production deployment architecture to centralize common resources. This network topology provided cost savings, enhanced security, and facilitated network integration (platform and hybrid):
## Steps to deploy the reference implementation
The following detailed deployment steps assume you are using a Dev Container inside Visual Studio Code.
> For your convenience, we use Dev Containers with a fully-featured development environment. If you prefer to use another editor, we recommend installing the necessary [dependencies](./prerequisites.md) and skip to the deployment instructions starting in [Step 3](#3-log-in-to-azure).
### 1. Clone the repo
> For Windows users, we require using Windows Subsystem for Linux (WSL) to [improve Dev Container performance](https://code.visualstudio.com/remote/advancedcontainers/improve-performance).
```pwsh
wsl
```
Clone the repository and open the project using the Dev Container.
```shell
git clone https://github.com/Azure/modern-web-app-pattern-java
cd modern-web-app-pattern-java
```
### 2. Open Dev Container in Visual Studio Code
If required, ensure Docker Desktop is started. Open the repository folder in Visual Studio Code. You can do this from the command prompt:
```shell
code .
```
Once Visual Studio Code is launched, you should see a popup allowing you to click on the button **Reopen in Container**.
If you don't see the popup, open the Visual Studio Code Command Palette to execute the command. There are three ways to open the command palette:
- For Mac users, use the keyboard shortcut ⇧⌘P
- For Windows and Linux users, use Ctrl+Shift+P
- From the Visual Studio Code top menu, navigate to View -> Command Palette.
Once the command palette is open, search for `Dev Containers: Rebuild and Reopen in Container`.
### 3. Login to Azure
Before deploying, you must be authenticated to Azure and have the appropriate subscription selected. Run the following command to authenticate:
```shell
az login
```
If you have multiple tenants, you can use the following command to log into the tenant:
```shell
az login --tenant
```
Set the subscription to the one you want to use (you can use [az account list](https://learn.microsoft.com/cli/azure/account?view=azure-cli-latest#az-account-list) to list available subscriptions):
```shell
export AZURE_SUBSCRIPTION_ID=""
```
```pwsh
az account set --subscription $AZURE_SUBSCRIPTION_ID
```
Use the next command to login with the Azure Dev CLI (AZD) tool:
```pwsh
azd auth login
```
If you have multiple tenants, you can use the following command to log into the tenant:
```pwsh
azd auth login --tenant-id
```
### 4. Create a new environment
Next we provide the AZD tool with variables that it uses to create the deployment. The first thing we initialize is the AZD environment with a name.
The environment name should be less than 18 characters and must be comprised of lower-case, numeric, and dash characters (for example, `contosowebapp`). The environment name is used for resource group naming and specific resource naming.
```shell
azd env new
```
Select the subscription that will be used for the deployment:
```shell
azd env set AZURE_SUBSCRIPTION_ID $AZURE_SUBSCRIPTION_ID
```
Set the Azure region to be used:
```shell
azd env set AZURE_LOCATION
```
Optional: Set the App Registration Service management reference:
```shell
azd env set AZURE_SERVICE_MANAGEMENT_REFERENCE
```
### 5. Build the applications
Run the following command to build the applications:
```shell
./mvnw clean install
```
### 6. Create the Azure resources and deploy the code
Run the following command to create the Azure resources and deploy the code (about 15-minutes to complete):
```shell
azd up
```
### 7. Tear down the deployment
Run the following command to tear down the deployment:
```
azd down --purge --force
```
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Additional links
- [Known issues](known-issues.md)
- [Troubleshooting](troubleshooting.md)
- [Pattern Simulations](demo.md)
- [Calculating SLA](slo-calculation.md)
- [Find additional resources](additional-resources.md)
- [Report security concerns](SECURITY.md)
- [Find Support](SUPPORT.md)
- [Contributing](CONTRIBUTING.md)
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.
## Data Collection
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkId=521839. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
### Telemetry Configuration
Telemetry collection is on by default.
To opt out, run the following command `azd env set ENABLE_TELEMETRY` to `false` in your AZD environment.