Add-on Provider Program

With cloudControl's Add-on provider program, you can make your cloud service available to developers world wide with only a few clicks.

This guide will be most helpful if you already run through the Add-on integration process with Heroku. If you are new to this and want to offer your Add-on to our developers, feel free to contact Henning, he will guide you through the process and help you with the integration.

This document will help you with the necessary technical changes and gives you an overview of the business process.

Benefits of the Program

  • Make your service available to thousands of cloudControl developers
  • Receive feedback from hundreds of beta users
  • Billing, payment (incl. German VAT) and first-level support is managed by the cloudControl staff
  • Develop your Add-on with industry standards
  • Joint marketing efforts with the cloudControl team

Technical Integration

cloudControl has specifically designed its Add-on provider program to follow the same technical steps for building and using an Add-on as found in the Heroku Add-on process guide. Below is a general outline of the process as well as instructions that are specific to cloudControl. If you have no provisional API yet, you can use this one.

First steps

1. Access the cloudControl Add-on Program

To access the program, signup for the platform here (free). Once done, use the preset email to unlock Add-on access for your account.

2. Install the kensa tool (version 1.2 or higher)

$ sudo gem install kensa

3. If you don't have a Heroku-style Add-on manifest, create one

$ kensa init

Note: To avoid confusion, we suggest to rename the manifest.json to cloudcontrol-manifest.json.

4. Individualize your Add-on manifest

Note: Heroku used to require you to specify your production server, and then Heroku would construct the URL used to provision your Add-on by appending "/heroku/resources" to it. Now you can provide a hash instead of a string, as shown below:

{
"id": "your-addon",
 "api": {
   "config_vars":["..."],
     "password":"...",
   "sso_salt":"...",
   "production":  {"base_url":"https://your.add-on.com/cloudcontrol/resources",
                      "sso_url":"https://your.add-on.com/cloudcontrol/resources"},
    }

Using this method allows you to control the URLs you use to provision your Add-on, and makes it easy for you to track requests coming from different cloud providers.

Note: When your Add-on receives a provisioning request from cloudControl, instead of "heroku_id" (as indicated in the Heroku documentation), you will see "cloudcontrol_id".

If you don't use the new manifest format described above, cloudControl will append "/cloudcontrol/resources" to your production URL.

 5. You should use kensa to validate your Add-on manifest and simulate provisioning, de-provisioning, plan changes etc.

$ kensa --help

6. Upload your Add-on manifest to cloudControl

Before you upload the cloudcontrol-manifest.json, set the environment variable ADDONS_URL=https://api.cloudcontrol.com:

$ ADDONS_URL=https://api.cloudcontrol.com kensa push -f cloudcontrol-manifest.json

7. Proceed to alpha testing

Note: cloudControl's platform is hosted in Amazon's EU region; if your Add-on needs a low latency connection to the applications using it, then you should co-locate with us at Amazon.

 

Business Process

The process of becoming Add-on partner can be achieved within 2-3 weeks, depending on effort and user feedback. These are the steps you need to achive on the business side:

1. Sign up for the Program

  • Either login with your existing cloudControl account or sign up for cloudControl's Add-on program directly
  • Agree to cloudControl's MoU & Add-on program terms

2. Building & Testing

  • Complete the tutorial (optional but recommended)
  • Download & install the Add-on development kit
  • Create and test your Add-on (see steps below)
  • Create Docs and libraries

3. Submit your Add-on to cloudControl

  • Test your production service
  • Submit manifest.json and docs to cloudControl

4. Alpha Testing

  • Provide documentation for your Add-on (Pull Request to our Repo)
  • Verify your account by sending us the signed MoU
  • Verify that SSO to your dashboard works
  • Implement their feedback
  • Mark your Add-on as complete

5. Beta Testing

  • Add your Add-on to the add-on marketplace
  • Start private beta (for chosen cloudControl users)
  • Implement feedback
  • Request public beta for all cloudControl users
  • Implement feedback of public beta

6. General Availability

  • Design your final pricing model
  • Define plans
  • Request general availability

7. Joint Marketing Efforts

  • Add your Add-on to the Add-on catalog
  • Claim your mention in cloudControl's newsletter
  • Submit a post for cloudControl's blog

Contact

Henning Paulke
Head of Partner Management
Email:
hp@cloudcontrol.de