Report for Reference Setup, Performance, Scalability, and Sizing Guid…

…elines

longhorn-2598

Signed-off-by: Phan Le <phan.le@suse.com>

examples/reference-setup-performance-scalability-and-sizing-guidelines/README.md

@@ -0,0 +1,14 @@
+# Reference Setup, Performance, Scalability, and Sizing Guidelines
+
+In this document, we present the reference setup, performance, scalability, and sizing guidelines when using the Longhorn storage system. 
+In practice, users deploy Longhorn in a vast array of different cluster specifications, making it impossible for us to test all potential setups. 
+Therefore, we will select and test some typical environments for users' reference. 
+By providing these references, users can gain insight into how Longhorn would perform in a similar cluster specification.
+
+## Public Cloud 
+1. [Medium Node Spec](./public-cloud/medium-node-spec.md)
+1. [Big Node Spec](./public-cloud/big-node-spec.md)
+
+## On-Prem 
+1. [Medium Node Spec](./on-prem/medium-node-spec.md)
+1. [Big Node Spec](./on-prem/big-node-spec.md)

examples/reference-setup-performance-scalability-and-sizing-guidelines/public-cloud/medium-node-spec.md

@@ -0,0 +1,49 @@
+# Reference Setup, Performance, Scalability, and Sizing Guidelines: Public Cloud - Medium Node Spec
+
+## Cluster Spec:
+Node spec:
+* EC2 instance type: ec2 m5.2xlarge
+* 8vCPUs, 32GB RAM
+* Root disk
+  * Size 50GB 
+  * Type EBS gp3
+* OS: Ubuntu 22.04 LTS
+* Kernel version: TODO
+
+Network:
+* Network bandwidth: up to 10 Gbits/sec
+* Network latency: ~0.3ms RTT via ping command
+
+Disk spec:
+* We are using dedicated disk for Longhorn volumes' replicas on the nodes:
+  * 1TB block storage on each node.
+  * EC2 EBS gp3 with IOPS set to 6000 and throughput set to 250MiB/s
+
+Kubernetes spec:
+* Kubernetes Version: v1.27.8+rke2r1
+* CNI plugin: Calico
+* Control plane nodes are seperated from worker nodes
+
+Longhorn config:
+* Longhorn version: v1.6.0
+* Settings:
+  * Using dedicated disk for Longhorn instead of root disk
+  * Storage Minimal Available Percentage setting: 10%
+  * Storage Over Provisioning Percentage setting: 150%
+
+## Workload design
+
+
+> Note: The workload is designed in a way that it will be balance accross the nodes.
+> Also Longhorn replicas will be balance a accross the nodes.
+> This setup optimize efficiency of the cluster and Longhorn system. 
+
+
+### Case 1: 1 control plane node + 3 worker nodes
+
+
+### Volume max size
+
+### Backup/Restore speed with AWS S3
+
+