The consumer tree organizes consumers into a structure that makes it easy to later apply resource plans. The tree defines organizational relationships among consumers and should mirror your business structure. In this tutorial we plan out a basic business structure and then create consumers to populate the consumer tree.
To help orient you, here is a list of the default resource components you see and work with in the Platform Management Console:
Consumer tree: “ManagementServices” (with nested child consumer “EGOManagementServices”), “SampleApplications” (with nested child consumer “EclipseSamples”), and ClusterServices (with nested child consumer “EGOClusterServices”).
In this tutorial, we create a new branch with a new top-level consumer and add descendants (parent and child consumers) to the tree. Never remove the ManagementServices or ClusterServices branches, nor change their consumer names, when building or modifying your tree.
Resource groups: “ComputeHosts” (executes workload units), “InternalResourceGroup” and “ManagementHosts” (run important EGO components and services).
In this tutorial, we work with the “ComputeHosts” resource group.
Resource plan (default resource group upon opening page is “ComputeHosts”): Only consumers registered to a selected resource group show; select different resource groups to modify corresponding resource plans.
In this tutorial, we add a new parent consumer and a child consumer under the SampleApplications branch, and register them to an existing resource group.
The consumer tree identifies consumers of cluster resources, and organizes them into a manageable structure.
The choice of consumers and the consumer hierarchy should reflect long-term business goals because it can be complicated to modify the tree. Before adding consumers to your tree, you need to map out the business structure you wish to reflect in your consumer tree.
For example, top-level business processes (or perhaps departments) become top-level consumers, while the lowest area of business becomes a leaf consumer. It is at the leaf level where you register such things as services or other application managers.
Out-of-the-box you have some built-in consumers that run necessary cluster services (ManagementServices and ClusterServices). You also have a SampleApplications consumer, used by the Sample client applications included in the EGO SDK.
General steps and considerations in mapping out a business structure include the following:
Map out your business structure by hand, restricting the number of levels to four.
Decide if any branches (top-level consumers) in your tree do not need to consume cluster resources, and then remove them from your diagram.
Prioritize your business processes, expecting that the highest priority process receive resources first when needed.
Ensure that your business structure makes a distinction that parallels how you want to manage and distribute your resources. You may want to break out special projects that need dedicated or specialized hosts.
Prioritize all your lower level business areas (leaf consumers) relative to other leaf consumers on the same branch.
Once mapped, a completed business structure might look like this:
You must be logged in as a cluster administrator and you should have already added most of your hosts to the cluster.
A consumer represents an entity that can demand resources from the cluster. A consumer might be a business service, a business process that is a complex collection of business services, an individual user, or an entire line of business.
Click Consumers > Consumers & Plans > Consumers.
The out-of-box consumers in your tree display (ManagementServices, SampleApplications, and ClusterServices).
If not already highlighted, select the tree root in the consumer tree.
Fill in the consumer properties.
Choose one or more administrators for this consumer.
Specified administrators automatically become administrators for any other consumers created on this branch. You cannot add a cluster administrator user account to the consumer administrator list, as this is already configured by default.
Specify the workload execution user account (the OS account under which workload units run).
Windows accounts should include a domain name.
If you specify a Windows user account that has not already been configured, you have to log on to EGO as the cluster administrator and then run egosh ego execpasswd before the execution user can run an activity without exiting.
Specify one or more resource groups this consumer should have access to.
Only the resource groups specified by this consumer's parent are available for selection. If you have not modified your resource groups, simply keep the default resource groups that are already checked.
Leave the Reclaim behavior section blank.
Reclaim behavior is an advanced feature and must be coordinated with the resource distribution plan settings.
Check the box Rebalance when time intervals change.
This ensures that when your resource plan changes according to set time intervals, that originally configured share ratios, allocations, and lend/borrow policies are reapplied and enforced across all consumer branches in the consumer tree.
Fill in the consumer properties for a new leaf consumer (child to the new top-level parent you just created), repeating step 4.
You have now created a new branch in your tree (a new top-level consumer), along with a sub-consumer (new leaf consumer).
If you have services or a Platform clustered application manager (such as Platform Symphony), you can now register them to the leaf consumer.