Skip to content

Documentation for iowarp(#968) CLIO-S3 benchmark - #22

Open
eDoggo3779 wants to merge 3 commits into
iowarp:mainfrom
eDoggo3779:docs/968-s3-gcs-cloud-storage
Open

eDoggo3779 wants to merge 3 commits into
iowarp:mainfrom
eDoggo3779:docs/968-s3-gcs-cloud-storage

Conversation

@eDoggo3779

@eDoggo3779 eDoggo3779 commented Oct 8, 2026 •

Copy link
Copy Markdown

Summary

Documents the configuration surface added by iowarp/clio-core#1093 (CLIO-S3 benchmark, merge commit 183ab948): S3/GCS cloud block devices and CTE storage tiers, the CAE S3 importer, and a new client env var.

Changes

  • New page: sdk/context-assimilation-engine/s3.md. The CAE S3 connector, laid out like the Globus page:
    • build flags (CAE_ENABLE_S3, spack +s3_cae, renamed from +s3)
    • credential and region resolution order
    • MinIO / S3_ENDPOINT
    • OMNI usage
    • the cae_s3_tool helper
    • error codes and troubleshooting
  • deployment/configuration.md
    • bdev_type now lists s3, gcs, hbm, pinned and noop, and the bdev compose example gains commented-out S3/GCS entries.
    • Storage Tiers: cloud path / bdev_type, an S3 tier in the YAML example, and two cautions (always use a key prefix; credentials come only from the runtime's environment).
    • New complete example: RAM + Amazon S3 tier.
    • New env-var section, "Cloud object stores (S3 / GCS)", listing every AWS_* / S3_* / GCS_* variable and which component reads it.
    • Adds CLIO_STRICT_RESPONSE_IDENTITY.
  • deployment/hpc-cluster.md: cloud credential variables table.
  • CAE overview.md / omni.md:
    • s3:// and gs:// in the factory table and the OMNI examples
    • the new AssimilationCtx fields s3_region / s3_profile
    • CAE_ENABLE_S3 / CAE_ENABLE_GCS build options
  • context-runtime/.../bdev.md: kS3 / kGcs backends, the pool_name format, and when to use a cloud backend.
  • context-transfer-engine/cte.md: the storage-type list named dev_dax and posix, which the config parser has never accepted. It now matches the validator (core_config.cc) and its test (test_cte_config_errors.cc): file, ram, hbm, pinned, noop, s3, gcs.

Notes

  • context-runtime/config/clio_default.yaml in clio-core is not updated, so the "Shipped Default" copy in these docs is left unchanged to keep the two identical.
  • The unmerged clio-fs-durability-docs branch edits the same configuration.md tables, so whichever of the two merges second may hit conflicts.
  • The site builds (npm run build) with no broken links or anchors.

eDoggo3779 and others added 3 commits October 7, 2026 02:40
Covers the user-facing configuration surface of iowarp/clio-core#1093
(CLIO-S3 benchmark): the Poco+SigV4 S3 bdev, s3/gcs as CTE storage-tier
types, the CAE S3 importer's in-process credential resolution, the cloud
environment variables (AWS_*, S3_*, GCS_*), and CLIO_STRICT_RESPONSE_IDENTITY.
Adds a dedicated S3 connector page modelled on the Globus one, and fixes the
CTE storage-device-type list, which named types that do not exist.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Fold the s3/gcs compose examples into the existing clio_bdev block and
  drop the separate cloud-bdev section (behavior, bucket creation, build
  requirements); retarget its links.
- Describe hbm/pinned/noop in the bdev_type row.
- Drop the cloud-tier paragraph; keep the key-prefix caution.
- State why credentials are env-only in two places (CTE storage tiers,
  CAE S3 page) and remove the other repetitions.
- Revert the env-var prefix note; shorten CLIO_STRICT_RESPONSE_IDENTITY;
  remove the cloud-object-stores preamble.
- hpc-cluster: table instead of prose for cloud credentials.
- CAE overview/omni: cut factory internals and credential notes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@eDoggo3779
eDoggo3779 marked this pull request as ready for review October 8, 2026 03:40

This branch has not been deployed

No deployments
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