Automating Your Businesswith the RightScale MultiCloud APISelf-Service Portals, One-Click SaaS, and More

Darryl Eaton, Director of Product Management

Josep Blanquer, Senior Systems Architect

# 2# 2

Talk with the Experts.

Agenda

• The Platform • About the API• Some Examples• Customer Use Cases

# 3# 3

Talk with the Experts.

RightScale is a Cloud Platform…

A blueprint of cloud services that make up what we typically call a ‘server:’• A location…• A certain size machine…• Some attached disks…• Some networking config…

so you can just press play.

POST /api/serversPOST /api/servers/23409/launch

Create instance.Launch.Attach IP.Attach volumes.

What is a Server?

# 4# 4

Talk with the Experts.

… With Building Blocks for Automation• Server Configuration Blueprints (ServerTemplates)• Cross-Cloud Image Collections (MultiCloud Image)• Deployments and Servers• Server Arrays• Configuration Variables (Inputs)• Monitoring Alerts and Escalation Definitions (AlertSpecs)• Default Settings for Clouds, Servers• Volume and Snapshot Behavioral Definitions• Resource Tags• Users and Roles (Permissions)• Network Rules (Security Groups)

# 5# 5

Talk with the Experts.

About the MultiCloud API

• RESTful: Resource URLs, HTTP Verbs, Error Codes, …

• Versioned: 1.5+ is our new MultiCloud API (1.0 is Legacy API for Ec2 Only)

• Supports JSON and XML Response Formats• Flexible Authorization: Account (user/pass, OAuth2) or from Instance (token)

• Simple resource queries through filters• Customer control of detail level through views• MediaTypes support and annotated responses• Extensive documentation, examples, and a Ruby client

A Common Programmatic Interface Across Multiple Clouds

# 6# 6

Talk with the Experts.

MediaTypes and Annotated Responses• Each Resource has an associated MediaType that includes:

• Attributes• Links (navigation hrefs to related resources)• Actions (possible actions to perform to the specific resource)

• Example response for an instance resource (simplified):

Content-Type: application/vnd.rightscale.instance

<instance> <name>name_361342744</name> <state>operational</state> <links> <link rel="self” href="/api/clouds/479517647/instances/ABC2383349127DEF”/> <link rel="deployment” href="/api/deployments/1181”/> <link rel="server_template” href="/api/server_templates/1223”/> </links> <actions> <action rel="terminate"/> <action rel="run_executable"/> </actions></instance>

# 7# 7

Talk with the Experts.

Login into an Account Session• POST /api/session

POST /api/session HTTP/1.1X_API_VERSION:1.5Content-Length: 78Content-Type: application/x-www-form-urlencoded

email=me@me.com&password=pass&account_href=/api/accounts/11

curl -X POST https://my.rightscale.com/api/session -d email=’me@me.com' -d password=’pass' -d account_href=/api/accounts/11 -H X_API_VERSION:1.5 -c /tmp/cookie

HTTP/1.1 204 No ContentSet-Cookie: rs_gbl=eNotkMtugkAUQP_lrpmEki4qbbUysO0VDYE78xQxJGqKKLx36tJ9… domain=.rightscale.com; path=/; HttpOnlySet-Cookie: _session_id=34311a9f4178768dece0159…; path=/; Secure; HttpOnly

Re

qu

est

Re

spo

nse

# 8# 8

Talk with the Experts.

Retrieving a Resource• GET /api/servers/9999

curl -X GET https://my.rightscale.com/api/servers/9999-H X_API_VERSION:1.5 -b /tmp/cookie

<server> <name>App Server1</name> <description>A PHP App server</description> <state>inactive</state> <updated_at>2012/05/24 19:35:58 +0000</updated_at> <created_at>2012/05/24 19:35:58 +0000</created_at> <links> <link rel="self" href="/api/servers/319715091"/> <link rel="deployment" href="/api/deployments/221556001"/> <link rel="next_instance" href="/api/clouds/2000/instances/AVPBOVP2TMTGB"/> </links> <actions> <action rel="launch"/> </actions></server>

# 9# 9

Talk with the Experts.

Querying Resources: Optional Filters• GET /api/servers

curl -X GET https://my.rightscale.com/api/servers-H X_API_VERSION:1.5 -b /tmp/cookie

[ {"name":"PHP FrontEnd (Chef Alpha) -2", "description":”My super server”, "state":"inactive", "links":[ {"rel":"self","href":"/api/servers/710990"}, {"rel":"deployment","href":"/api/deployments/1111"}, ], "created_at":"2009/12/01 21:51:31 +0000",},… { "name":”Database Master", "description":”Data Vault server”, "state":”operational", "links":[ {"rel":"self","href":"/api/servers/84936"}, {"rel":"deployment","href":"/api/deployments/99999"}, ], "created_at":"2009/12/01 21:51:31 +0000”}]

Note Container for Possible Filter

# 10# 10

Talk with the Experts.

Querying resources: filters• GET /api/servers?filter[]=“deployment_href==/api/deployments/1111”

curl -X GET https://my.rightscale.com/api/servers-H X_API_VERSION:1.5 -b /tmp/cookie

[ {"name":"PHP FrontEnd (Chef Alpha) -2", "description":”My super server”, "state":"inactive", "links":[ {"rel":"self","href":"/api/servers/710990"}, {"rel":"deployment","href":"/api/deployments/1111"}, ], "created_at":"2009/12/01 21:51:31 +0000",},… { "name":”Database Master", "description":”Data Vault server”, "state":”operational", "links":[ {"rel":"self","href":"/api/servers/84936"}, {"rel":"deployment","href":"/api/deployments/99999"}, ], "created_at":"2009/12/01 21:51:31 +0000”}]

# 11# 11

Talk with the Experts.

Querying resources: filters (insights)• Think bottom up: query the index URL of the MediaType

• List Servers in a deployment• GET /api/servers? filter[]=“deployment_href==/api/deployments/1111”

• List Snapshots taken from a Volume• GET /api/clouds/1/volume_snapshots? filter[]=“volume_href==/api/clouds/1/volumes/22”

• Embrace 1-to-many relationship resources• Connecting two resources is achieved by creating a new middle resource• E.g.,: Attaching a Volume to an Instance -> create a VolumeAttachment

• POST /clouds/1/volume_attachments (instance_href=X, volume_href=Y, device=/dev/sdk)

• Some top-down options available for convenience• Simpler URLs but less powerful and generic• List all servers within a deployment

• GET /api/deployments/1111/servers

• Attach a volume to Instance 2222• POST /api/clouds/1/instances/2222 (volume_href=X, device=/dev/sdk)

GET /api/servers? filter[]=“deployment_href==/api/deployments/1111”

GET /api/clouds/1/volume_snapshots? filter[]=“volume_href==/api/clouds/1/volumes/3”

POST /clouds/1/volume_attachments (instance_href=X, volume_href=Y, device=sdk)

GET /api/deployments/1111/servers

POST /api/clouds/1/instances/2222 (volume_href=X, device=sdk)

# 12# 12

Talk with the Experts.

Dialing in the Details: Views• GET /api/clouds/99/security_groups

curl -X GET https://my.rightscale.com/api/clouds/99/security_groups -H X_API_VERSION:1.5 -b /tmp/cookie

[ {"resource_uid":"sg-aaaaaaaa", "name":"GOBBLEDEGOOK", "links":[ {"rel":"self","href":"/api/clouds/99/security_groups/3UGV9J085F9XA”, {"rel":"cloud","href":"/api/clouds/99"}, {"rel":"security_group_rules","href":"/api/clouds/99/security_groups/

3UGV9J085F9XA/security_group_rules"} ]},… {"resource_uid":"sg-bbbbbbbb", "name":”SomeotherSG", "links":[ {"rel":"self","href":"/api/clouds/99/security_groups/2T1V9J08202NT”, {"rel":"cloud","href":"/api/clouds/99"}, {"rel":"security_group_rules","href":"/api/clouds/99/security_groups/

2T1V9J08202NT/security_group_rules"} ]},]

No view = Default view!

# 13# 13

Talk with the Experts.

Dialing in the amount of details: views• GET /api/clouds/99/security_groups?view=tiny

curl -X GET https://my.rightscale.com/api/clouds/99/security_groups?view=tiny -H X_API_VERSION:1.5 -b /tmp/cookie

[ {"href":"/api/clouds/99/security_groups/3UGV9J085F9XA”}… {"href":"/api/clouds/99/security_groups/2T1V9J08202NT”}]

# 14# 14

Talk with the Experts.

Performing Actions• POST /api/servers/9999/terminate

curl -X GET https://my.rightscale.com/api/servers/9999/terminate -H X_API_VERSION:1.5 -b /tmp/cookie

HTTP/1.1 204 No Content

• Some long running actions return a task for tracking:• POST /api/servers/9999/terminate

HTTP/1.1 202 Accepted

Location: /api/clouds/9/instances/2T1V9J08202NT/live/tasks/ae-12345

# 15# 15

Talk with the Experts.

Example from the RightScale Ops Team

POST /api/tags/by_tag (resource_type=instances,tags=[svc:app=true])

foreach instance_href as i {POST {i}/run_executable

(recipe_name=pull_code) // get 202 & task-id

do GET /…/task/{task-id}until(status == completed)

POST {i}/run_executable (recipe_name=web_restart)}

Get all servers by app tag

For each Server in result

Get new code

Wait for code to download

Restart Web server

•Rolling upgrade of your app servers:

# 16# 16

Talk with the Experts.

Same example using our right_api_client

Get all servers by tag

For each Server in result

Get new code

Wait for code to download

Restart Web

# 17# 17

Talk with the Experts.

Customer Use Case: One-Click SaaS1. Provision a new RightScale account, assign cloud credentials

2. Add common IT administrators to account

3. Add first customer user

4. Import the necessary server configurations into the account

5. Create the client’s deployment

6. Create the servers within the deployment with the correct configurations

7. Start the servers with the appropriate parameters

# 18# 18

Talk with the Experts.

1. Display a list of approved configurations to users

2. User selects single configuration, provides inputs like username and password for application

3. Create a new server based off that configuration, launch it

4. Tag the server with the user’s department for reporting

5. Get the public URL/IP once it is operational, return to user

6. User logs into application with provided username/password

7. Pull report on a periodic basis to show department spend

# 19# 19

Talk with the Experts.

What’s coming…• Executables

(RightScripts, Chef Recipes)• Create, Read, Update, Delete• Maintain in external repository,

push into RightScale via API

• Cost Reporting• SAML User Provisioning• Retiring 1.0 (EC2 Only API)• 1.5 will become 2.0 –

feedback welcome now!

# 20# 20

Talk with the Experts.

Resources• support.rightscale.com References

• http://support.rightscale.com/15-References/RightScale_API_Reference_Guide

• support.rightscale.com/api1.5 (MultiCloud API)• support.rightscale.com/rdoc (API 1.0 EC2 Only)

Talk with the Experts.

Questions? Feedback?