Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A plugin for managing APIs and other components in Oracle API Platform.

Capable of exporting APIs from the Development environment, and importing them into other environments using simple workflows. 

Reduces the potential for human error when moving APIs through environments.

Key Features

  • Easily configured
  • Keeps APIs consistent across environments
  • Easily roll back changes if needed

Plugin Operations

...

Key Features

  • Automated provisioning of gateways and gateway nodes
  • Update your API state as you deploy across gateways
  • Apply API grants as you import new and existing APIs
  • Easily roll back changes or build from previous API iterations
  • Ensure you have the same iteration of your API deploying across gateways

FlexDeploy Project Recommendations

API ComponentBuild WorkflowDeploy WorkflowProject SetupGeneral Notes
API

Export flexApi.json from source control

Save Artifacts

ImportAPI (using smart import)

DeployAPI

Ideally your flexApi.json is bundled along with

your implementation and everything is built/deployed 

in one project.

  • Just copy the flexApi.json between projects
  • Change key fields, name, endpoint etc.  (Could even use FD variables)
  • Use a groovy expression to update the API status on Deployment based on the FD_ENVIRONMENT_CODE
Gateway/NodesExport gateway and node json files

ImportGateway

InstallNode

Nothing real specific here.  One project that manages 

all the gateways/nodes should suffice. 

  • Json configuration files for the nodes and gateways should utilize FD variables for environment specifics
  • Default behavior for installNode joins it to an existing logical server (this can be overridden).



Plugin Operations

Info
titleCloud Account

All plugin operations require the FDOAP_CLOUD_ACCOUNT_CODE environment instance property to be set.  See Configuring Cloud Accounts for more info.  The following properties are required for the Oracle API Platform Cloud Account

Property NameProperty CodeRequiredDescription
Oracle API Platform UrlFDOAP_API_URLYBase Url for the API Platform
Oracle Identity UrlFDOAP_IDENTITY_URLYBase Url for Oracle Identity
Oracle API UsernameFDOAP_USERNAMEYUsername for authentication
Oracle API PasswordFDOAP_PASSWORDYPassword for authentication
Oracle API AudienceFDOAP_AUDIENCEYPrimary Audience for the API Platform
Oracle API ScopeFDOAP_SCOPEYScope for making API calls
Oracle API Client IdFDOAP_CLIENT_IDYClient Id for the API Platform Application
Oracle API Client SecretFDOAP_CLIENT_SECRETYClient Secret for the API Platform Application


Additional Notes

...