Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between pages "OHF" and "PTP/designs/rm view"
(Difference between pages)
(→Audit record repository) |
m (→Interface: IRMResourceManager) |
||
Line 1: | Line 1: | ||
− | === | + | == Overview == |
− | + | ||
− | + | This is a preliminary design for the PTP Resource Management system. This is the design of the first phase product, which is limited in scope to viewing the state of the resource manager. This includes the machines, jobs, queues, and nodes that are under the resource manager's control. The classes currently in PTP will implement these new interfaces in addition to their previously implemented interfaces. | |
− | + | ||
− | + | ||
− | + | [[Image: ptp_resource_manager_view.pdf|UML diagram]] | |
− | + | ||
− | == | + | == Package resourcemanager == |
− | + | For interfaces and abstract classes, the responsibilities and collaborations refer to concrete objects that are implementations of the interface or abstract class. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | === | + | === Interface: IRMResourceManager === |
− | + | ||
− | + | ; Responsibilities: Proxy used to connect to the ResourceManagerHost's actual resource manager (ARM).<br> Retrieve list of machines, nodes, jobs, process, and queues from ARM.<br> Notify registered objects that the lists have changed, either in composition, or in their element's attributes due to changes propagated from the ARM | |
+ | ; Collaborations: IRMResourceManagerHost<br> IRMResourceManagerListener<br> RMResourceManagerEvent<br> RMNodesChangedEvent<br>RMJobsChangedEvent<br> RMQueuesChangedEvent<br> RMStructureChangedEvent<br> IRMMachine, IRMNode, IRMJob, IRMQueue | ||
− | + | === Interface: IRMResourceManagerListener === | |
− | + | ||
− | + | ||
− | + | ; Responsibilities: Registration site for Observer pattern to allow objects to be notified of changes in the IRMResourceManager's status | |
− | + | ;Collaborations: IRMResourceManager<br> IRMEvent | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
+ | === Interface: ResourceManagerEvent === | ||
− | + | ; Responsibilities: Determine type of changed in the IRMResourceManager's state | |
− | + | ; Collaborations: none | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | == | + | === Class: ResourceManagerHost === |
− | + | ||
− | + | ;Responsibilities: Determine which remote (or local) host's resource manager to proxy<br> Determine which resource manager on the host to proxy<br> Provide hosts's status | |
+ | ; Collaborations: RMStatus | ||
+ | |||
+ | === Interface: IRMMachine === | ||
+ | |||
+ | ; Responsibilities: Provide the status information, i.e. attributes, for the ARM's associated machine<br> Set and provide specific attributes for a given attribute description<br> List all nodes associated with ARM's machine<br> Provide machine's status | ||
+ | ; Collaborations: IAttribute<br> IAttrDesc<br> RMStatus | ||
+ | |||
+ | === Interface: IRMQueue === | ||
+ | |||
+ | ; Responsibilities: Provide the status information, i.e. attributes, for the ARM's associated queue<br> Set and provide specific attributes for a given attribute description<br> List all nodes that may have jobs dispatched from this queue<br> Provide queue's status | ||
+ | ; Collaborations: IAttribute<br> IAttrDesc<br> RMStatus | ||
+ | |||
+ | === Interface: IRMNode === | ||
+ | |||
+ | ; Responsibilities: Provide the status information, i.e. attributes, for the ARM's associated node<br> Set and provide specific attributes for a given attribute description<br> List all jobs associated with ARM's node<br> List all queues that can run jobs on this node<br> Provide node's status | ||
+ | ; Collaborations: IAttribute<br> IAttrDesc<br> RMStatus | ||
+ | |||
+ | === Interface: IRMJob === | ||
+ | |||
+ | ; Responsibilities: Provide the status information, i.e. attributes, for the ARM's associated job<br> Set and provide specific attributes for a given attribute description<br> List all processes associated with ARM's job<br> Provide job's status | ||
+ | ; Collaborations: IAttribute<br> IAttrDesc<br> RMJobStatus | ||
+ | |||
+ | === Interface: IRMProcess === | ||
+ | |||
+ | ; Responsibilities: Provide the status information, i.e. attributes, for the ARM's associated process<br> Set and provide specific attributes for a given attribute description<br> Provide node on which the process runs | ||
+ | ; Collaborations: IAttribute<br> IAttrDesc | ||
+ | |||
+ | === Interface: IAttribute === | ||
+ | |||
+ | ; Responsibilities: Maintain the relationship between an attribute's value and its description<br> Specifies a strict-weak ordering of itself and other attributes<br> Provide a string representation of the attribute | ||
+ | ; Collaborations: IAttrDesc | ||
+ | |||
+ | === Interface: IAttrDesc === | ||
+ | |||
+ | ; Responsibilities: Provide a string description of the attribute <br>Provide a name of the attribute<br> Know the actual type of the attribute<br> Create new attributes of the correct type | ||
+ | ; Collaborations: IAttribute | ||
+ | |||
+ | === Enumeration: RMStatus === | ||
+ | |||
+ | ; Responsibilities: Provide consistent labeling of element status<br> OK element is up and able to accept jobs, etc.<br> DOWN element is down, reason will have to be provided in other attributes<br> UNAVAILABLE element is unable to accept jobs, etc., reason will have to be provied in other attributes | ||
+ | ; Collaborations: ResourceManagerHost, IRMMachine, IRMNode, IRMQueue | ||
+ | |||
+ | === Enumeration: RMJobStatus === | ||
+ | |||
+ | ; Responsibilities: Provide consistent labeling of job status<br> PENDING job is pending in queue<br> RUNNING job is running normally<br> SUSPENDED job is suspended, reason will have to be provided in other attributes<br> DONE job has completed normally<br> EXIT job has completed abnormally, reason will have to be provide in other attributes<br> UNKNOWN job status is unknown | ||
+ | ; Collaborations: IRMJob |
Revision as of 12:00, 9 May 2006
Contents
- 1 Overview
- 2 Package resourcemanager
- 2.1 Interface: IRMResourceManager
- 2.2 Interface: IRMResourceManagerListener
- 2.3 Interface: ResourceManagerEvent
- 2.4 Class: ResourceManagerHost
- 2.5 Interface: IRMMachine
- 2.6 Interface: IRMQueue
- 2.7 Interface: IRMNode
- 2.8 Interface: IRMJob
- 2.9 Interface: IRMProcess
- 2.10 Interface: IAttribute
- 2.11 Interface: IAttrDesc
- 2.12 Enumeration: RMStatus
- 2.13 Enumeration: RMJobStatus
Overview
This is a preliminary design for the PTP Resource Management system. This is the design of the first phase product, which is limited in scope to viewing the state of the resource manager. This includes the machines, jobs, queues, and nodes that are under the resource manager's control. The classes currently in PTP will implement these new interfaces in addition to their previously implemented interfaces.
File:Ptp resource manager view.pdf
Package resourcemanager
For interfaces and abstract classes, the responsibilities and collaborations refer to concrete objects that are implementations of the interface or abstract class.
Interface: IRMResourceManager
- Responsibilities
- Proxy used to connect to the ResourceManagerHost's actual resource manager (ARM).
Retrieve list of machines, nodes, jobs, process, and queues from ARM.
Notify registered objects that the lists have changed, either in composition, or in their element's attributes due to changes propagated from the ARM - Collaborations
- IRMResourceManagerHost
IRMResourceManagerListener
RMResourceManagerEvent
RMNodesChangedEvent
RMJobsChangedEvent
RMQueuesChangedEvent
RMStructureChangedEvent
IRMMachine, IRMNode, IRMJob, IRMQueue
Interface: IRMResourceManagerListener
- Responsibilities
- Registration site for Observer pattern to allow objects to be notified of changes in the IRMResourceManager's status
- Collaborations
- IRMResourceManager
IRMEvent
Interface: ResourceManagerEvent
- Responsibilities
- Determine type of changed in the IRMResourceManager's state
- Collaborations
- none
Class: ResourceManagerHost
- Responsibilities
- Determine which remote (or local) host's resource manager to proxy
Determine which resource manager on the host to proxy
Provide hosts's status - Collaborations
- RMStatus
Interface: IRMMachine
- Responsibilities
- Provide the status information, i.e. attributes, for the ARM's associated machine
Set and provide specific attributes for a given attribute description
List all nodes associated with ARM's machine
Provide machine's status - Collaborations
- IAttribute
IAttrDesc
RMStatus
Interface: IRMQueue
- Responsibilities
- Provide the status information, i.e. attributes, for the ARM's associated queue
Set and provide specific attributes for a given attribute description
List all nodes that may have jobs dispatched from this queue
Provide queue's status - Collaborations
- IAttribute
IAttrDesc
RMStatus
Interface: IRMNode
- Responsibilities
- Provide the status information, i.e. attributes, for the ARM's associated node
Set and provide specific attributes for a given attribute description
List all jobs associated with ARM's node
List all queues that can run jobs on this node
Provide node's status - Collaborations
- IAttribute
IAttrDesc
RMStatus
Interface: IRMJob
- Responsibilities
- Provide the status information, i.e. attributes, for the ARM's associated job
Set and provide specific attributes for a given attribute description
List all processes associated with ARM's job
Provide job's status - Collaborations
- IAttribute
IAttrDesc
RMJobStatus
Interface: IRMProcess
- Responsibilities
- Provide the status information, i.e. attributes, for the ARM's associated process
Set and provide specific attributes for a given attribute description
Provide node on which the process runs - Collaborations
- IAttribute
IAttrDesc
Interface: IAttribute
- Responsibilities
- Maintain the relationship between an attribute's value and its description
Specifies a strict-weak ordering of itself and other attributes
Provide a string representation of the attribute - Collaborations
- IAttrDesc
Interface: IAttrDesc
- Responsibilities
- Provide a string description of the attribute
Provide a name of the attribute
Know the actual type of the attribute
Create new attributes of the correct type - Collaborations
- IAttribute
Enumeration: RMStatus
- Responsibilities
- Provide consistent labeling of element status
OK element is up and able to accept jobs, etc.
DOWN element is down, reason will have to be provided in other attributes
UNAVAILABLE element is unable to accept jobs, etc., reason will have to be provied in other attributes - Collaborations
- ResourceManagerHost, IRMMachine, IRMNode, IRMQueue
Enumeration: RMJobStatus
- Responsibilities
- Provide consistent labeling of job status
PENDING job is pending in queue
RUNNING job is running normally
SUSPENDED job is suspended, reason will have to be provided in other attributes
DONE job has completed normally
EXIT job has completed abnormally, reason will have to be provide in other attributes
UNKNOWN job status is unknown - Collaborations
- IRMJob