FlexDeploy - Oracle API Platform Plugin Guide

Owned by Ben Hoffman
Last updated: May 14, 2019 by Joel Wenzel

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

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

ExportAPI

ImportAPI (using smart import)

DeployAPI(use the output iteration from the import step)

One project per API.

  • Group in a release along with whatever back end code is needed.
  • Recommend saving the API iterations as workflow outputs for visibility. 
  • 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


Cloud Account and where to find the properties


Cloud 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

From the MyServices dashboard.. click 'Users' and then 'Identity Console'

The following macros are not currently supported in the footer:
  • style