Skip to content

align samples with v1alpha1 design and system limits#99

Merged
rytswd merged 1 commit intomainfrom
samples
Jan 5, 2026
Merged

align samples with v1alpha1 design and system limits#99
rytswd merged 1 commit intomainfrom
samples

Conversation

@fernando-villalba
Copy link
Collaborator

This commit completely refactors the config/samples directory to reflect the final v1alpha1 API design and current Multigres system capabilities.

Changes:

  • Removed Outdated Artifacts: Deleted sample.yaml, reference.yaml, and the child-resources/ directory. These contained obsolete patterns (like unmanaged child resources) that do not align with the Operator's "Single Source of Truth" architecture.
  • Added Functional Scenarios:
    • minimal.yaml: Demonstrates the "Ultra-Minimalist" use case relying on webhooks/namespace defaults.
    • template-defaults.yaml: A production-ready example using the Template system.
    • no-templates.yaml: A example using full inline specifications.
    • external_etcd.yaml: Demonstrates Brownfield/External Etcd integration and mixed cell topology (shared vs. isolated).
  • Added Template Samples: Created config/samples/templates/ with core.yaml, cell.yaml, and shard.yaml to support the template-based examples.

Constraints Applied:
All new samples strictly adhere to the current Multigres routing limitation by configuring only the System Database (postgres) and the Default TableGroup (default). This ensures that users applying these samples get a fully functional, routable cluster out of the box.

This commit completely refactors the `config/samples` directory to reflect the
final v1alpha1 API design and current Multigres system capabilities.

**Changes:**
* **Removed Outdated Artifacts:** Deleted `sample.yaml`, `reference.yaml`, and the `child-resources/` directory. These contained obsolete patterns (like unmanaged child resources) that do not align with the Operator's "Single Source of Truth" architecture.
* **Added Functional Scenarios:**
    * `minimal.yaml`: Demonstrates the "Ultra-Minimalist" use case relying on webhooks/namespace defaults.
    * `template-defaults.yaml`: A production-ready example using the Template system.
    * `no-templates.yaml`: A example using full inline specifications.
    * `external_etcd.yaml`: Demonstrates Brownfield/External Etcd integration and mixed cell topology (shared vs. isolated).
* **Added Template Samples:** Created `config/samples/templates/` with `core.yaml`, `cell.yaml`, and `shard.yaml` to support the template-based examples.

**Constraints Applied:**
All new samples strictly adhere to the current Multigres routing limitation by configuring only the System Database (`postgres`) and the Default TableGroup (`default`). This ensures that users applying these samples get a fully functional, routable cluster out of the box.
@github-actions
Copy link

github-actions bot commented Jan 2, 2026

🔬 Go Test Coverage Report

Summary

Coverage Type Result
Threshold 0%
Previous Test Coverage Unknown%
New Test Coverage 0.0%

Status

✅ PASS

Detail

Show New Coverage
total:	(statements)	0.0%

Copy link
Member

@rytswd rytswd left a comment

Choose a reason for hiding this comment

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

This removed the child resources which were useful to test resource-handlers. I'll approve this for now, but will reinstate those resources for e2e testing scenarios in a different directory.

@rytswd rytswd merged commit 18db56f into main Jan 5, 2026
3 checks passed
@rytswd rytswd deleted the samples branch January 5, 2026 01:05
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.

2 participants