Skip to content

Commit 7c405d1

Browse files
committed
Update open api
Signed-off-by: trafalgarzzz <trafalgarz@outlook.com>
1 parent b4bc87a commit 7c405d1

19 files changed

+102
-42
lines changed

docs/DataMigrateSpec.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ Name | Type | Description | Notes
1010
**image** | **str** | Image (e.g. alluxio/alluxio) | [optional]
1111
**image_pull_policy** | **str** | One of the three policies: &#x60;Always&#x60;, &#x60;IfNotPresent&#x60;, &#x60;Never&#x60; | [optional]
1212
**image_tag** | **str** | Image tag (e.g. 2.3.0-SNAPSHOT) | [optional]
13-
**node_selector** | **dict(str, str)** | NodeSelector defiens node selector for DataLoad pod | [optional]
13+
**node_selector** | **dict(str, str)** | NodeSelector defiens node selector for DataMigrate pod | [optional]
1414
**options** | **dict(str, str)** | options for migrate, different for each runtime | [optional]
15+
**parallel_options** | **dict(str, str)** | ParallelOptions defines options like ssh port and ssh secret name when parallelism is greater than 1. | [optional]
16+
**parallelism** | **int** | Parallelism defines the parallelism tasks numbers for DataMigrate. If the value is greater than 1, the job acts as a launcher, and users should define the WorkerSpec. | [optional]
1517
**pod_metadata** | [**PodMetadata**](PodMetadata.md) | | [optional]
1618
**policy** | **str** | policy for migrate, including Once, Cron, OnEvent | [optional]
1719
**resources** | [**V1ResourceRequirements**](V1ResourceRequirements.md) | | [optional]
1820
**run_after** | [**OperationRef**](OperationRef.md) | | [optional]
1921
**runtime_type** | **str** | using which runtime to migrate data; if none, take dataset runtime as default | [optional]
2022
**schedule** | **str** | The schedule in Cron format, only set when policy is cron, see https://en.wikipedia.org/wiki/Cron. | [optional]
21-
**scheduler_name** | **str** | SchedulerName sets the scheduler to be used for DataLoad pod | [optional]
23+
**scheduler_name** | **str** | SchedulerName sets the scheduler to be used for DataMigrate pod | [optional]
2224
**to** | [**DataToMigrate**](DataToMigrate.md) | |
23-
**tolerations** | [**list[V1Toleration]**](V1Toleration.md) | Tolerations defines tolerations for DataLoad pod | [optional]
25+
**tolerations** | [**list[V1Toleration]**](V1Toleration.md) | Tolerations defines tolerations for DataMigrate pod | [optional]
2426
**ttl_seconds_after_finished** | **int** | TTLSecondsAfterFinished is the time second to clean up data operations after finished or failed | [optional]
2527

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

docs/DatasetSpec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**access_modes** | **list[str]** | AccessModes contains all ways the volume backing the PVC can be mounted | [optional]
88
**data_restore_location** | [**DataRestoreLocation**](DataRestoreLocation.md) | | [optional]
9-
**mounts** | [**list[Mount]**](Mount.md) | Mount Points to be mounted on Alluxio. |
9+
**mounts** | [**list[Mount]**](Mount.md) | Mount Points to be mounted on cache runtime. &lt;br&gt; This field can be empty because some runtimes don&#39;t need to mount external storage (e.g. &lt;a href&#x3D;\&quot;https://v6d.io/\&quot;&gt;Vineyard&lt;/a&gt;). | [optional]
1010
**node_affinity** | [**CacheableNodeAffinity**](CacheableNodeAffinity.md) | | [optional]
1111
**owner** | [**User**](User.md) | | [optional]
1212
**placement** | **str** | Manage switch for opening Multiple datasets single node deployment or not | [optional]

docs/EncryptOption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | The name of encryptOption | [optional]
6+
**name** | **str** | The name of encryptOption | [default to '']
77
**value_from** | [**EncryptOptionSource**](EncryptOptionSource.md) | | [optional]
88

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

docs/ExternalEndpointSpec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ExternalEndpointSpec defines the configurations for external etcd cluster
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**encrypt_options** | [**list[EncryptOption]**](EncryptOption.md) | encrypt info for accessing the external etcd cluster | [optional]
8-
**options** | **dict(str, str)** | Configurable options for External Etcd cluster. Support the following options. etcd.prefix: (String) the prefix of etcd key for vineyard objects Default value is as follows. etcd.prefix: \&quot;/vineyard\&quot; | [optional]
8+
**options** | **dict(str, str)** | Configurable options for External Etcd cluster. | [optional]
99
**uri** | **str** | URI specifies the endpoint of external Etcd cluster E,g. \&quot;etcd-svc.etcd-namespace.svc.cluster.local:2379\&quot; Default is not set and use http protocol to connect to external etcd cluster | [optional] [default to '']
1010

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

docs/MasterSpec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Name | Type | Description | Notes
1010
**image_pull_policy** | **str** | The image pull policy of Vineyard component. Default is &#x60;IfNotPresent&#x60;. | [optional]
1111
**image_tag** | **str** | The image tag of Vineyard component. For Master, the default image tag is &#x60;3.5.10&#x60;. For Worker, the default image tag is &#x60;latest&#x60;. | [optional]
1212
**node_selector** | **dict(str, str)** | NodeSelector is a selector to choose which nodes to launch the Vineyard component. E,g. {\&quot;disktype\&quot;: \&quot;ssd\&quot;} | [optional]
13-
**options** | **dict(str, str)** | Configurable options for Vineyard component. For Master, there is no configurable options. For Worker, support the following options. vineyardd.reserve.memory: (Bool) where to reserve memory for vineyardd If set to true, the memory quota will be counted to the vineyardd rather than the application. etcd.prefix: (String) the prefix of etcd key for vineyard objects Default value is as follows. vineyardd.reserve.memory: \&quot;true\&quot; etcd.prefix: \&quot;/vineyard\&quot; | [optional]
14-
**ports** | **dict(str, int)** | Ports used by Vineyard component. For Master, the default client port is 2379 and peer port is 2380. For Worker, the default rpc port is 9600. | [optional]
13+
**options** | **dict(str, str)** | Configurable options for Vineyard component. For Master, there is no configurable options. For Worker, support the following options. vineyardd.reserve.memory: (Bool) where to reserve memory for vineyardd If set to true, the memory quota will be counted to the vineyardd rather than the application. etcd.prefix: (String) the prefix of etcd key for vineyard objects wait.etcd.timeout: (String) the timeout period before waiting the etcd to be ready, in seconds Default value is as follows. vineyardd.reserve.memory: \&quot;true\&quot; etcd.prefix: \&quot;/vineyard\&quot; wait.etcd.timeout: \&quot;120\&quot; | [optional]
14+
**ports** | **dict(str, int)** | Ports used by Vineyard component. For Master, the default client port is 2379 and peer port is 2380. For Worker, the default rpc port is 9600 and the default exporter port is 9144. | [optional]
1515
**replicas** | **int** | The replicas of Vineyard component. If not specified, defaults to 1. For worker, the replicas should not be greater than the number of nodes in the cluster | [optional]
1616
**resources** | [**V1ResourceRequirements**](V1ResourceRequirements.md) | | [optional]
1717
**volume_mounts** | [**list[V1VolumeMount]**](V1VolumeMount.md) | VolumeMounts specifies the volumes listed in \&quot;.spec.volumes\&quot; to mount into the vineyard runtime component&#39;s filesystem. It is useful for specifying a persistent storage. Default is not set. | [optional]

docs/Mount.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Mount describes a mounting. <br> Refer to <a href=\"https://docs.alluxio.io/os/u
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**encrypt_options** | [**list[EncryptOption]**](EncryptOption.md) | The secret information | [optional]
8-
**mount_point** | **str** | MountPoint is the mount point of source. | [optional]
8+
**mount_point** | **str** | MountPoint is the mount point of source. | [default to '']
99
**name** | **str** | The name of mount | [optional]
1010
**options** | **dict(str, str)** | The Mount Options. &lt;br&gt; Refer to &lt;a href&#x3D;\&quot;https://docs.alluxio.io/os/user/stable/en/reference/Properties-List.html\&quot;&gt;Mount Options&lt;/a&gt;. &lt;br&gt; The option has Prefix &#39;fs.&#39; And you can Learn more from &lt;a href&#x3D;\&quot;https://docs.alluxio.io/os/user/stable/en/ufs/S3.html\&quot;&gt;The Storage Integrations&lt;/a&gt; | [optional]
1111
**path** | **str** | The path of mount, if not set will be /{Name} | [optional]

docs/SecretKeySelector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**key** | **str** | The required key in the secret | [optional]
7-
**name** | **str** | The name of required secret | [optional]
7+
**name** | **str** | The name of required secret | [default to '']
88

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

docs/VineyardCompTemplateSpec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
99
**image_pull_policy** | **str** | The image pull policy of Vineyard component. Default is &#x60;IfNotPresent&#x60;. | [optional]
1010
**image_tag** | **str** | The image tag of Vineyard component. For Master, the default image tag is &#x60;3.5.10&#x60;. For Worker, the default image tag is &#x60;latest&#x60;. | [optional]
1111
**node_selector** | **dict(str, str)** | NodeSelector is a selector to choose which nodes to launch the Vineyard component. E,g. {\&quot;disktype\&quot;: \&quot;ssd\&quot;} | [optional]
12-
**options** | **dict(str, str)** | Configurable options for Vineyard component. For Master, there is no configurable options. For Worker, support the following options. vineyardd.reserve.memory: (Bool) where to reserve memory for vineyardd If set to true, the memory quota will be counted to the vineyardd rather than the application. etcd.prefix: (String) the prefix of etcd key for vineyard objects Default value is as follows. vineyardd.reserve.memory: \&quot;true\&quot; etcd.prefix: \&quot;/vineyard\&quot; | [optional]
13-
**ports** | **dict(str, int)** | Ports used by Vineyard component. For Master, the default client port is 2379 and peer port is 2380. For Worker, the default rpc port is 9600. | [optional]
12+
**options** | **dict(str, str)** | Configurable options for Vineyard component. For Master, there is no configurable options. For Worker, support the following options. vineyardd.reserve.memory: (Bool) where to reserve memory for vineyardd If set to true, the memory quota will be counted to the vineyardd rather than the application. etcd.prefix: (String) the prefix of etcd key for vineyard objects wait.etcd.timeout: (String) the timeout period before waiting the etcd to be ready, in seconds Default value is as follows. vineyardd.reserve.memory: \&quot;true\&quot; etcd.prefix: \&quot;/vineyard\&quot; wait.etcd.timeout: \&quot;120\&quot; | [optional]
13+
**ports** | **dict(str, int)** | Ports used by Vineyard component. For Master, the default client port is 2379 and peer port is 2380. For Worker, the default rpc port is 9600 and the default exporter port is 9144. | [optional]
1414
**replicas** | **int** | The replicas of Vineyard component. If not specified, defaults to 1. For worker, the replicas should not be greater than the number of nodes in the cluster | [optional]
1515
**resources** | [**V1ResourceRequirements**](V1ResourceRequirements.md) | | [optional]
1616
**volume_mounts** | [**list[V1VolumeMount]**](V1VolumeMount.md) | VolumeMounts specifies the volumes listed in \&quot;.spec.volumes\&quot; to mount into the vineyard runtime component&#39;s filesystem. It is useful for specifying a persistent storage. Default is not set. | [optional]

docs/VineyardRuntime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# VineyardRuntime
22

3-
VineyardRuntime is the Schema for the vineyardruntimes API
3+
VineyardRuntime is the Schema for the VineyardRuntimes API
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------

docs/VineyardRuntimeSpec.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**disable_prometheus** | **bool** | Disable monitoring metrics for Vineyard Runtime Default is false | [optional]
88
**fuse** | [**VineyardSockSpec**](VineyardSockSpec.md) | | [optional]
99
**master** | [**MasterSpec**](MasterSpec.md) | | [optional]
10+
**replicas** | **int** | The replicas of the worker, need to be specified If worker.replicas and the field are both specified, the field will be respected | [optional]
1011
**tieredstore** | [**TieredStore**](TieredStore.md) | | [optional]
1112
**volumes** | [**list[V1Volume]**](V1Volume.md) | Volumes is the list of Kubernetes volumes that can be mounted by the vineyard components (Master and Worker). Default is null. | [optional]
1213
**worker** | [**VineyardCompTemplateSpec**](VineyardCompTemplateSpec.md) | | [optional]

0 commit comments

Comments
 (0)