Maven Plugin for deploying Springboot (or) other java projects to Azure API apps
Azure does not provide any maven plugin or jenkins plugin to deploy applications onto the Azure API or Web Apps. This plugin helps deploy binaries in the Azure API or Web Apps by using the Azure AD Oauth app & FTP.
-
To create a Oauth App in Azure AD, go to Azure Active directory in the navigation pane & click on New-Application-Registration
-
After Creating the App select Required Permissions on the app to add 'Windows Azure Service Management API' and provide all required permissions. (read - write). This ensures that the AD oauth app has access to the Azure Service Management APIs (start/stop Api/web App)
-
After granting permissions, access keys needs to be generated & saved as it is visible only during creation
-
Detailed Explanation of the Azure API app is provided in the following flow : https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications
Before adding resource group, make sure we have the following:
- Application ID (Client ID) (From previous steps)
- Client Password (From previous step)
- Tenant ID - refer below screenshot
Go to Azure Active Directory -> Properties -> Directory ID
Last process is to got to provide ResourceGroup access to this particular AD app. Make it the owner or provide modifier access as shown below
Setup the deployment credentials & save them for using further: https://docs.microsoft.com/en-us/azure/app-service/app-service-deployment-credentials
- azure-deployment-plugin - Maven Plugin which needs to be added to the project that needs to be deployed in the azure api app
- hello-world-sb - Simple hello world springboot application that needs to be deployed in Azure with a configuration in pom.xml to add the custom maven plugin (abiove)
Build procedure:
- Run a 'mvn clean install' on the root folder of this repository.
- Once successful build move onto the sample application. open the pom.xml & provide the Application & Azure specific values
ftpCredentials -> '<<username>>::<<password>>'
| Configuration | Description |
|---|---|
| appName | Application name in Azure |
| clientId | Azure AD Oauth App's Client Id |
| clientPassword | password associated with the Oauth App |
| ftpCredentials | Azure deployment credentials - username::password (format) |
| ftpHostName | Azure api app's ftp hostname |
| resourceGroup | Azure Api App's resource group |
| tenantId | Azure AD Tenant ID |
| subscriptionId | Azure API app's subscription ID |
On completing the above configuration, assuming that the project is already built & the binary is available in the target folder:
- Run the custom maven command azure-deploy:deploy from the 'hell-world-sb' project to push the jar file to the azure cloud via FTP.
- Ensure that the FTP ports are not blocked in your network.
- Continuous deployment is enabled by default. If there is an existing deployment already available, then the plugin does the below:
- Stops the application
- push the jar onto a temp directory
- moves the current deployment into backup folder & renames with timestamp (creates backup dir if not present)
- moves the new jar to the root folder
- on successful completion of above steps - starts the application back, on any exception - still holds on to the existing deployment already available
- clears the temp directory.
Concept Inherited from - https://docs.cloudfoundry.org/devguide/deploy-apps/blue-green.html
API APP screenshots:
Simple API app tied to a app-service-plan:
On Successful Deployment (see the following output)
Sample web.config for deployment is attached :
web.config - Uses Java8 for supporting springboot in Azure API App.