DEV Community

ITNEXT profile image Abhishek Gupta
Abhishek Gupta for ITNEXT

Posted on

Tutorial: Deploying Java EE apps on Azure (Part 2)

#azure #showdev #tutorial #docker

This is the second blog in a series that will walk you through the options of running Java EE applications on Azure. The first part provided details on how to deploy a Java EE app to an application server which is set up in a Virtual Machine on Microsoft Azure along with the Azure Database for PostgreSQL service as the backend database.

In this part, we will run the Java EE app as a Docker container on Azure Container Instances. The example used in the blog post is a simple three-tier application that uses Java EE 8 specifications such as JAX-RS, EJB, CDI, JPA, JSF, Bean Validation. We will use the Payara Server to deploy the application and use PostgreSQL as the relational database.

During the course of the tutorial, we will cover:

  • Postgres setup on Azure
  • Dockerize the Java EE app and setup Azure Container Registry to store the Docker image
  • Deploy the application to Azure Container Instances
  • Explore its functionality

Except for minor changes, the application used in this tutorial has been adapted from this project by Reza Rahman

Pre-requisites

You will need a Microsoft Azure account and the Azure CLI to work through the tutorial.

If you don't have a Microsoft Azure account, go ahead and sign up for a free one!. The Azure CLI is a cross-platform command-line experience for managing Azure resources - please intall it using these instructions.

First things first...

Set your Azure Subscription ID using the Azure CLI which will be used for this tutorial.

To set your Azure subscription ID

    export AZURE_SUBSCRIPTION_ID=[to be filled]
    az account set --subscription $AZURE_SUBSCRIPTION_ID
Enter fullscreen mode Exit fullscreen mode

Create a resource group that will contain all the services (resources) which you will create as a part of this tutorial. A resource group is like a logical container that holds related resources for an Azure solution. The resource group includes those resources that you want to manage as a group.

To create a resource group

    export AZURE_RESOURCE_GROUP_NAME=[to be filled]
    export AZURE_LOCATION=[to be filled]
    az group create --name $AZURE_RESOURCE_GROUP_NAME --location $AZURE_LOCATION
Enter fullscreen mode Exit fullscreen mode

Install Postgres on Azure

Azure Database for PostgreSQL is a relational database service based on the open-source Postgres database engine. It's a fully managed database-as-a-service offering which is available in two deployment options, as a single server and as a Hyperscale (Citus) cluster

We will be using the single server option for the purposes of this tutorial

We will use the az postgres server create command to create a Postgres server instance on Azure. First, set up some of the server properties such as the name, admin user etc.

    export AZURE_POSTGRES_SERVER_NAME=[to be filled]
    export AZURE_POSTGRES_ADMIN_USER=[to be filled]
    export AZURE_POSTGRES_ADMIN_PASSWORD=[to be filled]
    export SKU=B_Gen5_1
    export STORAGE=5120
Enter fullscreen mode Exit fullscreen mode

For storage and SKU options, please refer to the documentation

And, then invoke the command to initiate the database instance creation:

    az postgres server create --resource-group $AZURE_RESOURCE_GROUP_NAME --name $AZURE_POSTGRES_SERVER_NAME  --location $AZURE_LOCATION --admin-user $AZURE_POSTGRES_ADMIN_USER --admin-password $AZURE_POSTGRES_ADMIN_PASSWORD --storage-size $STORAGE --sku-name $SKU
Enter fullscreen mode Exit fullscreen mode

The provisioning process will take a few minutes.

To check the details of the Postgres database instance you just provisioned, invoke az postgres server show command

    az postgres server show --resource-group $AZURE_RESOURCE_GROUP_NAME --name $AZURE_POSTGRES_SERVER_NAME
Enter fullscreen mode Exit fullscreen mode

You should get a JSON response. Please note down the value for the fullyQualifiedDomainName attribute as you will be using this to connect to the Postgres instance later.

It should be of the format: [AZURE_POSTGRES_DB_NAME].postgres.database.azure.com

Allow Azure Container Instances to access the Postgres database

Later in the post, we will see how to deploy the application to Azure Container Instances. But, the Postgres database is not accessible to external services by default. We will use the az postgres server firewall-rule create command to create a firewall rule to explicitly allow Azure services to access the Postgres instance. This will allow the JavaEE application deployed within Azure Container Instances to communicate with Postgres.

export FIREWALL_RULE_NAME=AllowJavaEECafeAppOnACI

az postgres server firewall-rule create --resource-group $AZURE_RESOURCE_GROUP_NAME --server-name $AZURE_POSTGRES_SERVER_NAME --start-ip-address=0.0.0.0 --end-ip-address=0.0.0.0 --name $FIREWALL_RULE_NAME
Enter fullscreen mode Exit fullscreen mode

Note: This setting allows network connections from all IPs within the Azure network. For production use, try to configure the most restrictive firewall rules possible

Setup Azure Container Registry

Azure Container Registry is a managed, private Docker registry service to store and manage your private Docker container images (it based on the open-source Docker Registry 2.0). You can use Azure container registries with your existing container development and deployment pipelines, or use Azure Container Registry Tasks to build container images in Azure. Yo can either build on demand, or fully automate builds with triggers such as source code commits and base image updates.

Let's create a registry to store the Docker image for the JavaEE application. We will use the az acr create command

    export ACR_NAME=javaeecafe-acr
    az acr create --resource-group $AZURE_RESOURCE_GROUP_NAME --name $ACR_NAME --sku Basic --admin-enabled true
Enter fullscreen mode Exit fullscreen mode

We are using the Basic SKU. Valid value are: Basic, Classic, Premium, Standard

You can login to the registry once it's created and check the login server

    az acr login --name $ACR_NAME
    az acr show --name $ACR_NAME --query loginServer --output table
Enter fullscreen mode Exit fullscreen mode

You will use the ACR login server name soon. It's value follows the format: [ACR_NAME].azurecr.io

Setup and prepare application image

Now that we the have the VM as well as Payara server up and running, we can now deploy our application! Clone the git repository

    git clone https://github.com/abhirockzz/javaee-on-azure-caas
    cd javaee-on-azure-caas
Enter fullscreen mode Exit fullscreen mode

You need to enter the Postgres connectivity information to the <url> attribute of the <data-source section in web.xml.

You can find the web.xml file under javaee-on-azure-iaas/src/main/webapp/WEB-INF

The format is as follows:

    jdbc:postgresql://[POSTGRES_FQDN]:5432/postgres?user=[AZURE_POSTGRES_ADMIN_USER]@[AZURE_POSTGRES_SERVER_NAME]&amp;password=[AZURE_POSTGRES_ADMIN_PASSWORD]&amp;sslmode=require
Enter fullscreen mode Exit fullscreen mode

Here is the list placeholders which form a part of the JDBC URL:

  • POSTGRES_FQDN with value of fullyQualifiedDomainName
  • AZURE_POSTGRES_ADMIN_USER with admin user name used to provision PG
  • AZURE_POSTGRES_SERVER_NAME with server name used to provision PG
  • AZURE_POSTGRES_ADMIN_PASSWORD with admin password used to provision PG

Set the required values

    export POSTGRES_FQDN=
    export AZURE_POSTGRES_ADMIN_USER=
    export AZURE_POSTGRES_SERVER_NAME=
    export AZURE_POSTGRES_ADMIN_PASSWORD=
Enter fullscreen mode Exit fullscreen mode

Simply use these commands to replace

    export FILE_NAME=javaee-on-azure-iaas/src/main/webapp/WEB-INF/web.xml

    sed -i 's/POSTGRES_FQDN/'"$POSTGRES_FQDN"'/g' $FILE_NAME
    sed -i 's/AZURE_POSTGRES_SERVER_NAME/'"$AZURE_POSTGRES_SERVER_NAME"'/g' $FILE_NAME
    sed -i 's/AZURE_POSTGRES_ADMIN_USER/'"$AZURE_POSTGRES_ADMIN_USER"'/g' $FILE_NAME
    sed -i 's/AZURE_POSTGRES_ADMIN_PASSWORD/'"$AZURE_POSTGRES_ADMIN_PASSWORD"'/g' $FILE_NAME
Enter fullscreen mode Exit fullscreen mode

Here is an e.g. of what the <data-source> section will look like:

    <data-source>
        <name>java:global/JavaEECafeDB</name>
        <class-name>org.postgresql.ds.PGPoolingDataSource</class-name>
        <url>jdbc:postgresql://foobar-pg.postgres.database.azure.com:5432/postgres?user=foobar@foobar-pg&amp;password=foobarbaz&amp;sslmode=require</url>
    </data-source>
Enter fullscreen mode Exit fullscreen mode

The application is now configured. Let's build it!

    mvn clean install
Enter fullscreen mode Exit fullscreen mode

You should have the WAR file available. To confirm

    ls -lrt target | grep javaee-cafe.war
Enter fullscreen mode Exit fullscreen mode

Build and push image to Azure Container Registry

Our application artifact (WAR file) is ready. We can now build the Docker image and push it out to Azure Container Registry. Here is a quick look at the Dockerfile used for this

    FROM payara/server-full
    COPY target/javaee-cafe.war $DEPLOY_DIR
    RUN wget https://jdbc.postgresql.org/download/postgresql-42.2.8.jar
    RUN cp /opt/payara/postgresql-42.2.8.jar ${PAYARA_DIR}/glassfish/domains/${DOMAIN_NAME}/lib && rm /opt/payara/postgresql-42.2.8.jar
    EXPOSE 8080
Enter fullscreen mode Exit fullscreen mode

It builds on top of the base image for payara/server-full, copies the WAR file to a folder from where it can be automatically detected and deployed, downloads the Postgres JDBC driver and places it in the appropriate location for the Payara application server. That's it!

    export DOCKER_IMAGE=javaee-cafe
    docker build -t $DOCKER_IMAGE .
    docker tag $DOCKER_IMAGE $ACR_NAME.azurecr.io/$DOCKER_IMAGE
Enter fullscreen mode Exit fullscreen mode

To push the image

    docker push $ACR_NAME.azurecr.io/$DOCKER_IMAGE
Enter fullscreen mode Exit fullscreen mode

Use az acr repository list command to check the image.

    az acr repository list --name $ACR_NAME --output table
Enter fullscreen mode Exit fullscreen mode

Deploy the application to Azure Container Instances

Azure Container Instances allows you to run a container in Azure, without having to manage any VMs and or adopt a higher-level service. It is a solution for any scenario that can operate in isolated containers, including simple applications, task automation, and build jobs. For scenarios where you need full container orchestration, including service discovery across multiple containers, automatic scaling, and coordinated application upgrades, please take a look at Azure Kubernetes Service (AKS).

We are now ready to deploy the JavaEE application to Azure Container Instances. When you create a container instance, you can specify a custom DNS name label so your application is reachable at customlabel.azureregion.azurecontainer.io.

    export ACI_CONTAINER_NAME=javaee-cafe
    export DNS_NAME_LABEL=javaee-cafe
Enter fullscreen mode Exit fullscreen mode

We will need the password for Azure Container Registry to run our Docker image in Azure Container Instance.

    az acr credential show --name $ACR_NAME
Enter fullscreen mode Exit fullscreen mode

Enter below command to create the container and enter the password (obtained above) when prompted:

    az container create --resource-group $AZURE_RESOURCE_GROUP_NAME --name $ACI_CONTAINER_NAME --image $ACR_NAME.azurecr.io/$DOCKER_IMAGE --dns-name-label $DNS_NAME_LABEL --registry-username $ACR_NAME --ports 8080
Enter fullscreen mode Exit fullscreen mode

--ports 8080 ensures that we can access the application from port 8080. This is because Payara application server serves HTTP traffic on port 8080 by default.

The deployment will take sometime. In the meanwhile, you can track the logs using:

    az container attach -g $AZURE_RESOURCE_GROUP_NAME -n $ACI_CONTAINER_NAME
Enter fullscreen mode Exit fullscreen mode

You should see log messages indicating successful deployment of the javaee-cafe application

    [yyyy-mm-ddT13:34:21.317+0000] [Payara 5.193] [INFO] [NCLS-DEPLOYMENT-02035] [javax.enterprise.system.tools.deployment.autodeploy] [tid: _ThreadID=104 _ThreadName=payara-executor-service-scheduled-task] [timeMillis: 1574084061317] [levelValue: 800] [[
    [AutoDeploy] Successfully autodeployed : /home/abhishgu/payara5/glassfish/domains/domain1/autodeploy/javaee-cafe.war.]]
Enter fullscreen mode Exit fullscreen mode

Explore the application

Access the JSF front end

Use your browser to access http://[APP_FQDN]:8080/javaee-cafe. You can use the UI to create, delete and see coffees.

The APP_FQDN is nothing but the combination of the DNS label and the Azure region e.g. http://javaee-cafe.southeastasia.azurecontainer.io:8080/javaee-cafe

Use the REST API

The application also exposes a REST API for creating, deleting and listing coffees.

    export JAVAEE_ACI_REST=http://javaee-cafe.southeastasia.azurecontainer.io:8080/javaee-cafe/rest/coffees
Enter fullscreen mode Exit fullscreen mode

Create coffees

    curl -X POST $JAVAEE_ACI_REST:8080/javaee-cafe/rest/coffees -d '{"name":"cappuccino","price":"10"}' -H "Content-Type: application/json"
    curl -X POST $JAVAEE_ACI_REST:8080/javaee-cafe/rest/coffees -d '{"name":"caffe-latte","price":"15"}' -H "Content-Type: application/json"
Enter fullscreen mode Exit fullscreen mode

Get all coffees

    curl -H "Accept: application/json" $JAVAEE_ACI_REST:8080/javaee-cafe/rest/coffees
Enter fullscreen mode Exit fullscreen mode

You should see a JSON response listing both the coffee options you just added

Get a coffee by ID

    curl -H "Accept: application/json" $JAVAEE_ACI_REST:8080/javaee-cafe/rest/coffees/1
Enter fullscreen mode Exit fullscreen mode

Delete a coffee by ID

    curl -X DELETE $JAVAEE_ACI_REST:8080/javaee-cafe/rest/coffees/1
    curl -H "Accept: application/json" $JAVAEE_ACI_REST:8080/javaee-cafe/rest/coffees
Enter fullscreen mode Exit fullscreen mode

Notice that cappuccino is now deleted

Clean up resources

Once you are done exploring the application, you can delete the resources. Since we used a resource group, its easy executing a single command.

Please be aware that this will delete all the resources in the group which includes the ones you created as part of the tutorial (VM, Postgres etc.) as well as any other service instances you might have if you used an already existing resource group

    az group delete --name $AZURE_RESOURCE_GROUP_NAME
Enter fullscreen mode Exit fullscreen mode

Summary

You learned how to leverage Docker containers to package and deploy the application to Azure Container Instances along with a managed database offering for long term persistence.

The third installment will cover Kubernetes as a deployment platform for our Java EE application. Stay tuned!

Top comments (0)

Read next

kvetoslavnovak profile image

"Helper" Varaibles in Svelte 5

kvetoslavnovak -

echo9k profile image

Implementing similarity search algotithms

Guillermo Alcántara -

sabrinaesaquino profile image

Conjuring Cursed Halloween Tales with Qdrant's Dark Arts

Sabrina -

nevodavid profile image

40 open-source gems to become the ultimate developer🔥 🚀

Nevo David -