https://github.com/fluid-cloudnative/fluid-client-python
Fluid Python Client
https://github.com/fluid-cloudnative/fluid-client-python
Last synced: about 1 month ago
JSON representation
Fluid Python Client
- Host: GitHub
- URL: https://github.com/fluid-cloudnative/fluid-client-python
- Owner: fluid-cloudnative
- License: apache-2.0
- Created: 2021-05-17T05:51:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T03:44:55.000Z (4 months ago)
- Last Synced: 2025-03-28T11:01:31.268Z (about 2 months ago)
- Language: Python
- Size: 646 KB
- Stars: 2
- Watchers: 5
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fluid Python SDK
Fluid SDK in Python
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
## Requirements.
- Python >= 3.7
## Installation & Usage
### pip install
```sh
pip install fluid-pysdk
```
(you may need to run `pip` with root permission: `sudo pip install fluid-pysdk`)
## Getting Started
Fluid Python SDK provides two types of "client SDK" for users with different expertises and preference.
- `fluid.FluidClient` (the recommended one) provides a more Pythonic interface with polished user experience.
- `fluid.FluidK8sClient` provides a low-level YAML-style interface for those who have rich experience in Kubernetes.
The following shows the same code example using two types of client SDK. The example simply creates a dataset and get its status.
### with `fluid.FluidClient`
```python
import logging
import sys
from fluid import FluidClient, ClientConfig
logger = logging.getLogger("fluidsdk")
stream_handler = logging.StreamHandler(sys.stdout)
stream_handler.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
logger.addHandler(stream_handler)
logger.setLevel(logging.INFO)
def main():
name = "demo"
namespace = "default"
client_config = ClientConfig(namespace=namespace)
fluid_client = FluidClient(client_config)
try:
fluid_client.create_dataset(name, "hbase", "https://mirrors.tuna.tsinghua.edu.cn/apache/hbase/stable/", "/")
except Exception as e:
raise RuntimeError(f"Failed to create dataset: {e}")
logger.info(f"Dataset \"{namespace}/{name}\" created successfully")
try:
dataset = fluid_client.get_dataset(name, namespace)
except Exception as e:
raise RuntimeError(f"Error when getting dataset \"{namespace}/{name}\": {e}")
else:
logger.info(f"Dataset \"{namespace}/{name}\"'s phase is: {dataset.report_status(status_type='binding_status')['phase']}")
if __name__ == '__main__':
main()
```
### with `fluid.FluidK8sClient`
```python
import logging
import sys
from kubernetes import client
from fluid import FluidK8sClient
from fluid import constants
from fluid import models
logger = logging.getLogger("fluidsdk")
stream_handler = logging.StreamHandler(sys.stdout)
stream_handler.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
logger.addHandler(stream_handler)
logger.setLevel(logging.INFO)
# Output detailed debug message for fluidsdk
# logger.setLevel(logging.DEBUG)
def main():
fluid_client = FluidK8sClient()
name = "demo"
namespace = "default"
dataset = models.Dataset(
api_version=constants.API_VERSION,
kind=constants.DATASET_KIND,
metadata=client.V1ObjectMeta(
name=name,
namespace=namespace
),
spec=models.DatasetSpec(
mounts=[
models.Mount(
mount_point="https://mirrors.tuna.tsinghua.edu.cn/apache/hbase/stable/",
name="hbase",
path="/",
)
]
)
)
try:
fluid_client.create_dataset(dataset)
except Exception as e:
raise RuntimeError(f"Failed to create dataset: {e}")
logger.info(f"Dataset \"{dataset.metadata.namespace}/{dataset.metadata.name}\" created successfully")
try:
dataset = fluid_client.get_dataset(name, namespace)
except Exception as e:
raise RuntimeError(f"Error when getting dataset \"{namespace}/{name}\": {e}")
assert type(dataset) == models.Dataset
logger.info(f"Dataset \"{namespace}/{name}\"'s phase is: {dataset.status.phase}")
if __name__ == '__main__':
main()
```
## Versioning
Fluid Python SDK's version **ALWAYS** follows the Fluid's version as long as they share the fully compatible APIs. For example, if a released version of Fluid is v1.0.1, Fluid Python SDK with version prefix "v1.0.1" is guaranteed to have
same APIs as the released Fluid version.
Fluid Python SDK may have "post" version that updates the inner code but keep the APIs untouched (e.g. hotfixes). For example, "v1.0.1.post1" is a post version of "v1.0.1" which includes the latest
changes.
## Documentation For Models
- [APIGatewayStatus](docs/APIGatewayStatus.md)
- [AlluxioCompTemplateSpec](docs/AlluxioCompTemplateSpec.md)
- [AlluxioFuseSpec](docs/AlluxioFuseSpec.md)
- [AlluxioRuntime](docs/AlluxioRuntime.md)
- [AlluxioRuntimeList](docs/AlluxioRuntimeList.md)
- [AlluxioRuntimeSpec](docs/AlluxioRuntimeSpec.md)
- [CacheableNodeAffinity](docs/CacheableNodeAffinity.md)
- [CleanCachePolicy](docs/CleanCachePolicy.md)
- [Condition](docs/Condition.md)
- [Data](docs/Data.md)
- [DataBackup](docs/DataBackup.md)
- [DataBackupList](docs/DataBackupList.md)
- [DataBackupSpec](docs/DataBackupSpec.md)
- [DataLoad](docs/DataLoad.md)
- [DataLoadList](docs/DataLoadList.md)
- [DataLoadSpec](docs/DataLoadSpec.md)
- [DataMigrate](docs/DataMigrate.md)
- [DataMigrateList](docs/DataMigrateList.md)
- [DataMigrateSpec](docs/DataMigrateSpec.md)
- [DataProcess](docs/DataProcess.md)
- [DataProcessList](docs/DataProcessList.md)
- [DataProcessSpec](docs/DataProcessSpec.md)
- [DataRestoreLocation](docs/DataRestoreLocation.md)
- [DataToMigrate](docs/DataToMigrate.md)
- [Dataset](docs/Dataset.md)
- [DatasetCondition](docs/DatasetCondition.md)
- [DatasetList](docs/DatasetList.md)
- [DatasetSpec](docs/DatasetSpec.md)
- [DatasetStatus](docs/DatasetStatus.md)
- [DatasetToMigrate](docs/DatasetToMigrate.md)
- [EFCCompTemplateSpec](docs/EFCCompTemplateSpec.md)
- [EFCFuseSpec](docs/EFCFuseSpec.md)
- [EFCRuntime](docs/EFCRuntime.md)
- [EFCRuntimeList](docs/EFCRuntimeList.md)
- [EFCRuntimeSpec](docs/EFCRuntimeSpec.md)
- [EncryptOption](docs/EncryptOption.md)
- [EncryptOptionSource](docs/EncryptOptionSource.md)
- [ExternalEndpointSpec](docs/ExternalEndpointSpec.md)
- [ExternalStorage](docs/ExternalStorage.md)
- [GooseFSCompTemplateSpec](docs/GooseFSCompTemplateSpec.md)
- [GooseFSFuseSpec](docs/GooseFSFuseSpec.md)
- [GooseFSRuntime](docs/GooseFSRuntime.md)
- [GooseFSRuntimeList](docs/GooseFSRuntimeList.md)
- [GooseFSRuntimeSpec](docs/GooseFSRuntimeSpec.md)
- [HCFSStatus](docs/HCFSStatus.md)
- [InitFuseSpec](docs/InitFuseSpec.md)
- [InitUsersSpec](docs/InitUsersSpec.md)
- [JindoCompTemplateSpec](docs/JindoCompTemplateSpec.md)
- [JindoFuseSpec](docs/JindoFuseSpec.md)
- [JindoRuntime](docs/JindoRuntime.md)
- [JindoRuntimeList](docs/JindoRuntimeList.md)
- [JindoRuntimeSpec](docs/JindoRuntimeSpec.md)
- [JobProcessor](docs/JobProcessor.md)
- [JuiceFSCompTemplateSpec](docs/JuiceFSCompTemplateSpec.md)
- [JuiceFSFuseSpec](docs/JuiceFSFuseSpec.md)
- [JuiceFSRuntime](docs/JuiceFSRuntime.md)
- [JuiceFSRuntimeList](docs/JuiceFSRuntimeList.md)
- [JuiceFSRuntimeSpec](docs/JuiceFSRuntimeSpec.md)
- [Level](docs/Level.md)
- [MasterSpec](docs/MasterSpec.md)
- [Metadata](docs/Metadata.md)
- [MetadataSyncPolicy](docs/MetadataSyncPolicy.md)
- [Mount](docs/Mount.md)
- [OSAdvise](docs/OSAdvise.md)
- [OperationRef](docs/OperationRef.md)
- [OperationStatus](docs/OperationStatus.md)
- [PodMetadata](docs/PodMetadata.md)
- [Processor](docs/Processor.md)
- [Runtime](docs/Runtime.md)
- [RuntimeCondition](docs/RuntimeCondition.md)
- [RuntimeManagement](docs/RuntimeManagement.md)
- [RuntimeStatus](docs/RuntimeStatus.md)
- [ScriptProcessor](docs/ScriptProcessor.md)
- [SecretKeySelector](docs/SecretKeySelector.md)
- [TargetDataset](docs/TargetDataset.md)
- [TargetDatasetWithMountPath](docs/TargetDatasetWithMountPath.md)
- [TargetPath](docs/TargetPath.md)
- [ThinCompTemplateSpec](docs/ThinCompTemplateSpec.md)
- [ThinFuseSpec](docs/ThinFuseSpec.md)
- [ThinRuntime](docs/ThinRuntime.md)
- [ThinRuntimeList](docs/ThinRuntimeList.md)
- [ThinRuntimeProfile](docs/ThinRuntimeProfile.md)
- [ThinRuntimeProfileList](docs/ThinRuntimeProfileList.md)
- [ThinRuntimeProfileSpec](docs/ThinRuntimeProfileSpec.md)
- [ThinRuntimeSpec](docs/ThinRuntimeSpec.md)
- [TieredStore](docs/TieredStore.md)
- [User](docs/User.md)
- [VersionSpec](docs/VersionSpec.md)
- [VineyardCompTemplateSpec](docs/VineyardCompTemplateSpec.md)
- [VineyardRuntime](docs/VineyardRuntime.md)
- [VineyardRuntimeList](docs/VineyardRuntimeList.md)
- [VineyardRuntimeSpec](docs/VineyardRuntimeSpec.md)
- [VineyardSockSpec](docs/VineyardSockSpec.md)
- [VolumeSource](docs/VolumeSource.md)
- [WaitingStatus](docs/WaitingStatus.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author