Introduction

Purpose

Provide ability that user can use UCS blades as hardware resource pool in CloudStack, and provisioning operation system/hypervisor on UCS blade by CloudStack baremetal feature

Document History

...

User workflow [new in 4.2.1]

Image Added

Feature Specifications

• The feature would allow user to register UCS manager through CloudStack UI and provision OS/hypervisor on blades by CloudStack baremetal feature 
• Currently this feature would only support:
  • Registering UCS manager
  • Listing UCS profiles in CloudStack UI
  • Listing UCS blades 
  • Selecting a UCS profile and associating it to a selected blade
  • Provisioning the blade in previous step with baremetal template
  • Only supporting CloudStack basic mode
• Not supported features:
  • Releasing a blade back to resource pool(in next version)
  • Sync with UCS manager(assuming user won't change UCS hardware setup after registering into CloudStack)

Use cases

NOTE: Please refer to section "Web Service APIs" for usage of API showing in this section. For UCS terms and instructions that is out of scope of this documentation, please refer to attached Cisco documents for details  

1. add UCS manager

...

once you have your UCS setup in lab, you should have below information:

• UCS manager IP address
• UCS manager username
• UCS manager password

call CloudStack API addUcsManager to register UCS manager. After registering, CloudStack will automatically discover blades and add them into resource pool. The resource pool is created automatically after UCS manager was added.

LIMITATIONS: in this phase, we assume user will not add/remove blades in setup after registering UCS manager into CloudStack. That means, CloudStack will not notice your changes on UCS hardware after UCS manager was registered

2. list UCS

...

templates [new in 4.2.1]

you are able to retrieve pre-created UCS profile templates from UCS manager by calling listUcsProfile listUcsTemplates. You do this largely before associating a you are about to create a profile off template and associate the profile to a selected blade which is explained in later use case. . see instantiateUcsTemplateAndAssocaciateToBlade

NOTE: profile is 1. templates are synced between CloudStack and UCS manager. That means any change on profiles will be Any new added or removed templates are reflected next time you call listUcsProfile.call this API.

           2. per Cisco suggestion, only initial-template should be used for CloudPlatform integration

3. list UCS blades

after registering UCS manager into CloudStack(use case 1), CloudStack will consult UCS manager for current blades in UCS setup. These blades would be retrieved by calling *calling listUcsBlade.  * You do this largely before associating a

...

LIMITATIONS: in this phase, we assume user will not add/remove blades in setup after registering UCS manager into CloudStack. That means, CloudStack will not notice your changes on UCS hardware after UCS manager was registered

4.

...

instantiate UCS template and associate result profile to blade [new in 4.2.1]

once you have a template DN returned by listUcsTemplatesonce you have known how to retrieve UCS profiles and UCS blades through CloudStack, you are able to call instantiateUcsTemplateAndAssocaciateToBlade to associate create a UCS profile and associate it to a UCS blade by calling associatesUscProfileToBlade. When you doing this, CloudStack actually clonesa new profile from the profile you selected in "list UCS profile", which means the profile you selected is used as a template of actual profile associated to the blade. You can check the new created profile in UCS managerreturned by listUcsBlade.

NOTE: this operation will take a couple of minutes to finish, please wait with patient until it finished or timeout. The default timeout is 10 60 minutes which is not configurable at current stage

...

has not been finished at that time so I postponed this feature temporarily. It will come out soon.

6.

...

disassociate profile from UCS blade.

once you decide can call disassociateUcsProfileFromBlade to return remove a profile from UCS blade which has been added to baremetal cluster to resource pool, you should first remove the host from baremetal cluster by calling deleteHost. You don't have to do it by calling API, CloudStack UI has prefectly

implemented it. Details could be find in "CloudStack Administrator Guide"

At stage, releasing UCS profile from UCS blade has not been implemented yet. You have to go to UCS manager to do so. You can identify a blade in UCS manager using its DN which is part of response of listUcsBlade API, once the blade is identified, disassociating

. An optional parameter deleteProfile is given to indicate if the unassociated profile needs to be deleted after disassociation.

7. sync between UCS manager and CloudPlatform [new in 4.2.1]

sometimes user may directly operate on UCS manager for stuff like association or dissociation, this makes states between CloudPlatform and UCS manager out of sync. You can call refreshUcsBlades to instruct CloudPlatform to sync states with UCS managerprofile would release resource the blade uses.

Architecture and Design description

Implementation:

The feature is implemented as a plugin service locating in incubator-cloudstack/plugins/hypervisors/ucs. The service is self-contained with own API, it will not interfere with workflow of other CloudStack components.

web services APIs

addUcsManager

curl "http://localhost:8096/?command=addUcsManager&zoneid=$zoneid&name=ucsmanager&url=$url&username=admin&password=C1tr1x99"

addUcsManager response

...

listUcsProfile

...

listUcsTemplates

...

curl "http://localhost:8096/?command=listUcsProfile&ucsmanagerid=$ucsid"

...

listUcsTemplates response (list response)

...

...

listUcsBlade

...

listUcsBlades

...

curl "http://localhost:8096/?command=listUcsBlade&ucsmanagerid=$ucsid"

listUcsBlade response (list response)

...

associatesUscProfileToBlade

...

instantiateUcsTemplateAndAssocaciateToBlade

...

example:

curl "http://localhost:8096/10.215.3.5:8080/client/api?command=associatesUscProfileToBladeinstantiateUcsTemplateAndAssocaciateToBlade&ucsmanagerid=$ucsid&profiledn=$profileDn&bladeid=$bladeId"associatesUscProfileToBlade response9a34c186-12fa-4bbc-af04-5f1a2bf7ae4a&templatedn=org-root/ls-test&bladeid=3d491c6e-f0b6-40b0-bf6e-f89efdd73c30&profilename=xxxx&response=json&sessionkey=jmyGgRQO30V0QPKm%2BLcx9sl0ciU%3D&_=1381451319292

instantiateUcsTemplateAndAssocaciateToBlade response:

the same as listUcsBlade response, while associatedProfileDn points to profile the blade associates to

example:

{ "queryasyncjobresultresponse" : {"accountid":"970b694a-2f8c-11e3-a77d-000c29b36ff5","userid":"970b7b4f-2f8c-11e3-a77d-000c29b36ff5","cmd":"org.apache.cloudstack.api.InstantiateUcsTemplateAndAssociateToBladeCmd","jobstatus":1,"jobprocstatus":0,"jobresultcode":0,"jobresulttype":"object","jobresult":{"ucsblade":{"id":"3d491c6e-f0b6-40b0-bf6e-f89efdd73c30","ucsmanagerid":"9a34c186-12fa-4bbc-af04-5f1a2bf7ae4a","bladedn":"sys/chassis-1/blade-3","profiledn":"org-root/ls-xxxx"}},"created":"2013-10-10T17:29:00-0700","jobid":"cd9d0282-4dae-463f-80b6-451e168e2e92"} }

listUcsManagerslistUcsManager:

listUcsManager response

the same as addUcsManager

UI flow

• A new page for adding resource pool
• A new page for adding UCS manage in 'Add Resrouce Pool' page
• A new page for associating UCS profile to a selected UCS blade
• A new page for convert a UCS blade to Baremetal host

UI should be implemented using pluggable UI framework, for it's able to be dsiabled when needs

DB Schema:

...

mysql> describe ucs_blade;

...

disassociateUcsProfileFromBlade 

disassociateUcsProfileFromBlade response:

success response

refreshUcsBlades

refreshUcsBlades response:

the same to listUcsBlades

UI flow

Image Added Image Added Image Added Image Added Image Added Image Added Image Added Image Added

DB Schema:

mysql> describe ucs_blade;
+----------------+---------------------+------+-----+---------+----------------+
|

...

 Field          | Type                | Null | Key | Default | Extra          |
+----------------+---------------------+------+-----+---------+----------------+
|

...

 id             | bigint(20) unsigned | NO

...

   | PRI |

...

 NULL    | auto_increment |
|

...

 uuid           | varchar(40)

...

         | YES  | UNI | NULL    |                |
| ucs_manager_id | bigint(20) unsigned | NO

...

   |     | NULL    |                |
| host_id        | bigint(20) unsigned | YES

...

| dn             | varchar(512)        | NO   |     | NULL    |                |

...

| profile_dn     | varchar(512)        | YES  |     | NULL    |                |

...

  |     | NULL    |                |
| dn             | varchar(512)        | NO   |     | NULL    |                |
| profile_dn     | varchar(512)        | YES  |     | NULL    |                |
+----------------+---------------------+------+-----+---------+----------------+

mysql> describe ucs_manager;
+----------+---------------------+------+-----+---------+----------------+
|

...

 Field    | Type                | Null | Key | Default | Extra          |
+----------+---------------------+------+-----+---------+----------------+
|

...

 id       | bigint(20) unsigned | NO

...

   | PRI |

...

 NULL    | auto_increment |
|

...

 uuid     | varchar(40)

...

         | YES  | UNI | NULL    |                |
| zone_id  | bigint(20) unsigned | NO

...

| name     | varchar(128)        | YES  |     | NULL    |                |

...

| url      | varchar(255)        | NO   |     | NULL    |                |

...

| username | varchar(255)        | NO   |     | NULL    |                |

...

| password | varchar(255)        | NO   |     | NULL    |                |

...

   |     | NULL    |                |
| name     | varchar(128)        | YES  |     | NULL    |                |
| url      | varchar(255)        | NO   |     | NULL    |                |
| username | varchar(255)        | NO   |     | NULL    |                |
| password | varchar(255)        | NO   |     | NULL    |                |
+----------+---------------------+------+-----+---------+----------------+

...

Appendix A: Cisco related document, will upload soon 

...

Change History:

4.2.1:

1. clone profile was deprecated. In 4.2, when use associates a profile to blade, he chooses a profile and CloudPlatform will clone that profile to a new one. In 4.2.1, instead of choosing a profile, user chooses a profile templateand CloudPlatform will instantiate a profile from that template.

2. list profile was deprecated. In line with change #1, in 4.2.1 user can only list profile templates when associating a blade.

3. Adding sync blades button. In UI, there is a Refresh UCS Blades button which will sync blade status between UCS manager and CloudPlatform when clicked

4. Deprecated event: UCS.ASSOCIATEPROFILE. New events:    UCS.TEMPLATEASSOCIATION, UCS.REFRESHBLADES