From 8f8772a66ec412d20d186bbd8fa8e5d4c93500be Mon Sep 17 00:00:00 2001 From: Pradyumna Kaushik Date: Fri, 28 Sep 2018 01:41:56 -0400 Subject: [PATCH] Try 2 of image include. Outline for detailed doc. --- README.md | 22 +++++++++++++----- ...Elektron-Architecture.png => ElekArch.png} | Bin docs/Logging.md | 0 docs/SchedulingPolicySwitching.md | 0 docs/data/Data.md | 0 docs/data/DegreeOfCollocation.md | 0 docs/data/ScheduledTrace.md | 0 .../SchedulingPolicySwitchTrace.md | 0 docs/data/withSpsEnabled/SchedulingWindow.md | 0 .../TaskClassificationOverhead.md | 0 10 files changed, 16 insertions(+), 6 deletions(-) rename docs/{Elektron-Architecture.png => ElekArch.png} (100%) create mode 100644 docs/Logging.md create mode 100644 docs/SchedulingPolicySwitching.md create mode 100644 docs/data/Data.md create mode 100644 docs/data/DegreeOfCollocation.md create mode 100644 docs/data/ScheduledTrace.md create mode 100644 docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md create mode 100644 docs/data/withSpsEnabled/SchedulingWindow.md create mode 100644 docs/data/withSpsEnabled/TaskClassificationOverhead.md diff --git a/README.md b/README.md index 42ac43c..e4fc381 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,24 @@ _Elektron_ is a Mesos framework that behaves as a playground for developers to e However, in addition to being a scheduler, Elektron also takes advantage of tools such as [Performance Co-Pilot](http://pcp.io/) and [RAPL](https://01.org/blogs/2014/running-average-power-limit--rapl) to help contain the power envelope within defined thresholds, reduce peak power consumption, and also reduce total energy consumption. Elektron is able to leverage the Mesos-provided resource abstraction to allow different algorithms to decide how to consume resource offers made by a Mesos Master. #Architecture +![](https://bitbucket.org/sunybingcloud/elektron/src/spsCherryPick/docs/ElekArch.png) -![Elektron](docs/Elektron-Architecture.png) - - -#Features +#Usage * [Pluggable Scheduling Policies](docs/SchedulingPolicies.md) -* [Pluggable Power-Capping Strategies](docs/PowerCappingStrategies.md) -* Cluster resource monitoring +* [Pluggable Power-Capping strategies](docs/PowerCappingStrategies.md) +* [Scheduling Policy Switching](docs/SchedulingPolicySwitching.md) + +#Logging +Please go through the [logging library doc](docs/Logging.md) to understand how the logging library has been setup. There are also instructions on how one can add additional loggers. + +#Data +* [Cluster Resource Consumption](docs/data/ClusterResourceConsumption.md) +* [Schedule Trace](docs/data/ScheduledTrace.md) +* [Degree of Collocation](docs/data/DegreeOfCollocation.md) +* When scheduling policy switching enabled. + - [Task Classification Overhead](docs/data/withSpsEnabled/TaskClassificationOverhead.md) + - [Scheduling Policy Switch Trace](docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md) + - [Scheduling Window](docs/data/withSpsEnabled/SchedulingWindow.md) #Software Requirements **Requires [Performance Co-Pilot](http://pcp.io/) tool pmdumptext to be installed on the diff --git a/docs/Elektron-Architecture.png b/docs/ElekArch.png similarity index 100% rename from docs/Elektron-Architecture.png rename to docs/ElekArch.png diff --git a/docs/Logging.md b/docs/Logging.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/SchedulingPolicySwitching.md b/docs/SchedulingPolicySwitching.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/data/Data.md b/docs/data/Data.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/data/DegreeOfCollocation.md b/docs/data/DegreeOfCollocation.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/data/ScheduledTrace.md b/docs/data/ScheduledTrace.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md b/docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/data/withSpsEnabled/SchedulingWindow.md b/docs/data/withSpsEnabled/SchedulingWindow.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/data/withSpsEnabled/TaskClassificationOverhead.md b/docs/data/withSpsEnabled/TaskClassificationOverhead.md new file mode 100644 index 0000000..e69de29