summaryrefslogtreecommitdiff
path: root/site/old_tutorials
diff options
context:
space:
mode:
authorDante Niewenhuis <d.niewenhuis@hotmail.com>2024-11-05 18:41:50 +0100
committerGitHub <noreply@github.com>2024-11-05 18:41:50 +0100
commit15730a89974e10fb19e689c0379a7e761fba0c14 (patch)
treee84f19ce13358841ac14e7840d8c2bf823a72a51 /site/old_tutorials
parent0f835d57b0e989e25aa0b71fe374a0fb1a94e86f (diff)
Hiding all tutorials that are currently not working to reduce confusion (#263)
* Hidden all tutorials that are currently not working to reduce confusion * removed advanced guides from docusaurus * removed advanced guides from whats-next * removed advanced guides from support page
Diffstat (limited to 'site/old_tutorials')
-rw-r--r--site/old_tutorials/0-installation.md31
-rw-r--r--site/old_tutorials/1-design.mdx154
-rw-r--r--site/old_tutorials/2-experiment.mdx74
-rw-r--r--site/old_tutorials/3-whats-next.md12
-rw-r--r--site/old_tutorials/_category_.json8
5 files changed, 0 insertions, 279 deletions
diff --git a/site/old_tutorials/0-installation.md b/site/old_tutorials/0-installation.md
deleted file mode 100644
index 281e811f..00000000
--- a/site/old_tutorials/0-installation.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-description: How to install OpenDC locally, and start experimenting in no time.
----
-
-# Installation
-
-This page describes how to set up and configure a local single-user OpenDC installation so that you can quickly get your
-experiments running. You can also use the [hosted version of OpenDC](https://app.opendc.org) to get started even
-quicker (The web server is however missing some more complex features).
-
-
-## Prerequisites
-
-1. **Supported Platforms**
- OpenDC is actively tested on Windows, macOS and GNU/Linux.
-2. **Required Software**
- A Java installation of version 19 or higher is required for OpenDC. You may download the
- [Java distribution from Oracle](https://www.oracle.com/java/technologies/downloads/) or use the distribution provided
- by your package manager.
-
-## Download
-
-To get an OpenDC distribution, download a recent version from our [Releases](https://github.com/atlarge-research/opendc/releases) page on GitHub.
-For basic usage, the OpenDCExperimentRunner is all that is needed.
-
-## Setup
-
-Unpack the downloaded OpenDC distribution. Opening OpenDCExperimentRunner results in two folders, `bin` and `lib`.
-`lib` contains all `.jar` files needed to run OpenDC. `bin` two executable versions of the OpenDCExperimentRunner.
-In the following pages, we discuss how to run an experiment using the executables.
-
diff --git a/site/old_tutorials/1-design.mdx b/site/old_tutorials/1-design.mdx
deleted file mode 100644
index e8ab2c58..00000000
--- a/site/old_tutorials/1-design.mdx
+++ /dev/null
@@ -1,154 +0,0 @@
----
-description: How to design a virtual datacenter in OpenDC from scratch.
----
-
-# Design a Datacenter
-
-Now that you have installed OpenDC (or are using the hosted version), we will start designing a (virtual) datacenter
-in OpenDC.
-
-## Before we start
-
-There are a couple of steps we need to perform before we can start designing a datacenter in OpenDC. First, we need to
-enter the OpenDC web application. This done as follows:
-
-<div className="container">
- <div className="row">
- <div className="col col--6">
- <div className="card">
- <div className="card__body">
- <h4>Hosted Deployment</h4>
- <small>
- To enter the hosted version of OpenDC, you need a user account. User management is provided
- by <a href="https://auth0.com">Auth0</a>, which allows you to login with social accounts or via
- email.
- </small>
- </div>
- <div className="card__footer">
- <a href="https://app.opendc.org" className="button button--primary button--block">Login to OpenDC</a>
- </div>
- </div>
- </div>
- <div className="col col--6">
- <div className="card">
- <div className="card__body">
- <h4>Local Deployment</h4>
- <small>
- The local distribution of OpenDC runs in single-user mode by default, which does not require
- authentication. This allows you to quickly start designing and experimenting with new
- datacenters.
- </small>
- </div>
- <div className="card__footer">
- <a href="http://localhost:8080" className="button button--secondary button--block">Launch OpenDC (local)</a>
- </div>
- </div>
- </div>
- </div>
-</div>
-
-### Create a Project
-
-Next, we need to create a new project. Projects allow you to organize your designs and experiments together.
-Click on ‘+ New Project’ in the right corner to open the project creation dialog.
-Give your project a name and save it. You can now open it by clicking on it in the project table. If all went well,
-you’re redirected to your new project, and are presented with an empty project overview.
-
-### Create a Topology
-
-In OpenDC, the datacenter design is also called a **topology**. This topology represents the physical layout of a
-datacenter and specifies everything from the architectural layout of the datacenter’s rooms to which CPUs are in a
-particular machine.
-
-To create a design (topology), click on ‘+ New Topology’ in the top right corner of the topology table.
-Once you have created the topology, it will appear the topology table. By clicking on the topology, you will be
-redirected to a (still empty) overview of the topology. From here, we'll start designing a datacenter.
-
-### Terminology
-
-Here’s an overview of some of the language you’ll find when designing a datacenter in OpenDC:
-
-- **Topology**: the physical layout of your datacenter
-- **Room**: a room in the datacenter
-- **Tile**: one of the tiles that forms a room
-- **Rack**: a rack of servers that stands on top of a tile
-- **Machine**: a machine that takes up a single slot in a server rack, containing several components such as CPUs, GPUs,
- network interfaces and storage drives.
-
-## Build the datacenter
-
-Open the project and topology that you have created and click on the 'Floor Plan' tab (see [Figure 1](#floor-plan)).
-We’re now in datacenter construction mode. Notice the grid on the canvas? That’s where you’ll place tiles, in order to
-build rooms. Let’s take a moment to familiarize ourselves with the interface.
-
-If you dismiss the sidebar on your left, you have controls for zooming in and out. Next to the zooming buttons, you also
-have a ‘Screenshot’ button, in case you want to record the state of the canvas and export it to an image file. On the
-right side of the screen, you have the simHyperVisorContext menu. This menu changes depending on your zoom level.
-
-As there are currently no rooms, we are in ‘Building’ mode, and our only option is to ‘Construct a new room’. Click on
-that button to build a first datacenter room - once you’ve clicked on it, every tile of the canvas that you click on
-becomes a tile of that room. There is one restriction though: Each tile that you add must be adjacent to any previous
-tiles that you have added. You can see for yourself which tile positions are clickable through the highlight color that
-is shown on hovering over them.
-
-<figure className="figure" id="floor-plan">
- <img src={require("@site/src/components/HomepageFeatures/screenshot-construction.png").default} alt="Analysis of results reported by OpenDC" />
- <figcaption>The floor plan of a (virtual) datacenter in OpenDC.</figcaption>
-</figure>
-
-### Create a Room
-
-:::note Action
-
-Create at least a single room, with help of the above instructions.
-
-:::
-
-Once you’ve placed the tiles, you can give the room a name, if you want to. To do this, click on the room you want to
-edit. You’ll notice the application going into ‘Room’ mode, allowing you to manipulate the topology of the datacenter at
-a more fine-grained level. In the simHyperVisorContext menu, change the room name, and click on the ‘Save’ button. You can exit
-‘Room’ mode by clicking on any of the darkened areas outside of the selected room. This will bring you back to
-‘Building’ mode.
-
-### Place Server Racks
-
-:::note Action
-
-Add at least a single rack in the room.
-
-:::
-
-Empty rooms are of no use to the stakeholders of a datacenter. They want machines! Let’s place some racks in the room
-to fulfill this demand. Click on the room and add some racks. To stop adding racks, click on the blue element in the
-sidebar, again.
-
-### Fill the Racks with Servers
-
-:::note Action
-
-Add a couple of servers to the rack.
-
-:::
-
-To add actual servers to the empty racks, we’ll need to go one level deeper in the topological hierarchy of the
-datacenter. Clicking on a rack lets you do just that. Once you’ve clicked on it, you’ll notice the simHyperVisorContext menu now
-displaying slots. In each slot fits exactly one server unit. To add such a server unit, click on the ‘Add machine’
-button of that slot.
-Just like in ‘Room’ mode, you can exit ‘Rack’ mode by clicking on any of the darkened tiles around the currently
-selected rack.
-
-### Add Resources to the Servers
-
-We’re almost done creating our datacenter! The only problem we have is that the machines / servers we just added lack
-any real resources (such as CPUs, GPUs, memory cards, and disk storage).
-
-:::note Action
-
-Populate the machines with CPU and memory resources.
-
-:::
-
-To do this, click on any machine you want to edit. Notice the simHyperVisorContext menu changing, with tabs to add different kinds of
-units to your machine. Have a look around as to what can be added.
-
-Once you are satisfied with the datacenter design, we will experiment with the design in the next chapter.
diff --git a/site/old_tutorials/2-experiment.mdx b/site/old_tutorials/2-experiment.mdx
deleted file mode 100644
index 14970ea6..00000000
--- a/site/old_tutorials/2-experiment.mdx
+++ /dev/null
@@ -1,74 +0,0 @@
----
-description: How to experiment with your datacenter designs.
----
-
-# Create an Experiment
-
-After designing a datacenter in OpenDC, the next step is to experiment with the design using OpenDC's built-in
-simulator, in order to analyze its performance and compare it against other designs.
-
-In OpenDC, we use the concept of portfolios of scenarios to experiment with datacenter designs. In the next sections, we
-will explain how you can use these powerful concepts for the experimental analysis of your designs.
-
-## Create a Portfolio
-OpenDC organizes multiple scenarios (experiments) into a **portfolio**. Each portfolio is composed of a base scenario,
-a set of candidate scenarios given by the user and a set of targets (e.g., metrics) used to compare scenarios.
-
-To create a new portfolio, open a project in the OpenDC web interface and click on ‘+ New Portfolio’ in the top right
-corner of the portfolio table. This opens a modal with the following options:
-
-1. **Name**: the name of your portfolio.
-2. **Metrics**: the metrics that you want to use to compare the scenarios in the portfolio.
-3. **Repeats per Scenario**: the number of times each scenario should be simulated (to account for variance).
-
-## Create Scenarios
-
-A **scenario** represents a point in the datacenter design space that should be explored. It consists of a combination
-of workload, topology, and a set of operational phenomena. Phenomena can include correlated failures, performance
-variability, security breaches, etc., allowing the scenarios to more accurately capture the real-world operations.
-
-The baseline for comparison in a portfolio is the **base scenario**. It represents the status quo of the infrastructure
-or, when planning infrastructure from scratch, it consists of very simple base workloads and topologies.
-The other scenarios in a portfolio, called the **candidate scenarios**, represent changes to the configuration
-that might be of interest to the datacenter designer. Dividing scenarios into these two categories ensures that any
-comparative insights provided by OpenDC are meaningful within the simHyperVisorContext of the current architecture.
-
-To create a new scenario, open a portfolio in the OpenDC web interface and click on ‘+ New Scenario’ in the top right
-corner of the scenario table. This opens a modal with the following options (as shown in [Figure 1](#explore)):
-
-1. **Name**: the name of your scenario. The first scenario of a portfolio is always called the _Base scenario_.
-2. **Workload**: the applications (e.g., virtual machines, workflows, functions) that consume resources in your
- datacenter.
- 1. **Workload Trace**: A dataset that characterizes the historical runtime behavior of virtual machines in the
- workload over time.
- 2. **Load Sampling Fraction**: The percentage of the workload that should be simulated (e.g., 10% of virtual
- machines in the workload trace).
-3. **Environment**:
- 1. **Topology**: one of the topologies of the project to use for the scenario.
- 2. **Scheduler**: the algorithm that decides on which hosts the virtual machines should be placed.
-4. **Operational Phenomena**:
- 1. **Failures**: a flag to enable stochastic host failures during simulation.
- 2. **Performance interference**: a flag to enable performance interference between virtual machines (only available
- for a subset of traces).
-
-Once you have created the scenario, it will be enqueued for simulation. Usually the results of the simulation should be
-available within one minute after creation. However, if there are lots of queued simulation jobs, it might take a bit
-longer.
-
-<figure className="figure" id="explore">
- <img src={require("@site/src/components/HomepageFeatures/screenshot-explore.png").default} alt="Creating a new scenario in OpenDC" />
- <figcaption>Creating a new scenario in OpenDC. The user can select the topology, workload, and operational phenomena.</figcaption>
-</figure>
-
-## Analyze Results
-
-After creating scenarios, the scenario table will show whether the simulation is still pending, completed successfully,
-or failed for some reason. If the scenario was simulated successfully, its results will become visible on the ‘Results’
-tab as shown in [Figure 2](#analysis).
-
-<figure className="figure" id="analysis">
- <img src={require("@site/src/components/HomepageFeatures/screenshot-results.png").default} alt="Analysis of results reported by OpenDC" />
- <figcaption>Plots and visual summaries generated by OpenDC comparing different scenarios.</figcaption>
-</figure>
-
-This tab will show the selected metrics for the portfolio and allow you to compare their values for different scenarios.
diff --git a/site/old_tutorials/3-whats-next.md b/site/old_tutorials/3-whats-next.md
deleted file mode 100644
index 7c021119..00000000
--- a/site/old_tutorials/3-whats-next.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-description: How to supercharge your designs and experiments with OpenDC.
----
-
-# What's next?
-
-Congratulations! You have just learned how to design and experiment with a (virtual) datacenter in OpenDC. What's next?
-
-- Follow one of the [tutorials](/docs/category/tutorials) using OpenDC.
-- Check the [advanced guides](/docs/category/advanced-guides) for more complex material.
-- Read about [existing work using OpenDC](/community/research).
-- Get involved in the [OpenDC Community](/community/support).
diff --git a/site/old_tutorials/_category_.json b/site/old_tutorials/_category_.json
deleted file mode 100644
index 169f7a27..00000000
--- a/site/old_tutorials/_category_.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "label": "Getting Started",
- "position": 2,
- "link": {
- "type": "generated-index",
- "description": "10 minutes to learn the most important concepts of OpenDC."
- }
-}