pwillemse / xld-apigee-plugin

XL Deploy Apigee plugin

Preface

This document describes the functionality provided by the Apigee plugin.

See the XL Deploy reference manual for background information on XL Deploy and deployment automation concepts.

Overview

The Apigee plugin is a XL Deploy plugin that adds capability for deploying applications to an Apigee environment within an Apigee Organization.

Requirements

• Requirements
  • XL Deploy 7.0.1+

Installation

• Copy the latest JAR file from the releases page into the XL_DEPLOY_SERVER/plugins directory.
• Restart the XL Deploy server.

Usage

1. Go to Repository - Infrastructure, create a new apigee.Organization and fill in the properties. If needed, create also a overthere.HttpProxy and refer to it. See the end of the page for an example.
2. Go to Repository - Infrastructure - <Apigee Organization>, create a new apigee.Environment and fill in the Apigee environment name.
3. Repeat the previous step for all the Apigee environments that belong to this Apigee organization.
4. Create an environment under Repository - Environments and add the corresponding <Apigee Environment> as container.

Deployables

The plugin supports three types of deployables:

1. Create an deployment package udm.DeploymentPackage with apigee.ApiProxyZip as deployables. This is an API proxy. The deployment package name can be any version number i.e. 2.1.3. The deployable name should be the same as the Apigee Proxy name i.e. helloworld. During deployment, the deployable (the exported revision) will be imported to Apigee and then deployed. During undeployment, the revision will be deleted if the property deleteApiProxyRevisionAfterUndeployment is set to True.
2. Create an deployment package udm.DeploymentPackage with apigee.SharedFlowZip as deployables. This is a shared flow. The deployment package name can be any version number i.e. 2.1.3. The deployable name should be the same as the Apigee Proxy name i.e. helloworld. During deployment, the deployable (the exported revision) will be imported to Apigee and then deployed. During undeployment, the revision will be deleted if the property deleteSharedFlowRevisionAfterUndeployment is set to True.
3. Start deploying.

Types

• apigee.Organization
• apigee.Environment
• apigee.DeployedApiProxyZip
• apigee.ApiProxyZip
• apigee.DeployedSharedFlowZip
• apigee.SharedFlowZip

Apigee Org Configuation

Apigee Environment Configuation

UDM Environment Configuation

API Proxy Spec App Configuation

Example Deployment

Example of Http Proxy