From 1deb1bd3af13ce900c4e571d9ecc2bdd4cc3f1e2 Mon Sep 17 00:00:00 2001 From: Mahendra Paipuri Date: Fri, 6 Dec 2024 13:46:24 +0100 Subject: [PATCH] docs: Embed demo Grafana in iframe in documentation welcome page * Add link to demo instance in main docs Signed-off-by: Mahendra Paipuri --- README.md | 18 +++++++++++++----- website/cspell.json | 5 ++++- website/docusaurus.config.ts | 9 +++++++++ website/src/pages/index.tsx | 8 +++++++- 4 files changed, 33 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5dca0153..d025e975 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Installation instructions of CEEMS components can be found in ## Demo -

+

Access Demo

@@ -64,10 +64,10 @@ consumption is estimated by assuming a Thermal Design Power (TDP) value and curr usage of the instance. Several dashboards have been created in Grafana for visualizing metrics which are listed below. -- [Overall usage of cluster](http://195.220.87.159:30000/d/adrenju36n2tcb/cluster-status?orgId=1&from=now-24h&to=now&var-job=openstack&var-host=$__all&var-provider=rte&var-country_code=FR&refresh=15m) -- [Usage of different Projects/Accounts by SLURM and Openstack](http://195.220.87.159:30000/d/cdreu45pp9erkd/user-and-project-stats?orgId=1&from=now-90d&to=now&refresh=15m) -- [Usage of Openstack resources by a given user and project](http://195.220.87.159:30000/d/be5x3it7gpx4wf/openstack-instance-summary?orgId=1&from=now-90d&to=now&var-user=gazoo&var-account=cornerstone&refresh=15m) -- [Usage of SLURM resources by a given user and project](http://195.220.87.159:30000/d/fdsm8aom8hqf4fewfwe3123dascdsc/slurm-job-summary?orgId=1&from=now-90d&to=now&var-user=wilma&var-account=bedrock&refresh=15m) +- [Overall usage of cluster](https://ceems-demo.myaddr.tools/d/adrenju36n2tcb/cluster-status?orgId=1&from=now-24h&to=now&var-job=openstack&var-host=$__all&var-provider=rte&var-country_code=FR&refresh=15m) +- [Usage of different Projects/Accounts by SLURM and Openstack](https://ceems-demo.myaddr.tools/d/cdreu45pp9erkd/user-and-project-stats?orgId=1&from=now-90d&to=now&refresh=15m) +- [Usage of Openstack resources by a given user and project](https://ceems-demo.myaddr.tools/d/be5x3it7gpx4wf/openstack-instance-summary?orgId=1&from=now-90d&to=now&var-user=gazoo&var-account=cornerstone&refresh=15m) +- [Usage of SLURM resources by a given user and project](https://ceems-demo.myaddr.tools/d/fdsm8aom8hqf4fewfwe3123dascdsc/slurm-job-summary?orgId=1&from=now-90d&to=now&var-user=wilma&var-account=bedrock&refresh=15m) > [!WARNING] > All the dashboards provided in the demo instance are only meant to be for demonstrative @@ -104,6 +104,8 @@ screenshots of dashboards. ## Talks and Demos +- [Paper submitted to SC24 in Sustainable Computing Workshop](https://conferences.computer.org/sc-wpub/pdfs/SC-W2024-6oZmigAQfgJ1GhPL0yE3pS/555400b862/555400b862.pdf) +- [CEEMS at SC 2024](https://docs.google.com/presentation/d/1XBhfiHdTbNrS6e_I9mPy_BLPFEiAkmIwgp6FvSdMbLM/edit#slide=id.g317b4bf7fbe_2_54) - [An Introduction to CEEMS at ISC 2024](https://drive.google.com/file/d/1kUbD3GgDKwzgIuxjrTY95YJN5aSuIejQ/view?usp=drive_link) - [CEEMS Architecture and Usage](https://docs.google.com/presentation/d/1xNQTCsmPUz37KDb2BLrpWExuQWxk49NpVN9VDbxSe6Y/edit#slide=id.p) @@ -115,3 +117,9 @@ workloads. Please feel free to open issues and/or discussions for any potential ideas of improvement. + +## Acknowledgements + +The demo instance has been deployed on the [CROCC](https://drocc.fr/crocc/) +which was kindly sponsored by [ISDM MESO](https://isdm.umontpellier.fr/mesolr/) +in Montpellier, France. diff --git a/website/cspell.json b/website/cspell.json index e8d702f1..ef228ebe 100644 --- a/website/cspell.json +++ b/website/cspell.json @@ -56,7 +56,10 @@ "blkio", "tsbd", "gpuuuid", - "Pyroscope" + "Pyroscope", + "CROCC", + "ISDM", + "MESO" ], // flagWords - list of words to be always considered incorrect // This is useful for offensive words and common spelling errors. diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index c8da2d3b..77f5562a 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -103,6 +103,11 @@ const config: Config = { label: "Documentation", }, { to: "/api", label: "API", position: "left" }, + { + href: `https://ceems-demo.myaddr.tools`, + label: "Demo", + position: "right", + }, { href: `https://github.com/${organizationName}/${projectName}`, label: "GitHub", @@ -151,6 +156,10 @@ const config: Config = { { title: "More", items: [ + { + label: "Demo", + href: `https://ceems-demo.myaddr.tools`, + }, { label: "GitHub", href: `https://github.com/${organizationName}/${projectName}`, diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index f8a53b43..012f125f 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -22,7 +22,13 @@ function HomepageHeader() {

- Preview +
+ + Demo + +
+

+ );