Skip to content

docs: add compute brokers/marketplaces guidance and README audience update#19

Merged
theFong merged 2 commits intomainfrom
devin/1754708839-compute-brokers-docs
Aug 9, 2025
Merged

docs: add compute brokers/marketplaces guidance and README audience update#19
theFong merged 2 commits intomainfrom
devin/1754708839-compute-brokers-docs

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Aug 9, 2025

docs: add compute brokers/marketplaces guidance and README audience update

Summary

Added documentation for compute brokers, marketplaces, and multi-cloud aggregators.

  • docs/how-to-add-a-provider.md: New section "Compute Brokers & Marketplaces (Aggregators)" explaining how aggregators can use Location, SubLocation, and CloudProviderID to distinguish upstream compute, and recommending expressing cross-vendor differences via InstanceType attributes (including the existing "provider" attribute).
  • README.md: Updated "Who This Is For" to explicitly include compute brokers/marketplaces with a concise bullet.

Links

Notes

  • Lint passed; CI is green.
  • Docs-only changes; no code changes.

…pdate

Co-Authored-By: Alec Fong <alecsanf@usc.edu>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

README.md Outdated
- **NVIDIA Cloud Partners (NCPs)** looking to offer Brev-compatible GPU compute
- **Infra teams** building cluster-aware systems or abstractions on raw compute
- **Cloud providers** interested in contributing to a shared interface for accelerated compute
- **Compute brokers & marketplaces (aggregators)** offering multi-cloud compute; use `Location`, `SubLocation`, and `CloudProviderID` to differentiate upstream sources behind a consistent interface
Copy link
Member

Choose a reason for hiding this comment

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

we dont need to go into implementation detail here i like just "Compute brokers & marketplaces (aggregators) offering multi-cloud compute". Lets remove other stuff in this file that we added

- Provider (CloudProviderID): Identify your aggregator (e.g., "mybroker"). If you expose underlying vendors, include that metadata on the returned resources (e.g., via tags/labels) or encode it in stable IDs that you control.
- Location and SubLocation: Map upstream regions/zones into `Location` and `SubLocation` so users can choose placement consistently across sources. For example, use `Location="us-west"` and `SubLocation="vendorA/zone-2"` or `SubLocation="sv15/DC3"` for finer placement.
- InstanceType IDs: If upstream vendors don’t provide stable, cross-market IDs, generate stable IDs using `MakeGenericInstanceTypeID` and include upstream hints in IDs or metadata. Ensure stability over time to avoid breaking consumers.
- Capabilities: Only advertise features that your aggregator reliably supports across upstream vendors (e.g., Create/Terminate/Reboot). Omit capabilities (ModifyFirewall, Stop/Start, ResizeVolume, MachineImage, Tags) if they are not uniformly supported.
Copy link
Member

Choose a reason for hiding this comment

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

Actually the capabilities represent all the features the broker could support. Instead we can use instance type attributes to delineate behavior. there even is a "provider" attribute on the instance type that you can use.

- InstanceType IDs: If upstream vendors don’t provide stable, cross-market IDs, generate stable IDs using `MakeGenericInstanceTypeID` and include upstream hints in IDs or metadata. Ensure stability over time to avoid breaking consumers.
- Capabilities: Only advertise features that your aggregator reliably supports across upstream vendors (e.g., Create/Terminate/Reboot). Omit capabilities (ModifyFirewall, Stop/Start, ResizeVolume, MachineImage, Tags) if they are not uniformly supported.

Minimal pattern:
Copy link
Member

Choose a reason for hiding this comment

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

lets remove the following sections theres no need.

…utes and simplify README bullet

Co-Authored-By: Alec Fong <alecsanf@usc.edu>
@devin-ai-integration
Copy link
Contributor Author

Addressed feedback:\n- Removed capability-restriction guidance for brokers; clarified that capabilities reflect what the broker can support, and to express differences via InstanceType attributes (including the 'provider' attribute).\n- Removed the minimal pattern/example/design notes from the aggregator section.\n- Simplified README bullet to a concise audience line for brokers/marketplaces.\n\nCI is green. Please let me know if you'd like any additional tweaks.

@theFong theFong merged commit d0964c8 into main Aug 9, 2025
4 checks passed
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