Reference
Cua Fleets objects, REST operations, SDK methods and Terraform schema.
Cua Fleets objects, REST operations, SDK methods and Terraform schema.
Everything Cua Fleets exposes, by object: the REST resources behind the Fleet API, the SDK Fleet handle, and the trycua/fleets Terraform provider.
| Task | Object | Description |
|---|---|---|
| Keep capacity | Pool | Warm capacity: how many sandboxes of one template Fleet keeps ready to claim. |
| Keep capacity | Template | What each sandbox of a pool runs: image, runtime, size, services and probes. |
| Use a sandbox | Claim | A lease on one sandbox from a pool, until it is released or expires. |
| Use a sandbox | Sandbox | One running machine of a pool, bound to at most one claim. |
| Use a sandbox | Secret | Secrets the SDK writes in a pool's namespace: a claim's env token and registry pull credentials. |
| Use a sandbox | Service URL | HTTP and WebSocket access to a sandbox's services, and shareable signed URLs. |
| Build images | Image | A build recipe Fleet turns into a runnable image, and its build status. |
| Account | Namespace | The account-owned scope every pool, template, claim and secret lives in. |
| Account | API key | OAuth client credentials that act for your user, for the SDK, CLI and Terraform. |
| Configure | Terraform provider | Provider settings and the resources it manages. |
| Debug | Errors | HTTP statuses and SDK errors, with causes and fixes. |
https://run.cua.ai (CUA_FLEET_BASE_URL overrides it for the SDK).Authorization: Bearer <token>. Exchange an API key for a token with the OAuth client-credentials grant at https://auth.cua.ai/realms/cyclops-cs/protocol/openid-connect/token.CUA_CLIENT_ID and CUA_CLIENT_SECRET, a cua auth login session, or FLEETS_TOKEN.osgym.cua.ai/v1alpha1) under /api/k8s/apis/osgym.cua.ai/v1alpha1/namespaces/{namespace}/. Images are images.cua.ai/v1alpha1.-, at most 63 characters.{"items": [...]}. Updates are JSON merge patches (Content-Type: application/merge-patch+json).{"error": "<message>"}.| Object | REST | SDK | Terraform |
|---|---|---|---|
| Pool | Create pool, List pools, Get pool, Update pool, Delete pool | Fleet.apply_pool, Fleet.apply, Fleet.get_pool, Fleet.list_pools, Fleet.set_pool_replicas, Fleet.wait_pool_ready, Fleet.export_pool, Fleet.delete_pool, Fleet.ephemeral_pool_name, Fleet.pools | fleets_pool |
| Template | Create template, List templates, Get template, Update template, Delete template | Fleet.apply_pool_template, Fleet.check_pool_spec, Fleet.list_templates | fleets_pool |
| Claim | Create claim, List claims, Get claim, Renew claim, Delete claim | Fleet.acquire, Fleet.acquire_with, Fleet.claim, Fleet.attach_claim, Fleet.list_claims, Fleet.keep_alive, Fleet.release | none |
| Sandbox | none | Fleet.attach_claim, Fleet.service_url | none |
| Secret | none | none | none |
| Service URL | Call a service, Create a signed URL, List signed URLs, Revoke a signed URL | Fleet.service_url, Fleet.create_signed_service_url | none |
| Image | Create image, List images, Get image, Delete image, Presign image uploads | Fleet.create_image, Fleet.list_images, Fleet.get_image, Fleet.delete_image | none |
| Namespace | Create a namespace, List namespaces, Get a namespace, Delete a namespace | none | none |
| API key | Create an API key, List API keys, Revoke an API key | none | none |