Document Overview
There is a list of documents about Vald.
Let's try to check the documents that you want to know.
Overview
Overview shows the concept of Vald and mentions the top level design of Vald.
Tutorial
Tutorial takes you Vald World!!!
You can deploy Vald in your Kubernetes cluster and running Vald with sample code.
- Get Started
- Get Started With Faiss Agent
- Vald Agent Standalone on K8s
- Vald Agent Standalone on Docker
- Vald Multicluster on K8s
Usecase
Usecase supports you to imagine how to use Vald for your services.
Also, you can get the introduction examples.
User Guides
If you'd like to configure for your Vald Cluster or wonder how to operate, you can find out the answer from these documents.
- Configuration
- Backup Configuration
- Filtering Configuration
- Mirroring Configuration
- Cluster Role Binding
- Deployment
- Operations
- Upgrade Cluster
- Capacity Planning
- Client Api Config
- Observability Configuration
- Network Policy
- Index Correction
- Sdks
APIs
Vald provides Insert, Update, Upsert, Search, and Delete APIs.
Each API to use with gRPC for request to the Vald Cluster.
Each document describes the definition of API, which helps you to use Vald Official Client.
Troubleshooting
When you encounter any problem, please refer to these documents and try to resolve it.
Contributing
We are welcome to contribute to Vald even not as a developer.
Please make sure, how to contribute to Vald.
Support
When wondering anything about Vald, please contact to us via Slack or Github.