Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 4.32.0
- Package version: 4.33.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

Expand Down Expand Up @@ -105,6 +105,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**create_job_deployment_deployments_job_post**](docs/EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
*EXTERNALApi* | [**create_new_organization_organizations_post**](docs/EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
*EXTERNALApi* | [**create_service_account_service_accounts_post**](docs/EXTERNALApi.md#create_service_account_service_accounts_post) | **POST** /service-accounts | Create Service Account
*EXTERNALApi* | [**create_unified_deployment_deployments_post**](docs/EXTERNALApi.md#create_unified_deployment_deployments_post) | **POST** /deployments | Create Unified Deployment
*EXTERNALApi* | [**create_volume_endpoint_volumes_post**](docs/EXTERNALApi.md#create_volume_endpoint_volumes_post) | **POST** /volumes | Create Volume Endpoint
*EXTERNALApi* | [**delete_cluster_clusters_cluster_id_delete**](docs/EXTERNALApi.md#delete_cluster_clusters_cluster_id_delete) | **DELETE** /clusters/{cluster_id} | Delete Cluster
*EXTERNALApi* | [**delete_hardware_instance_hardware_instances_hardware_instance_id_delete**](docs/EXTERNALApi.md#delete_hardware_instance_hardware_instances_hardware_instance_id_delete) | **DELETE** /hardware-instances/{hardware_instance_id} | Delete Hardware Instance
Expand Down Expand Up @@ -289,11 +290,19 @@ Class | Method | HTTP request | Description
- [Spire](docs/Spire.md)
- [SpireCrds](docs/SpireCrds.md)
- [TeleportKubeAgent](docs/TeleportKubeAgent.md)
- [UnifiedWriteComputeDeploymentRequest](docs/UnifiedWriteComputeDeploymentRequest.md)
- [UnifiedWriteDeploymentRequest](docs/UnifiedWriteDeploymentRequest.md)
- [UnifiedWriteDeploymentResponse](docs/UnifiedWriteDeploymentResponse.md)
- [UnifiedWriteDynamoDeploymentRequest](docs/UnifiedWriteDynamoDeploymentRequest.md)
- [UnifiedWriteInferenceV3DeploymentRequest](docs/UnifiedWriteInferenceV3DeploymentRequest.md)
- [UnifiedWriteJobDeploymentRequest](docs/UnifiedWriteJobDeploymentRequest.md)
- [UpdateClusterMetadataRequest](docs/UpdateClusterMetadataRequest.md)
- [UpdateDeploymentResponse](docs/UpdateDeploymentResponse.md)
- [UpdateDeploymentStatusV3Request](docs/UpdateDeploymentStatusV3Request.md)
- [UpdateServiceAccountRequest](docs/UpdateServiceAccountRequest.md)
- [UpsertUserVaultItemRequest](docs/UpsertUserVaultItemRequest.md)
- [UsageAvailability](docs/UsageAvailability.md)
- [UsageComponent](docs/UsageComponent.md)
- [UserVaultItem](docs/UserVaultItem.md)
- [UserVaultType](docs/UserVaultType.md)
- [ValidationError](docs/ValidationError.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/ClusterCredential.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server** | **str** | |
**bearer_token** | **str** | |
**ca_cert** | **str** | |
**ca_cert** | **str** | Base64-encoded PEM CA certificate of the cluster's API server, as in a kubeconfig's `certificate-authority-data` or the `ca.crt` key of a service-account token Secret's `data`. |

## Example

Expand Down
3 changes: 3 additions & 0 deletions docs/CreateCServeV3DeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,19 @@ Name | Type | Description | Notes
**chart_revision** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**priority** | **str** | | [optional]
**hf_token_ref** | **int** | | [optional]
**recipe** | [**CServeV2Recipe**](CServeV2Recipe.md) | |
**cserve_version** | **str** | | [optional]
**hf_token** | **str** | | [optional]
**endpoint_bearer_token** | **str** | | [optional]
**bearer_token_ref** | **int** | | [optional]
**endpoint_certificate_authority** | **str** | | [optional]
**min_replicas** | **int** | |
**max_replicas** | **int** | |
**concurrency** | **int** | | [optional]
**cooldown_period** | **int** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**env_vars_refs** | **object** | | [optional]
**enable_logging** | **bool** | | [optional] [default to True]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
**session_affinity** | **bool** | Enable best-effort sticky routing via the `X-Session-Id` request header. Requests carrying the same header value land on the same pod, improving KV cache reuse for agentic workloads. Requests without the header are routed at random. Affinity is NOT durable: scaling, rollouts, restarts, or readiness-probe transitions will remap sessions to different pods. Do not use for irreplaceable in-pod state. | [optional] [default to False]
Expand Down
2 changes: 2 additions & 0 deletions docs/CreateComputeDeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Name | Type | Description | Notes
**priority** | **str** | | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**image_pull_ref** | **int** | | [optional]
**env_vars_refs** | **object** | | [optional]
**ssh_public_key** | **str** | |
**enable_logging** | **bool** | | [optional] [default to False]

Expand Down
4 changes: 4 additions & 0 deletions docs/CreateDynamoDeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ Name | Type | Description | Notes
**cooldown_period** | **int** | | [optional]
**extra_args** | **str** | | [optional]
**hf_token** | **str** | | [optional]
**hf_token_ref** | **int** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**env_vars_refs** | **object** | | [optional]
**endpoint_bearer_token** | **str** | | [optional]
**bearer_token_ref** | **int** | | [optional]
**endpoint_certificate_authority** | **str** | | [optional]
**image_pull_ref** | **int** | | [optional]
**enable_logging** | **bool** | | [optional] [default to True]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
Expand Down
4 changes: 4 additions & 0 deletions docs/CreateInferenceV3DeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ Name | Type | Description | Notes
**chart_revision** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**priority** | **str** | | [optional]
**hf_token_ref** | **int** | | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**image_pull_ref** | **int** | | [optional]
**port** | **int** | |
**min_replicas** | **int** | |
**max_replicas** | **int** | |
Expand All @@ -25,8 +27,10 @@ Name | Type | Description | Notes
**env_vars** | **Dict[str, str]** | | [optional]
**command** | **str** | | [optional]
**endpoint_bearer_token** | **str** | | [optional]
**bearer_token_ref** | **int** | | [optional]
**endpoint_certificate_authority** | **str** | | [optional]
**hf_token** | **str** | | [optional]
**env_vars_refs** | **object** | | [optional]
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
**enable_logging** | **bool** | | [optional] [default to False]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
Expand Down
2 changes: 2 additions & 0 deletions docs/CreateJobDeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Name | Type | Description | Notes
**priority** | **str** | | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**image_pull_ref** | **int** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**env_vars_refs** | **object** | | [optional]
**command** | **str** | | [optional]
**completions** | **int** | | [optional] [default to 1]
**parallelism** | **int** | | [optional] [default to 1]
Expand Down
4 changes: 4 additions & 0 deletions docs/DeploymentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Name | Type | Description | Notes
**user_annotations** | **Dict[str, str]** | | [optional]
**priority** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**hf_token_ref** | **int** | | [optional]
**serving_mode** | [**DynamoServingMode**](DynamoServingMode.md) | | [optional]
**worker_pools** | [**DynamoWorkerPools**](DynamoWorkerPools.md) | | [optional]
**communications** | [**DynamoCommunicationsOutput**](DynamoCommunicationsOutput.md) | | [optional]
Expand All @@ -32,8 +33,11 @@ Name | Type | Description | Notes
**cooldown_period** | **int** | | [optional] [default to 1800]
**extra_args** | **str** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**env_vars_refs** | **object** | | [optional]
**endpoint_certificate_authority** | **str** | | [optional]
**endpoint_bearer_token** | **str** | | [optional]
**bearer_token_ref** | **int** | | [optional]
**image_pull_ref** | **int** | | [optional]
**enable_logging** | **bool** | | [optional] [default to True]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
Expand Down
8 changes: 8 additions & 0 deletions docs/DeploymentType.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@

* `DYNAMO` (value: `'dynamo'`)

* `CCL_COMPUTE` (value: `'ccl_compute'`)

* `CCL_INFERENCE` (value: `'ccl_inference'`)

* `CCL_JOB` (value: `'ccl_job'`)

* `CCL_DYNAMO` (value: `'ccl_dynamo'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


94 changes: 90 additions & 4 deletions docs/EXTERNALApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Method | HTTP request | Description
[**create_job_deployment_deployments_job_post**](EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
[**create_new_organization_organizations_post**](EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
[**create_service_account_service_accounts_post**](EXTERNALApi.md#create_service_account_service_accounts_post) | **POST** /service-accounts | Create Service Account
[**create_unified_deployment_deployments_post**](EXTERNALApi.md#create_unified_deployment_deployments_post) | **POST** /deployments | Create Unified Deployment
[**create_volume_endpoint_volumes_post**](EXTERNALApi.md#create_volume_endpoint_volumes_post) | **POST** /volumes | Create Volume Endpoint
[**delete_cluster_clusters_cluster_id_delete**](EXTERNALApi.md#delete_cluster_clusters_cluster_id_delete) | **DELETE** /clusters/{cluster_id} | Delete Cluster
[**delete_hardware_instance_hardware_instances_hardware_instance_id_delete**](EXTERNALApi.md#delete_hardware_instance_hardware_instances_hardware_instance_id_delete) | **DELETE** /hardware-instances/{hardware_instance_id} | Delete Hardware Instance
Expand Down Expand Up @@ -903,6 +904,84 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_unified_deployment_deployments_post**
> UnifiedWriteDeploymentResponse create_unified_deployment_deployments_post(unified_write_deployment_request)

Create Unified Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_write_deployment_request import UnifiedWriteDeploymentRequest
from platform_api_python_client.models.unified_write_deployment_response import UnifiedWriteDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = platform_api_python_client.EXTERNALApi(api_client)
unified_write_deployment_request = platform_api_python_client.UnifiedWriteDeploymentRequest() # UnifiedWriteDeploymentRequest |

try:
# Create Unified Deployment
api_response = api_instance.create_unified_deployment_deployments_post(unified_write_deployment_request)
print("The response of EXTERNALApi->create_unified_deployment_deployments_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling EXTERNALApi->create_unified_deployment_deployments_post: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**unified_write_deployment_request** | [**UnifiedWriteDeploymentRequest**](UnifiedWriteDeploymentRequest.md)| |

### Return type

[**UnifiedWriteDeploymentResponse**](UnifiedWriteDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_volume_endpoint_volumes_post**
> GetVolumeResponse create_volume_endpoint_volumes_post(create_volume_request)

Expand Down Expand Up @@ -1212,7 +1291,7 @@ void (empty response body)

Delete User Vault Item By Id Endpoint

Delete a vault item by ID. TODO(vault-migration): reject the delete when a selected deployment revision references the secret. Revision-reference tracking lands in a follow-up migration, so nothing is checked yet.
Delete a vault item by ID. Returns 409 while a non-deleted deployment's selected revision references it.

### Example

Expand Down Expand Up @@ -3619,7 +3698,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_usage_deployments_usage_deployment_id_get**
> GetDeploymentUsageResponse get_usage_deployments_usage_deployment_id_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step)
> GetDeploymentUsageResponse get_usage_deployments_usage_deployment_id_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step, revision_number=revision_number, component=component, pod=pod)

Get Usage

Expand All @@ -3631,6 +3710,7 @@ Get Usage
import platform_api_python_client
from platform_api_python_client.models.get_deployment_usage_response import GetDeploymentUsageResponse
from platform_api_python_client.models.metric import Metric
from platform_api_python_client.models.usage_component import UsageComponent
from platform_api_python_client.rest import ApiException
from pprint import pprint

Expand Down Expand Up @@ -3659,10 +3739,13 @@ with platform_api_python_client.ApiClient(configuration) as api_client:
start_time_in_seconds = 56 # int |
end_time_in_seconds = 56 # int |
step = 15 # int | (optional) (default to 15)
revision_number = 56 # int | (optional)
component = platform_api_python_client.UsageComponent() # UsageComponent | (optional)
pod = 'pod_example' # str | (optional)

try:
# Get Usage
api_response = api_instance.get_usage_deployments_usage_deployment_id_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step)
api_response = api_instance.get_usage_deployments_usage_deployment_id_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step, revision_number=revision_number, component=component, pod=pod)
print("The response of EXTERNALApi->get_usage_deployments_usage_deployment_id_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -3681,6 +3764,9 @@ Name | Type | Description | Notes
**start_time_in_seconds** | **int**| |
**end_time_in_seconds** | **int**| |
**step** | **int**| | [optional] [default to 15]
**revision_number** | **int**| | [optional]
**component** | [**UsageComponent**](.md)| | [optional]
**pod** | **str**| | [optional]

### Return type

Expand Down Expand Up @@ -5337,7 +5423,7 @@ Name | Type | Description | Notes

Update User Vault Item Endpoint

Create or update a vault item, writing its value to both SSM and PostgreSQL. The key and value rules are declared on UpsertUserVaultItemRequest, so a malformed write is rejected with a 422 before this handler runs.
Create an immutable vault item. Existing secrets cannot be updated. Reusing an active type, key, and visibility returns 409, even for the same value. To replace a secret, create one with a new key and update its consumers before deleting the old secret. Recreating a deleted key allocates a new secret ID. The PUT route and request name are retained for existing clients.

### Example

Expand Down
3 changes: 3 additions & 0 deletions docs/GetCServeV3DeploymentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Name | Type | Description | Notes
**user_annotations** | **Dict[str, str]** | | [optional]
**priority** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**hf_token_ref** | **int** | | [optional]
**recipe** | [**CServeV2Recipe**](CServeV2Recipe.md) | |
**cserve_version** | **str** | | [optional]
**min_replicas** | **int** | |
Expand All @@ -29,6 +30,8 @@ Name | Type | Description | Notes
**concurrency** | **int** | | [optional]
**cooldown_period** | **int** | | [optional] [default to 1800]
**env_vars** | **Dict[str, str]** | | [optional]
**env_vars_refs** | **object** | | [optional]
**bearer_token_ref** | **int** | | [optional]
**enable_logging** | **bool** | | [optional] [default to True]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
**session_affinity** | **bool** | Enable best-effort sticky routing via the `X-Session-Id` request header. Requests carrying the same header value land on the same pod, improving KV cache reuse for agentic workloads. Requests without the header are routed at random. Affinity is NOT durable: scaling, rollouts, restarts, or readiness-probe transitions will remap sessions to different pods. Do not use for irreplaceable in-pod state. | [optional] [default to False]
Expand Down
1 change: 1 addition & 0 deletions docs/GetClusterResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**display_name** | **str** | |
**region** | **str** | | [optional]
**deployment_creation_disabled** | **bool** | | [optional] [default to False]
**managed_by_ccluster** | **bool** | |

## Example

Expand Down
2 changes: 2 additions & 0 deletions docs/GetComputeDeploymentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Name | Type | Description | Notes
**ssh_password** | **str** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**env_vars_refs** | **object** | | [optional]
**image_pull_ref** | **int** | | [optional]
**enable_logging** | **bool** | | [optional] [default to True]

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/GetDeploymentLogResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**events** | **List[Dict[str, object]]** | |
**events** | **List[object]** | |
**next_page_token** | **str** | | [optional]

## Example
Expand Down
2 changes: 2 additions & 0 deletions docs/GetDeploymentUsageResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**values** | [**List[DeploymentUsage]**](DeploymentUsage.md) | |
**availability** | [**UsageAvailability**](UsageAvailability.md) | | [optional]
**last_sample_at** | **int** | | [optional]

## Example

Expand Down
Loading
Loading