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.

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 Environment Name	FDAGP_ENV	Yes	The environment name which the proxy or shared flow will be deployed to.
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.

Cloud Account Properties

Property Name	Property Code	Required	Description
Apigee Org Name	FDAPGACCT_ORG	Yes	The org name of the apigee account.
Apigee Host URL	FDAPGACCT_HOST_URL	Yes	Apigee Host URL.
Apigee Authentication Type	FDAPGACCT_AUTHTYPE	Yes	Apigee Authentication Type
Apigee Username	FDAPGACCT_USER	Yes	The username of the apigee account.
Apigee Password	FDAPGACCT_PASSWORD	Yes	The password of the apigee account.
Apigee Token URL	FDAPGACCT_TOKEN_URL	No	Apigee Token URL.
Apigee MFA Token	FDAPGACCT_MFA_TOKEN	No	Apigee Multi Factor Authentication token
Apigee Bearer	FDAPGACCT_BEARER	No	Apigee Bearer Token (Access Token)
Apigee Refresh	FDAPGACCT_REFRESH	No	Apigee Refresh Token
Apigee Client Id	FDAPGACCT_CLIENT_ID	No	Apigee Client Id
Apigee Client Secret Key	FDAPGACCT_CLIENT_SECRET	No	Apigee Client Secret Key

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

Artifacts

This operation consumes artifacts from the artifacts repository.

Endpoint Selection

This operation does not require any specific external libraries or tools, hence you can add any endpoint to environment/instance configuration. We recommend use of LOCALHOST endpoint for simplicity. This operation will select all endpoints associated to the environment/instance.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

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.

API Proxy Folder Structure

      |-gateway/ ***
        |-test-app/
          |-apiproxy/
            |-proxies
            |-resources/
              |-py
            |-policies
            |-targets

Below you can see the recommended folder structure for the project if it is a shared flow.

Shared Flow Folder Structure

	  |-gateway/ ***
        |-test-app/
          |-apiproxy/
            |-proxies
            |-resources/
              |-py
            |-policies
            |-targets

FlexDeploy 5.4

apigeeDeploy