This operation deploys an Apigee API proxy or Shared flow to Apigee by using the maven apigee deploy plugin. You must have built artifacts as zip file or expanded folder, see Extract and Save Artifacts workflow on FlexDeploy - Apigee Plugin Guide page under Example Workflows. See Special Considerations below for details on folder structure. You can download zip file from Apigee and commit to SCM for use during build, or you can commit zip file in expanded format.
The plugin unzips any zipped file within the artifacts and will search for the API proxy or Shared flow folder and deploy it to Apigee. This operation automatically generates a pom.xml and parent-pom.xml necessary to use with Maven for deployment. If it is already present, it will be replaced. The new pom contains property replacement tokens in many places. Passwords and other values will not be stored in the file.
If a config.json file is present in the folder it will be processed. The FDAGP_ENV variable holds the environment that will be used when making replacements.
| Info |
|---|
Either FDAPG_CLOUD_ACCOUNT_CODE environment instance property value or FDAPG_INP_CLOUD_ACCOUNT_CODE plugin input value should exist. When both exists, plugin input value will take precedence. See Creating/Editing a Cloud Account and Provider for details on how to setup Cloud Account for Apigee. |
Environment/Instance Properties
| Property Name | Property Code | Required | Description | ||||
|---|---|---|---|---|---|---|---|
| Apigee Org Name | FDAPG_ORG | Yes | The org name of the Apigee account. | ||||
| Apigee Username | FDAPG_USER | Yes | The username of the Apigee account. | ||||
| Apigee Password | FDAPG_PASSWORD | Yes | The password of the Apigee account.|||||
| Apigee Environment Name | FDAGP_ENV | Yes | The environment name which the proxy or shared flow will be deployed to. | Apigee Host URL | FDAPG_HOST_URL | Yes | The host URL of the Apigee proxy. If the user is not using a private server the value should be https://api.enterprise.apigee.com |
| Apigee Deploy Option | FDAPG_DEPLOY_OPTION | Yes | The option to indicate how proxy or shared flow revision will be managed during deployment. | ||||
| Apigee Account | FDAPG_CLOUD_ACCOUNT_CODE | No | The Apigee account with all the required properties for running Apigee Instance. |
Project Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Apigee Proxy/Shared Flow Name | FDAPG_NAME | Yes | The name of the proxy or shared flow that will be deployed. This property is defaulted to the project name. This property is case sensitive and must be the exact same as the name of the API Proxy on Apigee. |
| API Type | FDAPG_API_TYPE | Yes | The type of the API, either API Proxy or Shared Flow. |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| Apigee Account | FDAPG_INP_CLOUD_ACCOUNT_CODE | No | The Apigee account with all the required properties for running Apigee Instance. |
| Additional Deploy Arguments | FDAPG_MVN_ARGS | No | Space-delimited list of additional Maven arguments (e.g. -e -X). |
Outputs
| Output Name | Description |
|---|---|
...
The artifacts folder must contain an Apigee bundle that has a maven compatible file structure. Below you can see the recommended folder structure for the project if it is an API proxy.
...