| Table of Contents |
|---|
Objective
You have a working Azure Java Function and the source code is managed in a Git repository. The goal of the tutorial is to automate the deployment of one or more Java Functions to Azure Function App. This automation will include:
...
We will walk through each of the FlexDeploy features that will be created/configured to accomplish this goal and have the Java Function deployed in a very short amount of time.
Checklist
Checklist | Description |
|---|---|
Azure Tenant Id | Azure Tenant Id for the company |
Azure Subscription Id | Azure Subscription where the Function App exists |
Azure Client ID | Client ID to connect to desired Azure Subscription |
Azure Client Key | Password for the Client ID |
Azure Client ID permission | The Client ID must have relevant access in target Function App to deploy code |
Azure Function App | The Function App with relevant runtime should already be created |
Azure Resource Group | The Resource Group containing the Function App |
Azure CLI installation | Azure CLI needs to be installed where the plugin operation shall run (FlexDeploy server) |
Azure CLI in class path | Azure CLI should be added to class path on the FlexDeploy Server. Else the path can also be set under FlexDeploy environment level property |
Configure cloud account
First, an Azureaccount needs to be configured under Topology. FlexDeploy will connect to the right Azure Subscription with provided details and do the deployment.
Navigate to the
...
Select Integrations from the left-hand pane
...
Integrations section through the menu
Access the Cloud tab under
...
Integraions
Create a new Cloud account of the provider type “Azure” with the “
...
Create” button.
...
It should have a Client ID, Client Key, Tenant Id, and Subscription Id configured in it. The Client ID must have relevant access in the target Function App to deploy code and make other associated changes(Application Setting update etc).
...
Client Key is a password field and hence needs to be kept hidden. To update the same click on the pencil icon as shown below
Update the Client Key value under Secret Text. This is to make sure no one else can retrieve the password
...
Git repository structure
The Git repository should contain the codebase. Alongside it can also contain any Application Setting and Connection String related attributes in respective files(any naming convention allowed). These files are not mandatory, however, in case someone has any Application Setting and Connection String property to update this is recommended. Please review the Application Setting and Connection String property update for a detailed explanation.
The Sample Git repository structure is given below.
...
Build and Deploy Workflows
Navigate to the Workflows tab and create a workflow using the “+”(Click to create new Workflow) button as highlighted below.
...
Map the variables against the output of the deployFunctions operation to capture the responses.
...
Project configuration
Navigate to the Project tab and create a Project with a logical name(JavaAzureFunction in this case)
...
| Anchor | ||||
|---|---|---|---|---|
|
Configure the Source SCM repository under Source Control as shown below.
...
For detailed steps of Source Control configuration please refer to Configure Source Control in FlexDeploy
Project Properties
...
To configure Project specific settings one can navigate to the Project Configuration tab as shown above.
Next, select the PROPERTIES option from the left-hand pane.
To deploy a Function to Azure Function App, the first two mandatory properties are the Function App Name and Resource Group Name. These need to be configured under Project properties.
Remote Build: This flag is applicable in case we want to upload the code to the Azure Function App backend and build it there itself (e.g.: .NET/Node.js). We are creating the Java executable(jar) file explicitly as part of the build workflow, hence this checkbox can be left unchecked for this flow.
Under Project properties, one also needs to provide the Application Setting/Connection String file names(if applicable).
Show deployment log: Once deployment is completed, in case someone wants to verify the execution steps, they need to check the below checkbox under Project properties.
In this case, the plugin will internally retrieve the deployment Id and will fetch the Deployment log(if available), and return the same as an Output variable.
This is applicable only for Code archive deployment(not for docker image deployment.)
...
There could also be scenarios where someone only need to update the Application Setting or Connection String without actually deploying the code. In that case one can use upsertFunctionApplicationSetting or upsertFunctionConnectionString operations respectively. The workflow execution will be exactly same only the code archive creation /Docker image update step will not be required. Build workflow generated artifact should only container AppSetting.json or ConnString.json. These values can also be passed as input as already mentioned in detail in above section.
Target Properties
Select Topology from the menu and then select Topology Overview from the left menu. You will see a table that has Instances as the rows and Environments as the columns with colored circles representing the Environment Instance. Color coding represents:
...
Selecting the GREEN circle for DEV will display the configurable properties/Endpoint and allows for the configuration of
Properties | Mandatory Field | Description |
|---|---|---|
Function Slot Name |
| Target slot for deployment |
Target Slot to swap | Optional | In case slot swap is required |
Azure Cloud Account |
| Azure account with relevant details |
Absolute path of Azure CLI | Optional | Not required if Azure CLI already added to workflow execution m/c class path |
GIT Path | Optional | Path to the Git executable. Required only if git is not on class path. |
Below given are the environment-specific values which need to be updated.
...
The Azure Could account needs to be set here from the drop-down. It will show all Cloud Accounts configured under Topology, which we have already mentioned earlier.
...
| Anchor | ||||
|---|---|---|---|---|
|
Azure Function App default slot is production. However, one can configure multiple slots and deploy Functions on those slots inside Function App. Function Slot Name is a mandatory field, where the code needs to deploy.
...
executeFunctionAppSlotSwap operation can be used to perform the slot swap.
Build Execution
For detailed steps on how to initiate Build Azure Function, review artifacts, and ultimately deploy to Azure Function App please refer to Build and deploy execution through FlexDeploy
...