Skip to content

doc(play/aws-disk-bench): add AWS disk benchmark on Kube#15

Merged
mtulio merged 4 commits intodevelfrom
doc-play-ocp-aws-disk-bench
Jun 7, 2025
Merged

doc(play/aws-disk-bench): add AWS disk benchmark on Kube#15
mtulio merged 4 commits intodevelfrom
doc-play-ocp-aws-disk-bench

Conversation

@mtulio
Copy link
Owner

@mtulio mtulio commented Aug 17, 2022

Document steps to benchmark AWS EBS volumes on OCP.

@vercel
Copy link

vercel bot commented Aug 17, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
labs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 7, 2025 5:42am
mtuliolabs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 7, 2025 5:42am

This comment was marked as outdated.

@mtulio mtulio marked this pull request as ready for review June 7, 2025 05:10
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds a new guide to benchmark AWS disks on OpenShift by updating the site navigation and introducing a detailed playbook.

  • Registers “Benchmark AWS disks on OCP” in the MkDocs navigation.
  • Adds ocp-aws-disk-benchmark.md with steps to create MachineConfigs/MachineSets and run FIO tests.
  • Covers benchmarking for ephemeral, gp2, gp3, io1, and io2 disk types.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
mkdocs.yml Added nav entry for the AWS disk benchmark guide
docs/playbooks/openshift/ocp-aws-disk-benchmark.md New playbook with setup and FIO benchmarking workflow
Comments suppressed due to low confidence (2)

docs/playbooks/openshift/ocp-aws-disk-benchmark.md:1

  • The title only mentions ephemeral disks but the guide covers gp2, gp3, io1, and io2 as well. Consider updating it to reflect all tested disk types, e.g., "OCP on AWS - Benchmarking Ephemeral and EBS Disk Types".
# OCP on AWS - Using Instance Disks for Ephemeral Storage

docs/playbooks/openshift/ocp-aws-disk-benchmark.md:212

  • This sets m6id.xlarge for the ephemeral test, but earlier you recommended c6id.xlarge as an example. Ensure the instance type is intentional or align with the documented example.
export INSTANCE_TYPE="m6id.xlarge"

Comment on lines +273 to +279
oc get node -l disk_type=ephemeral -w
```

Make sure the device has been mounted correctly to the mount path `/var/lib/containers`:

```bash
oc debug node/$(oc get nodes -l disk_type=${disk_type} -o jsonpath='{.items[0].metadata.name}') -- chroot /host /bin/bash -c "df -h /var/lib/containers"
Copy link

Copilot AI Jun 7, 2025

Choose a reason for hiding this comment

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

[nitpick] You mix DISK_TYPE (uppercase) and disk_type (lowercase) environment variables. It’s clearer to use one consistent naming convention for the label and variable throughout.

Suggested change
oc get node -l disk_type=ephemeral -w
```
Make sure the device has been mounted correctly to the mount path `/var/lib/containers`:
```bash
oc debug node/$(oc get nodes -l disk_type=${disk_type} -o jsonpath='{.items[0].metadata.name}') -- chroot /host /bin/bash -c "df -h /var/lib/containers"
oc get node -l DISK_TYPE=ephemeral -w

Make sure the device has been mounted correctly to the mount path /var/lib/containers:

oc debug node/$(oc get nodes -l DISK_TYPE=${DISK_TYPE} -o jsonpath='{.items[0].metadata.name}') -- chroot /host /bin/bash -c "df -h /var/lib/containers"

Copilot uses AI. Check for mistakes.
Copy link
Owner Author

Choose a reason for hiding this comment

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

incorrect suggestion

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@mtulio mtulio merged commit 2f86d14 into devel Jun 7, 2025
8 checks passed
@mtulio mtulio deleted the doc-play-ocp-aws-disk-bench branch June 7, 2025 05:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant