FlexDeploy - Apigee Plugin Guide
The FlexDeploy Apigee plugin allows the user to deploy Apigee API proxies and shared flows to Apigee Edge or Apigee X, plugin internally uses maven apigee deploy plugin. The FlexDeploy Apigee plugin also automatically generates the pom.xml and parent-pom.xml files, so users do not have to maintain those files.
Supported Versions
Tested on Apigee version 19.01.14
Supports Apigee Edge SaaS or Private Cloud OPDK
Key Features
Easily configured for deployment of API Proxy and Shared Flow.
Supports basic authentication.
No need to maintain maven pom files for deployment.
FlexDeploy Project Recommendations
Apigee Component | FlexDeploy Project Name | Purpose |
|---|---|---|
API Proxy | API Proxy Name | Manage single API proxy per FlexDeploy project. FlexDeploy project name should match proxy name for consistency. Use SCM for source code for API Proxy. The artifacts within the FlexDeploy project can be zipped or an expanded folder. |
Shared Flow | Shared Flow Name | Manage single Shared flow per FlexDeploy project. FlexDeploy project name should match Shared flow name for consistency. Use SCM for source code for Shared flow. The artifacts within the FlexDeploy project can be zipped or an expanded folder. |
The FlexDeploy Application name will be used as the group Id for the maven pom.xml and must only contain alphanumeric, underscore, dash, and dot characters. It is also recommended that the application name be set to the client's company name.
Cloud Account Properties
Apigee Edge
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 https://flexagon.atlassian.net/wiki/spaces/FD70/pages/10523836417/Set+Up+of+Apigee+X#Setting-up-the-Cloud-Account-for-Apigee-X
Property Name | Property Code | Required | Description |
|---|---|---|---|
Apigee Org Name |
| Yes | The org name of the apigee account. |
Apigee Host URL |
| Yes | Apigee Host URL. |
Apigee Bearer |
| No | Apigee Bearer Token (Access Token) this takes precedence over service account file. |
Service Account File |
| No | Content of the service account file. |
Apigee Portal Site Id |
| No | Apigee Portal Site ID |
Apigee Client Secret Key |
| No | Apigee Google Token Email |
Plugin Operations
Example Workflows
Simply create workflow with name and type shown below, click Save, go to Definition, click Source button, then download source code replace entire contents on Source popup.
Workflow Name | Workflow Type | Source Code | Description |
|---|---|---|---|
Extract and Save Artifacts | Build | Extract files from supported SCM and save as artifacts for use during deploy. | |
ApigeeDeploy | Deploy | Deploy build artifact files to Apigee. |
- style