Update S3 configuration format in README

[CodeAdminDe]

Fix: CRD spec requires an object to configure filer.s3.

Error: The Seaweed "seaweed-sample" is invalid: spec.filer.s3: Invalid value: "boolean": spec.filer.s3 in body must be of type object: "boolean"

I stumbled across it while testing and thought a quick patch wouldn't hurt. :-)

Summary by CodeRabbit

• Documentation
  • Updated S3 configuration format in documentation from a boolean value to a nested mapping structure with an explicit enabled field. Users should review configuration examples to ensure compliance with the new S3 API structure under filer configuration.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The CRD example in README.md is updated, restructuring the S3 configuration from a boolean value to a nested object with an explicit enabled field. This changes the expected structure for S3 API configuration under the filer section.

Changes

Cohort / File(s)	Summary
Documentation configuration example README.md	Updated S3 configuration structure from inline boolean (s3: true) to nested mapping (s3: { enabled: true }) in the CRD example, requiring explicit enabled field for S3 API under filer configuration

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single file change with straightforward structural modification in documentation example
• No logic, parsing, or validation code changes required for review
• Minimal impact scope limited to README.md

Poem

🐰 A boolean hops, but structure's the key,
Nested maps reveal what's there to see,
S3 enabled, explicit and clear,
Docs dance forward, year after year!
🎉✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and clearly describes the main change: updating the S3 configuration format in the README from a boolean to an object structure.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a7ef90 and 31caa2a.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

205-206: S3 configuration correctly updated to match CRD schema across all files.

The change from s3: true to the nested object structure s3: { enabled: true } directly resolves the validation error and aligns with the CRD's expected schema. The added comment improves clarity for users. Sample files in config/samples/ have been consistently updated across all occurrences (seaweed.yaml, seaweed_topology.yaml, seaweed_tree_topology.yaml, migration_example.yaml, and seaweed_with_iam_embedded.yaml), ensuring documentation and examples remain aligned.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @CodeAdminDe, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves an issue in the README.md where the example S3 configuration for the Filer was incorrect, leading to CRD validation errors. The update modifies the filer.s3 entry from a simple boolean to an object with an enabled: true field, ensuring the documentation provides a valid and functional configuration snippet.

Highlights

• S3 Configuration Fix: Updated the S3 configuration example in README.md to correctly reflect the required object type for filer.s3.
• CRD Compliance: The change addresses a validation error where the CRD spec for filer.s3 expects an object, not a boolean, by changing s3: true to s3: enabled: true.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request correctly updates the S3 configuration format in the README.md example. The change from a boolean to an object for filer.s3 aligns the documentation with the CRD specification, fixing the error described. This is a valuable clarification for users. I've added one minor suggestion to further improve the comment's clarity regarding the relationship between S3 and IAM.

[gemini-code-assist]

To improve clarity, you could enhance the comment to mention that enabling S3 also enables IAM by default. This would align the example more closely with other sample files like config/samples/seaweed_v1_seaweed_with_iam_embedded.yaml and provide more context to users. While this makes the iam: true on the next line appear redundant, it's a good clarification to add here.

Suggested change

	enabled: true # Enable S3 API
	enabled: true # Enable S3 API (enables embedded IAM by default)