Introduction

Last Edited: July 24th, 2014

Key Topics

  1. Introduction
  2. General Concepts
  3. CF Commands
  4. Billing Lifecycle
  5. Single Sign On

Integrating to Cloud Foundry

Cloud Foundry's marketplace is built on top of AppDirect's marketplace CMS. For an ISV wishing to onboard to Cloud Foundry's marketplace, they will first onboard in to AppDirect's master catalog. From there they can be added to the curated sub-set of applications listed on Cloud Foundry's marketplace.

 

This section outlines the various steps an ISV will need to take to onboard to the Cloud Foundry marketplace. There are two types of applications that can be onboarded to the marketplace:

 

  1. Editions-based applications that cannot be bound to an application in development on Cloud Foundry's platform
  2. Add-On based applications that can be bound to applications in development on Cloud Foundry's platform.

Types of Integrated Applications

There are two primary types of applications that can be integrated for Cloud Foundry's marketplace: Editions-based applications and Addon-based applications. Editions-based applications are applications that are not bindable (i.e. cannot be bound to applications in development on Cloud Foundry's platform) and can be associated with one or more applications. New Relic is an example of an application that is an Editions-based application. Editions-based applications should follow the integration steps outlined in the "Editions-based Applications" section below.

 

Addon-based applications are applications that can be bound to a specific application in development on Cloud Foundry's platform. These applications require an additional BIND / UNBIND operation after the service has been provisioned. MongoLab Database-as-a-Service is an example of an Addon-based application that allows for the database to be bound to an application in development. A minority of services are expected to require the extra binding operation. Addon-based applications should follow the integration steps outlined in the "Add-Ons Based Applications" section.

Editions-Based Applications

Applications that are editions-based are services that cannot be bound to applications in development on the Cloud Foundry platform and are usually associated with multiple applications. Editions-based applications will follow the standard API integration documentation for integrating to AppDirect's platform. 

An ISV should refer to the following documents for guidance on how to integrate to the platform:

  • Get familiar with the integration and get an overview of the integration to AppDirect in the Introduction section
  • Become familiar with the General Concepts associated with a Cloud Foundry integration
  • Understand and begin integration for Subscription Management which will walk an ISV through the various API calls that AppDirect will make upon the purchase, provisioning and cancellation of an application

Add-Ons Based Applications

Add-Ons based applications are services that have multiple add-ons that can be bound to applications in development on the Cloud Foundry platform. Add-Ons based applications will follow these Cloud Foundry specific steps outlined in the sections below: 

An ISV should refer to the following documents for guidance on how to integrate to the platform:

  • Get familiar with the integration and get an overview of the integration to AppDirect in the Introduction section
  • Become familiar with the General Concepts associated with a Cloud Foundry integration
  • Understand and begin integration for Subscription Management which will walk an ISV through the various API calls that AppDirect will make upon the purchase, provisioning and cancellation of an application
  • Integrate to the Cloud Foundry Commands

Prerequisites

Before you can integrate any add-on successfully through the Cloud Foundry marketplace, you must:

  1. Register a developer account on the Cloud Foundry Marketplace developer portal, so you can create profiles for your add-ons and configure their integration
  2. Register an account on the Cloud Foundry Web Console, so you can host your apps on Cloud Foundry and purchase add-ons — including your own add-ons while you test their integration.
  3. Install the cf command-line interface (CLI) gem.
    • Complete the steps that Cloud Foundry describes here (NOTE: AppDirect is not responsible for the timeliness, accuracy, or suitability of information on any third-party website).
    • Run gem install cf in a command line. (TIP: This CLI syntax always installs the latest cf version. NOTE: Because you have now installed Ruby, this CLI syntax is OS-agnostic).
  4. Configure cf to target the Cloud Foundry Web Console by running these commands in its command line:
    • cf target api.a1.cf-app.com
    • cf login