Minor fix to RAS doc. Update Trident-RAS-API.md
Project: http://git-wip-us.apache.org/repos/asf/storm/repo Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/00503d99 Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/00503d99 Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/00503d99 Branch: refs/heads/master Commit: 00503d99fc6d79dd45ca9dfa8426134ab7e768ed Parents: 3b56c6b Author: Kyle Nusbaum <[email protected]> Authored: Mon Mar 28 11:21:31 2016 -0500 Committer: Kyle Nusbaum <[email protected]> Committed: Mon Mar 28 11:27:38 2016 -0500 ---------------------------------------------------------------------- docs/Trident-RAS-API.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/storm/blob/00503d99/docs/Trident-RAS-API.md ---------------------------------------------------------------------- diff --git a/docs/Trident-RAS-API.md b/docs/Trident-RAS-API.md index 30a3889..7d8a1be 100644 --- a/docs/Trident-RAS-API.md +++ b/docs/Trident-RAS-API.md @@ -6,13 +6,13 @@ documentation: true ## Trident RAS API -The Trident RAS (Resource Aware Scheduler) API provides a mechanism to specify the resource consumption of their topology. The API looks exactly like the base RAS API, only it is called on Trident Streams instead of Bolts and Spouts. +The Trident RAS (Resource Aware Scheduler) API provides a mechanism to allow users to specify the resource consumption of a Trident topology. The API looks exactly like the base RAS API, only it is called on Trident Streams instead of Bolts and Spouts. In order to avoid duplication and inconsistency in documentation, the purpose and effects of resource setting are not described here, but are instead found in the [Resource Aware Scheduler Overview](Resource_Aware_Scheduler_overview.html) ### Use -First an example: +First, an example: ```java TridentTopology topo = new TridentTopology(); @@ -35,15 +35,16 @@ First an example: .setMemoryLoad(2048); ``` -Resources can be set per operation (except for grouping, shuffling, partitioning). -Operations that are combined by Trident into single Bolts have their resources summed. +Resources can be set for each operation (except for grouping, shuffling, partitioning). +Operations that are combined by Trident into single Bolts will have their resources summed. Every Bolt is given **at least** the default resources, regardless of user settings. In the above case, we end up with - * a spout and spout coordinator with a CPU load of 20% each, and a memory load of 512MiB on heap and 256MiB off heap. - * a bolt with 60% cpu load (10% + 50%) and a memory load of 1536MiB (1024 + 512) on heap from the combined `Split` and `BangAdder` - * a bolt with 100% cpu load and a memory load of 2048MiB. + * a spout and spout coordinator with a CPU load of 20% each, and a memory load of 512MiB on-heap and 256MiB off-heap. + * a bolt with 60% cpu load (10% + 50%) and a memory load of 1536MiB (1024 + 512) on-heap from the combined `Split` and `BangAdder` + * a bolt with 100% cpu load and a memory load of 2048MiB on-heap, with default value for off-heap. -The methods can be called for every operation (or some of the operations) or used in the same manner as `parallelismHint()`. -That is, resource declarations have the same *boundaries* as parallelismHints. They don't cross any groupings, shufflings, or any other kind of repartitioning. +The API can be called as many times as is desired. +It may be called after every operation, after some of the operations, or used in the same manner as `parallelismHint()` to set resources for a whole section. +Resource declarations have the same *boundaries* as parallelism hints. They don't cross any groupings, shufflings, or any other kind of repartitioning.
