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
46 changes: 36 additions & 10 deletions 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.18.0
- Package version: 4.19.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

Expand Down Expand Up @@ -76,15 +76,15 @@ configuration = platform_api_python_client.Configuration(
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)
create_compute_deployment_request = platform_api_python_client.CreateComputeDeploymentRequest() # CreateComputeDeploymentRequest |
cluster_registration_request = platform_api_python_client.ClusterRegistrationRequest() # ClusterRegistrationRequest |

try:
# Create Compute Deployment
api_response = api_instance.create_compute_deployment_deployments_compute_post(create_compute_deployment_request)
print("The response of EXTERNALApi->create_compute_deployment_deployments_compute_post:\n")
# Create Cluster
api_response = api_instance.create_cluster_clusters_post(cluster_registration_request)
print("The response of EXTERNALApi->create_cluster_clusters_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling EXTERNALApi->create_compute_deployment_deployments_compute_post: %s\n" % e)
print("Exception when calling EXTERNALApi->create_cluster_clusters_post: %s\n" % e)

```

Expand All @@ -94,6 +94,7 @@ All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EXTERNALApi* | [**create_cluster_clusters_post**](docs/EXTERNALApi.md#create_cluster_clusters_post) | **POST** /clusters | Create Cluster
*EXTERNALApi* | [**create_compute_deployment_deployments_compute_post**](docs/EXTERNALApi.md#create_compute_deployment_deployments_compute_post) | **POST** /deployments/compute | Create Compute Deployment
*EXTERNALApi* | [**create_cserve_v2_deployment_deployments_cserve_v2_post**](docs/EXTERNALApi.md#create_cserve_v2_deployment_deployments_cserve_v2_post) | **POST** /deployments/cserve_v2 | Create Cserve V2 Deployment
*EXTERNALApi* | [**create_cserve_v3_deployment_deployments_cserve_v3_post**](docs/EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Create Cserve V3 Deployment
Expand All @@ -103,10 +104,10 @@ 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* | [**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
*EXTERNALApi* | [**delete_service_account_service_accounts_workos_id_delete**](docs/EXTERNALApi.md#delete_service_account_service_accounts_workos_id_delete) | **DELETE** /service-accounts/{workos_id} | Delete Service Account
*EXTERNALApi* | [**delete_user_vault_item_endpoint_user_vault_delete**](docs/EXTERNALApi.md#delete_user_vault_item_endpoint_user_vault_delete) | **DELETE** /user_vault | Delete User Vault Item Endpoint
*EXTERNALApi* | [**download_url_file_url_download_post**](docs/EXTERNALApi.md#download_url_file_url_download_post) | **POST** /file_url/download | Download Url
*EXTERNALApi* | [**generate_service_account_secret_service_accounts_workos_id_secrets_post**](docs/EXTERNALApi.md#generate_service_account_secret_service_accounts_workos_id_secrets_post) | **POST** /service-accounts/{workos_id}/secrets | Generate Service Account Secret
*EXTERNALApi* | [**get_all_user_vault_items_endpoint_user_vault_get**](docs/EXTERNALApi.md#get_all_user_vault_items_endpoint_user_vault_get) | **GET** /user_vault | Get All User Vault Items Endpoint
*EXTERNALApi* | [**get_clusters_clusters_get**](docs/EXTERNALApi.md#get_clusters_clusters_get) | **GET** /clusters | Get Clusters
Expand Down Expand Up @@ -134,6 +135,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**list_service_accounts_service_accounts_get**](docs/EXTERNALApi.md#list_service_accounts_service_accounts_get) | **GET** /service-accounts | List Service Accounts
*EXTERNALApi* | [**rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put**](docs/EXTERNALApi.md#rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put) | **PUT** /deployments/revisions/{deployment_id}/{revision_number} | Rollout Existing Revision
*EXTERNALApi* | [**setup_stripe_customer_payments_setup_post**](docs/EXTERNALApi.md#setup_stripe_customer_payments_setup_post) | **POST** /payments/setup | Setup Stripe Customer
*EXTERNALApi* | [**update_cluster_clusters_cluster_id_put**](docs/EXTERNALApi.md#update_cluster_clusters_cluster_id_put) | **PUT** /clusters/{cluster_id} | Update Cluster
*EXTERNALApi* | [**update_compute_deployment_deployments_compute_put**](docs/EXTERNALApi.md#update_compute_deployment_deployments_compute_put) | **PUT** /deployments/compute | Update Compute Deployment
*EXTERNALApi* | [**update_cserve_v2_deployment_deployments_cserve_v2_put**](docs/EXTERNALApi.md#update_cserve_v2_deployment_deployments_cserve_v2_put) | **PUT** /deployments/cserve_v2 | Update Cserve V2 Deployment
*EXTERNALApi* | [**update_cserve_v3_deployment_deployments_cserve_v3_put**](docs/EXTERNALApi.md#update_cserve_v3_deployment_deployments_cserve_v3_put) | **PUT** /deployments/cserve_v3 | Update Cserve V3 Deployment
Expand All @@ -143,16 +145,23 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**update_inference_v3_deployment_deployments_inference_v3_put**](docs/EXTERNALApi.md#update_inference_v3_deployment_deployments_inference_v3_put) | **PUT** /deployments/inference_v3 | Update Inference V3 Deployment
*EXTERNALApi* | [**update_service_account_service_accounts_workos_id_put**](docs/EXTERNALApi.md#update_service_account_service_accounts_workos_id_put) | **PUT** /service-accounts/{workos_id} | Update Service Account
*EXTERNALApi* | [**update_user_vault_item_endpoint_user_vault_put**](docs/EXTERNALApi.md#update_user_vault_item_endpoint_user_vault_put) | **PUT** /user_vault | Update User Vault Item Endpoint
*EXTERNALApi* | [**upload_url_file_url_upload_post**](docs/EXTERNALApi.md#upload_url_file_url_upload_post) | **POST** /file_url/upload | Upload Url


## Documentation For Models

- [ArgoRollouts](docs/ArgoRollouts.md)
- [BackendProtocol](docs/BackendProtocol.md)
- [CServeRecipePerf](docs/CServeRecipePerf.md)
- [CServeRecipeResponse](docs/CServeRecipeResponse.md)
- [CServeV2Recipe](docs/CServeV2Recipe.md)
- [CertManager](docs/CertManager.md)
- [CloudProvider](docs/CloudProvider.md)
- [ClusterCapacityResponse](docs/ClusterCapacityResponse.md)
- [ClusterComponents](docs/ClusterComponents.md)
- [ClusterConfig](docs/ClusterConfig.md)
- [ClusterCredential](docs/ClusterCredential.md)
- [ClusterRegistrationRequest](docs/ClusterRegistrationRequest.md)
- [ClusterRegistrationResponse](docs/ClusterRegistrationResponse.md)
- [ConfigFileMount](docs/ConfigFileMount.md)
- [CreateCServeV2DeploymentResponse](docs/CreateCServeV2DeploymentResponse.md)
- [CreateCServeV3DeploymentRequest](docs/CreateCServeV3DeploymentRequest.md)
Expand All @@ -168,8 +177,6 @@ Class | Method | HTTP request | Description
- [CreateOrganizationResponse](docs/CreateOrganizationResponse.md)
- [CreateServiceAccountRequest](docs/CreateServiceAccountRequest.md)
- [CreateServiceAccountResponse](docs/CreateServiceAccountResponse.md)
- [CreateUrlRequest](docs/CreateUrlRequest.md)
- [CreateUrlResponse](docs/CreateUrlResponse.md)
- [CreditsResponse](docs/CreditsResponse.md)
- [DailyBillResponse](docs/DailyBillResponse.md)
- [DeploymentResponse](docs/DeploymentResponse.md)
Expand All @@ -180,6 +187,9 @@ Class | Method | HTTP request | Description
- [DeploymentType](docs/DeploymentType.md)
- [DeploymentUsage](docs/DeploymentUsage.md)
- [DeploymentUsageValue](docs/DeploymentUsageValue.md)
- [ExternalDns](docs/ExternalDns.md)
- [FinalStack](docs/FinalStack.md)
- [FluentBit](docs/FluentBit.md)
- [GenerateServiceAccountSecretResponse](docs/GenerateServiceAccountSecretResponse.md)
- [GetCServeV2DeploymentResponse](docs/GetCServeV2DeploymentResponse.md)
- [GetCServeV3DeploymentResponse](docs/GetCServeV3DeploymentResponse.md)
Expand All @@ -192,11 +202,19 @@ Class | Method | HTTP request | Description
- [GetInferenceDeploymentResponse](docs/GetInferenceDeploymentResponse.md)
- [GetInferenceV3DeploymentResponse](docs/GetInferenceV3DeploymentResponse.md)
- [GetJobDeploymentResponse](docs/GetJobDeploymentResponse.md)
- [GpuOperator](docs/GpuOperator.md)
- [GpuTypeCapacity](docs/GpuTypeCapacity.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [HardwareInstanceResponse](docs/HardwareInstanceResponse.md)
- [ImagePullSecretCredentials](docs/ImagePullSecretCredentials.md)
- [IngressNginx](docs/IngressNginx.md)
- [InviteUserRequest](docs/InviteUserRequest.md)
- [Istio](docs/Istio.md)
- [IstioCniOverrides](docs/IstioCniOverrides.md)
- [IstioCniSubchartOverrides](docs/IstioCniSubchartOverrides.md)
- [IstioOverrides](docs/IstioOverrides.md)
- [Keda](docs/Keda.md)
- [KubePrometheusStack](docs/KubePrometheusStack.md)
- [ListCServeRecipeResponse](docs/ListCServeRecipeResponse.md)
- [ListClusterCapacityResponse](docs/ListClusterCapacityResponse.md)
- [ListDailyBillResponse](docs/ListDailyBillResponse.md)
Expand All @@ -207,16 +225,24 @@ Class | Method | HTTP request | Description
- [ListPrebuiltImageResponse](docs/ListPrebuiltImageResponse.md)
- [ListServiceAccountsResponse](docs/ListServiceAccountsResponse.md)
- [ListUserVaultItemsResponse](docs/ListUserVaultItemsResponse.md)
- [Longhorn](docs/Longhorn.md)
- [Metric](docs/Metric.md)
- [MetricsConfig](docs/MetricsConfig.md)
- [MetricsServer](docs/MetricsServer.md)
- [NetworkOperator](docs/NetworkOperator.md)
- [OpentelemetryCollector](docs/OpentelemetryCollector.md)
- [PodDetails](docs/PodDetails.md)
- [PodStatus](docs/PodStatus.md)
- [PrebuiltImageResponse](docs/PrebuiltImageResponse.md)
- [PrometheusAdapter](docs/PrometheusAdapter.md)
- [RevisionPodDetails](docs/RevisionPodDetails.md)
- [RolloutStatus](docs/RolloutStatus.md)
- [RolloutStrategyParams](docs/RolloutStrategyParams.md)
- [ServiceAccountResponse](docs/ServiceAccountResponse.md)
- [ServiceStatus](docs/ServiceStatus.md)
- [Spire](docs/Spire.md)
- [SpireCrds](docs/SpireCrds.md)
- [TeleportKubeAgent](docs/TeleportKubeAgent.md)
- [UpdateDeploymentResponse](docs/UpdateDeploymentResponse.md)
- [UpdateDeploymentStatusV3Request](docs/UpdateDeploymentStatusV3Request.md)
- [UpdateServiceAccountRequest](docs/UpdateServiceAccountRequest.md)
Expand Down
30 changes: 30 additions & 0 deletions docs/ArgoRollouts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ArgoRollouts


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | | [optional] [default to True]
**values** | **object** | | [optional]

## Example

```python
from platform_api_python_client.models.argo_rollouts import ArgoRollouts

# TODO update the JSON string below
json = "{}"
# create an instance of ArgoRollouts from a JSON string
argo_rollouts_instance = ArgoRollouts.from_json(json)
# print the JSON string representation of the object
print(ArgoRollouts.to_json())

# convert the object into a dict
argo_rollouts_dict = argo_rollouts_instance.to_dict()
# create an instance of ArgoRollouts from a dict
argo_rollouts_from_dict = ArgoRollouts.from_dict(argo_rollouts_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/CertManager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# CertManager


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | | [optional] [default to True]
**values** | **object** | | [optional]

## Example

```python
from platform_api_python_client.models.cert_manager import CertManager

# TODO update the JSON string below
json = "{}"
# create an instance of CertManager from a JSON string
cert_manager_instance = CertManager.from_json(json)
# print the JSON string representation of the object
print(CertManager.to_json())

# convert the object into a dict
cert_manager_dict = cert_manager_instance.to_dict()
# create an instance of CertManager from a dict
cert_manager_from_dict = CertManager.from_dict(cert_manager_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


16 changes: 16 additions & 0 deletions docs/CloudProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# CloudProvider


## Enum

* `GCP` (value: `'gcp'`)

* `AWS` (value: `'aws'`)

* `AZURE` (value: `'azure'`)

* `NEBIUS` (value: `'nebius'`)

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


47 changes: 47 additions & 0 deletions docs/ClusterComponents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# ClusterComponents

Per-component ApplicationSet entries — the caller-facing surface. This is the request-body schema for cluster updates: callers may flip `enabled` and supply per-component `values`, but nothing here is cluster identity. Cluster identity lives in `Shared` and is passed as serialization context when building ApplicationSet elements. Field declaration order is for code locality only — actual bring-up order is driven by each subclass's `wave` ClassVar (rendered into the child Application's argocd.argoproj.io/sync-wave annotation).

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kube_prometheus_stack** | [**KubePrometheusStack**](KubePrometheusStack.md) | | [optional]
**istio** | [**Istio**](Istio.md) | | [optional]
**cert_manager** | [**CertManager**](CertManager.md) | | [optional]
**ingress_nginx** | [**IngressNginx**](IngressNginx.md) | | [optional]
**spire_crds** | [**SpireCrds**](SpireCrds.md) | | [optional]
**spire** | [**Spire**](Spire.md) | | [optional]
**external_dns** | [**ExternalDns**](ExternalDns.md) | | [optional]
**prometheus_adapter** | [**PrometheusAdapter**](PrometheusAdapter.md) | | [optional]
**keda** | [**Keda**](Keda.md) | | [optional]
**fluent_bit** | [**FluentBit**](FluentBit.md) | | [optional]
**argo_rollouts** | [**ArgoRollouts**](ArgoRollouts.md) | | [optional]
**network_operator** | [**NetworkOperator**](NetworkOperator.md) | | [optional]
**opentelemetry_collector** | [**OpentelemetryCollector**](OpentelemetryCollector.md) | | [optional]
**gpu_operator** | [**GpuOperator**](GpuOperator.md) | | [optional]
**longhorn** | [**Longhorn**](Longhorn.md) | | [optional]
**metrics_server** | [**MetricsServer**](MetricsServer.md) | | [optional]
**teleport_kube_agent** | [**TeleportKubeAgent**](TeleportKubeAgent.md) | | [optional]
**final_stack** | [**FinalStack**](FinalStack.md) | | [optional]

## Example

```python
from platform_api_python_client.models.cluster_components import ClusterComponents

# TODO update the JSON string below
json = "{}"
# create an instance of ClusterComponents from a JSON string
cluster_components_instance = ClusterComponents.from_json(json)
# print the JSON string representation of the object
print(ClusterComponents.to_json())

# convert the object into a dict
cluster_components_dict = cluster_components_instance.to_dict()
# create an instance of ClusterComponents from a dict
cluster_components_from_dict = ClusterComponents.from_dict(cluster_components_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


29 changes: 29 additions & 0 deletions docs/ClusterConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ClusterConfig


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**components** | [**ClusterComponents**](ClusterComponents.md) | |

## Example

```python
from platform_api_python_client.models.cluster_config import ClusterConfig

# TODO update the JSON string below
json = "{}"
# create an instance of ClusterConfig from a JSON string
cluster_config_instance = ClusterConfig.from_json(json)
# print the JSON string representation of the object
print(ClusterConfig.to_json())

# convert the object into a dict
cluster_config_dict = cluster_config_instance.to_dict()
# create an instance of ClusterConfig from a dict
cluster_config_from_dict = ClusterConfig.from_dict(cluster_config_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


31 changes: 31 additions & 0 deletions docs/ClusterCredential.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ClusterCredential


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server** | **str** | |
**bearer_token** | **str** | |
**ca_cert** | **str** | |

## Example

```python
from platform_api_python_client.models.cluster_credential import ClusterCredential

# TODO update the JSON string below
json = "{}"
# create an instance of ClusterCredential from a JSON string
cluster_credential_instance = ClusterCredential.from_json(json)
# print the JSON string representation of the object
print(ClusterCredential.to_json())

# convert the object into a dict
cluster_credential_dict = cluster_credential_instance.to_dict()
# create an instance of ClusterCredential from a dict
cluster_credential_from_dict = ClusterCredential.from_dict(cluster_credential_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


33 changes: 33 additions & 0 deletions docs/ClusterRegistrationRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# ClusterRegistrationRequest


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**display_name** | **str** | |
**storage_class** | **str** | |
**region** | **str** | | [optional]
**cloud_provider** | [**CloudProvider**](CloudProvider.md) | | [optional]
**credential** | [**ClusterCredential**](ClusterCredential.md) | |

## Example

```python
from platform_api_python_client.models.cluster_registration_request import ClusterRegistrationRequest

# TODO update the JSON string below
json = "{}"
# create an instance of ClusterRegistrationRequest from a JSON string
cluster_registration_request_instance = ClusterRegistrationRequest.from_json(json)
# print the JSON string representation of the object
print(ClusterRegistrationRequest.to_json())

# convert the object into a dict
cluster_registration_request_dict = cluster_registration_request_instance.to_dict()
# create an instance of ClusterRegistrationRequest from a dict
cluster_registration_request_from_dict = ClusterRegistrationRequest.from_dict(cluster_registration_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading
Loading