anyscale 0.26.23__py3-none-any.whl → 0.26.25__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- anyscale/_private/anyscale_client/anyscale_client.py +1 -1
- anyscale/_private/docgen/__main__.py +0 -8
- anyscale/_private/docgen/models.md +39 -182
- anyscale/_private/workload/workload_config.py +1 -1
- anyscale/client/README.md +2 -35
- anyscale/client/openapi_client/__init__.py +2 -21
- anyscale/client/openapi_client/api/default_api.py +275 -1868
- anyscale/client/openapi_client/models/__init__.py +2 -21
- anyscale/client/openapi_client/models/cloud_data_bucket_file_type.py +2 -1
- anyscale/client/openapi_client/models/cloud_deployment.py +2 -2
- anyscale/client/openapi_client/models/cloud_deployment_compute_config.py +291 -0
- anyscale/client/openapi_client/models/cloud_deployment_selector.py +206 -0
- anyscale/client/openapi_client/models/cloud_providers.py +2 -1
- anyscale/client/openapi_client/models/compute_template_config.py +61 -34
- anyscale/client/openapi_client/models/create_cluster_compute_config.py +59 -31
- anyscale/client/openapi_client/models/create_compute_template_config.py +61 -34
- anyscale/client/openapi_client/models/create_workspace_from_template.py +3 -2
- anyscale/client/openapi_client/models/decorated_compute_template_config.py +61 -34
- anyscale/client/openapi_client/models/decorated_session.py +31 -3
- anyscale/client/openapi_client/models/workspace_dataplane_proxied_artifacts.py +31 -3
- anyscale/cluster_compute.py +4 -4
- anyscale/commands/anyscale_api/sessions_commands.py +1 -70
- anyscale/commands/cloud_commands.py +5 -4
- anyscale/commands/image_commands.py +2 -2
- anyscale/commands/job_commands.py +1 -1
- anyscale/commands/service_commands.py +1 -1
- anyscale/commands/workspace_commands_v2.py +1 -1
- anyscale/connect_utils/prepare_cluster.py +1 -3
- anyscale/controllers/cloud_controller.py +12 -6
- anyscale/controllers/cloud_functional_verification_controller.py +2 -2
- anyscale/image/commands.py +1 -1
- anyscale/sdk/anyscale_client/__init__.py +2 -15
- anyscale/sdk/anyscale_client/api/default_api.py +1270 -2871
- anyscale/sdk/anyscale_client/models/__init__.py +2 -15
- anyscale/sdk/anyscale_client/models/cloud_deployment_compute_config.py +291 -0
- anyscale/sdk/anyscale_client/models/cloud_deployment_selector.py +206 -0
- anyscale/sdk/anyscale_client/models/cloud_providers.py +2 -1
- anyscale/sdk/anyscale_client/models/cluster_compute_config.py +61 -34
- anyscale/sdk/anyscale_client/models/cluster_services_urls.py +29 -1
- anyscale/sdk/anyscale_client/models/compute_template_config.py +61 -34
- anyscale/sdk/anyscale_client/models/create_cluster_compute_config.py +59 -31
- anyscale/sdk/anyscale_client/models/session.py +31 -3
- anyscale/shared_anyscale_utils/utils/id_gen.py +3 -1
- anyscale/version.py +1 -1
- anyscale/workspace/models.py +1 -1
- {anyscale-0.26.23.dist-info → anyscale-0.26.25.dist-info}/METADATA +1 -1
- {anyscale-0.26.23.dist-info → anyscale-0.26.25.dist-info}/RECORD +52 -84
- anyscale/client/openapi_client/models/bank_account_information.py +0 -239
- anyscale/client/openapi_client/models/billing_information.py +0 -181
- anyscale/client/openapi_client/models/credit_card_information.py +0 -268
- anyscale/client/openapi_client/models/decoratedunifiedjob_response.py +0 -121
- anyscale/client/openapi_client/models/invoice.py +0 -413
- anyscale/client/openapi_client/models/invoice_list_response.py +0 -147
- anyscale/client/openapi_client/models/invoice_status.py +0 -102
- anyscale/client/openapi_client/models/invoices_query.py +0 -150
- anyscale/client/openapi_client/models/log_stream.py +0 -151
- anyscale/client/openapi_client/models/logstream_response.py +0 -121
- anyscale/client/openapi_client/models/miniproject_list_response.py +0 -147
- anyscale/client/openapi_client/models/organization_project_collaborator.py +0 -175
- anyscale/client/openapi_client/models/organization_project_collaborator_value.py +0 -148
- anyscale/client/openapi_client/models/organizationprojectcollaborator_list_response.py +0 -147
- anyscale/client/openapi_client/models/product_type.py +0 -100
- anyscale/client/openapi_client/models/service_usage.py +0 -353
- anyscale/client/openapi_client/models/templatized_compute_configs.py +0 -202
- anyscale/client/openapi_client/models/templatized_decorated_application_templates.py +0 -202
- anyscale/client/openapi_client/models/templatizedcomputeconfigs_response.py +0 -121
- anyscale/client/openapi_client/models/templatizeddecoratedapplicationtemplates_response.py +0 -121
- anyscale/client/openapi_client/models/write_session.py +0 -147
- anyscale/sdk/anyscale_client/models/build_list_response.py +0 -147
- anyscale/sdk/anyscale_client/models/build_log_response.py +0 -123
- anyscale/sdk/anyscale_client/models/buildlogresponse_response.py +0 -121
- anyscale/sdk/anyscale_client/models/compute_template_query.py +0 -316
- anyscale/sdk/anyscale_client/models/computetemplate_list_response.py +0 -147
- anyscale/sdk/anyscale_client/models/create_build.py +0 -263
- anyscale/sdk/anyscale_client/models/create_compute_template.py +0 -229
- anyscale/sdk/anyscale_client/models/create_compute_template_config.py +0 -464
- anyscale/sdk/anyscale_client/models/session_list_response.py +0 -147
- anyscale/sdk/anyscale_client/models/sessions_query.py +0 -206
- anyscale/sdk/anyscale_client/models/start_session_options.py +0 -206
- anyscale/sdk/anyscale_client/models/terminate_session_options.py +0 -206
- anyscale/sdk/anyscale_client/models/update_compute_template.py +0 -146
- anyscale/sdk/anyscale_client/models/update_compute_template_config.py +0 -464
- anyscale/sdk/anyscale_client/models/update_session.py +0 -150
- {anyscale-0.26.23.dist-info → anyscale-0.26.25.dist-info}/LICENSE +0 -0
- {anyscale-0.26.23.dist-info → anyscale-0.26.25.dist-info}/NOTICE +0 -0
- {anyscale-0.26.23.dist-info → anyscale-0.26.25.dist-info}/WHEEL +0 -0
- {anyscale-0.26.23.dist-info → anyscale-0.26.25.dist-info}/entry_points.txt +0 -0
- {anyscale-0.26.23.dist-info → anyscale-0.26.25.dist-info}/top_level.txt +0 -0
@@ -981,10 +981,10 @@ class AnyscaleClient(AnyscaleClientInterface):
|
|
981
981
|
)
|
982
982
|
for build in self.list_cluster_env_builds(cluster_env.id):
|
983
983
|
if (
|
984
|
+
# NOTE: Ignore ray version mismatch for now. We plan to eventually remove ray version from the API model.
|
984
985
|
build.docker_image_name == image_uri_str
|
985
986
|
and build.registry_login_secret == registry_login_secret
|
986
987
|
and build.status == ClusterEnvironmentBuildStatus.SUCCEEDED
|
987
|
-
and (ray_version is None or build.ray_version == ray_version)
|
988
988
|
):
|
989
989
|
return build.id
|
990
990
|
|
@@ -340,16 +340,10 @@ ALL_MODULES = [
|
|
340
340
|
"ComputeNodeType",
|
341
341
|
"ComputeTemplate",
|
342
342
|
"ComputeTemplateConfig",
|
343
|
-
"ComputeTemplateQuery",
|
344
|
-
"ComputetemplateListResponse",
|
345
343
|
"ComputetemplateResponse",
|
346
344
|
"ComputetemplateconfigResponse",
|
347
345
|
"CreateClusterCompute",
|
348
346
|
"CreateClusterComputeConfig",
|
349
|
-
"CreateComputeTemplate",
|
350
|
-
"CreateComputeTemplateConfig",
|
351
|
-
"UpdateComputeTemplate",
|
352
|
-
"UpdateComputeTemplateConfig",
|
353
347
|
],
|
354
348
|
),
|
355
349
|
Module(
|
@@ -695,10 +689,8 @@ ALL_MODULES = [
|
|
695
689
|
"BASEIMAGESENUM",
|
696
690
|
"BaseJobStatus",
|
697
691
|
"Build",
|
698
|
-
"BuildListResponse",
|
699
692
|
"BuildResponse",
|
700
693
|
"BuildStatus",
|
701
|
-
"CreateBuild",
|
702
694
|
"CreateSSOConfig",
|
703
695
|
"GrpcProtocolConfig",
|
704
696
|
"HTTPValidationError",
|
@@ -132,22 +132,6 @@ Name | Type | Description | Notes
|
|
132
132
|
**cloud_id** | **str** | The build cloud associated with this build. If None, the build is a v1 build. | [optional] [default to null]
|
133
133
|
**digest** | **str** | The digest of the image created by this build. | [optional] [default to null]
|
134
134
|
|
135
|
-
## BuildListResponse
|
136
|
-
|
137
|
-
A list response form the API. Contains a field \"results\" which has the contents of the response.
|
138
|
-
|
139
|
-
Name | Type | Description | Notes
|
140
|
-
------------ | ------------- | ------------- | -------------
|
141
|
-
**results** | [**List[Build]**](#build) | | [default to null]
|
142
|
-
**metadata** | [**ListResponseMetadata**](#listresponsemetadata) | | [optional] [default to null]
|
143
|
-
|
144
|
-
## BuildLogResponse
|
145
|
-
|
146
|
-
|
147
|
-
Name | Type | Description | Notes
|
148
|
-
------------ | ------------- | ------------- | -------------
|
149
|
-
**logs** | **str** | Logs of the build. | [default to null]
|
150
|
-
|
151
135
|
## BuildResponse
|
152
136
|
|
153
137
|
A response from the API. Contains a field \"result\" which has the contents of the response.
|
@@ -163,14 +147,6 @@ An enumeration.
|
|
163
147
|
Possible Values:
|
164
148
|
['pending', 'in_progress', 'succeeded', 'failed', 'pending_cancellation', 'canceled']
|
165
149
|
|
166
|
-
## BuildlogresponseResponse
|
167
|
-
|
168
|
-
A response from the API. Contains a field \"result\" which has the contents of the response.
|
169
|
-
|
170
|
-
Name | Type | Description | Notes
|
171
|
-
------------ | ------------- | ------------- | -------------
|
172
|
-
**result** | [**BuildLogResponse**](#buildlogresponse) | | [default to null]
|
173
|
-
|
174
150
|
## Cloud
|
175
151
|
|
176
152
|
Model used to create a Cloud.
|
@@ -213,6 +189,30 @@ Name | Type | Description | Notes
|
|
213
189
|
**vpc_peering_target_project_id** | **str** | Project ID of the VPC to peer with. | [optional] [default to null]
|
214
190
|
**vpc_peering_target_vpc_id** | **str** | ID of the VPC to peer with. | [optional] [default to null]
|
215
191
|
|
192
|
+
## CloudDeploymentComputeConfig
|
193
|
+
|
194
|
+
|
195
|
+
Name | Type | Description | Notes
|
196
|
+
------------ | ------------- | ------------- | -------------
|
197
|
+
**cloud_deployment** | [**CloudDeploymentSelector**](#clouddeploymentselector) | The cloud deployment to use for this compute config. If not specified, the default cloud deployment for the cloud will be used. | [optional] [default to null]
|
198
|
+
**allowed_azs** | **List[str]** | The availability zones that sessions are allowed to be launched in, e.g. \"us-west-2a\". If not specified or \"any\" is provided as the option, any AZ may be used. If \"any\" is provided, it must be the only item in the list. | [optional] [default to null]
|
199
|
+
**head_node_type** | [**ComputeNodeType**](#computenodetype) | Node configuration to use for the head node. | [default to null]
|
200
|
+
**worker_node_types** | [**List[WorkerNodeType]**](#workernodetype) | A list of node types to use for worker nodes. | [optional] [default to null]
|
201
|
+
**advanced_configurations_json** | [**object**](#) | Advanced configurations for this compute node type to pass to the cloud provider when launching this instance. | [optional] [default to null]
|
202
|
+
**auto_select_worker_config** | **bool** | If set to true, worker node groups will automatically be selected based on workload. | [optional] [default to false]
|
203
|
+
**flags** | [**object**](#) | A set of advanced cluster-level flags that can be used to configure a particular workload. | [optional] [default to null]
|
204
|
+
|
205
|
+
## CloudDeploymentSelector
|
206
|
+
|
207
|
+
Cloud deployment selectors; one or more selectors may be passed to target a specific deployment from all of a cloud's deployments.
|
208
|
+
|
209
|
+
Name | Type | Description | Notes
|
210
|
+
------------ | ------------- | ------------- | -------------
|
211
|
+
**id** | **str** | Cloud deployment ID. Note that this is not the same as the cloud ID. | [optional] [default to null]
|
212
|
+
**compute_stack** | [**ComputeStack**](#computestack) | Cloud deployment compute stack, e.g., `VM` or `K8S`. | [optional] [default to null]
|
213
|
+
**provider** | [**CloudProviders**](#cloudproviders) | Cloud deployment provider name, e.g., `AWS` or `GCP`. | [optional] [default to null]
|
214
|
+
**region** | **str** | Cloud deployment region, e.g., `us-west-2`. | [optional] [default to null]
|
215
|
+
|
216
216
|
## CloudListResponse
|
217
217
|
|
218
218
|
A list response form the API. Contains a field \"results\" which has the contents of the response.
|
@@ -227,7 +227,7 @@ Name | Type | Description | Notes
|
|
227
227
|
An enumeration.
|
228
228
|
|
229
229
|
Possible Values:
|
230
|
-
['AWS', 'GCP', 'CLOUDGATEWAY', 'PCP', 'GENERIC']
|
230
|
+
['AWS', 'GCP', 'CLOUDGATEWAY', 'PCP', 'GENERIC', 'AZURE']
|
231
231
|
|
232
232
|
## CloudResponse
|
233
233
|
|
@@ -337,15 +337,16 @@ Configuration of compute resources to use for launching a Cluster. Used when rea
|
|
337
337
|
Name | Type | Description | Notes
|
338
338
|
------------ | ------------- | ------------- | -------------
|
339
339
|
**cloud_id** | **str** | The ID of the Anyscale cloud to use for launching Clusters. | [default to null]
|
340
|
-
**
|
341
|
-
**
|
340
|
+
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
341
|
+
**deployment_configs** | [**List[CloudDeploymentComputeConfig]**](#clouddeploymentcomputeconfig) | A list of cloud deployment-specific configs to use. | [optional] [default to null]
|
342
|
+
**max_workers** | **int** | DEPRECATED. This attribute will be ignored - please use the \"max_resources\" flag to configure resource limits. | [optional] [default to null]
|
343
|
+
**region** | **str** | The region to launch Clusters in, e.g. \"us-west-2\". | [optional] [default to null]
|
342
344
|
**allowed_azs** | **List[str]** | The availability zones that sessions are allowed to be launched in, e.g. \"us-west-2a\". If not specified or \"any\" is provided as the option, any AZ may be used. If \"any\" is provided, it must be the only item in the list. | [optional] [default to null]
|
343
345
|
**head_node_type** | [**ComputeNodeType**](#computenodetype) | Node configuration to use for the head node. | [default to null]
|
344
346
|
**worker_node_types** | [**List[WorkerNodeType]**](#workernodetype) | A list of node types to use for worker nodes. | [optional] [default to null]
|
345
347
|
**aws_advanced_configurations_json** | [**object**](#) | [DEPRECATED: use advanced_configurations_json instead] The advanced configuration json that we pass directly AWS APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
346
348
|
**gcp_advanced_configurations_json** | [**object**](#) | [DEPRECATED: use advanced_configurations_json instead] The advanced configuration json that we pass directly GCP APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
347
349
|
**advanced_configurations_json** | [**object**](#) | Advanced configurations for this compute node type to pass to the cloud provider when launching this instance. | [optional] [default to null]
|
348
|
-
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
349
350
|
**auto_select_worker_config** | **bool** | If set to true, worker node groups will automatically be selected based on workload. | [optional] [default to false]
|
350
351
|
**flags** | [**object**](#) | A set of advanced cluster-level flags that can be used to configure a particular workload. | [optional] [default to null]
|
351
352
|
**idle_termination_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after the cluster is idle. Idle time is defined as the time during which a Cluster is not running a user command or a Ray driver. Time spent running commands on Jupyter or ssh is still considered 'idle'. To disable, set this field to 0. | [optional] [default to null]
|
@@ -507,6 +508,7 @@ Name | Type | Description | Notes
|
|
507
508
|
**train_metrics_dashboard_url** | **str** | URL for the train Grafana dashboard. | [optional] [default to null]
|
508
509
|
**serve_metrics_dashboard_url** | **str** | URL for the serve Grafana dashboard. | [optional] [default to null]
|
509
510
|
**serve_deployment_metrics_dashboard_url** | **str** | URL for the serve deployment Grafana dashboard. | [optional] [default to null]
|
511
|
+
**serve_llm_metrics_dashboard_url** | **str** | URL for the serve LLM Grafana dashboard. | [optional] [default to null]
|
510
512
|
**persistent_metrics_url** | **str** | URL for the persistent Grafana (metrics) dashboard in the non-running cluster state. | [optional] [default to null]
|
511
513
|
**connect_url** | **str** | URL for Anyscale connect. | [optional] [default to null]
|
512
514
|
**jupyter_notebook_url** | **str** | URL for Jupyter Lab. | [optional] [default to null]
|
@@ -668,42 +670,20 @@ DEPRECATED: Please use ClusterCompute and the corresponding ClusterComputeConfig
|
|
668
670
|
Name | Type | Description | Notes
|
669
671
|
------------ | ------------- | ------------- | -------------
|
670
672
|
**cloud_id** | **str** | The ID of the Anyscale cloud to use for launching sessions. | [default to null]
|
671
|
-
**
|
672
|
-
**
|
673
|
+
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
674
|
+
**deployment_configs** | [**List[CloudDeploymentComputeConfig]**](#clouddeploymentcomputeconfig) | A list of cloud deployment-specific configs to use. | [optional] [default to null]
|
675
|
+
**max_workers** | **int** | DEPRECATED. This attribute will be ignored - please use the \"max_resources\" flag to configure resource limits. | [optional] [default to null]
|
676
|
+
**region** | **str** | The region to launch sessions in, e.g. \"us-west-2\". | [optional] [default to null]
|
673
677
|
**allowed_azs** | **List[str]** | The availability zones that sessions are allowed to be launched in, e.g. \"us-west-2a\". If not specified or \"any\" is provided as the option, any AZ may be used. If \"any\" is provided, it must be the only item in the list. | [optional] [default to null]
|
674
678
|
**head_node_type** | [**ComputeNodeType**](#computenodetype) | Node configuration to use for the head node. | [default to null]
|
675
679
|
**worker_node_types** | [**List[WorkerNodeType]**](#workernodetype) | A list of node types to use for worker nodes. | [optional] [default to null]
|
676
680
|
**aws_advanced_configurations_json** | [**object**](#) | The advanced configuration json that we pass directly AWS APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
677
681
|
**gcp_advanced_configurations_json** | [**object**](#) | The advanced configuration json that we pass directly GCP APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
678
682
|
**advanced_configurations_json** | [**object**](#) | Advanced configurations for this compute node type to pass to the cloud provider when launching this instance. | [optional] [default to null]
|
679
|
-
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
680
683
|
**auto_select_worker_config** | **bool** | If set to true, worker node groups will automatically be selected based on workload. | [optional] [default to false]
|
681
684
|
**flags** | [**object**](#) | A set of advanced cluster-level flags that can be used to configure a particular workload. | [optional] [default to null]
|
682
685
|
**idle_termination_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after the cluster is idle. Idle time is defined as the time during which a Cluster is not running a user command or a Ray driver. Time spent running commands on Jupyter or ssh is still considered 'idle'. To disable, set this field to 0. | [optional] [default to null]
|
683
686
|
|
684
|
-
## ComputeTemplateQuery
|
685
|
-
|
686
|
-
|
687
|
-
Name | Type | Description | Notes
|
688
|
-
------------ | ------------- | ------------- | -------------
|
689
|
-
**orgwide** | **bool** | This option is deprectated. It does nothing. | [optional] [default to false]
|
690
|
-
**project_id** | **str** | | [optional] [default to null]
|
691
|
-
**creator_id** | **str** | Filters Compute Templates by creator. This is only supported when `orgwide` is True. | [optional] [default to null]
|
692
|
-
**name** | [**TextQuery**](#textquery) | Filters Compute Templates by name. If this field is absent, no filtering is done. | [optional] [default to null]
|
693
|
-
**include_anonymous** | **bool** | Whether to include anonymous Compute Templates in the search.Anonymous compute templates are usually not shown in list views. | [optional] [default to false]
|
694
|
-
**archive_status** | [**ArchiveStatus**](#archivestatus) | The archive status to filter by. Defaults to unarchived. | [optional] [default to null]
|
695
|
-
**cloud_id** | **str** | Filters Compute Templates by cloud | [optional] [default to null]
|
696
|
-
**version** | **int** | Filters Compute Templates by version. Versions are positive integers. Setting this field to -1 will return only the latest version of each Compute Template. Setting this field to -2 will not filter by version. Setting version to None is equivalent to setting version to '-1'. | [optional] [default to null]
|
697
|
-
|
698
|
-
## ComputetemplateListResponse
|
699
|
-
|
700
|
-
A list response form the API. Contains a field \"results\" which has the contents of the response.
|
701
|
-
|
702
|
-
Name | Type | Description | Notes
|
703
|
-
------------ | ------------- | ------------- | -------------
|
704
|
-
**results** | [**List[ComputeTemplate]**](#computetemplate) | | [default to null]
|
705
|
-
**metadata** | [**ListResponseMetadata**](#listresponsemetadata) | | [optional] [default to null]
|
706
|
-
|
707
687
|
## ComputetemplateResponse
|
708
688
|
|
709
689
|
A response from the API. Contains a field \"result\" which has the contents of the response.
|
@@ -770,19 +750,6 @@ Name | Type | Description | Notes
|
|
770
750
|
**env_vars** | [**object**](#) | Environment variables in the docker image that will be used at runtime. | [optional] [default to null]
|
771
751
|
**registry_login_secret** | **str** | The name or identifier of a secret containing credentials to authenticate to the docker registry hosting the image. | [optional] [default to null]
|
772
752
|
|
773
|
-
## CreateBuild
|
774
|
-
|
775
|
-
Model used to create a Build.
|
776
|
-
|
777
|
-
Name | Type | Description | Notes
|
778
|
-
------------ | ------------- | ------------- | -------------
|
779
|
-
**application_template_id** | **str** | ID of the App Config this Build belongs to. | [default to null]
|
780
|
-
**config_json** | [**CreateAppConfigConfigurationSchema**](#createappconfigconfigurationschema) | Config JSON to use to create a new Build. | [optional] [default to null]
|
781
|
-
**containerfile** | **str** | The containerfile used to build the image. | [optional] [default to null]
|
782
|
-
**docker_image_name** | **str** | The name of the docker image for this build. | [optional] [default to null]
|
783
|
-
**registry_login_secret** | **str** | The name or identifier of a secret containing credentials to authenticate to the docker registry hosting the image. | [optional] [default to null]
|
784
|
-
**ray_version** | **str** | The Ray version to use for this build. | [optional] [default to null]
|
785
|
-
|
786
753
|
## CreateCloud
|
787
754
|
|
788
755
|
Model used to create a Cloud.
|
@@ -840,7 +807,9 @@ Configuration of compute resources to use for launching a Cluster. Used when cre
|
|
840
807
|
Name | Type | Description | Notes
|
841
808
|
------------ | ------------- | ------------- | -------------
|
842
809
|
**cloud_id** | **str** | The ID of the Anyscale cloud to use for launching Clusters. | [default to null]
|
843
|
-
**
|
810
|
+
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
811
|
+
**deployment_configs** | [**List[CloudDeploymentComputeConfig]**](#clouddeploymentcomputeconfig) | A list of cloud deployment-specific configs to use. | [optional] [default to null]
|
812
|
+
**max_workers** | **int** | DEPRECATED. This attribute will be ignored - please use the \"max_resources\" flag to configure resource limits. | [optional] [default to null]
|
844
813
|
**region** | **str** | Deprecated! When creating a cluster compute, a region does not have to be provided. Instead we will use the value from the cloud. | [optional] [default to USE_CLOUD]
|
845
814
|
**allowed_azs** | **List[str]** | The availability zones that sessions are allowed to be launched in, e.g. \"us-west-2a\". If not specified or \"any\" is provided as the option, any AZ may be used. If \"any\" is provided, it must be the only item in the list. | [optional] [default to null]
|
846
815
|
**head_node_type** | [**ComputeNodeType**](#computenodetype) | Node configuration to use for the head node. | [default to null]
|
@@ -848,7 +817,6 @@ Name | Type | Description | Notes
|
|
848
817
|
**aws_advanced_configurations_json** | [**object**](#) | [DEPRECATED: use advanced_configurations_json instead] The advanced configuration json that we pass directly AWS APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
849
818
|
**gcp_advanced_configurations_json** | [**object**](#) | [DEPRECATED: use advanced_configurations_json instead] The advanced configuration json that we pass directly GCP APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
850
819
|
**advanced_configurations_json** | [**object**](#) | Advanced configurations for this compute node type to pass to the cloud provider when launching this instance. | [optional] [default to null]
|
851
|
-
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
852
820
|
**auto_select_worker_config** | **bool** | If set to true, worker node groups will automatically be selected based on workload. | [optional] [default to false]
|
853
821
|
**flags** | [**object**](#) | A set of advanced cluster-level flags that can be used to configure a particular workload. | [optional] [default to null]
|
854
822
|
**idle_termination_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after the cluster is idle. Idle time is defined as the time during which a Cluster is not running a user command or a Ray driver. Time spent running commands on Jupyter or ssh is still considered 'idle'. To disable, set this field to 0. | [optional] [default to 120]
|
@@ -889,38 +857,6 @@ Name | Type | Description | Notes
|
|
889
857
|
**python** | [**PythonModules**](#pythonmodules) | Python related dependencies. | [optional] [default to null]
|
890
858
|
**post_build_cmds** | **List[str]** | List of post build commands that'll be included in the image. | [optional] [default to null]
|
891
859
|
|
892
|
-
## CreateComputeTemplate
|
893
|
-
|
894
|
-
DEPRECATED: Please use CreateClusterCompute instead.
|
895
|
-
|
896
|
-
Name | Type | Description | Notes
|
897
|
-
------------ | ------------- | ------------- | -------------
|
898
|
-
**name** | **str** | | [optional] [default to null]
|
899
|
-
**project_id** | **str** | | [optional] [default to null]
|
900
|
-
**config** | [**CreateComputeTemplateConfig**](#createcomputetemplateconfig) | | [default to null]
|
901
|
-
**anonymous** | **bool** | An anonymous cluster compute does not show up in the list of cluster configs. They can still have a name so they can be easily identified. | [optional] [default to false]
|
902
|
-
**new_version** | **bool** | If a Compute Template with the same name already exists, create this config as a new version. | [optional] [default to false]
|
903
|
-
|
904
|
-
## CreateComputeTemplateConfig
|
905
|
-
|
906
|
-
DEPRECATED: Please use CreateClusterCompute and the corresponding ClusterComputeConfig instead. Configuration of compute resources to use for launching a session. Used when creating a compute template.
|
907
|
-
|
908
|
-
Name | Type | Description | Notes
|
909
|
-
------------ | ------------- | ------------- | -------------
|
910
|
-
**cloud_id** | **str** | The ID of the Anyscale cloud to use for launching sessions. | [default to null]
|
911
|
-
**max_workers** | **int** | Desired limit on total running workers for this session. | [optional] [default to null]
|
912
|
-
**region** | **str** | The region to launch sessions in, e.g. \"us-west-2\". | [default to null]
|
913
|
-
**allowed_azs** | **List[str]** | The availability zones that sessions are allowed to be launched in, e.g. \"us-west-2a\". If not specified or \"any\" is provided as the option, any AZ may be used. If \"any\" is provided, it must be the only item in the list. | [optional] [default to null]
|
914
|
-
**head_node_type** | [**ComputeNodeType**](#computenodetype) | Node configuration to use for the head node. | [default to null]
|
915
|
-
**worker_node_types** | [**List[WorkerNodeType]**](#workernodetype) | A list of node types to use for worker nodes. | [optional] [default to null]
|
916
|
-
**aws_advanced_configurations_json** | [**object**](#) | The advanced configuration json that we pass directly AWS APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
917
|
-
**gcp_advanced_configurations_json** | [**object**](#) | The advanced configuration json that we pass directly GCP APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
918
|
-
**advanced_configurations_json** | [**object**](#) | Advanced configurations for this compute node type to pass to the cloud provider when launching this instance. | [optional] [default to null]
|
919
|
-
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
920
|
-
**auto_select_worker_config** | **bool** | If set to true, worker node groups will automatically be selected based on workload. | [optional] [default to false]
|
921
|
-
**flags** | [**object**](#) | A set of advanced cluster-level flags that can be used to configure a particular workload. | [optional] [default to null]
|
922
|
-
**idle_termination_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after the cluster is idle. Idle time is defined as the time during which a Cluster is not running a user command or a Ray driver. Time spent running commands on Jupyter or ssh is still considered 'idle'. To disable, set this field to 0. | [optional] [default to 120]
|
923
|
-
|
924
860
|
## CreateJobQueueConfig
|
925
861
|
|
926
862
|
Specifies configuration of the job being added to a Job Queue
|
@@ -1752,11 +1688,12 @@ Name | Type | Description | Notes
|
|
1752
1688
|
**train_metrics_dashboard_url** | **str** | URL for Train Grafana dashboard for this Session. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1753
1689
|
**serve_metrics_dashboard_url** | **str** | URL for Serve Grafana dashboard for this Session. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1754
1690
|
**serve_deployment_metrics_dashboard_url** | **str** | URL for Serve deployment Grafana dashboard for this Session. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1691
|
+
**serve_llm_metrics_dashboard_url** | **str** | URL for Serve LLM Grafana dashboard for this Session. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1755
1692
|
**persistent_metrics_url** | **str** | URL for persistent Grafana (metrics) dashboard for this Session in the non-running cluster state. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1756
1693
|
**connect_url** | **str** | URL for Anyscale connect for this Session. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1757
1694
|
**jupyter_notebook_url** | **str** | URL for Jupyter Lab for this Session. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1758
1695
|
**ray_dashboard_url** | **str** | URL for Ray dashboard for this Session. This field will only be populated after the Session finishes starting. | [optional] [default to null]
|
1759
|
-
**access_token** | **str** |
|
1696
|
+
**access_token** | **str** | [DEPRECATED] Call GET /api/v2/authentication/{cluster_id}/cluster_access_token to get this. | [default to null]
|
1760
1697
|
**service_proxy_url** | **str** | Link to the web services proxy (e.g. jupyter, tensorboard, etc). This field will be populated when the web based services are available after the Session finishes starting. | [optional] [default to null]
|
1761
1698
|
**tensorboard_available** | **bool** | Represents whether Tensorboard is available. | [default to null]
|
1762
1699
|
**cluster_config_last_modified_at** | **datetime** | Time when the cluster config for the Session was last modified. | [default to null]
|
@@ -1777,15 +1714,6 @@ Name | Type | Description | Notes
|
|
1777
1714
|
**idle_termination_status** | [**IdleTerminationStatus**](#idleterminationstatus) | The status of autosuspend | [optional] [default to null]
|
1778
1715
|
**ray_dashboard_snapshot_last_reported_at** | **datetime** | The time of the last snapshot recorded from the ray dashboard | [optional] [default to null]
|
1779
1716
|
|
1780
|
-
## SessionListResponse
|
1781
|
-
|
1782
|
-
A list response form the API. Contains a field \"results\" which has the contents of the response.
|
1783
|
-
|
1784
|
-
Name | Type | Description | Notes
|
1785
|
-
------------ | ------------- | ------------- | -------------
|
1786
|
-
**results** | [**List[Session]**](#session) | | [default to null]
|
1787
|
-
**metadata** | [**ListResponseMetadata**](#listresponsemetadata) | | [optional] [default to null]
|
1788
|
-
|
1789
1717
|
## SessionOperation
|
1790
1718
|
|
1791
1719
|
Describes a long running session operation that will eventually complete.
|
@@ -1854,17 +1782,6 @@ Name | Type | Description | Notes
|
|
1854
1782
|
------------ | ------------- | ------------- | -------------
|
1855
1783
|
**result** | [**SessionOperation**](#sessionoperation) | | [default to null]
|
1856
1784
|
|
1857
|
-
## SessionsQuery
|
1858
|
-
|
1859
|
-
Query model used to filter Cluster. It is exposed in SDK.
|
1860
|
-
|
1861
|
-
Name | Type | Description | Notes
|
1862
|
-
------------ | ------------- | ------------- | -------------
|
1863
|
-
**name** | [**TextQuery**](#textquery) | Filters Cluster by name. If this field is absent, no filtering is done. | [optional] [default to null]
|
1864
|
-
**paging** | [**PageQuery**](#pagequery) | Pagination information. | [optional] [default to null]
|
1865
|
-
**state_filter** | [**List[SessionState]**](#sessionstate) | Filter Cluster by Session State. If this field is an empty set, no filtering is done. | [optional] [default to []]
|
1866
|
-
**creator_id** | **str** | Filters Jobs by creator_id. If this field is absent, no filtering is done. | [optional] [default to null]
|
1867
|
-
|
1868
1785
|
## SortByClauseJobsSortField
|
1869
1786
|
|
1870
1787
|
This model is used in the backend to represent the SQL ORDER BY clauses.
|
@@ -1899,17 +1816,6 @@ Name | Type | Description | Notes
|
|
1899
1816
|
**cluster_compute_id** | **str** | Cluster Compute used to start the Cluster. | [optional] [default to null]
|
1900
1817
|
**allow_public_internet_traffic** | **bool** | Whether public internet traffic can access Serve endpoints or if an authentication token is required. Will not update current value if not provided. | [optional] [default to null]
|
1901
1818
|
|
1902
|
-
## StartSessionOptions
|
1903
|
-
|
1904
|
-
Options to set when starting a session.
|
1905
|
-
|
1906
|
-
Name | Type | Description | Notes
|
1907
|
-
------------ | ------------- | ------------- | -------------
|
1908
|
-
**cluster_config** | **str** | New cluster config to apply to the Session. | [optional] [default to null]
|
1909
|
-
**build_id** | **str** | Build ID to start the session with. | [optional] [default to null]
|
1910
|
-
**compute_template_id** | **str** | Compute template ID to start the session with. | [optional] [default to null]
|
1911
|
-
**allow_public_internet_traffic** | **bool** | Whether public internet traffic can access Serve endpoints or if an authentication token is required. Will not update current value if not provided. | [optional] [default to null]
|
1912
|
-
|
1913
1819
|
## StaticSSOConfig
|
1914
1820
|
|
1915
1821
|
|
@@ -1935,17 +1841,6 @@ Name | Type | Description | Notes
|
|
1935
1841
|
------------ | ------------- | ------------- | -------------
|
1936
1842
|
**take_snapshot** | **bool** | DEPRECATED: Snapshotting is no longer supported.For reproducible environments between clusters, please use Cluster Environments or Runtime Environments. | [optional] [default to false]
|
1937
1843
|
|
1938
|
-
## TerminateSessionOptions
|
1939
|
-
|
1940
|
-
Optional values to set when terminating a Session.
|
1941
|
-
|
1942
|
-
Name | Type | Description | Notes
|
1943
|
-
------------ | ------------- | ------------- | -------------
|
1944
|
-
**workers_only** | **bool** | Only destroy the workers when terminating. | [optional] [default to false]
|
1945
|
-
**keep_min_workers** | **bool** | Retain the minimal amount of workers specified in the config when terminating. | [optional] [default to false]
|
1946
|
-
**delete** | **bool** | Delete the session after terminating. | [optional] [default to false]
|
1947
|
-
**take_snapshot** | **bool** | Takes a snapshot to preserve the state of the session before terminating. The state will be restored the next time the session is started. | [optional] [default to true]
|
1948
|
-
|
1949
1844
|
## TextQuery
|
1950
1845
|
|
1951
1846
|
Query model to filter results based on Text properties (e.g. name, description). Exactly one field should be populated.
|
@@ -2006,35 +1901,6 @@ Name | Type | Description | Notes
|
|
2006
1901
|
**cluster_environment_build_id** | **str** | Cluster Environment Build that this Cluster is using. This property may only be changed if the Cluster is in the Terminated state.Use the Start Cluster operation if you wish to change this for a non-Terminated Cluster. | [optional] [default to null]
|
2007
1902
|
**cluster_compute_id** | **str** | Cluster Compute that this Cluster is using. This property may only be changed if the Cluster is in the Terminated state. Use the Start Cluster operation if you wish to change this for a non-Terminated Cluster. | [optional] [default to null]
|
2008
1903
|
|
2009
|
-
## UpdateComputeTemplate
|
2010
|
-
|
2011
|
-
DEPRECATED: Compute templates are immutable. Please use CreateClusterCompute instead.
|
2012
|
-
|
2013
|
-
Name | Type | Description | Notes
|
2014
|
-
------------ | ------------- | ------------- | -------------
|
2015
|
-
**name** | **str** | | [optional] [default to null]
|
2016
|
-
**config** | [**UpdateComputeTemplateConfig**](#updatecomputetemplateconfig) | | [optional] [default to null]
|
2017
|
-
|
2018
|
-
## UpdateComputeTemplateConfig
|
2019
|
-
|
2020
|
-
DEPRECATED: Compute templates are immutable. Please use CreateClusterCompute and the corresponding ClusterComputeConfig instead. Configuration of compute resources to use for launching a session. Used when updating a compute template.
|
2021
|
-
|
2022
|
-
Name | Type | Description | Notes
|
2023
|
-
------------ | ------------- | ------------- | -------------
|
2024
|
-
**cloud_id** | **str** | The ID of the Anyscale cloud to use for launching sessions. | [default to null]
|
2025
|
-
**max_workers** | **int** | Desired limit on total running workers for this session. | [optional] [default to null]
|
2026
|
-
**region** | **str** | The region to launch sessions in, e.g. \"us-west-2\". | [default to null]
|
2027
|
-
**allowed_azs** | **List[str]** | The availability zones that sessions are allowed to be launched in, e.g. \"us-west-2a\". If not specified or \"any\" is provided as the option, any AZ may be used. If \"any\" is provided, it must be the only item in the list. | [optional] [default to null]
|
2028
|
-
**head_node_type** | [**ComputeNodeType**](#computenodetype) | Node configuration to use for the head node. | [default to null]
|
2029
|
-
**worker_node_types** | [**List[WorkerNodeType]**](#workernodetype) | A list of node types to use for worker nodes. | [optional] [default to null]
|
2030
|
-
**aws_advanced_configurations_json** | [**object**](#) | The advanced configuration json that we pass directly AWS APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
2031
|
-
**gcp_advanced_configurations_json** | [**object**](#) | The advanced configuration json that we pass directly GCP APIs when launching an instance. We may do some validation on this json and reject the json if it is using a configuration that Anyscale does not support. | [optional] [default to null]
|
2032
|
-
**advanced_configurations_json** | [**object**](#) | Advanced configurations for this compute node type to pass to the cloud provider when launching this instance. | [optional] [default to null]
|
2033
|
-
**maximum_uptime_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after cluster start. | [optional] [default to null]
|
2034
|
-
**auto_select_worker_config** | **bool** | If set to true, worker node groups will automatically be selected based on workload. | [optional] [default to false]
|
2035
|
-
**flags** | [**object**](#) | A set of advanced cluster-level flags that can be used to configure a particular workload. | [optional] [default to null]
|
2036
|
-
**idle_termination_minutes** | **int** | If set to a positive number, Anyscale will terminate the cluster this many minutes after the cluster is idle. Idle time is defined as the time during which a Cluster is not running a user command or a Ray driver. Time spent running commands on Jupyter or ssh is still considered 'idle'. To disable, set this field to 0. | [optional] [default to 120]
|
2037
|
-
|
2038
1904
|
## UpdateOrganization
|
2039
1905
|
|
2040
1906
|
Fields to update in the organization.
|
@@ -2052,15 +1918,6 @@ Name | Type | Description | Notes
|
|
2052
1918
|
**cluster_config** | **str** | New cluster config to apply to the Project on update action. | [optional] [default to null]
|
2053
1919
|
**description** | **str** | New description to update in the Project. | [optional] [default to null]
|
2054
1920
|
|
2055
|
-
## UpdateSession
|
2056
|
-
|
2057
|
-
Model for updating a Session. A field will not be updated if its value is absent.
|
2058
|
-
|
2059
|
-
Name | Type | Description | Notes
|
2060
|
-
------------ | ------------- | ------------- | -------------
|
2061
|
-
**cluster_config** | **str** | DEPRECATED: You cannot provide cluster_configs directly to Anyscale clusters. New cluster config to apply to the Session on update action. | [optional] [default to null]
|
2062
|
-
**idle_timeout** | **int** | Idle timeout (in minutes) | [optional] [default to null]
|
2063
|
-
|
2064
1921
|
## UserServiceAccessTypes
|
2065
1922
|
|
2066
1923
|
An enumeration.
|
@@ -205,7 +205,7 @@ class WorkloadConfig(ModelBase):
|
|
205
205
|
ray_version: Optional[str] = field(
|
206
206
|
default=None,
|
207
207
|
metadata={
|
208
|
-
"docstring": "The Ray version (X.Y.Z) specified for this image specified by either an image URI or a containerfile. If
|
208
|
+
"docstring": "The Ray version (X.Y.Z) specified for this image specified by either an image URI or a containerfile. If you don't specify a Ray version, Anyscale defaults to the latest Ray version available at the time of the Anyscale CLI/SDK release."
|
209
209
|
},
|
210
210
|
)
|
211
211
|
|