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

spdk: add Notice for Disk #746

Merged
merged 2 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
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
38 changes: 1 addition & 37 deletions content/docs/1.5.0/spdk/_index.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,4 @@
---
title: V2 Data Engine (Preview Feature)
weight: 3
weight: 0
---

## Platform Support

Currently, V2 Data Engine only supports `x86_64` platform.

## Feature Support

- Volume lifecycle (creation, attachment, detachment and deletion)
- Degraded volume
- Offline replica rebuilding
- Block disk management
- Orphaned replica management

In addition to the features mentioned above, additional functionalities such as replica number adjustment, online replica rebuilding, snapshot, backup, restore and so on will be introduced in future versions.

## Prerequisites

- x86-64 CPU with SSE4.2 instruction support

- Required linux kernel modules
- uio
- uio_pci_generic
- nvme-tcp

- HugePage support
- 1 GiB of 2 MiB-sized pages

## Notice

### CPU

When the V2 Data Engine is enabled, each instance-manager pod utilizes **1 CPU core**. This high CPU usage is attributed to the `spdk_tgt` process running within each instance-manager pod. The spdk_tgt process is responsible for handling input/output (IO) operations and requires intensive polling. As a result, it consumes 100% of a dedicated CPU core to efficiently manage and process the IO requests, ensuring optimal performance and responsiveness for storage operations.

### Memory

SPDK utilizes huge pages to enhance performance and minimize memory overhead. To enable the usage of huge pages, it is necessary to configure 2MiB-sized huge pages on each Longhorn node. Specifically, **512 pages (equivalent to a total of 1 GiB)** need to be available on each Longhorn node.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Automatic Offline Replica Rebuilding
weight: 2
weight: 4
---

## Introduction
Expand Down
13 changes: 13 additions & 0 deletions content/docs/1.5.0/spdk/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Features
weight: 1
---

- Volume lifecycle (creation, attachment, detachment and deletion)
- Degraded volume
- Offline replica rebuilding
- Block disk management
- Orphaned replica management

In addition to the features mentioned above, additional functionalities such as replica number adjustment, online replica rebuilding, snapshot, backup, restore and so on will be introduced in future versions.

2 changes: 1 addition & 1 deletion content/docs/1.5.0/spdk/performance-benchmark.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Performance Benchmark
weight: 3
weight: 5
---

## Environment
Expand Down
33 changes: 33 additions & 0 deletions content/docs/1.5.0/spdk/prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Prerequisites
weight: 2
---

## Prerequisites

- x86-64 CPU with SSE4.2 instruction support
> NOTICE
> Currently, V2 Data Engine only supports `x86_64` platform.

- Required linux kernel modules
- uio
- uio_pci_generic
- nvme-tcp

- HugePage support
- 1 GiB of 2 MiB-sized pages

## Notice

### CPU

When the V2 Data Engine is enabled, each instance-manager pod utilizes **1 CPU core**. This high CPU usage is attributed to the `spdk_tgt` process running within each instance-manager pod. The spdk_tgt process is responsible for handling input/output (IO) operations and requires intensive polling. As a result, it consumes 100% of a dedicated CPU core to efficiently manage and process the IO requests, ensuring optimal performance and responsiveness for storage operations.

### Memory

SPDK utilizes huge pages to enhance performance and minimize memory overhead. To enable the usage of huge pages, it is necessary to configure 2MiB-sized huge pages on each Longhorn node. Specifically, **512 pages (equivalent to a total of 1 GiB)** need to be available on each Longhorn node.


### Disk

**Local NVMe disks** are highly recommended for optimal storage performance of volumes using V2 Data Engine.
2 changes: 1 addition & 1 deletion content/docs/1.5.0/spdk/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quick Start
weight: 1
weight: 3
---

**Table of Contents**
Expand Down