Set Up of Apigee X
- Karl Henselin
- Abhishek Jadhav (Unlicensed)
Introduction
Google Cloud Introduced Apigee X The time for digital excellence is here—Introducing Apigee X. Apigee Edge and Apigee X both offer robust API management solutions, but they do have some important distinctions. Apigee Edge, the original Apigee product, has been a trusted choice for many customers. However, it is no longer an option for new purchases. Apigee X represents the latest version of the Apigee product, encompassing all the features of Apigee Edge and exciting new additions. It’s the go-to choice for new purchases. The key difference between Apigee Edge and Apigee X boils down to availability. Apigee X is readily accessible to new customers, whereas Apigee Edge is not.
Please refer for more information:
Apigee X: Google Cloud’s More Powerful API Management Platform | Google Cloud Blog
What is Apigee X, and why is it a powerful API tool
Plugin Operations
apigeeDeploy : This operation deploys an Apigee API proxy or Shared flow to Apigee X or Apigee Edge by using the maven apigee deploy plugin.
apigeeConfigDeploy : This operation deploys Configurations like API Products, Developers, Developer Apps, Flow hooks, Extensions, Mask Config, Custom Roles, Cache, KVM, Target Server, and Resource Files, to the Apigee host by using the maven apigee config plugin.
Please refer for more information FlexDeploy - Apigee Plugin Guide
Setting up the Cloud Account for Apigee X
To perform deployment on Apigee X we need to configure the cloud account.
On clicking the create button, we will get option to add the details.
Note: 1. We can use either bearer token or service account key file, if both provided bearer token takes precedence over service account file.
2. Google token email option is only available for Apigee deploy.
Generate Service Account File
service account key file is the file associated with our GCP service cloud account. We can download this file from the GCP console.
Note: Permissions for deploying different types of resources on Apigee X, needs to be assigned to the Service Account.
Please refer to the link for more information about Service Account and Service Account File.
Create and delete service account keys | IAM Documentation | Google Cloud
Generate Bearer Token
Access-token can be generated using the key file.
gcloud auth activate-service-account --key-file ${KEY_FILE}
e.g
gcloud auth activate-service-account --key-file "C:\\Users\\GCP\\demo-account-38555-c4605d668ba.json"
gcloud auth print-access-tokenNote: We can use the --lifetime option on the gcloud auth print-access-token to set the expiration lifetime explicitly.
The default access token lifetime is 3600 seconds, but we can use this flag to reduce the lifetime or extend it up to 43200 seconds (12 hours).
Please refer to the link for more information.
https://developers.google.com/spectrum-access-system/guides/authorization-and-authentication
Workflow example for Apigee X
For Apigee X we have to select the Apigee X related cloud account from the drop down list. This list have both Apigee X and Apigee Edge related account. On the basis of selected Cloud Account type plugin will perform the operation and do the deployment for Apigee X or Apigee Edge. In this example we have selected “APIGEEX” Cloud Account.
Target properties example for Apigee X
Cloud Account: For Apigee X we have to select the Apigee X related cloud account from the drop down list. Cloud account provided from the workflow will takes precedence over cloud account provided as target property.
Apigee Environment Name: The environment name which the proxy or shared flow or Configurations will be deployed to.
Apigee X Deploy Option: The option to indicates how proxy or shared flow revision will be managed during deployment. Override is default, other options are async, inactive and clean.
Apigee X Config Deploy Option: This option to indicates the mode of deployment for the configurations. Update is default, other options are create, delete and sync.
- style