...
Property Name | Property Code | Required | Description |
|---|---|---|---|
Apigee Configuration File Path |
| No | Path to the configuration file. If a relative path is given, a path inside of the FD_ARTIFACTS_DIR will be assumed. If no path is given, edge.json will be used if it exists in the root of FD_ARTIFACTS_DIR. |
Apigee Configuration file Directory |
| No | Path to directory containing the multi-file configuration file Directory. If a relative path is given, a path inside of the FD_ARTIFACTS_DIR will be assumed. If no path is given, env/org/api folders will be used if it exists in the root of FD_ARTIFACTS_DIR. For more information on multi-file Apigee Config Deployment: https://github.com/apigee/apigee-config-maven-plugin?tab=readme-ov-file#multi-file-config |
Cloud Account Properties
Apigee Edge
...
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 |
|---|---|---|---|
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 |
...
Projects with several config entities can utilize the multi-file structure to organize config while keeping individual file sizes within manageable limits. The plugin requires the use of specific file names and directories to organize config (multi-file config). To make use of this structure, use the FDAPG_CONFIG_DIR_PATH project property.
├── api
│ ├── forecastweatherapi
│ │ ├── resourceFiles
│ │ │ ├── jsc
│ │ │ │ ├── test.js
│ │ ├── kvms.json
│ │ └── resourcefiles.json
│ └── oauth
│ ├── kvms.json
│ └── maskconfigs.json
├── env
│ ├── prod
│ │ ├── caches.json
│ │ └── flowhooks.json
│ └── test
│ ├── caches.json
│ ├── kvms.json
│ ├── targetServers.json
│ └── virtualHosts.json
│ └── references.json
│ └── keystores.json
│ └── aliases.json
└── org
├── apiProducts.json
├── developerApps.json
├── developers.json
├── kvms.json
├── companies.json
├── companyApps.json
├── reports.json
└── maskconfigs.json
└── userroles.json
...
Projects with fewer config entities can use the single file edge.json format to capture all configs of an API project. The edge.json file organizes config into 3 scopes corresponding to the scopes of config entities that can be created in Edge (single file config). The plugin looks for edge.json in the current directory by default FD_ARTIFACTS_DIR by default. If your config file is in a different directory, or the file is not names edge.json, use the FDAPG_CONFIG_FILE_PATH project property.
envConfig
orgConfig
apiConfig
...