From d70312f122d9ef7c31b05757239ffc66af832dee Mon Sep 17 00:00:00 2001 From: Dante Niewenhuis Date: Fri, 16 May 2025 10:32:08 +0200 Subject: Updated website documentation (#334) * Updated website documentation * Updated some documentation and fixed links * small updates * small updates --- site/docs/documentation/Input/AllocationPolicy.md | 265 +++++++++++++++++++++ site/docs/documentation/Input/CheckpointModel.md | 25 ++ site/docs/documentation/Input/Experiment.md | 136 +++-------- site/docs/documentation/Input/ExperimentSchema.md | 81 ------- site/docs/documentation/Input/ExportModel.md | 50 ++++ site/docs/documentation/Input/FailureModel.md | 8 +- site/docs/documentation/Input/M3SA.md | 92 ------- site/docs/documentation/Input/M3SASchema.md | 115 --------- site/docs/documentation/Input/Topology.md | 220 ----------------- site/docs/documentation/Input/Topology/Battery.md | 37 +++ site/docs/documentation/Input/Topology/Host.md | 55 +++++ .../documentation/Input/Topology/PowerModel.md | 31 +++ .../documentation/Input/Topology/PowerSource.md | 20 ++ site/docs/documentation/Input/Topology/Topology.md | 183 ++++++++++++++ site/docs/documentation/Input/TopologySchema.md | 160 ------------- site/docs/documentation/Input/Workload.md | 47 ++-- site/docs/documentation/Input/img.png | Bin 110177 -> 0 bytes site/docs/documentation/M3SA/M3SA.md | 92 +++++++ site/docs/documentation/M3SA/M3SASchema.md | 115 +++++++++ site/docs/documentation/Output.md | 173 ++++++++------ site/docs/getting-started/1-first-experiment.md | 212 ----------------- .../docs/getting-started/1-start-using-intellij.md | 172 +++++++++++++ site/docs/getting-started/2-first-experiment.md | 211 ++++++++++++++++ site/docs/getting-started/3-whats-next.md | 2 +- .../docs/getting-started/4-start-using-intellij.md | 172 ------------- site/static/img/failureModels.png | Bin 0 -> 110177 bytes 26 files changed, 1422 insertions(+), 1252 deletions(-) create mode 100644 site/docs/documentation/Input/AllocationPolicy.md create mode 100644 site/docs/documentation/Input/CheckpointModel.md delete mode 100644 site/docs/documentation/Input/ExperimentSchema.md create mode 100644 site/docs/documentation/Input/ExportModel.md delete mode 100644 site/docs/documentation/Input/M3SA.md delete mode 100644 site/docs/documentation/Input/M3SASchema.md delete mode 100644 site/docs/documentation/Input/Topology.md create mode 100644 site/docs/documentation/Input/Topology/Battery.md create mode 100644 site/docs/documentation/Input/Topology/Host.md create mode 100644 site/docs/documentation/Input/Topology/PowerModel.md create mode 100644 site/docs/documentation/Input/Topology/PowerSource.md create mode 100644 site/docs/documentation/Input/Topology/Topology.md delete mode 100644 site/docs/documentation/Input/TopologySchema.md delete mode 100644 site/docs/documentation/Input/img.png create mode 100644 site/docs/documentation/M3SA/M3SA.md create mode 100644 site/docs/documentation/M3SA/M3SASchema.md delete mode 100644 site/docs/getting-started/1-first-experiment.md create mode 100644 site/docs/getting-started/1-start-using-intellij.md create mode 100644 site/docs/getting-started/2-first-experiment.md delete mode 100644 site/docs/getting-started/4-start-using-intellij.md create mode 100644 site/static/img/failureModels.png (limited to 'site') diff --git a/site/docs/documentation/Input/AllocationPolicy.md b/site/docs/documentation/Input/AllocationPolicy.md new file mode 100644 index 00000000..96aacc9c --- /dev/null +++ b/site/docs/documentation/Input/AllocationPolicy.md @@ -0,0 +1,265 @@ +Allocation policies define how, when and where a task is executed. + +There are two types of allocation policies: +1. **[Filter](#filter-policy)** - The basic allocation policy that selects a host for each task based on filters and weighters +2. **[TimeShift](#timeshift-policy)** - Extends the Filter scheduler allowing tasks to be delayed to better align with the availability of low-carbon power. + +In the following section we discuss the different allocation policies, and how to define them in an Experiment file. + +## Filter policy +To use a filter scheduler, the user has to set the type of the policy to "filter". +A filter policy requires a list of filters and weighters which characterize the policy. + +A filter policy consists of two main components: +1. **[Filters](#filters)** - Filters select all hosts that are eligible to execute the given task. +2. **[Weighters](#weighters)** - Weighters are used to rank the eligible hosts. The host with the highest weight is selected to execute the task. + +:::info Code +All code related to reading Allocation policies can be found [here](https://github.com/atlarge-research/opendc/blob/master/opendc-experiments/opendc-experiments-base/src/main/kotlin/org/opendc/experiments/base/experiment/specs/allocation/AllocationPolicySpec.kt) +::: + +### Filters +Filters select all hosts that are eligible to execute the given task. +Filters are defined as JSON objects in the experiment file. + +The user defines which filter to use by setting the "type". +OpenDC currently supports the following 7 filters: + +#### ComputeFilter +Returns host if it is running. +Does not require any more parameters. + +```json +{ + "type": "Compute" +} +``` + +#### SameHostHostFilter +Ensures that after failure, a task is executed on the same host again. +Does not require any more parameters. + +```json +{ + "type": "DifferentHost" +} +``` + +#### DifferentHostFilter +Ensures that after failure, a task is *not* executed on the same host again. +Does not require any more parameters. + +```json +{ + "type": "DifferentHost" +} +``` + +#### InstanceCountHostFilter +Returns host if the number of instances running on the host is less than the maximum number of instances allowed. +The User needs to provide the maximum number of instances that can be run on a host. +```json +{ + "type": "InstanceCount", + "limit": 1 +} +``` + +#### RamHostFilter +Returns hosts if the amount of RAM available on the host is greater than the amount of RAM required by the task. +The user can provide an allocationRatio which is multiplied with the amount of RAM available on the host. +This can be used to allow for over subscription. +```json +{ + "type": "Ram", + "allocationRatio": 2.5 +} +``` + +#### VCpuCapacityHostFilter +Returns hosts if CPU capacity available on the host is greater than the CPU capacity required by the task. + +```json +{ + "type": "VCpuCapacity" +} +``` + +#### VCpuHostFilter +Returns host if the number of cores available on the host is greater than the number of cores required by the task. +The user can provide an allocationRatio which is multiplied with the amount of RAM available on the host. +This can be used to allow for over subscription. + +```json +{ + "type": "VCpu", + "allocationRatio": 2.5 +} +``` + +:::info Code +All code related to reading Filters can be found [here](https://github.com/atlarge-research/opendc/blob/master/opendc-experiments/opendc-experiments-base/src/main/kotlin/org/opendc/experiments/base/experiment/specs/allocation/HostFilterSpec.kt) +::: + +### Weighters +Weighters are used to rank the eligible hosts. The host with the highest weight is selected to execute the task. +Weighters are defined as JSON objects in the experiment file. + +The user defines which filter to use by setting the "type". +The user can also provide a multiplying that is multiplied with the weight of the host. +This can be used to increase or decrease the importance of the host. +Negative multipliers are also allowed, and can be used to invert the ranking of the host. +OpenDC currently supports the following 5 weighters: + +#### RamWeigherSpec +Order the hosts by the amount of RAM available on the host. + +```json +{ + "type": "Ram", + "multiplier": 2.0 +} +``` + +#### CoreRamWeighter +Order the hosts by the amount of RAM available per core on the host. + +```json +{ + "type": "CoreRam", + "multiplier": 0.5 +} +``` + +#### InstanceCountWeigherSpec +Order the hosts by the number of instances running on the host. + +```json +{ + "type": "InstanceCount", + "multiplier": -1.0 +} +``` + +#### VCpuCapacityWeigherSpec +Order the hosts by the capacity per core on the host. + +```json +{ + "type": "VCpuCapacity", + "multiplier": 0.5 +} +``` + +#### VCpuWeigherSpec +Order the hosts by the number of cores available on the host. + +```json +{ + "type": "VCpu", + "multiplier": 2.5 +} +``` + +:::info Code +All code related to reading Weighters can be found [here](https://github.com/atlarge-research/opendc/blob/master/opendc-experiments/opendc-experiments-base/src/main/kotlin/org/opendc/experiments/base/experiment/specs/allocation/HostWeigherSpec.kt) +::: + +### Examples +Following is an example of a Filter policy: +```json +{ + "type": "filter", + "filters": [ + { + "type": "Compute" + }, + { + "type": "VCpu", + "allocationRatio": 1.0 + }, + { + "type": "Ram", + "allocationRatio": 1.5 + } + ], + "weighers": [ + { + "type": "Ram", + "multiplier": 1.0 + } + ] +} +``` + +## TimeShift policy +Timeshift extends the Filter policy by allowing tasks to be delayed to better align with the availability of low-carbon power. +A user can define a timeshift policy by setting the type to "timeshift". + +task is scheduled when the current carbon intensity is below the carbon threshold. Otherwise, they are delayed. The +carbon threshold is determined by taking the 35 percentile of next week’s carbon forecast. When used, tasks can be interrupted +when the carbon intensity exceeds the threshold during execution. All tasks have a maximum delay time defined in the workload. When the maximum delay is reached, +tasks cannot be delayed anymore. + + +Similar to the filter policy, the user can define a list of filters and weighters. +However, in addittion, the user can provide parameters that influence how tasks are delayed: + +| Variable | Type | Required? | Default | Description | +|------------------------|-----------------------------|-----------|-----------------|-----------------------------------------------------------------------------------| +| filters | List[Filter] | no | [ComputeFilter] | Filters used to select eligible hosts. | +| weighters | List[Weighter] | no | [] | Weighters used to rank hosts. | +| windowSize | integer | no | 168 | How far back does the scheduler look to determine the Carbon Intensity threshold? | +| forecast | boolean | no | true | Does the the policy use carbon forecasts? | +| shortForecastThreshold | double | no | 0.2 | Threshold is used for short tasks (<2hours) | +| longForecastThreshold | double | no | 0.35 | Threshold is used for long tasks (>2hours) | +| forecastSize | integer | no | 24 | The number of hours of forecasts that is taken into account | +| taskStopper | [TaskStopper](#taskstopper) | no | null | Policy for interrupting tasks. If not provided, tasks are never interrupted | + +### TaskStopper + +Aside from delaying tasks, users might want to interrupt tasks that are running. +For example, if a tasks is running when only high-carbon energy is available, the task can be interrupted and rescheduled to a later time. + +A TaskStopper is defined as a JSON object in the Timeshift policy. +A TasksStopper consists of the following components: + +| Variable | Type | Required? | Default | Description | +|-----------------------|-----------------------------|-----------|---------|-----------------------------------------------------------------------------------| +| windowSize | integer | no | 168 | How far back does the scheduler look to determine the Carbon Intensity threshold? | +| forecast | boolean | no | true | Does the the policy use carbon forecasts? | +| forecastThreshold | double | no | 0.6 | Threshold is used for short tasks (<2hours) | +| forecastSize | integer | no | 24 | The number of hours of forecasts that is taken into account | + + +## Prefabs +Aside from custom policies, OpenDC also provides a set of pre-defined policies that can be used. +A prefab can be defined by setting the type to "prefab" and providing the name of the prefab. + +Example: +```json +{ + "type": "prefab", + "policyName": "Mem" +} +``` + +The following prefabs are available: + +| Name | Filters | Weighters | Timeshifting | +|---------------------|----------------------------------------------|----------------------------|--------------| +| Mem | ComputeFilter
VCpuFilter
RamFilter | RamWeigher(1.0) | No | +| MemInv | ComputeFilter
VCpuFilter
RamFilter | RamWeigher(-1.0) | No | +| CoreMem | ComputeFilter
VCpuFilter
RamFilter | CoreRamWeigher(1.0) | No | +| CoreMemInv | ComputeFilter
VCpuFilter
RamFilter | CoreRamWeigher(-1.0) | No | +| ActiveServers | ComputeFilter
VCpuFilter
RamFilter | InstanceCountWeigher(1.0) | No | +| ActiveServersInv | ComputeFilter
VCpuFilter
RamFilter | InstanceCountWeigher(-1.0) | No | +| ProvisionedCores | ComputeFilter
VCpuFilter
RamFilter | VCpuWeigher(1.0) | No | +| ProvisionedCoresInv | ComputeFilter
VCpuFilter
RamFilter | VCpuWeigher(-1.0) | No | +| Random | ComputeFilter
VCpuFilter
RamFilter | [] | No | +| TimeShift | ComputeFilter
VCpuFilter
RamFilter | RamWeigher(1.0) | Yes | + +:::info Code +All code related to prefab schedulers can be found [here](https://github.com/atlarge-research/opendc/blob/master/opendc-compute/opendc-compute-simulator/src/main/kotlin/org/opendc/compute/simulator/scheduler/ComputeSchedulers.kt) +::: + diff --git a/site/docs/documentation/Input/CheckpointModel.md b/site/docs/documentation/Input/CheckpointModel.md new file mode 100644 index 00000000..7c622ea0 --- /dev/null +++ b/site/docs/documentation/Input/CheckpointModel.md @@ -0,0 +1,25 @@ +Checkpointing is a technique to reduce the impact of machine failure. +When using Checkpointing, tasks make periodical snapshots of their state. +If a task fails, it can be restarted from the last snapshot instead of starting from the beginning. + +A user can define a checkpoint model using the following parameters: + +| Variable | Type | Required? | Default | Description | +|---------------------------|--------|-----------|---------|----------------------------------------------------------------------------------------------------------------------| +| checkpointInterval | Int64 | no | 3600000 | The time between checkpoints in ms | +| checkpointDuration | Int64 | no | 300000 | The time to create a snapshot in ms | +| checkpointIntervalScaling | Double | no | 1.0 | The scaling of the checkpointInterval after each successful checkpoint. The default of 1.0 means no scaling happens. | + +### Example + +```json +{ + "checkpointInterval": 3600000, + "checkpointDuration": 300000, + "checkpointIntervalScaling": 1.5 +} +``` + +In this example, a snapshot is created every hour, and the snapshot creation takes 5 minutes. +The checkpointIntervalScaling is set to 1.5, which means that after each successful checkpoint, +the interval between checkpoints will be increased by 50% (for example from 1 to 1.5 hours). diff --git a/site/docs/documentation/Input/Experiment.md b/site/docs/documentation/Input/Experiment.md index a4212ddf..8d3462a9 100644 --- a/site/docs/documentation/Input/Experiment.md +++ b/site/docs/documentation/Input/Experiment.md @@ -5,113 +5,40 @@ In this page, we will discuss how to properly define experiments for OpenDC. :::info Code All code related to reading and processing Experiment files can be found [here](https://github.com/atlarge-research/opendc/tree/master/opendc-experiments/opendc-experiments-base/src/main/kotlin/org/opendc/experiments/base/experiment) - -The code used to run a given experiment can be found [here](https://github.com/atlarge-research/opendc/tree/master/opendc-experiments/opendc-experiments-base/src/main/kotlin/org/opendc/experiments/base/runner) +The code used to run experiments can be found [here](https://github.com/atlarge-research/opendc/tree/master/opendc-experiments/opendc-experiments-base/src/main/kotlin/org/opendc/experiments/base/runner) ::: ## Schema -The schema for the scenario file is provided in [schema](ExperimentSchema) -In the following section, we describe the different components of the schema. -Some components of an experiment are not single values, but lists. This is used to run multiple scenarios using -a single experiment file. OpenDC will execute all permutations of the different values. -This means that if all list based values have a single value, only one Scenario will be run. - -| Variable | Type | Required? | Default | Description | -|---------------------|----------------------------------------------|-----------|----------|-------------------------------------------------------------------| -| name | string | no | "" | Name of the scenario, used for identification and referencing. | -| outputFolder | string | no | "output" | Directory where the simulation outputs will be stored. | -| initialSeed | integer | no | 0 | Seed used for random number generation to ensure reproducibility. | -| runs | integer | no | 1 | Number of times the scenario should be run. | -| exportModels | List[[ExportModel](#exportmodel)] | no | Default | Specifications for exporting data from the simulation. | -| maxNumFailures | List[integer] | no | [10] | The max number of times a task can fail before being terminated. | -| topologies | List[[Topology](#topology)] | yes | N/A | List of topologies used in the scenario. | -| workloads | List[[Workload](#workload)] | yes | N/A | List of workloads to be executed within the scenario. | -| allocationPolicies | List[[AllocationPolicy](#allocation-policy)] | yes | N/A | Allocation policies used for resource management in the scenario. | -| failureModels | List[[FailureModel](#failuremodel)] | no | Default | List of failure models to simulate various types of failures. | -| checkpointModels | List[[CheckpointModel](#checkpointmodel)] | no | null | Paths to carbon footprint trace files. | -| carbonTracePaths | List[string] | no | null | Paths to carbon footprint trace files. | - - -Many of the input fields of the experiment file are complex objects themselves. Next, we will describe the required input -type of each of these fields. - -### ExportModel - -| Variable | Type | Required? | Default | Description | -|---------------------|-----------------------------------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| exportInterval | Int64 | no | 300 | The duration between two exports in seconds | -| computeExportConfig | [ComputeExportConfig](#checkpointmodel) | no | Default | The features that should be exported during the simulation | -| filesToExport | List[string] | no | all files | List of the files that should be exported during simulation. The elements should be picked from the set ("host", "task", "powerSource", "battery", "service") | - - - -### ComputeExportConfig -The features that should be exported by OpenDC - -| Variable | Type | Required? | Default | Description | -|--------------------------|--------------|-----------|--------------|-----------------------------------------------------------------------| -| hostExportColumns | List[String] | no | All features | The features that should be exported to the host output file. | -| taskExportColumns | List[String] | no | All features | The features that should be exported to the task output file. | -| powerSourceExportColumns | List[String] | no | All features | The features that should be exported to the power source output file. | -| serviceExportColumns | List[String] | no | All features | The features that should be exported to the service output file. | - - -### Topology -Defines the topology on which the workload will be run. - -:::info -For more information about the Topology go [here](Topology) -::: - -| Variable | Type | Required? | Default | Description | -|-------------|--------|-----------|---------|---------------------------------------------------------------------| -| pathToFile | string | yes | N/A | Path to the JSON file defining the topology. | - -### Workload -Defines the workload that needs to be executed. - -:::info -For more information about workloads go [here](Workload) -::: - -| Variable | Type | Required? | Default | Description | -|-------------|--------|-----------|---------|---------------------------------------------------------------------| -| pathToFile | string | yes | N/A | Path to the file containing the workload trace. | -| type | string | yes | N/A | Type of the workload (e.g., "ComputeWorkload"). | - -### Allocation Policy -Defines the allocation policy that should be used to decide on which host each task should be executed - -:::info Code -The different allocation policies that can be used can be found [here](https://github.com/atlarge-research/opendc/blob/master/opendc-compute/opendc-compute-simulator/src/main/kotlin/org/opendc/compute/simulator/scheduler/ComputeSchedulers.kt) -::: - -| Variable | Type | Required? | Default | Description | -|------------|--------|-----------|---------|----------------------------| -| policyType | string | yes | N/A | Type of allocation policy. | - -### FailureModel -The failure model that should be used during the simulation -See [FailureModels](FailureModel) for detailed instructions. - -### CheckpointModel -The checkpoint model that should be used to create snapshots. - -| Variable | Type | Required? | Default | Description | -|---------------------------|--------|-----------|---------|---------------------------------------------------------------------------------------------------------------------| -| checkpointInterval | Int64 | no | 3600000 | The time between checkpoints in ms | -| checkpointDuration | Int64 | no | 300000 | The time to create a snapshot in ms | -| checkpointIntervalScaling | Double | no | 1.0 | The scaling of the checkpointInterval after each succesful checkpoint. The default of 1.0 means no scaling happens. | - +In the following section, we describe the different components of an experiment. Following is a table with all experiment components: + +| Variable | Type | Required? | Default | Description | +|--------------------|----------------------------------------------------------------------|-----------|---------------|-------------------------------------------------------------------------------------------------------| +| name | string | no | "" | Name of the scenario, used for identification and referencing. | +| outputFolder | string | no | "output" | Directory where the simulation outputs will be stored. | +| runs | integer | no | 1 | Number of times the same scenario should be run. Each scenario is run with a different seed. | +| initialSeed | integer | no | 0 | The seed used for random number generation during a scenario. Setting a seed ensures reproducability. | +| topologies | List[path/to/file] | yes | N/A | Paths to the JSON files defining the topologies. | +| workloads | List[[Workload](/docs/documentation/Input/Workload)] | yes | N/A | Paths to the files defining the workloads executed. | +| allocationPolicies | List[[AllocationPolicy](/docs/documentation/Input/AllocationPolicy)] | yes | N/A | Allocation policies used for resource management in the scenario. | +| failureModels | List[[FailureModel](/docs/documentation/Input/FailureModel)] | no | List[null] | List of failure models to simulate various types of failures. | +| maxNumFailures | List[integer] | no | [10] | The max number of times a task can fail before being terminated. | +| checkpointModels | List[[CheckpointModel](/docs/documentation/Input/CheckpointModel)] | no | List[null] | Paths to carbon footprint trace files. | +| exportModels | List[[ExportModel](/docs/documentation/Input/ExportModel)] | no | List[default] | Specifications for exporting data from the simulation. | + +Most components of an experiment are not single values, but lists of values. +This allows users to run multiple scenarios using a single experiment file. +OpenDC will generate and execute all permutations of the different values. + +Some of the components in an experiment file are paths to files, or complicated objects. The format of these components +are defined in their respective pages. ## Examples -In the following section, we discuss several examples of Scenario files. Any scenario file can be verified using the -JSON schema defined in [schema](TopologySchema). +In the following section, we discuss several examples of experiment files. ### Simple -The simplest scneario that can be provided to OpenDC is shown below: +The simplest experiment that can be provided to OpenDC is shown below: ```json { "topologies": [ @@ -127,18 +54,19 @@ The simplest scneario that can be provided to OpenDC is shown below: ], "allocationPolicies": [ { - "policyType": "Mem" + "type": "prefab", + "policyName": "Mem" } ] } ``` -This scenario creates a simulation from file topology1, located in the topologies folder, with a workload trace from the +This experiment creates a simulation from file topology1, located in the topologies folder, with a workload trace from the bitbrains-small file, and an allocation policy of type Mem. The simulation is run once (by default), and the default name is "". ### Complex -Following is an example of a more complex topology: +Following is an example of a more complex experiment: ```json { "topologies": [ @@ -164,10 +92,12 @@ Following is an example of a more complex topology: ], "allocationPolicies": [ { - "policyType": "Mem" + "type": "prefab", + "policyName": "Mem" }, { - "policyType": "Mem-Inv" + "type": "prefab", + "policyName": "Mem-Inv" } ] } diff --git a/site/docs/documentation/Input/ExperimentSchema.md b/site/docs/documentation/Input/ExperimentSchema.md deleted file mode 100644 index 78ec55f7..00000000 --- a/site/docs/documentation/Input/ExperimentSchema.md +++ /dev/null @@ -1,81 +0,0 @@ -Below is the schema for the Scenario JSON file. This schema can be used to validate a scenario file. -A scenario file can be validated using a JSON schema validator, such as https://www.jsonschemavalidator.net/. - -```json -{ - "$schema": "OpenDC/Scenario", - "$defs": { - "topology": { - "type": "object", - "properties": { - "pathToFile": { - "type": "string" - } - }, - "required": [ - "pathToFile" - ] - }, - "workload": { - "type": "object", - "properties": { - "pathToFile": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "pathToFile", - "type" - ] - }, - "allocationPolicy": { - "type": "object", - "properties": { - "policyType": { - "type": "string" - } - }, - "required": [ - "policyType" - ] - } - }, - "properties": { - "name": { - "type": "string" - }, - "topologies": { - "type": "array", - "items": { - "$ref": "#/$defs/topology" - }, - "minItems": 1 - }, - "workloads": { - "type": "array", - "items": { - "$ref": "#/$defs/workload" - }, - "minItems": 1 - }, - "allocationPolicies": { - "type": "array", - "items": { - "$ref": "#/$defs/allocationPolicy" - }, - "minItems": 1 - }, - "runs": { - "type": "integer" - } - }, - "required": [ - "topologies", - "workloads", - "allocationPolicies" - ] -} -``` diff --git a/site/docs/documentation/Input/ExportModel.md b/site/docs/documentation/Input/ExportModel.md new file mode 100644 index 00000000..12e7eba2 --- /dev/null +++ b/site/docs/documentation/Input/ExportModel.md @@ -0,0 +1,50 @@ +During simulation, OpenDC exports data to files (see [Output](/docs/documentation/Output.md)). +The user can define what and how data is exported using the `exportModels` parameter in the experiment file. + +## ExportModel + + + +| Variable | Type | Required? | Default | Description | +|---------------------|-----------------------------------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| exportInterval | Int64 | no | 300 | The duration between two exports in seconds | +| filesToExport | Int64 | no | 24 | How often OpenDC prints an update during simulation. | | +| computeExportConfig | [ComputeExportConfig](#checkpointmodel) | no | Default | The features that should be exported during the simulation | +| filesToExport | List[string] | no | all files | List of the files that should be exported during simulation. The elements should be picked from the set ("host", "task", "powerSource", "battery", "service") | + + + +### ComputeExportConfig +The ComputeExportConfig defines which features should be exported during the simulation. +Several features will always be exported, regardless of the configuration. +When not provided, all features are exported. + + +| Variable | Type | Required? | Base | Default | Description | +|--------------------------|--------------|-----------|------------------------------------------------------------------------|--------------|-----------------------------------------------------------------------| +| hostExportColumns | List[String] | no | name
cluster_name
timestamp
timestamp_absolute
| All features | The features that should be exported to the host output file. | +| taskExportColumns | List[String] | no | task_id
task_name
timestamp
timestamp_absolute
| All features | The features that should be exported to the task output file. | +| powerSourceExportColumns | List[String] | no | name
cluster_name
timestamp
timestamp_absolute
| All features | The features that should be exported to the power source output file. | +| batteryExportColumns | List[String] | no | name
cluster_name
timestamp
timestamp_absolute
| All features | The features that should be exported to the battery output file. | +| serviceExportColumns | List[String] | no | timestamp
timestamp_absolute
| All features | The features that should be exported to the service output file. | + +### Example + +```json +{ + "exportInterval": 3600, + "printFrequency": 168, + "filesToExport": ["host", "task", "service"], + "computeExportConfig": { + "hostExportColumns": ["power_draw", "energy_usage", "cpu_usage", "cpu_utilization"], + "taskExportColumns": ["submission_time", "schedule_time", "finish_time", "task_state"], + "serviceExportColumns": ["tasks_total", "tasks_pending", "tasks_active", "tasks_completed", "tasks_terminated", "hosts_up"] + } +} +``` +In this example: +- the simulation will export data every hour (3600 seconds). +- The simulation will print an update every 168 seconds. +- Only the host, task and service files will be exported. +- Only a selection of features are exported for each file. + diff --git a/site/docs/documentation/Input/FailureModel.md b/site/docs/documentation/Input/FailureModel.md index ecaf7c03..714d2157 100644 --- a/site/docs/documentation/Input/FailureModel.md +++ b/site/docs/documentation/Input/FailureModel.md @@ -1,3 +1,9 @@ +### FailureModel +The failure model that should be used during the simulation +See [FailureModels](FailureModel.md) for detailed instructions. + + + OpenDC provides three types of failure models: [Trace-based](#trace-based-failure-models), [Sample-based](#sample-based-failure-models), and [Prefab](#prefab-failure-models). @@ -159,7 +165,7 @@ Example: The final type of failure models is the prefab models. These are models that are predefined in OpenDC and are based on research. Currently, OpenDC has 9 prefab models based on [The Failure Trace Archive: Enabling the comparison of failure measurements and models of distributed systems](https://www-sciencedirect-com.vu-nl.idm.oclc.org/science/article/pii/S0743731513000634) The figure below shows the values used to define the failure models. -![img.png](img.png) +![failureModels.png](../../../static/img/failureModels.png) Each failure model is defined four times, on for each of the four distribution. The final list of available prefabs is thus: diff --git a/site/docs/documentation/Input/M3SA.md b/site/docs/documentation/Input/M3SA.md deleted file mode 100644 index 6c97d207..00000000 --- a/site/docs/documentation/Input/M3SA.md +++ /dev/null @@ -1,92 +0,0 @@ -M3SA is setup using a json file. The Multi-Model is a top-layer applied on top of the -simulator, -capable to leverage into a singular tool the prediction of multiple models. The Meta-Model is a model generated from the -Multi-Model, and predicts using the predictions of individual models. - -The Multi-Model's properties can be set using a JSON file. The JSON file must be linked to the scenario file and is -required -to follow the structure below. - -## Schema - -The schema for the scenario file is provided in [schema](M3SASchema.md) -In the following section, we describe the different components of the schema. - -### General Structure - -| Variable | Type | Required? | Default | Possible Answers | Description | -|------------------------|---------|-----------|---------------|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| multimodel | boolean | no | true | true, false | Whether or not to build a Multi-Model. If set to false, a Meta-Model will not be computed either. | -| metamodel | boolean | no | true | true, false | Whether to build a Meta-Model. | -| metric | string | yes | N/A | N/A | What metric to be analyzed from the computed files. | -| current_unit | string | no | "" | any string (e.g., "CO2", "Wh") | The international system unit of the metric to be analyzed, without prefixes. e.g., "W" for Watt is ok, "kW" is not. | -| unit_scaling_magnitude | integer | no | 10 | -9, -6, -3, 1, 3, 6, 9 | The scaling factor to be applied to the metric (10^-9, 10^-6, 10^3, 10^3, 10^6, 10^9). For no scaling, input 1. | -| window_size | integer | no | 1 | any positive, non-zero, integer | The size of the window, used for aggregating the chunks. | -| window_function | string | no | "mean" | "mean", "median" | The function used by the window for aggregating the chunks (e.g., for "mean", the window will compute the mean of the samples). | -| meta_function | string | no | "mean" | "mean", "median" | The function used by the Meta-Model to be generated. For "mean", the Meta-Model takes the mean of the individual models, at the granularity established by the window-size. | -| samples_per_minute | double | no | N/A | any positive, non-zero, double | The number of samples per minute, in the prediction data (simulator export rate). e.g., "0.2" means 1 sample every 5 minutes, "20" means a 20 samples per minute, or 1 sample every 3 seconds. | -| seed | integer | no | 0 | any integer >= 0 | The seed of the simulation. This must correspond to the seed from the output folder (from seed=x). | -| plot_type | string | no | "time_series" | "time_series", "cumulative", "cumulative_time_series" | The type of the plot, generated by the Multi-Model and Meta-Model. | -| plot_title | string | no | "" | any string | The title of the plot. | -| x_ticks_count | integer | no | None | any integer, larger than 0 | The number of ticks on x-axis. | -| y_ticks_count | integer | no | None | any integer, larger than 0 | The number of ticks on y-axis. | -| x_label | string | no | "Time" | any string | The label for the x-axis of the plot. | -| y_label | string | no | "Metric Unit" | any string | The label for the y-axis of the plot. | -| y_min | double | no | None | any positive, non-zero, double | The minimum value for the vertical axis of the plot. | -| y_max | double | no | None | any positive, non-zero, double | The maximum value for the vertical axis of the plot. | -| x_min | double | no | None | any positive, non-zero, double | The minimum value for the horizontal axis of the plot. | -| x_max | double | no | None | any positive, non-zero, double | The maximum value for the horizontal axis of the plot. | - -## Examples - -In the following section, we discuss several examples of M3SA setup files. Any setup file can be verified -using the JSON schema defined in [schema](M3SASchema.md). - -### Simple - -The simplest M3SA setup that can be provided to OpenDC is shown below: - -```json -{ - "metric": "power_draw" -} -``` - -This configuration creates a Multi-Model and Meta-Model on the power_draw. All the other parameters are handled by the -default values, towards reducing the complexity of the setup. - -### Complex - -A more complex M3SA setup, where the user has more control on teh generated output, is show below: - -```json -{ - "multimodel": true, - "metamodel": false, - "metric": "carbon_emission", - "window_size": 10, - "window_function": "median", - "metamodel_function": "mean", - "samples_per_minute": 0.2, - "unit_scaling_magnitude": 1000, - "current_unit": "gCO2", - "seed": 0, - "plot_type": "cumulative_time_series", - "plot_title": "Carbon Emission Prediction", - "x_label": "Time [days]", - "y_label": "Carbon Emission [gCO2/kWh]", - "x_min": 0, - "x_max": 200, - "y_min": 500, - "y_max": 1000, - "x_ticks_count": 3, - "y_ticks_count": 3 -} -``` - -This configuration creates a Multi-Model and a Meta-Model which predicts the carbon_emission. The window size is 10, and -the aggregation function (for the window) is median. The Meta-Model function is mean. The data has been exported at a -rate of 0.2 samples per minute (i.e., a sample every 5 minutes). The plot type is cummulative_time_series, which starts -from a y-axis value of 500 and goes up to 1000. Therefore, the Multi-Model and the Meta-Model will show only -the values greater than y_min (500) and smaller than y_max (1000). Also, the x-axis will start from 0 and go up to 200, -with 3 ticks on the x-axis and 3 ticks on the y-axis. diff --git a/site/docs/documentation/Input/M3SASchema.md b/site/docs/documentation/Input/M3SASchema.md deleted file mode 100644 index 5a3503ca..00000000 --- a/site/docs/documentation/Input/M3SASchema.md +++ /dev/null @@ -1,115 +0,0 @@ -Below is the schema for the MultiMetaModel JSON file. This schema can be used to validate a MultiMetaModel setup file. -A setup file can be validated using a JSON schema validator, such as https://www.jsonschemavalidator.net/. - -```json -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "multimodel": { - "type": "boolean", - "default": true, - "description": "Whether or not to build a Multi-Model. If set to false, a Meta-Model will not be computed either." - }, - "metamodel": { - "type": "boolean", - "default": true, - "description": "Whether to build a Meta-Model." - }, - "metric": { - "type": "string", - "description": "What metric to be analyzed from the computed files." - }, - "current_unit": { - "type": "string", - "default": "", - "description": "The international system unit of the metric to be analyzed, without prefixes. e.g., 'W' for Watt is ok, 'kW' is not." - }, - "unit_scaling_magnitude": { - "type": "integer", - "default": 10, - "enum": [-9, -6, -3, 1, 3, 6, 9], - "description": "The scaling factor to be applied to the metric (10^-9, 10^-6, 10^3, 10^3, 10^6, 10^9). For no scaling, input 1." - }, - "seed": { - "type": "integer", - "default": 0, - "minimum": 0, - "description": "The seed of the simulation. This must correspond to the seed from the output folder (from seed=x)." - }, - "window_size": { - "type": "integer", - "default": 1, - "minimum": 1, - "description": "The size of the window, used for aggregating the chunks." - }, - "window_function": { - "type": "string", - "default": "mean", - "enum": ["mean", "median"], - "description": "The function used by the window for aggregating the chunks (e.g., for 'mean', the window will compute the mean of the samples)." - }, - "meta_function": { - "type": "string", - "default": "mean", - "enum": ["mean", "median"], - "description": "The function used by the Meta-Model to be generated. For 'mean', the Meta-Model takes the mean of the individual models, at the granularity established by the window-size." - }, - "samples_per_minute": { - "type": "number", - "minimum": 0.0001, - "description": "The number of samples per minute, in the prediction data (simulator export rate). e.g., '0.2' means 1 sample every 5 minutes, '20' means 20 samples per minute, or 1 sample every 3 seconds." - }, - "plot_type": { - "type": "string", - "default": "time_series", - "enum": ["time_series", "cumulative", "cumulative_time_series"], - "description": "The type of the plot, generated by the Multi-Model and Meta-Model." - }, - "plot_title": { - "type": "string", - "default": "", - "description": "The title of the plot." - }, - "x_label": { - "type": "string", - "default": "Time", - "description": "The label for the x-axis of the plot." - }, - "y_label": { - "type": "string", - "default": "Metric Unit", - "description": "The label for the y-axis of the plot." - }, - "y_min": { - "type": "number", - "description": "The minimum value for the vertical axis of the plot." - }, - "y_max": { - "type": "number", - "description": "The maximum value for the vertical axis of the plot." - }, - "x_min": { - "type": "number", - "description": "The minimum value for the horizontal axis of the plot." - }, - "x_max": { - "type": "number", - "description": "The maximum value for the horizontal axis of the plot." - }, - "x_ticks_count": { - "type": "integer", - "minimum": 1, - "description": "The number of ticks on x-axis." - }, - "y_ticks_count": { - "type": "integer", - "minimum": 1, - "description": "The number of ticks on y-axis." - } - }, - "required": [ - "metric" - ] -} -``` diff --git a/site/docs/documentation/Input/Topology.md b/site/docs/documentation/Input/Topology.md deleted file mode 100644 index 0d2479bd..00000000 --- a/site/docs/documentation/Input/Topology.md +++ /dev/null @@ -1,220 +0,0 @@ -The topology of a datacenter is defined using a JSON file. A topology consist of one or more clusters. -Each cluster consist of at least one host on which jobs can be executed. Each host consist of one or more CPUs, -a memory unit and a power model. - -:::info Code -The code related to reading and processing topology files can be found [here](https://github.com/atlarge-research/opendc/tree/master/opendc-compute/opendc-compute-topology/src/main/kotlin/org/opendc/compute/topology) -::: - - -## Schema - -The schema for the topology file is provided in [schema](TopologySchema). -In the following section, we describe the different components of the schema. - -### Cluster - -| variable | type | required? | default | description | -|----------|---------------------|-----------|---------|-----------------------------------------------------------------------------------| -| name | string | no | Cluster | The name of the cluster. This is only important for debugging and post-processing | -| count | integer | no | 1 | The amount of clusters of this type are in the data center | -| hosts | List[[Host](#host)] | yes | N/A | A list of the hosts in a cluster. | - -### Host - -| variable | type | required? | default | description | -|-------------|-----------------------------|-----------|---------|--------------------------------------------------------------------------------| -| name | string | no | Host | The name of the host. This is only important for debugging and post-processing | -| count | integer | no | 1 | The amount of hosts of this type are in the cluster | -| cpuModel | [CPU](#cpu) | yes | N/A | The CPUs in the host | -| memory | [Memory](#memory) | yes | N/A | The memory used by the host | -| power model | [Power Model](#power-model) | yes | N/A | The power model used to determine the power draw of the host | - -### CPU - -| variable | type | Unit | required? | default | description | -|-----------|---------|-------|-----------|---------|--------------------------------------------------| -| name | string | N/A | no | unknown | The name of the CPU. | -| vendor | string | N/A | no | unknown | The vendor of the CPU | -| arch | string | N/A | no | unknown | the micro-architecture of the CPU | -| count | integer | N/A | no | 1 | The amount of cpus of this type used by the host | -| coreCount | integer | count | yes | N/A | The number of cores in the CPU | -| coreSpeed | Double | Mhz | yes | N/A | The speed of each core in Mhz | - -### Memory - -| variable | type | Unit | required? | default | description | -|-------------|---------|------|-----------|---------|--------------------------------------------------------------------------| -| name | string | N/A | no | unknown | The name of the CPU. | -| vendor | string | N/A | no | unknown | The vendor of the CPU | -| arch | string | N/A | no | unknown | the micro-architecture of the CPU | -| count | integer | N/A | no | 1 | The amount of cpus of this type used by the host | -| memorySize | integer | Byte | yes | N/A | The number of cores in the CPU | -| memorySpeed | Double | ? | no | -1 | The speed of each core in Mhz. PLACEHOLDER: this currently does nothing. | - -### Power Model - -| variable | type | Unit | required? | default | description | -|-----------------|--------|------|-----------|----------|-------------------------------------------------------------------------------| -| vendor | string | N/A | yes | N/A | The type of model used to determine power draw | -| modelName | string | N/A | yes | N/A | The type of model used to determine power draw | -| arch | string | N/A | yes | N/A | The type of model used to determine power draw | -| totalPower | Int64 | Watt | no | max long | The power draw of a host when using max capacity in Watt | -| carbonTracePath | string | N/A | no | null | Path to a carbon intensity trace. If not given, carbon intensity is always 0. | - -## Examples - -In the following section, we discuss several examples of topology files. Any topology file can be verified using the -JSON schema defined in [schema](TopologySchema). - -### Simple - -The simplest data center that can be provided to OpenDC is shown below: - -```json -{ - "clusters": [ - { - "hosts": [ - { - "cpu": - { - "coreCount": 16, - "coreSpeed": 1000 - }, - "memory": { - "memorySize": 100000 - } - } - ] - } - ] -} -``` - -This creates a data center with a single cluster containing a single host. This host consist of a single 16 core CPU -with a speed of 1 Ghz, and 100 MiB RAM memory. - -### Count - -Duplicating clusters, hosts, or CPUs is easy using the "count" keyword: - -```json -{ - "clusters": [ - { - "count": 2, - "hosts": [ - { - "count": 5, - "cpu": - { - "coreCount": 16, - "coreSpeed": 1000, - "count": 10 - }, - "memory": - { - "memorySize": 100000 - } - } - ] - } - ] -} -``` - -This topology creates a datacenter consisting of 2 clusters, both containing 5 hosts. Each host contains 10 16 core -CPUs. -Using "count" saves a lot of copying. - -### Complex - -Following is an example of a more complex topology: - -```json -{ - "clusters": [ - { - "name": "C01", - "count": 2, - "hosts": [ - { - "name": "H01", - "count": 2, - "cpus": [ - { - "coreCount": 16, - "coreSpeed": 1000 - } - ], - "memory": { - "memorySize": 1000000 - }, - "powerModel": { - "modelType": "linear", - "idlePower": 200.0, - "maxPower": 400.0 - } - }, - { - "name": "H02", - "count": 2, - "cpus": [ - { - "coreCount": 8, - "coreSpeed": 3000 - } - ], - "memory": { - "memorySize": 100000 - }, - "powerModel": { - "modelType": "square", - "idlePower": 300.0, - "maxPower": 500.0 - } - } - ] - } - ] -} -``` - -This topology defines two types of hosts with different coreCount, and coreSpeed. -Both types of hosts are created twice. - - -### With Units of Measure - -Aside from using number to indicate values it is also possible to define values using strings. This allows the user to define the unit of the input parameter. -```json -{ - "clusters": [ - { - "count": 2, - "hosts" : - [ - { - "name": "H01", - "cpuModel": - { - "coreCount": 8, - "coreSpeed": "3.2 Ghz" - }, - "memory": { - "memorySize": "128e3 MiB", - "memorySpeed": "1 Mhz" - }, - "powerModel": { - "modelType": "linear", - "power": "400 Watts", - "maxPower": "1 KW", - "idlePower": "0.4 W" - } - } - ] - } - ] -} -``` diff --git a/site/docs/documentation/Input/Topology/Battery.md b/site/docs/documentation/Input/Topology/Battery.md new file mode 100644 index 00000000..70492694 --- /dev/null +++ b/site/docs/documentation/Input/Topology/Battery.md @@ -0,0 +1,37 @@ +Batteries can be used to store energy for later use. +In previous work, we have used batteries to store energy from the grid when the carbon intensity is low, +and use this energy when the carbon intensity is high. + +Batteries are defined using the following parameters: + +| variable | type | Unit | required? | default | description | +|------------------|---------------------------|-------|-----------|---------|-----------------------------------------------------------------------------------| +| name | string | N/A | no | Battery | The name of the battery. This is only important for debugging and post-processing | +| capacity | Double | kWh | yes | N/A | The total amount of energy that the battery can hold. | +| chargingSpeed | Double | W | yes | N/A | Charging speed of the battery. | +| initialCharge | Double | kWh | no | 0.0 | The initial charge of the battery. If not given, the battery starts empty. | +| batteryPolicy | [Policy](#battery-policy) | N/A | yes | N/A | The policy which decides when to charge and discharge. | +| embodiedCarbon | Double | gram | no | 0.0 | The embodied carbon emitted while creating this battery. | +| expectedLifetime | Double | Years | yes | 0.0 | The expected lifetime of the battery. | + +## Battery Policy +To determine when to charge and discharge the battery, a policy is required. +Currently, all policies for batteries are based on the carbon intensity of the grid. + +The best performing policy is called "runningMeanPlus" and is based on the running mean of the carbon intensity. +it can be defined with the following JSON: + +```json +{ + "type": "runningMeanPlus", + "startingThreshold": 123.2, + "windowSize": 168 +} +``` + +In which `startingThreshold` is the initial carbon threshold used. +`windowSize` is the size of the window used to calculate the running mean. + +:::info Alert +This page with be extended with more text and policies in the future. +::: diff --git a/site/docs/documentation/Input/Topology/Host.md b/site/docs/documentation/Input/Topology/Host.md new file mode 100644 index 00000000..7b5b8394 --- /dev/null +++ b/site/docs/documentation/Input/Topology/Host.md @@ -0,0 +1,55 @@ +A host is a machine that can execute tasks. A host consist of the following components: + +| variable | type | required? | default | description | +|-------------|:-------------------------------------------------------------|:----------|---------|--------------------------------------------------------------------------------| +| name | string | no | Host | The name of the host. This is only important for debugging and post-processing | +| count | integer | no | 1 | The amount of hosts of this type are in the cluster | +| cpuModel | [CPU](#cpu) | yes | N/A | The CPUs in the host | +| memory | [Memory](#memory) | yes | N/A | The memory used by the host | +| power model | [Power Model](/docs/documentation/Input/Topology/PowerModel) | no | Default | The power model used to determine the power draw of the host | + +## CPU + +| variable | type | Unit | required? | default | description | +|-----------|---------|-------|-----------|---------|--------------------------------------------------| +| modelName | string | N/A | no | unknown | The name of the CPU. | +| vendor | string | N/A | no | unknown | The vendor of the CPU | +| arch | string | N/A | no | unknown | the micro-architecture of the CPU | +| count | integer | N/A | no | 1 | The number of CPUs of this type used by the host | +| coreCount | integer | count | yes | N/A | The number of cores in the CPU | +| coreSpeed | Double | Mhz | yes | N/A | The speed of each core in Mhz | + +## Memory + +| variable | type | Unit | required? | default | description | +|-------------|---------|------|-----------|---------|--------------------------------------------------------------------------| +| modelName | string | N/A | no | unknown | The name of the CPU. | +| vendor | string | N/A | no | unknown | The vendor of the CPU | +| arch | string | N/A | no | unknown | the micro-architecture of the CPU | +| memorySize | integer | Byte | yes | N/A | The number of cores in the CPU | +| memorySpeed | Double | Mhz | no | -1 | The speed of each core in Mhz. PLACEHOLDER: this currently does nothing. | + +## Example + +```json +{ + "name": "H01", + "cpu": { + "coreCount": 16, + "coreSpeed": 2100 + }, + "memory": { + "memorySize": 100000 + }, + "powerModel": { + "modelType": "sqrt", + "idlePower": 32.0, + "maxPower": 180.0 + }, + "count": 100 +} +``` + +This example creates 100 hosts with 16 cores and 2.1 Ghz CPU speed, and 100 GB of memory. +The power model used is a square root model with a power of 400 W, idle power of 32 W, and max power of 180 W. +For more information on the power model, see [Power Model](/docs/documentation/Input/Topology/PowerModel). diff --git a/site/docs/documentation/Input/Topology/PowerModel.md b/site/docs/documentation/Input/Topology/PowerModel.md new file mode 100644 index 00000000..06f4a4da --- /dev/null +++ b/site/docs/documentation/Input/Topology/PowerModel.md @@ -0,0 +1,31 @@ +OpenDC uses power models to determine the power draw based on the utilization of a host. +All models in OpenDC are based on linear models interpolated between the idle and max power draw. +OpenDC currently supports the following power models: +1. **Constant**: The power draw is constant and does not depend on the utilization of the host. +2. **Sqrt**: The power draw interpolates between idle and max using a square root function. +3. **Linear**: The power draw interpolates between idle and max using a linear function. +4. **Square**: The power draw interpolates between idle and max using a square function. +5. **Cubic**The power draw interpolates between idle and max using a cubic function. + +The power model is defined using the following parameters: + +| variable | type | Unit | required? | default | description | +|-----------|--------|------|-----------|---------|--------------------------------------------------------------------| +| modelType | string | N/A | yes | N/A | The type of model used to determine power draw | +| power | double | Mhz | no | 400 | The power draw of a host when using the constant power draw model. | +| idlePower | double | Mhz | yes | N/A | The power draw of a host when idle in Watt. | +| maxPower | double | Mhz | yes | N/A | The power draw of a host when using max capacity in Watt. | + + +## Example + +```json +{ + "modelType": "sqrt", + "idlePower": 32.0, + "maxPower": 180.0 +} +``` + +This creates a power model that uses a square root function to determine the power draw of a host. +The model uses an idle and max power of 32 W and 180 W respectively. diff --git a/site/docs/documentation/Input/Topology/PowerSource.md b/site/docs/documentation/Input/Topology/PowerSource.md new file mode 100644 index 00000000..993083dd --- /dev/null +++ b/site/docs/documentation/Input/Topology/PowerSource.md @@ -0,0 +1,20 @@ +Each cluster has a power source that provides power to the hosts in the cluster. +A user can connect a power source to a carbon trace to determine the carbon emissions during a workload. + +The power source consist of the following components: + +| variable | type | Unit | required? | default | description | +|-----------------|--------------|------|-----------|----------------|-----------------------------------------------------------------------------------| +| name | string | N/A | no | PowerSource | The name of the cluster. This is only important for debugging and post-processing | +| maxPower | integer | Watt | no | Long.Max_Value | The total power that the power source can provide in Watt. | +| carbonTracePath | path/to/file | N/A | no | null | A list of the hosts in a cluster. | + +## Example + +```json +{ + "carbonTracePath": "carbon_traces/AT_2021-2024.parquet" +} +``` + +This example creates a power source with infinite power draw that uses the carbon trace from the file `carbon_traces/AT_2021-2024.parquet`. diff --git a/site/docs/documentation/Input/Topology/Topology.md b/site/docs/documentation/Input/Topology/Topology.md new file mode 100644 index 00000000..afc94e08 --- /dev/null +++ b/site/docs/documentation/Input/Topology/Topology.md @@ -0,0 +1,183 @@ +The topology of a datacenter defines all available hardware. Topologies are defined using a JSON file. +A topology consist of one or more clusters. Each cluster consist of at least one host on which jobs can be executed. +Each host consist of one or more CPUs, a memory unit and a power model. + +:::info Code +The code related to reading and processing topology files can be found [here](https://github.com/atlarge-research/opendc/tree/master/opendc-compute/opendc-compute-topology/src/main/kotlin/org/opendc/compute/topology) +::: + +In the following section, we describe the different components of a topology file. + +### Cluster + +| variable | type | required? | default | description | +|-------------|---------------------------------------------------------------|-----------|---------|-----------------------------------------------------------------------------------| +| name | string | no | Cluster | The name of the cluster. This is only important for debugging and post-processing | +| count | integer | no | 1 | The amount of clusters of this type are in the data center | +| hosts | List[[Host](/docs/documentation/Input/Topology/Host)] | yes | N/A | A list of the hosts in a cluster. | +| powerSource | [PowerSource](/docs/documentation/Input/Topology/PowerSource) | no | N/A | The power source used by all hosts connected to this cluster. | +| battery | [Battery](/docs/documentation/Input/Topology/Battery) | no | null | The battery used by a cluster to store energy. When null, no batteries are used. | + +Hosts, power sources and batteries all require objects to use. See their respective pages for more information. + +## Examples + +In the following section, we discuss several examples of topology files. + +### Simple + +The simplest data center that can be provided to OpenDC is shown below: + +```json +{ + "clusters": [ + { + "hosts": [ + { + "cpu": + { + "coreCount": 16, + "coreSpeed": 1000 + }, + "memory": { + "memorySize": 100000 + } + } + ], + "powerSource": { + "carbonTracePath": "carbon_traces/AT_2021-2024.parquet" + } + } + ] +} +``` + +This creates a data center with a single cluster containing a single host. This host consist of a single 16 core CPU +with a speed of 1 Ghz, and 100 MiB RAM memory. + +### Count + +Duplicating clusters, hosts, or CPUs is easy using the "count" keyword: + +```json +{ + "clusters": [ + { + "count": 2, + "hosts": [ + { + "count": 5, + "cpu": + { + "coreCount": 16, + "coreSpeed": 1000, + "count": 10 + }, + "memory": + { + "memorySize": 100000 + } + } + ], + "powerSource": { + "carbonTracePath": "carbon_traces/AT_2021-2024.parquet" + } + } + ] +} +``` + +This topology creates a datacenter consisting of 2 clusters, both containing 5 hosts. Each host contains 10 16 core +CPUs. +Using "count" saves a lot of copying. + +### Complex + +Following is an example of a more complex topology: + +```json +{ + "clusters": [ + { + "name": "C01", + "count": 2, + "hosts": [ + { + "name": "H01", + "count": 2, + "cpus": [ + { + "coreCount": 16, + "coreSpeed": 1000 + } + ], + "memory": { + "memorySize": 1000000 + }, + "powerModel": { + "modelType": "linear", + "idlePower": 200.0, + "maxPower": 400.0 + } + }, + { + "name": "H02", + "count": 2, + "cpus": [ + { + "coreCount": 8, + "coreSpeed": 3000 + } + ], + "memory": { + "memorySize": 100000 + }, + "powerModel": { + "modelType": "square", + "idlePower": 300.0, + "maxPower": 500.0 + } + } + ] + } + ] +} +``` + +This topology defines two types of hosts with different coreCount, and coreSpeed. +Both types of hosts are created twice. + + +### With Units of Measure + +Aside from using number to indicate values it is also possible to define values using strings. This allows the user to define the unit of the input parameter. +```json +{ + "clusters": [ + { + "count": 2, + "hosts" : + [ + { + "name": "H01", + "cpuModel": + { + "coreCount": 8, + "coreSpeed": "3.2 Ghz" + }, + "memory": { + "memorySize": "128e3 MiB", + "memorySpeed": "1 Mhz" + }, + "powerModel": { + "modelType": "linear", + "power": "400 Watts", + "maxPower": "1 KW", + "idlePower": "0.4 W" + } + } + ] + } + ] +} +``` diff --git a/site/docs/documentation/Input/TopologySchema.md b/site/docs/documentation/Input/TopologySchema.md deleted file mode 100644 index d0199568..00000000 --- a/site/docs/documentation/Input/TopologySchema.md +++ /dev/null @@ -1,160 +0,0 @@ -Below is the schema for the Topology JSON file. This schema can be used to validate a topology file. -A topology file can be validated using a JSON schema validator, such as https://www.jsonschemavalidator.net/. - -```json -{ - "$schema": "OpenDC/Topology", - "$defs": { - "cpuModel": { - "description": "definition of a cpuModel", - "type": "object", - "properties": { - "vendor": { - "type": "string", - "default": "unknown" - }, - "modelName": { - "type": "string", - "default": "unknown" - }, - "arch": { - "type": "string", - "default": "unknown" - }, - "coreCount": { - "type": "integer" - }, - "coreSpeed": { - "description": "The core speed of the cpuModel in Mhz", - "type": "number" - }, - "count": { - "description": "The amount CPUs of this type present in the cluster", - "type": "integer" - } - }, - "required": [ - "coreCount", - "coreSpeed" - ] - }, - "memory": { - "type": "object", - "properties": { - "vendor": { - "type": "string", - "default": "unknown" - }, - "modelName": { - "type": "string", - "default": "unknown" - }, - "arch": { - "type": "string", - "default": "unknown" - }, - "memorySize": { - "description": "The amount of the memory in B", - "type": "integer" - }, - "memorySpeed": { - "description": "The speed of the memory in Mhz. Note: currently, this does nothing", - "type": "number", - "default": -1 - } - }, - "required": [ - "memorySize" - ] - }, - "powerModel": { - "type": "object", - "properties": { - "modelType": { - "description": "The type of model used to determine power draw", - "type": "string" - }, - "power": { - "description": "The constant power draw when using the 'constant' power model type in Watt", - "type": "number", - "default": 400 - }, - "maxPower": { - "description": "The power draw of a host when idle in Watt", - "type": "number" - }, - "idlePower": { - "description": "The power draw of a host when using max capacity in Watt", - "type": "number" - } - }, - "required": [ - "modelType", - "maxPower", - "idlePower" - ] - }, - "host": { - "type": "object", - "properties": { - "name": { - "type": "string", - "default": "Host" - }, - "count": { - "description": "The amount hosts of this type present in the cluster", - "type": "integer", - "default": 1 - }, - "cpuModel": { - "$ref": "#/$defs/cpuModel" - }, - "memory": { - "$ref": "#/$defs/memory" - } - }, - "required": [ - "cpuModel", - "memory" - ] - }, - "cluster": { - "type": "object", - "properties": { - "name": { - "type": "string", - "default": "Cluster" - }, - "count": { - "description": "The amount clusters of this type present in the Data center", - "type": "integer", - "default": 1 - }, - "hosts": { - "type": "array", - "items": { - "$ref": "#/$defs/host" - }, - "minItems": 1 - } - }, - "required": [ - "hosts" - ] - } - }, - "properties": { - "clusters": { - "description": "Clusters present in the data center", - "type": "array", - "items": { - "$ref": "#/$defs/cluster" - }, - "minItems": 1 - } - }, - "required": [ - "clusters" - ] -} -``` diff --git a/site/docs/documentation/Input/Workload.md b/site/docs/documentation/Input/Workload.md index b0a45942..73f39e60 100644 --- a/site/docs/documentation/Input/Workload.md +++ b/site/docs/documentation/Input/Workload.md @@ -1,24 +1,31 @@ -OpenDC works with two types of traces that describe the tasks that need to be run. Both traces have to be provided as -parquet files. +Workloads define what tasks in the simulation, when they were submitted, and their computational requirements. +Workload are defined using two files: -#### Task -The meta trace provides an overview of the tasks: +- **[Tasks](#tasks)**: The Tasks file contains the metadata of the tasks +- **[Fragments](#fragments)**: The Fragments file contains the computational demand of each task over time -| Metric | Datatype | Unit | Summary | -|-----------------|----------|----------|------------------------------------------------| -| id | string | | The id of the server | -| submission_time | int64 | datetime | The submission time of the server | -| duration | int64 | datetime | The finish time of the submission | -| cpu_count | int32 | count | The number of CPUs required to run this task | -| cpu_capacity | float64 | MHz | The amount of CPU required to run this task | -| mem_capacity | int64 | MB | The amount of memory required to run this task | +Both files are provided using the parquet format. -#### Fragment -The Fragment file provides information about the computational demand of each task over time: +#### Tasks +The Tasks file provides an overview of the tasks: -| Metric | Datatype | Unit | Summary | -|-----------|------------|---------------|---------------------------------------------| -| id | string | | The id of the task | -| duration | int64 | milli seconds | The duration since the last sample | -| cpu_count | int32 | count | The number of cpus required | -| cpu_usage | float64 | MHz | The amount of computational power required. | +| Metric | Required? | Datatype | Unit | Summary | +|-----------------|-----------|----------|------------------------------|--------------------------------------------------------| +| id | Yes | string | | The id of the server | +| submission_time | Yes | int64 | datetime | The submission time of the server | +| nature | No | string | [deferrable, non-deferrable] | Defines if a task can be delayed | +| deadline | No | string | datetime | The latest the scheduling of a task can be delayed to. | +| duration | Yes | int64 | datetime | The finish time of the submission | +| cpu_count | Yes | int32 | count | The number of CPUs required to run this task | +| cpu_capacity | Yes | float64 | MHz | The amount of CPU required to run this task | +| mem_capacity | Yes | int64 | MB | The amount of memory required to run this task | + +#### Fragments +The Fragments file provides information about the computational demand of each task over time: + +| Metric | Required? | Datatype | Unit | Summary | +|-----------|-----------|----------|---------------|---------------------------------------------| +| id | Yes | string | | The id of the task | +| duration | Yes | int64 | milli seconds | The duration since the last sample | +| cpu_count | Yes | int32 | count | The number of cpus required | +| cpu_usage | Yes | float64 | MHz | The amount of computational power required. | diff --git a/site/docs/documentation/Input/img.png b/site/docs/documentation/Input/img.png deleted file mode 100644 index 5ad3a85b..00000000 Binary files a/site/docs/documentation/Input/img.png and /dev/null differ diff --git a/site/docs/documentation/M3SA/M3SA.md b/site/docs/documentation/M3SA/M3SA.md new file mode 100644 index 00000000..6c97d207 --- /dev/null +++ b/site/docs/documentation/M3SA/M3SA.md @@ -0,0 +1,92 @@ +M3SA is setup using a json file. The Multi-Model is a top-layer applied on top of the +simulator, +capable to leverage into a singular tool the prediction of multiple models. The Meta-Model is a model generated from the +Multi-Model, and predicts using the predictions of individual models. + +The Multi-Model's properties can be set using a JSON file. The JSON file must be linked to the scenario file and is +required +to follow the structure below. + +## Schema + +The schema for the scenario file is provided in [schema](M3SASchema.md) +In the following section, we describe the different components of the schema. + +### General Structure + +| Variable | Type | Required? | Default | Possible Answers | Description | +|------------------------|---------|-----------|---------------|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| multimodel | boolean | no | true | true, false | Whether or not to build a Multi-Model. If set to false, a Meta-Model will not be computed either. | +| metamodel | boolean | no | true | true, false | Whether to build a Meta-Model. | +| metric | string | yes | N/A | N/A | What metric to be analyzed from the computed files. | +| current_unit | string | no | "" | any string (e.g., "CO2", "Wh") | The international system unit of the metric to be analyzed, without prefixes. e.g., "W" for Watt is ok, "kW" is not. | +| unit_scaling_magnitude | integer | no | 10 | -9, -6, -3, 1, 3, 6, 9 | The scaling factor to be applied to the metric (10^-9, 10^-6, 10^3, 10^3, 10^6, 10^9). For no scaling, input 1. | +| window_size | integer | no | 1 | any positive, non-zero, integer | The size of the window, used for aggregating the chunks. | +| window_function | string | no | "mean" | "mean", "median" | The function used by the window for aggregating the chunks (e.g., for "mean", the window will compute the mean of the samples). | +| meta_function | string | no | "mean" | "mean", "median" | The function used by the Meta-Model to be generated. For "mean", the Meta-Model takes the mean of the individual models, at the granularity established by the window-size. | +| samples_per_minute | double | no | N/A | any positive, non-zero, double | The number of samples per minute, in the prediction data (simulator export rate). e.g., "0.2" means 1 sample every 5 minutes, "20" means a 20 samples per minute, or 1 sample every 3 seconds. | +| seed | integer | no | 0 | any integer >= 0 | The seed of the simulation. This must correspond to the seed from the output folder (from seed=x). | +| plot_type | string | no | "time_series" | "time_series", "cumulative", "cumulative_time_series" | The type of the plot, generated by the Multi-Model and Meta-Model. | +| plot_title | string | no | "" | any string | The title of the plot. | +| x_ticks_count | integer | no | None | any integer, larger than 0 | The number of ticks on x-axis. | +| y_ticks_count | integer | no | None | any integer, larger than 0 | The number of ticks on y-axis. | +| x_label | string | no | "Time" | any string | The label for the x-axis of the plot. | +| y_label | string | no | "Metric Unit" | any string | The label for the y-axis of the plot. | +| y_min | double | no | None | any positive, non-zero, double | The minimum value for the vertical axis of the plot. | +| y_max | double | no | None | any positive, non-zero, double | The maximum value for the vertical axis of the plot. | +| x_min | double | no | None | any positive, non-zero, double | The minimum value for the horizontal axis of the plot. | +| x_max | double | no | None | any positive, non-zero, double | The maximum value for the horizontal axis of the plot. | + +## Examples + +In the following section, we discuss several examples of M3SA setup files. Any setup file can be verified +using the JSON schema defined in [schema](M3SASchema.md). + +### Simple + +The simplest M3SA setup that can be provided to OpenDC is shown below: + +```json +{ + "metric": "power_draw" +} +``` + +This configuration creates a Multi-Model and Meta-Model on the power_draw. All the other parameters are handled by the +default values, towards reducing the complexity of the setup. + +### Complex + +A more complex M3SA setup, where the user has more control on teh generated output, is show below: + +```json +{ + "multimodel": true, + "metamodel": false, + "metric": "carbon_emission", + "window_size": 10, + "window_function": "median", + "metamodel_function": "mean", + "samples_per_minute": 0.2, + "unit_scaling_magnitude": 1000, + "current_unit": "gCO2", + "seed": 0, + "plot_type": "cumulative_time_series", + "plot_title": "Carbon Emission Prediction", + "x_label": "Time [days]", + "y_label": "Carbon Emission [gCO2/kWh]", + "x_min": 0, + "x_max": 200, + "y_min": 500, + "y_max": 1000, + "x_ticks_count": 3, + "y_ticks_count": 3 +} +``` + +This configuration creates a Multi-Model and a Meta-Model which predicts the carbon_emission. The window size is 10, and +the aggregation function (for the window) is median. The Meta-Model function is mean. The data has been exported at a +rate of 0.2 samples per minute (i.e., a sample every 5 minutes). The plot type is cummulative_time_series, which starts +from a y-axis value of 500 and goes up to 1000. Therefore, the Multi-Model and the Meta-Model will show only +the values greater than y_min (500) and smaller than y_max (1000). Also, the x-axis will start from 0 and go up to 200, +with 3 ticks on the x-axis and 3 ticks on the y-axis. diff --git a/site/docs/documentation/M3SA/M3SASchema.md b/site/docs/documentation/M3SA/M3SASchema.md new file mode 100644 index 00000000..5a3503ca --- /dev/null +++ b/site/docs/documentation/M3SA/M3SASchema.md @@ -0,0 +1,115 @@ +Below is the schema for the MultiMetaModel JSON file. This schema can be used to validate a MultiMetaModel setup file. +A setup file can be validated using a JSON schema validator, such as https://www.jsonschemavalidator.net/. + +```json +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "multimodel": { + "type": "boolean", + "default": true, + "description": "Whether or not to build a Multi-Model. If set to false, a Meta-Model will not be computed either." + }, + "metamodel": { + "type": "boolean", + "default": true, + "description": "Whether to build a Meta-Model." + }, + "metric": { + "type": "string", + "description": "What metric to be analyzed from the computed files." + }, + "current_unit": { + "type": "string", + "default": "", + "description": "The international system unit of the metric to be analyzed, without prefixes. e.g., 'W' for Watt is ok, 'kW' is not." + }, + "unit_scaling_magnitude": { + "type": "integer", + "default": 10, + "enum": [-9, -6, -3, 1, 3, 6, 9], + "description": "The scaling factor to be applied to the metric (10^-9, 10^-6, 10^3, 10^3, 10^6, 10^9). For no scaling, input 1." + }, + "seed": { + "type": "integer", + "default": 0, + "minimum": 0, + "description": "The seed of the simulation. This must correspond to the seed from the output folder (from seed=x)." + }, + "window_size": { + "type": "integer", + "default": 1, + "minimum": 1, + "description": "The size of the window, used for aggregating the chunks." + }, + "window_function": { + "type": "string", + "default": "mean", + "enum": ["mean", "median"], + "description": "The function used by the window for aggregating the chunks (e.g., for 'mean', the window will compute the mean of the samples)." + }, + "meta_function": { + "type": "string", + "default": "mean", + "enum": ["mean", "median"], + "description": "The function used by the Meta-Model to be generated. For 'mean', the Meta-Model takes the mean of the individual models, at the granularity established by the window-size." + }, + "samples_per_minute": { + "type": "number", + "minimum": 0.0001, + "description": "The number of samples per minute, in the prediction data (simulator export rate). e.g., '0.2' means 1 sample every 5 minutes, '20' means 20 samples per minute, or 1 sample every 3 seconds." + }, + "plot_type": { + "type": "string", + "default": "time_series", + "enum": ["time_series", "cumulative", "cumulative_time_series"], + "description": "The type of the plot, generated by the Multi-Model and Meta-Model." + }, + "plot_title": { + "type": "string", + "default": "", + "description": "The title of the plot." + }, + "x_label": { + "type": "string", + "default": "Time", + "description": "The label for the x-axis of the plot." + }, + "y_label": { + "type": "string", + "default": "Metric Unit", + "description": "The label for the y-axis of the plot." + }, + "y_min": { + "type": "number", + "description": "The minimum value for the vertical axis of the plot." + }, + "y_max": { + "type": "number", + "description": "The maximum value for the vertical axis of the plot." + }, + "x_min": { + "type": "number", + "description": "The minimum value for the horizontal axis of the plot." + }, + "x_max": { + "type": "number", + "description": "The maximum value for the horizontal axis of the plot." + }, + "x_ticks_count": { + "type": "integer", + "minimum": 1, + "description": "The number of ticks on x-axis." + }, + "y_ticks_count": { + "type": "integer", + "minimum": 1, + "description": "The number of ticks on y-axis." + } + }, + "required": [ + "metric" + ] +} +``` diff --git a/site/docs/documentation/Output.md b/site/docs/documentation/Output.md index 339ac615..584b0702 100644 --- a/site/docs/documentation/Output.md +++ b/site/docs/documentation/Output.md @@ -1,91 +1,114 @@ -Running OpenDC results in three output files. The first file ([Task](#task)) contains metrics related to the jobs being executed. -The second file ([Host](#host)) contains all metrics related to the hosts on which jobs can be executed. The third file ([Power](#power)) -contains all metrics related to the power sources that power the hosts. Finally, the third file ([Service](#service)) -contains metrics describing the overall performance. An experiment in OpenDC has +Running OpenDC results in five output files: +1. [Task](#task) contains metrics related to the jobs being executed. +2. [Host](#host) contains all metrics related to the hosts on which jobs can be executed. +3. [Power Source](#power-source) contains all metrics related to the power sources that power the hosts. +4. [Battery](#battery) contains all metrics related to the batteries that power the hosts. +5. [Service](#service) contains metrics describing the overall performance. + +User can define which files, and features are to be included in the output in the experiment file (see [ExportModel](/docs/documentation/Input/ExportModel.md)). ### Task The task output file, contains all metrics of related to the tasks that are being executed. -| Metric | Datatype | Unit | Summary | -|--------------------|----------|-----------|-------------------------------------------------------------------------------| -| timestamp | int64 | ms | Timestamp of the sample since the start of the workload | -| absolute timestamp | int64 | ms | The absolute timestamp based on the given workload | -| server_id | binary | string | The id of the server determined during runtime | -| server_name | binary | string | The name of the server provided by the Trace | -| host_id | binary | string | The id of the host on which the server is hosted or `null` if it has no host. | -| mem_capacity | int64 | Mb | | -| cpu_count | int32 | count | | -| cpu_limit | double | MHz | The capacity of the CPUs of Host on which the server is running. | -| cpu_time_active | int64 | ms | The duration that a CPU was active in the server. | -| cpu_time_idle | int64 | ms | The duration that a CPU was idle in the server. | -| cpu_time_steal | int64 | ms | The duration that a vCPU wanted to run, but no capacity was available. | -| cpu_time_lost | int64 | ms | The duration of CPU time that was lost due to interference. | -| uptime | int64 | ms | The uptime of the host since last sample. | -| downtime | int64 | ms | The downtime of the host since last sample. | -| provision_time | int64 | ms | The time for which the server was enqueued for the scheduler. | -| boot_time | int64 | ms | The time a task got booted. | -| boot_time_absolute | int64 | ms | The absolute time a task got booted. | -| creation_time | int64 | ms | The time at which the task was created by the ComputeService | -| finish_time | int64 | ms | The time at which the task was finished (either completed or terminated) | -| task_state | String | TaskState | The status of the Task | +| Metric | Datatype | Unit | Summary | +|--------------------|----------|-----------|-----------------------------------------------------------------------------| +| timestamp | int64 | ms | Timestamp of the sample since the start of the workload. | +| timestamp_absolute | int64 | ms | The absolute timestamp based on the given workload. | +| task_id | binary | string | The id of the task determined during runtime. | +| task_name | binary | string | The name of the task provided by the Trace. | +| host_name | binary | string | The id of the host on which the task is hosted or `null` if it has no host. | +| mem_capacity | int64 | Mb | The memory required by the task. | +| cpu_count | int32 | count | The number of CPUs required by the task. | +| cpu_limit | double | MHz | The capacity of the CPUs of Host on which the task is running. | +| cpu_usage | double | MHz | The cpu capacity provided by the CPU to the task. | +| cpu_demand | double | MHz | The cpu capacity demanded of the CPU by the task. | +| cpu_time_active | int64 | ms | The duration that a CPU was active in the task. | +| cpu_time_idle | int64 | ms | The duration that a CPU was idle in the task. | +| cpu_time_steal | int64 | ms | The duration that a vCPU wanted to run, but no capacity was available. | +| cpu_time_lost | int64 | ms | The duration of CPU time that was lost due to interference. | +| uptime | int64 | ms | The uptime of the host since last sample. | +| downtime | int64 | ms | The downtime of the host since last sample. | +| num_failures | int64 | count | How many times was a task interrupted due to machine failure. | +| num_pauses | int64 | ms | How many times was a task interrupted due to the TaskStopper. | +| submission_time | int64 | ms | The time for which the task was enqueued for the scheduler. | +| schedule_time | int64 | ms | The time at which task got booted. | +| finish_time | int64 | ms | The time at which the task was finished (either completed or terminated). | +| task_state | String | TaskState | The current state of the Task. | ### Host -The host output file, contains all metrics of related to the host run. +The host output file, contains all metrics of related to the hosts that are running. -| Metric | DataType | Unit | Summary | -|--------------------|----------|------------|-------------------------------------------------------------------------------------------------| -| timestamp | int64 | ms | Timestamp of the sample | -| absolute timestamp | int64 | ms | The absolute timestamp based on the given workload | -| host_id | binary | string | The id of the host given by OpenDC | -| cpu_count | int32 | count | The number of available cpuModel cores | -| mem_capacity | int64 | Mb | The amount of available memory | -| guests_terminated | int32 | count | The number of guests that are in a terminated state. | -| guests_running | int32 | count | The number of guests that are in a running state. | -| guests_error | int32 | count | The number of guests that are in an error state. | -| guests_invalid | int32 | count | The number of guests that are in an unknown state. | -| cpu_limit | double | MHz | The capacity of the CPUs in the host. | -| cpu_usage | double | MHz | The usage of all CPUs in the host. | -| cpu_demand | double | MHz | The demand of all vCPUs of the guests | -| cpu_utilization | double | ratio | The CPU utilization of the host. This is calculated by dividing the cpu_usage, by the cpu_limit | -| cpu_time_active | int64 | ms | The duration that a CPU was active in the host. | -| cpu_time_idle | int64 | ms | The duration that a CPU was idle in the host. | -| cpu_time_steal | int64 | ms | The duration that a vCPU wanted to run, but no capacity was available. | -| cpu_time_lost | int64 | ms | The duration of CPU time that was lost due to interference. | -| power_draw | double | Watt | The current power draw of the host. | -| energy_usage | double | Joule (Ws) | The total energy consumption of the host since last sample. | -| uptime | int64 | ms | The uptime of the host since last sample. | -| downtime | int64 | ms | The downtime of the host since last sample. | -| boot_time | int64 | ms | The time a host got booted. | -| boot_time_absolute | int64 | ms | The absolute time a host got booted. | +| Metric | DataType | Unit | Summary | +|--------------------|----------|------------|-----------------------------------------------------------------------------------------------------| +| timestamp | int64 | ms | Timestamp of the sample. | +| timestamp_absolute | int64 | ms | The absolute timestamp based on the given workload. | +| host_name | binary | string | The name of the host. | +| cluster_name | binary | string | The name of the cluster that this host is part of. | +| cpu_count | int32 | count | The number of cores in this host. | +| mem_capacity | int64 | Mb | The amount of available memory. | +| tasks_terminated | int32 | count | The number of tasks that are in a terminated state. | +| tasks_running | int32 | count | The number of tasks that are in a running state. | +| tasks_error | int32 | count | The number of tasks that are in an error state. | +| tasks_invalid | int32 | count | The number of tasks that are in an unknown state. | +| cpu_capacity | double | MHz | The total capacity of the CPUs in the host. | +| cpu_usage | double | MHz | The total CPU capacity provided to all tasks on this host. | +| cpu_demand | double | MHz | The total CPU capacity demanded by all tasks on this host. | +| cpu_utilization | double | ratio | The CPU utilization of the host. This is calculated by dividing the cpu_usage, by the cpu_capacity. | +| cpu_time_active | int64 | ms | The duration that a CPU was active in the host. | +| cpu_time_idle | int64 | ms | The duration that a CPU was idle in the host. | +| cpu_time_steal | int64 | ms | The duration that a vCPU wanted to run, but no capacity was available. | +| cpu_time_lost | int64 | ms | The duration of CPU time that was lost due to interference. | +| power_draw | double | Watt | The current power draw of the host. | +| energy_usage | double | Joule (Ws) | The total energy consumption of the host since last sample. | +| embodied_carbon | double | gram | The total embodied carbon emitted since the last sample. | +| uptime | int64 | ms | The uptime of the host since last sample. | +| downtime | int64 | ms | The downtime of the host since last sample. | +| boot_time | int64 | ms | The time a host got booted. | +| boot_time_absolute | int64 | ms | The absolute time a host got booted. | ### Power Source -The host output file, contains all metrics of related to the host run. +The power source output file, contains all metrics of related to the power sources. + +| Metric | DataType | Unit | Summary | +|--------------------|----------|------------|-------------------------------------------------------------------| +| timestamp | int64 | ms | Timestamp of the sample. | +| timestamp_absolute | int64 | ms | The absolute timestamp based on the given workload. | +| source_name | binary | string | The name of the power source. | +| cluster_name | binary | string | The name of the cluster that this power source is part of. | +| power_draw | double | Watt | The current power draw of the host. | +| energy_usage | double | Joule (Ws) | The total energy consumption of the host since last sample. | +| carbon_intensity | double | gCO2/kW | The amount of carbon that is emitted when using a unit of energy. | +| carbon_emission | double | gram | The amount of carbon emitted since the previous sample. | -| Metric | DataType | Unit | Summary | -|--------------------|----------|------------|------------------------------------------------------------------------------------------| -| timestamp | int64 | ms | Timestamp of the sample | -| absolute timestamp | int64 | ms | The absolute timestamp based on the given workload | -| hosts_connected | int | Count | The number of hosts connected to the power Source (WARNING: does not work at the moment) | -| power_draw | double | Watt | The current power draw of the host. | -| energy_usage | double | Joule (Ws) | The total energy consumption of the host since last sample. | -| carbon_intensity | double | gCO2/kW | The amount of carbon that is emitted when using a unit of energy | -| carbon_emission | double | gram | The amount of carbon emitted since the previous sample | +### Battery +The host output file, contains all metrics of related batteries. +| Metric | DataType | Unit | Summary | +|--------------------|----------|--------------|-------------------------------------------------------------------| +| timestamp | int64 | ms | Timestamp of the sample. | +| timestamp_absolute | int64 | ms | The absolute timestamp based on the given workload. | +| battery_name | binary | string | The name of the battery. | +| cluster_name | binary | string | The name of the cluster that this battery is part of. | +| power_draw | double | Watt | The current power draw of the host. | +| energy_usage | double | Joule (Ws) | The total energy consumption of the host since last sample. | +| carbon_intensity | double | gCO2/kW | The amount of carbon that is emitted when using a unit of energy. | +| embodied_carbon | double | gram | The total embodied carbon emitted since the last sample. | +| charge | double | Joule | The current charge of the battery. | +| capacity | double | Joule | The total capacity of the battery. | +| battery_state | String | BatteryState | The current state of the battery. | ### Service The service output file, contains metrics providing an overview of the performance. -| Metric | DataType | Unit | Summary | -|--------------------|----------|-------|------------------------------------------------------------------------| -| timestamp | int64 | ms | Timestamp of the sample | -| absolute timestamp | int64 | ms | The absolute timestamp based on the given workload | -| hosts_up | int32 | count | The number of hosts that are up at this instant. | -| hosts_down | int32 | count | The number of hosts that are down at this instant. | -| tasks_total | int32 | count | The number of servers that are currently active. | -| tasks_pending | int32 | count | The number of servers that are pending to be scheduled. | -| tasks_active | int32 | count | The number of servers that are currently active. | -| tasks_terminated | int32 | count | The number of servers that are currently active. | -| tasks_completed | int32 | count | The number of servers that are currently active. | -| attempts_success | int32 | count | The scheduling attempts that were successful. | -| attempts_failure | int32 | count | The scheduling attempts that were unsuccessful due to client error. | +| Metric | DataType | Unit | Summary | +|--------------------|----------|-------|-------------------------------------------------------| +| timestamp | int64 | ms | Timestamp of the sample | +| timestamp_absolute | int64 | ms | The absolute timestamp based on the given workload | +| hosts_up | int32 | count | The number of hosts that are up at this instant. | +| hosts_down | int32 | count | The number of hosts that are down at this instant. | +| tasks_total | int32 | count | The number of tasks seen by the service. | +| tasks_pending | int32 | count | The number of tasks that are pending to be scheduled. | +| tasks_active | int32 | count | The number of tasks that are currently active. | +| tasks_terminated | int32 | count | The number of tasks that were terminated. | +| tasks_completed | int32 | count | The number of tasks that finished successfully | diff --git a/site/docs/getting-started/1-first-experiment.md b/site/docs/getting-started/1-first-experiment.md deleted file mode 100644 index 9c84c435..00000000 --- a/site/docs/getting-started/1-first-experiment.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -description: Designing a simple experiment ---- - -# First Experiment -Now that you have downloaded OpenDC, we will start creating a simple experiment. -In this experiment we will compare the performance of a small, and a big data center on the same workload. - -
-Expand this - -This is content -
- -:::tip Answer -
-Expand for the Answer -
-::: - -:::info Learning goal -During this tutorial, we will learn how to create and execute a simple experiment in OpenDC. -::: - -## Designing a Data Center - -The first requirement to run an experiment in OpenDC is a **topology**. -A **topology** defines the hardware on which a **workload** is executed. -Larger topologies will be capable of running more workloads, and will often quicker. - -A **topology** is defined using a JSON file. A **topology** contains one or more _clusters_. -_clusters_ are groups of _hosts_ on a specific location. Each cluster consists of one or more _hosts_. -A _host_ is a machine on which one or more tasks can be executed. _hosts_ are composed of a _cpu_ and a _memory_ unit. - -### Simple Data Center -in this experiment, we are comparing two data centers. Below is an example of the small **topology** file: - -```json -{ - "clusters": - [ - { - "name": "C01", - "hosts" : - [ - { - "name": "H01", - "cpu": - { - "coreCount": 12, - "coreSpeed": 3300 - }, - "memory": { - "memorySize": 140457600000 - } - } - ] - } - ] -} -``` - -This **topology** consist of a single _cluster_, with a single _host_. - -:::tip -To use this **topology** in experiment copy the content to a new JSON file, or download it [here](documents/topologies/small.json "download") -::: - -### Simple Data Center -in this experiment, we are comparing two data centers. Below is an example of the bigger **topology** file: - -```json -{ - "clusters": - [ - { - "name": "C01", - "hosts" : - [ - { - "name": "H01", - "cpu": - { - "coreCount": 32, - "coreSpeed": 3200 - }, - "memory": { - "memorySize": 256000 - } - } - ] - }, - { - "name": "C02", - "hosts" : - [ - { - "name": "H02", - "count": 6, - "cpu": - { - "coreCount": 8, - "coreSpeed": 2930 - }, - "memory": { - "memorySize": 64000 - } - } - ] - }, - { - "name": "C03", - "hosts" : - [ - { - "name": "H03", - "count": 2, - "cpu": - { - "coreCount": 16, - "coreSpeed": 3200 - }, - "memory": { - "memorySize": 128000 - } - } - ] - } - ] -} -``` - -Compared to the small topology, the big topology consist of three clusters, all consisting of a single host. - -:::tip -To use this **topology** in experiment copy the content to a new JSON file, or download it [here](documents/topologies/big.json "download") -::: - -:::info -For more in depth information about Topologies, see [Topology](../documentation/Input/Topology) -::: - -## Workloads - -Next to the topology, we need a workload to simulate on the data center. -In OpenDC, workloads are defined as a bag of tasks. Each task is accompanied by one or more fragments. -These fragments define the computational requirements of the task over time. -For this experiment, we will use the bitbrains-small workload. This is a small workload of 50 tasks, -spanning over a bit more than a month time. You can download the workload [here](documents/workloads/bitbrains-small.zip "download") - -:::info -For more in depth information about Workloads, see [Workload](../documentation/Input/Workload) -::: - -## Executing an experiment - -To run an experiment, we need to create an **experiment** file. This is a JSON file, that defines what should be executed -by OpenDC, and how. Below is an example of a simple **experiment** file: - -```json -{ - "name": "simple", - "topologies": [{ - "pathToFile": "topologies/small.json" - }, - { - "pathToFile": "topologies/big.json" - }], - "workloads": [{ - "pathToFile": "traces/bitbrains-small", - "type": "ComputeWorkload" - }] -} -``` - -In this **experiment**, three things are defined. First, is the `name`. This defines how the experiment is called -in the output folder. Second, is the `topologies`. This defines where OpenDC can find the topology files. -Finally, the `workloads`. This defines which workload OpenDC should run. You can download the experiment file [here](documents/experiments/simple_experiment.json "download") - -As you can see, `topologies` defines two topologies. In this case OpenDC will run two simulations, one with the small -topology, and one with the big topology. - -:::info -For more in depth information about Experiments, see [Experiment](../documentation/Input/Experiment) -::: - -## Running OpenDC -At this point, we should have all components to run an experiment. To make sure every file can be used by OpenDC, -please create an experiment folder such as the one shown below: -``` -── {simulation-folder-name} 📁 🔧 - ├── topologies 📁 🔒 - │ └── small.json 📄 🔧 - │ └── big.json 📄 🔧 - ├── experiments 📁 🔒 - │ └── simple_experiment.json 📄 🔧 - ├── workloads 📁 🔒 - │ └── bitbrains-small 📁 🔒 - │ └── fragments.parquet 📄 🔧 - │ └── tasks.parquet 📄 🔧 - ├── OpenDCExperimentRunner 📁 🔒 - │ └── lib 📁 🔒 - │ └── bin 📁 🔒 - ├── output 📁 🔒 -``` - -Executing the experiment can be done directly from the terminal. -Execute the following code from the terminal in simulation-folder-name - -``` -$ ./OpenDCExperimentRunner/bin/OpenDCExperimentRunner.sh --experiment-path "experiments/simple_experiment.json" -``` diff --git a/site/docs/getting-started/1-start-using-intellij.md b/site/docs/getting-started/1-start-using-intellij.md new file mode 100644 index 00000000..6aec91f1 --- /dev/null +++ b/site/docs/getting-started/1-start-using-intellij.md @@ -0,0 +1,172 @@ + + +# In this How-To we explain how you setup IntelliJ IDEA + +First of all you can download IntelliJ here: https://lp.jetbrains.com/intellij-idea-promo/ + +# Basic steps + +``` +git clone git@github.com:atlarge-research/opendc +``` + +Check if you have a compatible java version available. Make sure to have one of these versions available: [21] + +If not install a supported version! + +On a MAC + +``` +/usr/libexec/java_home -V +``` + +On Debian + +``` +update-alternatives --list java +``` + +On Redhat/Centos + +``` +yum list installed | grep java +``` + + +Open the project in IntelliJ + +![Intellij Open Project](img/intellij_open_project.png) + +Now fix the settings so that you use the correct java version. (In the example the java version is set to "21") +Navigation path in the settings pannel: "Build, Execution, Deployment" -> "Build Tools" -> "Gradle" + +![Intellij Settings](img/intellij_settings.png) + +Now navigate in the file menu to and open the file: "gradle"/"libs.versions.toml" + +Make sure the java version is set to the same version as previously cofigured in the settings. + +![Intellij Libs Versions Toml](img/intellij_libs_versions_toml.png) + + +Now open the Gradle panel on the right-hand side of the editor (1) and hit the refresh button at the top of the panel (2). + +![Intellij Gradle Panel](img/intellij_gradle_panel.png) + + +# Setup your first experiment and run it from source + + +Create a directory where you are going to put the files for your first experiment. + +File structure: + +![Experiment File Structure](img/experiment_file_structure.png) + +You can download the example workload trace (bitbrains-small-9d2e576e6684ddc57c767a6161e66963.zip) [here](https://atlarge-research.github.io/opendc/assets/files/bitbrains-small-9d2e576e6684ddc57c767a6161e66963.zip) + +Now unzip the trace. + +The content of "topology.json" + +``` +{ + "clusters": + [ + { + "name": "C01", + "hosts" : + [ + { + "name": "H01", + "cpu": + { + "coreCount": 32, + "coreSpeed": 3200 + }, + "memory": { + "memorySize": 256000 + } + } + ] + }, + { + "name": "C02", + "hosts" : + [ + { + "name": "H02", + "count": 6, + "cpu": + { + "coreCount": 8, + "coreSpeed": 2930 + }, + "memory": { + "memorySize": 64000 + } + } + ] + }, + { + "name": "C03", + "hosts" : + [ + { + "name": "H03", + "count": 2, + "cpu": + { + "coreCount": 16, + "coreSpeed": 3200 + }, + "memory": { + "memorySize": 128000 + } + } + ] + } + ] +} +``` + +The content of "experiment.json" + +The paths in the "experiment.json" file are relative to the "working directory" which is configured next. + + +``` +{ + "name": "simple", + "topologies": [{ + "pathToFile": "topology.json" + }], + "workloads": [{ + "pathToFile": "bitbrains-small", + "type": "ComputeWorkload" + }] +} +``` + +In the project file structure on the left open the following file: + +"opendc-experiments"/"opendc-experiments-base"/"src"/"main"/"kotlin"/"org.opendc.experiment.base"/"runner"/"ExperimentCLi.kt" + +![Intellij Experimentcli](img/Intellij_experimentcli.png) + +Now open the "Run/Debug" configuration (top right). + +![Intellij Open Run Config](img/intellij_open_run_config.png) + +We need to edit two settings: + +"Program arguments": --experiment-path experiment.json + +"Working Directory": a path where you have put the experiment files + +![Intellij Edit The Run Config](img/intellij_edit_the_run_config.png) + +Now you can click "Run" and start your first experiment. + +In the working directory a "output" direcotry is created with the results of the experiment. + diff --git a/site/docs/getting-started/2-first-experiment.md b/site/docs/getting-started/2-first-experiment.md new file mode 100644 index 00000000..79fd6424 --- /dev/null +++ b/site/docs/getting-started/2-first-experiment.md @@ -0,0 +1,211 @@ +--- +description: Designing a simple experiment +--- + +# First Experiment +Now that you have downloaded OpenDC, we will start creating a simple experiment. +In this experiment we will compare the performance of a small, and a big data center on the same workload. + + +[//]: # (:::tip Answer) + +[//]: # (
) + +[//]: # (Expand for the Answer) + +[//]: # (
) + +[//]: # (:::) + +:::info Learning goal +During this tutorial, we will learn how to create and execute a simple experiment in OpenDC. +::: + +## Designing a Data Center + +The first requirement to run an experiment in OpenDC is a **topology**. +A **topology** defines the hardware on which a **workload** is executed. +Larger topologies will be capable of running more workloads, and will often quicker. + +A **topology** is defined using a JSON file. A **topology** contains one or more _clusters_. +_clusters_ are groups of _hosts_ on a specific location. Each cluster consists of one or more _hosts_. +A _host_ is a machine on which one or more tasks can be executed. _hosts_ are composed of a _cpu_ and a _memory_ unit. + +### Simple Data Center +in this experiment, we are comparing two data centers. Below is an example of the small **topology** file: + +```json +{ + "clusters": + [ + { + "name": "C01", + "hosts" : + [ + { + "name": "H01", + "cpu": + { + "coreCount": 12, + "coreSpeed": 3300 + }, + "memory": { + "memorySize": 140457600000 + } + } + ] + } + ] +} +``` + +This **topology** consist of a single _cluster_, with a single _host_. + +:::tip +To use this **topology** in experiment copy the content to a new JSON file, or download it [here](documents/topologies/small.json "download") +::: + +### Simple Data Center +in this experiment, we are comparing two data centers. Below is an example of the bigger **topology** file: + +```json +{ + "clusters": + [ + { + "name": "C01", + "hosts" : + [ + { + "name": "H01", + "cpu": + { + "coreCount": 32, + "coreSpeed": 3200 + }, + "memory": { + "memorySize": 256000 + } + } + ] + }, + { + "name": "C02", + "hosts" : + [ + { + "name": "H02", + "count": 6, + "cpu": + { + "coreCount": 8, + "coreSpeed": 2930 + }, + "memory": { + "memorySize": 64000 + } + } + ] + }, + { + "name": "C03", + "hosts" : + [ + { + "name": "H03", + "count": 2, + "cpu": + { + "coreCount": 16, + "coreSpeed": 3200 + }, + "memory": { + "memorySize": 128000 + } + } + ] + } + ] +} +``` + +Compared to the small topology, the big topology consist of three clusters, all consisting of a single host. + +:::tip +To use this **topology** in experiment copy the content to a new JSON file, or download it [here](documents/topologies/big.json "download") +::: + +:::info +For more in depth information about Topologies, see [Topology](../documentation/Input/Topology) +::: + +## Workloads + +Next to the topology, we need a workload to simulate on the data center. +In OpenDC, workloads are defined as a bag of tasks. Each task is accompanied by one or more fragments. +These fragments define the computational requirements of the task over time. +For this experiment, we will use the bitbrains-small workload. This is a small workload of 50 tasks, +spanning over a bit more than a month time. You can download the workload [here](documents/workloads/bitbrains-small.zip "download") + +:::info +For more in depth information about Workloads, see [Workload](../documentation/Input/Workload.md) +::: + +## Executing an experiment + +To run an experiment, we need to create an **experiment** file. This is a JSON file, that defines what should be executed +by OpenDC, and how. Below is an example of a simple **experiment** file: + +```json +{ + "name": "simple", + "topologies": [{ + "pathToFile": "topologies/small.json" + }, + { + "pathToFile": "topologies/big.json" + }], + "workloads": [{ + "pathToFile": "traces/bitbrains-small", + "type": "ComputeWorkload" + }] +} +``` + +In this **experiment**, three things are defined. First, is the `name`. This defines how the experiment is called +in the output folder. Second, is the `topologies`. This defines where OpenDC can find the topology files. +Finally, the `workloads`. This defines which workload OpenDC should run. You can download the experiment file [here](documents/experiments/simple_experiment.json "download") + +As you can see, `topologies` defines two topologies. In this case OpenDC will run two simulations, one with the small +topology, and one with the big topology. + +:::info +For more in depth information about Experiments, see [Experiment](../documentation/Input/Experiment) +::: + +## Running OpenDC +At this point, we should have all components to run an experiment. To make sure every file can be used by OpenDC, +please create an experiment folder such as the one shown below: +``` +── {simulation-folder-name} 📁 🔧 + ├── topologies 📁 🔒 + │ └── small.json 📄 🔧 + │ └── big.json 📄 🔧 + ├── experiments 📁 🔒 + │ └── simple_experiment.json 📄 🔧 + ├── workloads 📁 🔒 + │ └── bitbrains-small 📁 🔒 + │ └── fragments.parquet 📄 🔧 + │ └── tasks.parquet 📄 🔧 + ├── OpenDCExperimentRunner 📁 🔒 + │ └── lib 📁 🔒 + │ └── bin 📁 🔒 + ├── output 📁 🔒 +``` + +Executing the experiment can be done directly from the terminal. +Execute the following code from the terminal in simulation-folder-name + +``` +$ ./OpenDCExperimentRunner/bin/OpenDCExperimentRunner.sh --experiment-path "experiments/simple_experiment.json" +``` diff --git a/site/docs/getting-started/3-whats-next.md b/site/docs/getting-started/3-whats-next.md index 03737629..b7598022 100644 --- a/site/docs/getting-started/3-whats-next.md +++ b/site/docs/getting-started/3-whats-next.md @@ -9,4 +9,4 @@ Congratulations! You have just learned how to design and experiment with a (virt - Follow one of the [tutorials](/docs/category/tutorials) using OpenDC. - Read about [existing work using OpenDC](/community/research). - Get involved in the [OpenDC Community](/community/support). -- If you are interested in contributing to OpenDC you can find a How-To here [4-start-using-intellij](4-start-using-intellij.md), please also read https://github.com/atlarge-research/opendc/blob/master/CONTRIBUTING.md. +- If you are interested in contributing to OpenDC you can find a How-To here [4-start-using-intellij](1-start-using-intellij.md), please also read https://github.com/atlarge-research/opendc/blob/master/CONTRIBUTING.md. diff --git a/site/docs/getting-started/4-start-using-intellij.md b/site/docs/getting-started/4-start-using-intellij.md deleted file mode 100644 index 6aec91f1..00000000 --- a/site/docs/getting-started/4-start-using-intellij.md +++ /dev/null @@ -1,172 +0,0 @@ - - -# In this How-To we explain how you setup IntelliJ IDEA - -First of all you can download IntelliJ here: https://lp.jetbrains.com/intellij-idea-promo/ - -# Basic steps - -``` -git clone git@github.com:atlarge-research/opendc -``` - -Check if you have a compatible java version available. Make sure to have one of these versions available: [21] - -If not install a supported version! - -On a MAC - -``` -/usr/libexec/java_home -V -``` - -On Debian - -``` -update-alternatives --list java -``` - -On Redhat/Centos - -``` -yum list installed | grep java -``` - - -Open the project in IntelliJ - -![Intellij Open Project](img/intellij_open_project.png) - -Now fix the settings so that you use the correct java version. (In the example the java version is set to "21") -Navigation path in the settings pannel: "Build, Execution, Deployment" -> "Build Tools" -> "Gradle" - -![Intellij Settings](img/intellij_settings.png) - -Now navigate in the file menu to and open the file: "gradle"/"libs.versions.toml" - -Make sure the java version is set to the same version as previously cofigured in the settings. - -![Intellij Libs Versions Toml](img/intellij_libs_versions_toml.png) - - -Now open the Gradle panel on the right-hand side of the editor (1) and hit the refresh button at the top of the panel (2). - -![Intellij Gradle Panel](img/intellij_gradle_panel.png) - - -# Setup your first experiment and run it from source - - -Create a directory where you are going to put the files for your first experiment. - -File structure: - -![Experiment File Structure](img/experiment_file_structure.png) - -You can download the example workload trace (bitbrains-small-9d2e576e6684ddc57c767a6161e66963.zip) [here](https://atlarge-research.github.io/opendc/assets/files/bitbrains-small-9d2e576e6684ddc57c767a6161e66963.zip) - -Now unzip the trace. - -The content of "topology.json" - -``` -{ - "clusters": - [ - { - "name": "C01", - "hosts" : - [ - { - "name": "H01", - "cpu": - { - "coreCount": 32, - "coreSpeed": 3200 - }, - "memory": { - "memorySize": 256000 - } - } - ] - }, - { - "name": "C02", - "hosts" : - [ - { - "name": "H02", - "count": 6, - "cpu": - { - "coreCount": 8, - "coreSpeed": 2930 - }, - "memory": { - "memorySize": 64000 - } - } - ] - }, - { - "name": "C03", - "hosts" : - [ - { - "name": "H03", - "count": 2, - "cpu": - { - "coreCount": 16, - "coreSpeed": 3200 - }, - "memory": { - "memorySize": 128000 - } - } - ] - } - ] -} -``` - -The content of "experiment.json" - -The paths in the "experiment.json" file are relative to the "working directory" which is configured next. - - -``` -{ - "name": "simple", - "topologies": [{ - "pathToFile": "topology.json" - }], - "workloads": [{ - "pathToFile": "bitbrains-small", - "type": "ComputeWorkload" - }] -} -``` - -In the project file structure on the left open the following file: - -"opendc-experiments"/"opendc-experiments-base"/"src"/"main"/"kotlin"/"org.opendc.experiment.base"/"runner"/"ExperimentCLi.kt" - -![Intellij Experimentcli](img/Intellij_experimentcli.png) - -Now open the "Run/Debug" configuration (top right). - -![Intellij Open Run Config](img/intellij_open_run_config.png) - -We need to edit two settings: - -"Program arguments": --experiment-path experiment.json - -"Working Directory": a path where you have put the experiment files - -![Intellij Edit The Run Config](img/intellij_edit_the_run_config.png) - -Now you can click "Run" and start your first experiment. - -In the working directory a "output" direcotry is created with the results of the experiment. - diff --git a/site/static/img/failureModels.png b/site/static/img/failureModels.png new file mode 100644 index 00000000..5ad3a85b Binary files /dev/null and b/site/static/img/failureModels.png differ -- cgit v1.2.3