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.

Sign up for GitHub

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

ENG-1480 Add SSD To System Requirements #317

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ENG-1480 Add SSD To System Requirements #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions umh.docs.umh.app/content/en/docs/getstarted/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ installing your first instance and connecting to an OPC UA simulator in no time.
</div>

- ARM-based systems, such as a Raspberry Pi, are not currently supported.
- An SSD is required, as the UMH’s data buffering process is I/O intensive, particularly with Kafka. For production environments, we recommend dedicating a separate SSD for the UMH rather than sharing it with other VMs, to ensure optimal read/write performance and avoid bottlenecks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Improve formatting for better readability

The current content is presented as a single paragraph. Consider using Markdown formatting to improve readability:

  • Use bold text for key terms
  • Break into multiple paragraphs
  • Use bullet points for recommendations
-An SSD is required, as the UMH's data buffering process is I/O intensive, particularly with Kafka. For production environments, we recommend dedicating a separate SSD for the UMH rather than sharing it with other VMs, to ensure optimal read/write performance and avoid bottlenecks.
+**Storage Requirement**: An SSD (Solid State Drive) is required.
+
+**Reason**: The UMH's data buffering process, particularly with **Kafka**, is I/O intensive.
+
+**Production Environment Recommendations**:
+- Dedicate a separate SSD for UMH
+- Avoid sharing with other VMs
+- Ensures optimal read/write performance
+- Prevents potential I/O bottlenecks
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- An SSD is required, as the UMH’s data buffering process is I/O intensive, particularly with Kafka. For production environments, we recommend dedicating a separate SSD for the UMH rather than sharing it with other VMs, to ensure optimal read/write performance and avoid bottlenecks.
**Storage Requirement**: An SSD (Solid State Drive) is required.
**Reason**: The UMH's data buffering process, particularly with **Kafka**, is I/O intensive.
**Production Environment Recommendations**:
- Dedicate a separate SSD for UMH
- Avoid sharing with other VMs
- Ensures optimal read/write performance
- Prevents potential I/O bottlenecks

🧹 Nitpick (assertive)

Enhance SSD requirements with specific details

While the addition of SSD requirements is valuable, consider providing more specific details to help users make informed decisions:

  1. Minimum SSD specifications:
    • Recommended capacity
    • Minimum read/write speeds
    • Recommended SSD types (NVMe vs SATA)
  2. Different requirements for:
    • Development/testing environments
    • Production environments
  3. Estimated storage needs based on typical usage patterns

Consider restructuring the content like this:

-An SSD is required, as the UMH's data buffering process is I/O intensive, particularly with Kafka. For production environments, we recommend dedicating a separate SSD for the UMH rather than sharing it with other VMs, to ensure optimal read/write performance and avoid bottlenecks.
+An SSD is required due to I/O intensive operations:
+
+- **Development/Testing**: Minimum 256GB SSD with 2000MB/s read/write speeds
+- **Production**: Dedicated SSD recommended
+  - Minimum 512GB NVMe SSD
+  - 3000MB/s+ read/write speeds
+  - Not shared with other VMs to prevent I/O bottlenecks
+
+This requirement is primarily driven by Kafka's data buffering process, which requires consistent and fast storage performance.

Committable suggestion skipped: line range outside the PR's diff.


### Operating System

Expand Down