Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix readme for cs4.0 #425

Merged
merged 2 commits into from
Mar 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# CloudSuite 4.0 #

**This branch is WIP and contains the upcoming release of CloudSuite v4.0. If you are looking for CloudSuite 3, please checkout the [CSv3][CSv3] branch.**
**This branch contains the release of CloudSuite v4.0. If you are looking for CloudSuite 3, please checkout the [CSv3][CSv3] branch.**

[CloudSuite][csp] is a benchmark suite for cloud services. The fourth release consists of ten applications that have
been selected based on their popularity in today's datacenters. The benchmarks are based on real-world software
stacks and represent real-world setups. In v4.0, we have added multi-architecture support to Cloudsuite, so that the
workloads can be run on processors using x86, ARM, and RISC-V architectures.
[CloudSuite][csp] is a benchmark suite for cloud services. The fourth release consists of eight first-party applications that have been selected based on their popularity in today's datacenters. The benchmarks are based on real-world software stacks and represent real-world setups.

CloudSuite 4.0 includes a thorough software stack update and bug fixes for all workloads. It also includes support for all workloads on ARM to follow the rising trend of the ARM server market. It also features detailed guidelines for tuning and running the workloads in representative states, facilitating ease of use.

# How to Run #

Expand All @@ -20,6 +19,9 @@ For more details on how to run the workloads, please follow each workload's docu
- [Web Search](docs/benchmarks/web-search.md)
- [Web Serving](docs/benchmarks/web-serving.md)

To ease the deployment of CloudSuite into private and public cloud systems, we provide docker images for all CloudSuite benchmarks
(available [here][csb]).

# Workload Status #
To see which workloads are currently functioning on the new architectures, you can find the status matrix [here][status_pg].

Expand All @@ -29,19 +31,12 @@ CloudSuite's software components are all available as open-source software. All
their own licensing terms. Researchers interested in using CloudSuite are required to fully understand and abide by the
licensing terms of the various components. For more information, please refer to the [license page][csl].

# Deploying CloudSuite #

To ease the deployment of CloudSuite into private and public cloud systems, we provide docker images for all CloudSuite benchmarks
(available [here][csb]). We are also integrating CloudSuite into Google's [PerfKit Benchmarker][pkb]. PerfKit helps at automating the process of
benchmarking across existing cloud-server systems.

# Support #

We encourage CloudSuite users to use GitHub issues for requests for enhancements, questions or bug fixes.
We encourage CloudSuite users to use GitHub issues to request for enhancements, questions or bug fixes.

[csp]: http://cloudsuite.ch "CloudSuite Page"
[csl]: http://cloudsuite.ch/pages/license/ "CloudSuite License"
[csb]: http://cloudsuite.ch/#download "CloudSuite Benchmarks"
[pkb]: https://github.com/GoogleCloudPlatform/PerfKitBenchmarker "Google's PerfKit Benchmarker"
[CSv3]: https://github.com/parsa-epfl/cloudsuite/tree/CSv3 "CloudSuite v3"
[status_pg]: https://github.com/parsa-epfl/cloudsuite/wiki/CloudSuite-4.0-Workload-Status-Matrix