Difference between revisions of "Developer's Guide/ResourceManagerClient"

From Gcube Wiki
Jump to: navigation, search
(Created page with '== Resource Manager Client == The Resource Manager Client library is a set of utilities which allows the management of a gCube infrastructure. It exploits and combines the funct…')
 
(Usage)
Line 14: Line 14:
  
 
<pre>
 
<pre>
ResourceManagerClient [options] scope  true/false [args...]
+
ResourceManagerClient [options] scope  true/false [parameters...]
 
</pre>
 
</pre>
  
 
where :
 
where :
  
*scope : identifies the operation scope, thus the Resource Manager Service instance to contact. The Resource Manager service to contact for every type of operation is automatically discovered from the Infrastructure ISs.
+
*''scope'' : identifies the operation scope, thus the Resource Manager Service instance to contact. The Resource Manager service to contact for every type of operation is automatically discovered from the Infrastructure ISs.
*true/false : specifies if the Resource Manager need to be contacted in a secure way. If yes the user proxy is loaded from the environment ( the X509_USER_PROXY variable need to be set ) and attached to the service request.
+
*''true/false'' : specifies if the Resource Manager needs to be contacted in a secure way. If yes the user proxy is loaded from the environment ( the X509_USER_PROXY variable need to be set ) and attached to the service request.
*options:
+
*''options'':
 
** '''DEPLOY''' : to deploy one or more SAs
 
** '''DEPLOY''' : to deploy one or more SAs
 
**'''UNDEPLOY_RI''' : to undeploy one or more RunningInstance knowing the Ids.
 
**'''UNDEPLOY_RI''' : to undeploy one or more RunningInstance knowing the Ids.
Line 30: Line 30:
 
**'''REMOVE_SCOPE''' : to remove one or more Resources from the given scope
 
**'''REMOVE_SCOPE''' : to remove one or more Resources from the given scope
 
**'''REPORT''' : to get the deployment/undeplopyment report
 
**'''REPORT''' : to get the deployment/undeplopyment report
 +
*''parameters'':
 +
** DEPLOY : [<ServiceName> <ServiceClass> <version> <GHNId>]*
 +
A property file containinig the deployment information can  be provided instead:
 +
DEPLOY : <Property File>
 +
** UNDEPLOY_RI : [<RunningIstanceID>]*
 +
**UNDEPLOY_SA : [<ServiceName> <ServiceClass> <version> ]* <GHNId>
 +
A property file containinig the undeployment information can  be provided instead:
 +
UNDEPLOY_SA : <Property File>
 +
**UPGRADE_RI :[<RunningIstanceID>]*
 +
**UPGRADE_SA : [<ServiceName> <ServiceClass> <version> ]* <GHNId>
 +
A property file containinig the upgrade information can  be provided instead:
 +
UPGRADE_SA : <Property File>
 +
**ADD_SCOPE : <ResourceType> [<ResourceID>]*
 +
<ResourceType> must be one of: GHN, RunningInstance, Collection, MetadataCollection, GenericResource
 +
** REMOVE_SCOPE : <ResourceType> [<ResourceID>]*
 +
<ResourceType> must be one of: GHN, RunningInstance, Collection, MetadataCollection, GenericResource
 +
** REPORT : <deployment/undeployment ID>

Revision as of 10:46, 31 January 2011

Resource Manager Client

The Resource Manager Client library is a set of utilities which allows the management of a gCube infrastructure. It exploits and combines the functionalities exposed by the Resource Manager Service, giving Site/Infrastructure Administrators a powerful tool to easily perform the following infrastructure management operations:

  • Service Deployment
  • Service Undeployment
  • Service Upgrade
  • Add Scope to a Resource
  • Remove Scope from a Resource

Usage

The Library can be invoked by CLI using the following syntax:

ResourceManagerClient [options] scope  true/false [parameters...]

where :

  • scope : identifies the operation scope, thus the Resource Manager Service instance to contact. The Resource Manager service to contact for every type of operation is automatically discovered from the Infrastructure ISs.
  • true/false : specifies if the Resource Manager needs to be contacted in a secure way. If yes the user proxy is loaded from the environment ( the X509_USER_PROXY variable need to be set ) and attached to the service request.
  • options:
    • DEPLOY : to deploy one or more SAs
    • UNDEPLOY_RI : to undeploy one or more RunningInstance knowing the Ids.
    • UNDEPLOY_SA : to undeploy one or more SAs from the given scope
    • UPGRADE_RI : to upgrade one or more RIs in the given scope
    • UPGRADE_SA : to upgrade one or more SAs in the given scope.
    • ADD_SCOPE : to add one or more Resources to the given scope
    • REMOVE_SCOPE : to remove one or more Resources from the given scope
    • REPORT : to get the deployment/undeplopyment report
  • parameters:
    • DEPLOY : [<ServiceName> <ServiceClass> <version> <GHNId>]*

A property file containinig the deployment information can be provided instead: DEPLOY : <Property File>

    • UNDEPLOY_RI : [<RunningIstanceID>]*
    • UNDEPLOY_SA : [<ServiceName> <ServiceClass> <version> ]* <GHNId>

A property file containinig the undeployment information can be provided instead: UNDEPLOY_SA : <Property File>

    • UPGRADE_RI :[<RunningIstanceID>]*
    • UPGRADE_SA : [<ServiceName> <ServiceClass> <version> ]* <GHNId>

A property file containinig the upgrade information can be provided instead: UPGRADE_SA : <Property File>

    • ADD_SCOPE : <ResourceType> [<ResourceID>]*

<ResourceType> must be one of: GHN, RunningInstance, Collection, MetadataCollection, GenericResource

    • REMOVE_SCOPE : <ResourceType> [<ResourceID>]*

<ResourceType> must be one of: GHN, RunningInstance, Collection, MetadataCollection, GenericResource

    • REPORT : <deployment/undeployment ID>