search

WASdev / azure.liberty.aks

Apache License 2.0
2 stars 8 forks source link

readme

Related Repositories

Deploy a Java application with Open Liberty or WebSphere Liberty on an Azure Kubernetes Service (AKS) cluster

Prerequisites

  1. You will need an Azure subscription. If you don't have one, you can get one for free for one year here.
  2. You need to have either an Owner role or Contributor and User Access Administrator roles in the subscription.
  3. Install a Java SE implementation (for example, AdoptOpenJDK OpenJDK 8 LTS/OpenJ9).
  4. Install Maven 3.5.0 or higher.
  5. Install Docker for your OS.
  6. Install Azure CLI 2.0.75 or later.
  7. Install Bicep.
  8. Install jq

Local Build Setup and Requirements

This project utilizes GitHub Packages for hosting and retrieving some dependencies. To ensure you can smoothly run and build the project in your local environment, specific configuration settings are required.

GitHub Packages requires authentication to download or publish packages. Therefore, you need to configure your Maven settings.xml file to authenticate using your GitHub credentials. The primary reason for this is that GitHub Packages does not support anonymous access, even for public packages.

Please follow these steps:

  1. Create a Personal Access Token (PAT)

    • Go to Personal access tokens.
    • Click on Generate new token.
    • Give your token a descriptive name, set the expiration as needed, and select the scopes (read:packages, write:packages).
    • Click Generate token and make sure to copy the token.

  2. Configure Maven Settings

    • Locate or create the settings.xml file in your .m2 directory(~/.m2/settings.xml).

    • Add the GitHub Package Registry server configuration with your username and the PAT you just created. It should look something like this:

      <settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 
                       https://maven.apache.org/xsd/settings-1.2.0.xsd">

<!-- other settings
...
-->

 <servers>
   <server>
     <id>github</id>
     <username>YOUR_GITHUB_USERNAME</username>
     <password>YOUR_PERSONAL_ACCESS_TOKEN</password>
   </server>
 </servers>

<!-- other settings
...
-->

</settings>

Steps of deployment

  1. Checkout azure-javaee-iaas

    1. Change to directory hosting the repo project & run mvn clean install

  2. Checkout arm-ttk under the specified parent directory

    1. Run git checkout cf5c927eaf1f5652556e86a6b67816fc910d1b74 to checkout the verified version of arm-ttk

  3. Checkout this repo under the same parent directory and change to directory hosting the repo project

  4. Build the project by replacing all placeholder ${<place_holder>} with valid values

    1. Create a new AKS cluster and a new Azure Container Registry (ACR) instance with Application Gateway Ingress Controller (AGIC) enabled:

      mvn -Dgit.repo=<repo_user> -Dgit.tag=<repo_tag> -DcreateCluster=true -DcreateACR=true -DdeployWLO=<true|false> -Dedition=<edition> -DproductEntitlementSource=<productEntitlementSource> -DdeployApplication=<true|false> -DappImagePath=<app-image-path> -DappReplicas=<number of replicas> -DenableAppGWIngress=true -DappgwUsePrivateIP=<true|false> -DappGatewayCertificateOption=generateCert -DenableCookieBasedAffinity=true -Dtest.args="-Test All" -Pbicep -Passembly -Ptemplate-validation-tests clean install

    2. Or use an existing AKS cluster and an existing ACR instance without AGIC:

      mvn -Dgit.repo=<repo_user> -Dgit.tag=<repo_tag> -DcreateCluster=false -DclusterName=<aks-cluster-name> -DclusterRGName=<cluster-group-name> -DcreateACR=false -DacrName=<acr-instance-name> -DacrRGName=<acr-group-name> -DdeployWLO=<true|false> -Dedition=<edition> -DproductEntitlementSource=<productEntitlementSource> -DdeployApplication=<true|false> -DappImagePath=<app-image-path> -DappReplicas=<number of replicas> -DenableAppGWIngress=false -DappgwUsePrivateIP=<true|false> -DappGatewayCertificateOption=generateCert -DenableCookieBasedAffinity=true -Dtest.args="-Test All" -Pbicep -Passembly -Ptemplate-validation-tests clean install

  5. Change to ./target/cli directory

  6. Using deploy.azcli to deploy the application package to AKS cluster

    ./deploy.azcli -n <deploymentName> -g <resourceGroupName> -l <resourceGroupLocation>

After deployment

  1. If you check the resource group resourceGroupName in Azure portal, you will see related resources created:
    1. A new AKS cluster if it's specified;
    2. A new ACR instance if it's specified;
    3. Two deployment script instances;
  2. To visit the application home page if you chose to deploy a sample app:
    1. Open the resource group resourceGroupName;
    2. Navigate to "Deployments > deploymentName > Outputs";
    3. Copy value of property appHttpEndpoint > append context root defined in the 'server.xml' of your application if it's not equal to '/' > open it in the browser;
    4. If you enabled AGIC: copy value of property appHttpsEndpoint > append context root defined in the 'server.xml' of your application if it's not equal to '/' > open it in the browser;

Deployment Description

The offer provisions the WebSphere Liberty Operator or Open Liberty Operator and supporting Azure resources.