Adding DEMO UI app to the docs site (#21)

* add demo ui app to the docs

* minor changes

Author: zseta

docs/source/conf.py

@@ -44,7 +44,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "ScyllaDB 1M ops/sec benchmark demo"
+project = "ScyllaDB DEMOs"
 copyright = str(date.today().year) + ", ScyllaDB. All rights reserved."
 author = u"ScyllaDB Project Contributors"
 

docs/source/demo-ui.md

@@ -0,0 +1,51 @@
+# DEMO UI: ScyllaDB in different cloud environments
+
+<p><iframe width="560" height="315" src="https://www.youtube.com/embed/-nPO9KeNydM?si=wkCRK5ZJ0cfz9h4u" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></p>
+
+Currently supported DEMOs:
+* ScyllaDB Cloud 1 million operations/second (AWS and ScyllaDB Cloud account needed)
+* ScyllaDB Enterprise 1 million operations/second (AWS account needed)
+* Scaling from 3 to 6 nodes (AWS account needed)
+
+
+## Prerequisites
+* [AWS CLI](https://aws.amazon.com/cli/)
+* [Docker](https://docker.com)
+* [ScyllaDB Cloud API key](https://cloud.scylladb.com/)
+
+## Usage
+1. Clone the repository
+    ```
+    git clone https://github.com/scylladb/1m-ops-demo.git
+    cd 1m-ops-demo/
+    ```
+1. Make sure AWS CLI is configured properly, and know the location of the credentials file (e.g. `~/.aws/credentials`)
+1. Edit `config.py`
+    ```json
+    {
+        "aws_creds_file": "/home/user/.aws/credentials",
+        "region": "us-east-1",
+        "scylla_cloud_token": "API-TOKEN",
+        "running_in_docker": true
+    }
+    ```
+    * `aws_creds_file`: the location (absolute path) of your AWS credentials file
+    * `region`: AWS region you want to use for the demo
+    * `scylla_cloud_token`: You can generate an API token in ScyllaDB Cloud
+    * `running_in_docker`: Normally this should be `true`
+1. Run the web app (by default, it uses port 5000)
+    ```bash
+    ./build_and_run.sh 
+    ```
+    This will spin up a Docker container and run the web app on the `5000` port. You can stop the container with `docker stop scylla-demo`
+1. Open DEMO UI application
+    
+    Go to http://0.0.0.0:5000
+1. Select a demo you want to try (this will run `terraform init` under the hood)
+    ![demo ui](_static/img/demo_ui.jpg)
+1. (Optional) Configure cluster size and workload settings on the left side
+    ![demo ui workload](_static/img/demo_ui2.jpg)
+1. Hit `APPLY` (this runs `terraform apply`)
+1. Keep an eye on the console output to see when Terraform finishes
+1. Click on the different dashboard tabs to monitor the cluster.
+1. If you are done, don't forget to run `DESTROY` to remove infrastructure elements and avoid unnecessary costs.

docs/source/getting-started-enterprise.md

@@ -1,4 +1,4 @@
-# Get started
+# Get started with ScyllaDB Enterprise on AWS
 
 Follow along this video to get started:
 

docs/source/getting-started.md

@@ -1,4 +1,4 @@
-# Get started
+# Get started with ScyllaDB Cloud
 
 Follow along this video to get started:
 

docs/source/index.rst

@@ -6,17 +6,17 @@
 :hide-pre-content:
 :hide-post-content:
 
-.. title:: 1 million ops/sec Terraform demo
+.. title:: ScyllaDB DEMO toolkit
 
 .. hero-box::
-  :title: 1 million ops/sec ScyllaDB demos with Terraform
+  :title: Automation tools for ScyllaDB DEMO and PoC projects
   :image: /_static/img/mascots-2/cloud.svg
   :button_icon: icon-github
   :button_style: bold
   :button_url: https://github.com/scylladb/1m-ops-demo
-  :button_text: Source code
+  :button_text: GitHub
 
-  Test and benchmark ScyllaDB under a 1 million operations per second workload.
+  Test and benchmark ScyllaDB under custom workloads in different cloud environments using our Terraform and Ansible templates
 
 .. raw:: html
 
@@ -29,7 +29,16 @@
   <div class="grid-x grid-margin-x">
 
 .. topic-box::
-  :title: ScyllaDB Cloud 1M ops/sec
+  :title: DEMO UI: ScyllaDB in different cloud environments 
+  :link: demo-ui
+  :icon: icon-rocket
+  :class: large-4
+  :anchor: Get started
+
+  Try our web app and launch ScyllaDB clusters and workloads in different cloud environments.
+
+.. topic-box::
+  :title: Terraform: ScyllaDB Cloud 1M ops/sec
   :link: getting-started
   :icon: icon-cloud
   :class: large-4
@@ -38,7 +47,7 @@
   Set up 1 million operations/second demo with ScyllaDB Cloud
 
 .. topic-box::
-  :title: ScyllaDB Enterprise 1M ops/sec
+  :title: Terraform: ScyllaDB Enterprise 1M ops/sec
   :link: getting-started-enterprise
   :icon: icon-instance
   :class: large-4
@@ -47,13 +56,13 @@
   Set up 1 million operations/second demo with ScyllaDB Enterprise
 
 .. topic-box::
-  :title: Set Up Your Own 1M OPS Benchmark - blog
+  :title: Blog: Set Up Your Own 1M OPS Benchmark
   :icon: icon-edit
   :link: https://www.scylladb.com/2023/11/29/set-up-your-own-1m-ops-benchmark-with-scylladb-cloud-terraform
   :class: large-4,small-12
   :anchor: Read the article
 
-  To learn more details about the instance types and scripts used for the Cloud version read our blog post.
+  To learn more about the instance types and scripts used for the ScyllaDB Cloud 1M ops/sec Terraform project.
 
 .. raw:: html
 
@@ -62,7 +71,8 @@
 .. toctree::
    :maxdepth: 3
    :hidden:
-
+  
+   DEMO UI <demo-ui>
    Getting started with Cloud <getting-started>
    Getting started with Enterprise <getting-started-enterprise>
    Blogpost - Set Up Your Own 1M OPS Benchmark <https://www.scylladb.com/2023/11/29/set-up-your-own-1m-ops-benchmark-with-scylladb-cloud-terraform/>