Revision as of 20:35, 14 April 2014

Overview

This proposal includes the ability to setup different capabilities for different datastore types. This is a management only feature, useful for globally enabling/disabling capabilities. The only exception to that is the List Capabilities for Datastore. That method would be available to all users, so that end users could determine the behavior of a particular datastore.

An example capability would be "volume_support". As a result of a datastore having this capability,an block storage volume would be created on server create. A datastore without this capability (such as redis) would not create a volume.

Capabilities

Supported with the first iteration:

• volume_support - When creating an instance, a cinder volume will be provisioned with the server
• enable_root_user - When creating an instance, the root user password is returned to the user

Eventually we want to add support for the following capabilities:

• multiple_users - If not enabled, return an appropriate error code for any user related routes
• databases - If not enabled, return an appropriate error code for any database related routes (ie, redis does not support database, but mysql should)
• security_groups

API Resources

Summary

Example Calls

List Capabilities (GET)

This call lists all capabilities

GET /capabilities

Response

{
   "capabilities": {
       [
           {
               "id": "550e8400-e29b-41d4-a716-446655440000",
               "name": "Volume Support",
               "description": "If enabled, a cinder volume will be created and attached to the database server"
               "enabled": true
           }
       ]
   }
}

List capabilities for a datastore version

This call lists all capabilities that are associated with a particular datastore version

GET datastore_versions/e60153d4-8ac4-414a-ad58-fe2e0035704a/capabilities

Response

{
   "capabilities": {
       [
           {
               "id": "550e8400-e29b-41d4-a716-446655440000",
               "name": "Volume Support",
               "description": "If enabled, a cinder volume will be created and attached to the database server"
           }
       ]
   }
}

Add a capability to a datastore version

This call allows a user to associate a capability to a datastore version

POST datastore_versions/e60153d4-8ac4-414a-ad58-fe2e0035704a/capabilities

Request Body

{
    "capability_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response"""

{
   "capabilities": {
       [
           {
               "id": "550e8400-e29b-41d4-a716-446655440000",
               "name": "Volume Support",
               "description": "If enabled, a cinder volume will be created and attached to the database server"
           }
       ]
   }
}

List Capabilities (GET)

This call lists all capabilities

GET /capabilities

Response

{
   "capabilities": {
       [
           {
               "id": "550e8400-e29b-41d4-a716-446655440000",
               "name": "Volume Support",
               "description": "If enabled, a cinder volume will be created and attached to the database server"
               "enabled": true
           }
       ]
   }
}

Database Schema

Two new entities will be created in the trove database: capabilities and datastore_capabilities. These entities will store the capabilities and the association between those capabilities and the datastore

Capabilities (capabilities)

This table will contain the id, name and description of the capabilities

Datastore Capabilities (datastore_capabilities)

This table maintains a many-to-many relationship of datastores to capabilities via the foreign key references to capability_id and datastore_id