vdaas/vald-agent-sidecar repository overview

⁠Vald Agent Sidecar

vald-agent-sidecar is the docker image for the vald-agent-sidecar component.

This image saves the index metadata files to external storage like Amazon S3 or Google Cloud Storage.

It has 2 main features:

1. Backup
   • When Agent completes creating the index metadata files, Sidecar hooks to store them in the external storage.
2. Restore
   • When the Vald Agent Pod restarts, the index structure on the vald-agent component is restored from the external backup files.

For more details, please refer to the component document⁠.

⁠Requirement

⁠linux/amd64

• Image: vald-agent-ngt
• External components: Amazon S3 or Google Cloud Storage

⁠linux/arm64

• Image: vald-agent-ngt
• External components: Amazon S3 or Google Cloud Storage

⁠Get Started

vald-agent-sidecar is used for one of the components of the Vald cluster, which means it should be used on the Kubernetes cluster, not the local environment or Docker.

Please refer to the Get Started⁠ for deploying the Vald cluster and Backup configuration⁠ to enable the backup feature.

⁠Versions

⁠Dockerfile

The Dockerfile of this image is here⁠.

⁠About Vald Project

The information about the Vald project, please refer to the following:

• Official website⁠
• GitHub⁠

⁠Contacts

We're love to support you! Please feel free to contact us anytime with your questions or issue reports.

• Official Slack WS⁠
• GitHub Issue⁠

⁠License

This product is under the terms of the Apache License v2.0; refer LICENSE⁠ file.