This operation deploys an Apigee API proxy or Shared flow to Apigee X or Apigee Edge 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 target 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.

Target Properties

Property Name	Property Code	Required	Description

Property Name	Property Code	Required	Description
Apigee Environment Name	`FDAPG_ENV`	Yes	The environment name which the proxy or shared flow will be deployed to.
Apigee Edge Deploy Option	`FDAPG_DEPLOY_OPTION`	Yes	The option to indicate how proxy or shared flow revision will be managed during deployment. New Revision is default, other option is Update Existing Revision. Note: This property is required only for Apigee Edge.
Apigee X Deploy Option	`FDAPG_X_DEPLOY_OPTION`	Yes	The option to indicate how proxy or shared flow revision will be managed during deployment. Override is default, other options are async, inactive and clean. Note: This property is required only for Apigee X.
Apigee Account	`FDAPG_CLOUD_ACCOUNT_CODE`	No	The Apigee account with all the required properties for running Apigee Instance. Note: "On the basis of selected Cloud Account type plugin will perform the operation and do the deployment for Apigee X or Apigee Edge."

Project Properties

Property Name	Property Code	Required	Description

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

Apigee Edge

Property Name	Property Code	Required	Description

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

Apigee X

Please refer to the link for more information Set Up of Apigee X | Setting up the Cloud Account for Apigee X

Property Name	Property Code	Required	Description

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 Bearer	`FDAPGACCT_BEARER`	No	Apigee Bearer Token (Access Token) this takes precedence over service account file.
Service Account File	`FDAPGACCT_SA_FILE`	No	Content of the service account file.
Apigee Portal Site Id	`FDAPGACCT_PORTAL_SITE_ID`	No	Apigee Portal Site ID
Apigee Client Secret Key	`FDAPGACCT_GOOGLE_TOKEN_EMAIL`	No	Apigee Google Token Email

Inputs

Input Name	Input Code	Required	Description

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. Note: "On the basis of selected Cloud Account type plugin will perform the operation and do the deployment for Apigee X or Apigee Edge."
Additional Deploy Arguments	`FDAPG_MVN_ARGS`	No	Space-delimited list of additional Maven arguments (e.g. -e -X).

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 target configuration. We recommend use of LOCALHOST endpoint for simplicity. This operation will select all endpoints associated to the target.

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

Reference Guide

These files are sample files provided by Apigee for Apigee Edge:

https://github.com/apigee/apigee-deploy-maven-plugin/tree/1.x/samples

https://github.com/apigee/apigee-config-maven-plugin/tree/1.x/samples

These files are sample files provided by Apigee for Apigee X:

https://github.com/apigee/apigee-deploy-maven-plugin/tree/main/samples

FlexDeploy 8.0

apigeeDeploy