Skip to content

Latest commit

 

History

History
186 lines (118 loc) · 9.57 KB

4-create-postgres-on-azure.md

File metadata and controls

186 lines (118 loc) · 9.57 KB
Raw

4 - Create and Configure PostgreSQL on Azure

In the previous exercise, you migrated a Jakarta EE app to JBoss EAP and ran it in your developer environment with a pre-provisioned database.

In this exercise we'll deploy Azure Database for PostgreSQL and reconfigure our application to use it when deploying to our already-created Azure App Service instance of JBoss EAP.

4.1 - Overview of Postgres pricing tiers

Azure Database for PostgreSQL offers several options to meet your data needs.

  • Single Server is a preconfigured database server and is best for workloads where the database have minimal customization requirements. This is what we will use in today's workshop.
  • Flexible Server provides maximum control for your database with a simplified developer experience and is best for workloads that require things like custom maintenance windows, zone redunant high availability, and start/stop capabilities or burstable SKUs for cost optimization.
  • Hyperscale provides horizontal scale-out capability to hundreds of nodes and is best for high performance workloads that require dynamic scalability, or require transactional and analytical queries to run on the same database.

Learn more about Azure Database for Postgres Pricing.

4.2 - Exercise: Create Postgres DB

You can create Postgres databases using the Azure Portal or Azure CLI. Let's use the Azure CLI.

To create the database service (using the default SKU and PostgreSQL version 11), run the following command:

az postgres server create --resource-group $RESOURCE_GROUP \
  --name $DB_SERVER_NAME --location $LOCATION --admin-user $DB_USERNAME \
  --admin-password $DB_PASSWORD --sku-name GP_Gen5_2 --version 11

NOTE This uses PostgreSQL version 11. If you need support for later versions, you'll need to deploy a Flexible Server or Hyperscale server!

This will take 3-4 minutes to complete. One complete, verify that the database was created with this command:

az postgres server show -g $RESOURCE_GROUP -n $DB_SERVER_NAME

Now we can use az postgres server list to save the full name of our database to an environment variable that we will use later. Run this command:

export SERVER_FQDN=$(az postgres server show -g $RESOURCE_GROUP \
  -n $DB_SERVER_NAME | jq -r .fullyQualifiedDomainName) && \
  echo $SERVER_FQDN

You should see the FQDN that looks like <server_name>-.postgres.database.azure.com.

Next, In the Azure Portal, navigate to Home > All Resources. You should see your Database in the list of recent resources (along with your JBoss EAP App Service). Click on the database to show various details about the service.

Next, we'll need to allow access to the database from services within Azure (like App Service, where our EAP app will eventually run). You can do that in the "Connection security" panel of the Azure Database blade by toggling the "Allow access to Azure services" button to the "ON" position and clicking Save. Alternatively, you can run the following CLI command:

 az postgres server firewall-rule create -g $RESOURCE_GROUP \
   -s $DB_SERVER_NAME -n AllowAllWindowsAzureIps \
   --start-ip-address 0.0.0.0 --end-ip-address 0.0.0.0

Next, create a database named monolith within Postgres with this command:

az postgres db create -g $RESOURCE_GROUP -s $DB_SERVER_NAME -n monolith

Now that we have the database, let's move on to configuring our App Service to use it!

4.3 - Configure EAP on App Service for Postgres

When EAP is deployed to App Service, it is deployed as a read-only image that isn't designed to be manually configured as you would a traditional on-prem EAP deployment, because if the service is restarted, those changes will disappear. But there is a startup hook and a writeable filesystem (that does not reset between reboots) you can use to configure EAP with custom settings. We'll use this for our database configuration.

First, we need to create some files that will implement that hook, and upload it to our App Service.

In the IDE, right-click on the setup directory and choose New File:

Name the file startup.sh. In this file, add the following content:

#!/usr/bin/env bash

export SETUP_DIR=/home/site/libs
$JBOSS_HOME/bin/jboss-cli.sh --connect --file=${SETUP_DIR}/jboss-cli-commands.cli

This file refers to another file (jboss-cli-commands.cli) that we've already created for you that will add Postgres support to JBoss EAP using the JBoss CLI when it starts up. Feel free to look at this file to see what it does.

We'll also need the Postgres JDBC driver library. Run this command to fetch it into the same directory:

wget -O $GITPOD_REPO_ROOT/setup/postgresql.jar \
  https://jdbc.postgresql.org/download/postgresql-42.2.24.jar

Confirm it downloaded and is a JAR file:

file $GITPOD_REPO_ROOT/setup/postgresql.jar

It should report:

<path>/setup/postgresql.jar: Java archive data (JAR)

4.3.1 - Create Application Settings

The scripts above refer to a number of environment variables that must be set on the EAP App Service. On the Azure Portal, navigate to Home > All Resources once again, and you should see your App Service that you created earlier, alongside your Postgres Database.

Click on the App Service to get details about it. Under the Settings category on the left, click on Configuration:

Here, you will need create 3 new settings. You can print out the values you'll need by running the following commands in a Terminal in your IDE:

echo "POSTGRES_CONNECTION_URL --> jdbc:postgresql://${SERVER_FQDN}:5432/monolith?sslmode=require" && \
echo "POSTGRES_SERVER_ADMIN_FULL_NAME --> ${DB_USERNAME}@${DB_SERVER_NAME}" && \
echo "POSTGRES_SERVER_ADMIN_PASSWORD --> $DB_PASSWORD"

Create a new Application Setting for each of the above by clicking on New Application Setting and filling in the values and clicking OK:

Once you have created 3 new settings, be sure to save the changes. Click on Save then Continue to restart your application:

You can also use the az command line to accomplish the same thing:

az webapp config appsettings set -g $RESOURCE_GROUP -n $WEBAPP_NAME --settings \
  "POSTGRES_CONNECTION_URL=jdbc:postgresql://$SERVER_FQDN:5432/monolith?sslmode=require" \
  "POSTGRES_SERVER_ADMIN_FULL_NAME=${DB_USERNAME}@${DB_SERVER_NAME}" \
  "POSTGRES_SERVER_ADMIN_PASSWORD=$DB_PASSWORD"

These values will be read by the scripts and EAP to configure Postgres. To make this happen on startup, run the following commands to upload these files using the az webapp deploy command:

az webapp deploy --resource-group $RESOURCE_GROUP --name $WEBAPP_NAME \
    --src-path $GITPOD_REPO_ROOT/setup/postgresql.jar  \
    --target-path /home/site/libs/postgresql.jar --type lib --restart false && \
\
az webapp deploy --resource-group $RESOURCE_GROUP --name $WEBAPP_NAME \
    --src-path $GITPOD_REPO_ROOT/setup/jboss-cli-commands.cli  \
    --target-path /home/site/libs/jboss-cli-commands.cli --type lib --restart false && \
\
az webapp deploy --resource-group $RESOURCE_GROUP --name $WEBAPP_NAME \
  --src-path $GITPOD_REPO_ROOT/setup/startup.sh  --type startup --restart true

The --type argument informs where the files are placed on the app service. This will also trigger the app to restart to apply the new configuration. In the next section you will set up GitHub Actions to continiously build and deploy your CoolStore application to App Service.

4.4 - Exercise: Push your changes to your repository

In this exercise you've made several changes to key source files for the Java application, as well as some configuration files. Let's push all of that to your personal repository fork.

Click on the Source Control window and review the changes you've made:

Changes

To commit these, first you'll need to stage changes. Click on the Stage All Changes icon next to your changes, as shown:

Changes

Next, enter a comment such as "Migrated to JBoss" in the Message box, and press CMD-ENTER (or CTRL-ENTER on Windows):

Changes

With your commit done, you can now push that commit up to your GitHub repository.

Changes

If you then browse your your GitHub repository in a separate tab (e.g. https://github.com/JoeSmith/workshop-migrate-jboss-on-app-service), you should see your newest commit at the top with the same comment you entered. Congratulations! You can repeat this step as you make changes.

Congratulations! You now have deployed a PostgreSQL database and connected it to your JBoss EAP instance running on App Service, but you have not yet deployed any application to EAP. In the next section, you will set up automation to deploy and redeploy the app each time you wish to make a change.

⬅️ Previous section: 3 - Migrate a WebLogic app to JBoss EAP

➡️ Next section: 5 - Deploy with GitHub Actions