Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

vald

module

v0.0.17 Latest Latest Go to latest Published: Feb 26, 2020 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/vdaas/vald

Links

Open Source Insights

README ¶

vald is high scalable distributed high-speed approximate nearest neighbor search engine

Requirement

kubernetes 1.12~

Installation

helm repo add vald https://vald.vdaas.org/charts
helm install --generate-name vald/vald

If you use the default values.yaml, the nightly images will be installed.

Docker image tagging policy

nightly ... latest build of master branch
vX.X.X ... released versions
latest ... latest build of release versions
stable ... latest long-term supported version

Example

Write example here

Architecture Overview

Development

Before your first commit to this repository, it is strongly recommended to run the commands below.

make init

Contribution

Please read the contribution guide

Author

Contributor

hlts2

LICENSE

vald released under Apache 2.0 license, refer LICENSE file.

component	implementation	Docker name	Docker build status
agent	NGT	vdaas/vald-agent-ngt
discoverer	K8s	vdaas/vald-discoverer-k8s
gateway		vdaas/vald-gateway
backup manager	MySQL	vdaas/vald-manager-backup-mysql
backup manager	Cassandra	vdaas/vald-manager-backup-cassandra
compressor		vdaas/vald-manager-compressor
meta	Redis	vdaas/vald-meta-redis
meta	Cassandra	vdaas/vald-meta-cassandra
index manager		vdaas/vald-manager-index

Directories ¶

Path	Synopsis
apis module
grpc/agent
grpc/discoverer
grpc/errors
grpc/filter/egress
grpc/filter/ingress
grpc/gateway/vald
grpc/manager/backup
grpc/manager/compressor
grpc/manager/index
grpc/manager/replication
grpc/manager/traffic
grpc/meta
grpc/payload
cmd
agent/ngt Package main provides program main	Package main provides program main
cli/vdctl
discoverer/k8s Package main provides program main	Package main provides program main
gateway/vald Package main provides program main	Package main provides program main
manager/backup/cassandra Package main provides program main	Package main provides program main
manager/backup/mysql Package main provides program main	Package main provides program main
manager/compressor Package main provides program main	Package main provides program main
manager/index Package main provides program main	Package main provides program main
meta/cassandra Package main provides program main	Package main provides program main
meta/redis Package main provides program main	Package main provides program main
example
client Module
hack
benchmark/e2e/internal
benchmark/internal/assets
benchmark/metrics
license/gen
swagger
tools/config/agent/ngt
tools/config/discoverer/k8s
tools/config/gateway/vald
tools/config/manager/backup/mysql
tools/config/meta/redis
tools/metrics
internal
backoff Package backoff provides backoff function controller Package backoff provides backoff function controller	Package backoff provides backoff function controller Package backoff provides backoff function controller
cache Package cache provides implementation of cache Package cache provides implementation of cache	Package cache provides implementation of cache Package cache provides implementation of cache
cache/cacher Package cacher provides implementation of cache type definition	Package cacher provides implementation of cache type definition
cache/gache Package gache provides implementation of cache using gache Package gache provides implementation of cache using gache	Package gache provides implementation of cache using gache Package gache provides implementation of cache using gache
client/discoverer Package discoverer Package discoverer	Package discoverer Package discoverer
compress Package compress provides compressor interface Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions	Package compress provides compressor interface Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions Package compress provides compress functions
config Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic	Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic Package config providers configuration type and load configuration logic
core/converter/tensorflow Package tensorflow provides implementation of Go API for extract data to vector Package tensorflow provides implementation of Go API for extract data to vector	Package tensorflow provides implementation of Go API for extract data to vector Package tensorflow provides implementation of Go API for extract data to vector
core/ngt Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT	Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT Package ngt provides implementation of Go API for https://github.com/yahoojapan/NGT
db/kvs/redis Package redis provides implementation of Go API for redis interface	Package redis provides implementation of Go API for redis interface
db/nosql/cassandra Package redis provides implementation of Go API for redis interface	Package redis provides implementation of Go API for redis interface
db/rdb/mysql
errgroup Package errgroup provides server global wait group for graceful kill all goroutine	Package errgroup provides server global wait group for graceful kill all goroutine
errors Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function	Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function Package errors provides error types and function
info Package info provides build-time info	Package info provides build-time info
k8s Package k8s provides kubernetes control functionality Package k8s provides kubernetes control functionality	Package k8s provides kubernetes control functionality Package k8s provides kubernetes control functionality
k8s/metrics/node Package node provides kubernetes node information and preriodically update Package node provides kubernetes node information and preriodically update	Package node provides kubernetes node information and preriodically update Package node provides kubernetes node information and preriodically update
k8s/metrics/pod Package pod provides kubernetes pod information and preriodically update Package pod provides kubernetes pod information and preriodically update	Package pod provides kubernetes pod information and preriodically update Package pod provides kubernetes pod information and preriodically update
k8s/node Package node provides kubernetes node information and preriodically update Package node provides kubernetes node information and preriodically update	Package node provides kubernetes node information and preriodically update Package node provides kubernetes node information and preriodically update
k8s/pod Package pod provides kubernetes pod information and preriodically update Package pod provides kubernetes pod information and preriodically update	Package pod provides kubernetes pod information and preriodically update Package pod provides kubernetes pod information and preriodically update
log
log/format
log/glg
log/level
log/logger
log/mock
log/retry
net/grpc Package grpc provides generic functionality for grpc Package grpc provides generic functionality for grpc Package grpc provides generic functionality for grpc Package grpc provides generic functionality for grpc	Package grpc provides generic functionality for grpc Package grpc provides generic functionality for grpc Package grpc provides generic functionality for grpc Package grpc provides generic functionality for grpc
net/grpc/status Package status provides statuses and errors returned by grpc handler functions	Package status provides statuses and errors returned by grpc handler functions
net/http/dump Package dump provides http request/response dump logic	Package dump provides http request/response dump logic
net/http/json
net/http/metrics Package metrics provides pprof profiler handler	Package metrics provides pprof profiler handler
net/http/middleware Package middleware provides rest.Func Middleware Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func Package middleware provides rest.Func Middleware	Package middleware provides rest.Func Middleware Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func Package middleware provides rest.Func Middleware
net/http/rest Package rest provides REST API common logic & variable	Package rest provides REST API common logic & variable
net/http/routing Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func	Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func Package routing provides implementation of Go API for routing http Handler wrapped by rest.Func
net/http/transport Package transport provides http transport roundtrip option Package transport provides http transport roundtrip option	Package transport provides http transport roundtrip option Package transport provides http transport roundtrip option
net/tcp Package tcp provides tcp option Package tcp provides tcp option Package tcp provides tcp option	Package tcp provides tcp option Package tcp provides tcp option Package tcp provides tcp option
params Package params provides implementation of Go API for argument parser Package params provides implementation of Go API for argument parser	Package params provides implementation of Go API for argument parser Package params provides implementation of Go API for argument parser
rand Package rand provides random number algorithms	Package rand provides random number algorithms
runner Package runner provides implementation of process runner	Package runner provides implementation of process runner
safety Package safety provides safety functionality like revcover	Package safety provides safety functionality like revcover
servers Package servers provides implementation of Go API for managing server flow Package servers provides implementation of Go API for managing server flow	Package servers provides implementation of Go API for managing server flow Package servers provides implementation of Go API for managing server flow
servers/server Package servers provides implementation of Go API for managing server flow Package server provides implementation of Go API for managing server flow	Package servers provides implementation of Go API for managing server flow Package server provides implementation of Go API for managing server flow
servers/starter Package starter provides server startup and shutdown flow control Package starter provides server startup and shutdown flow control	Package starter provides server startup and shutdown flow control Package starter provides server startup and shutdown flow control
timeutil
timeutil/location
tls Package tls provides implementation of Go API for tls certificate provider Package tls provides implementation of Go API for tls certificate provider	Package tls provides implementation of Go API for tls certificate provider Package tls provides implementation of Go API for tls certificate provider
version Package version provides version comparison functionality	Package version provides version comparison functionality
pkg
agent/ngt/config Package setting stores all server application settings	Package setting stores all server application settings
agent/ngt/handler
agent/ngt/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
agent/ngt/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
agent/ngt/model Package model defines object structure	Package model defines object structure
agent/ngt/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
agent/ngt/service Package service manages the main logic of server.	Package service manages the main logic of server.
agent/ngt/service/kvs
agent/ngt/usecase
discoverer/k8s/config Package setting stores all server application settings	Package setting stores all server application settings
discoverer/k8s/handler
discoverer/k8s/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
discoverer/k8s/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
discoverer/k8s/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
discoverer/k8s/service Package service manages the main logic of server.	Package service manages the main logic of server.
discoverer/k8s/usecase
gateway/vald/config Package setting stores all server application settings	Package setting stores all server application settings
gateway/vald/handler
gateway/vald/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
gateway/vald/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
gateway/vald/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
gateway/vald/service Package service Package service manages the main logic of server.	Package service Package service manages the main logic of server.
gateway/vald/usecase
manager/backup/cassandra/config Package setting stores all server application settings	Package setting stores all server application settings
manager/backup/cassandra/handler
manager/backup/cassandra/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
manager/backup/cassandra/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
manager/backup/cassandra/model Package grpc provides grpc server logic	Package grpc provides grpc server logic
manager/backup/cassandra/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
manager/backup/cassandra/service Package service manages the main logic of server.	Package service manages the main logic of server.
manager/backup/cassandra/usecase
manager/backup/mysql/config Package setting stores all server application settings	Package setting stores all server application settings
manager/backup/mysql/handler
manager/backup/mysql/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
manager/backup/mysql/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
manager/backup/mysql/model Package grpc provides grpc server logic	Package grpc provides grpc server logic
manager/backup/mysql/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
manager/backup/mysql/service Package service manages the main logic of server.	Package service manages the main logic of server.
manager/backup/mysql/usecase
manager/compressor/config Package setting stores all server application settings	Package setting stores all server application settings
manager/compressor/handler
manager/compressor/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
manager/compressor/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
manager/compressor/model Package grpc provides grpc server logic	Package grpc provides grpc server logic
manager/compressor/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
manager/compressor/service Package service Package service Package service manages the main logic of server.	Package service Package service Package service manages the main logic of server.
manager/compressor/usecase
manager/index/config Package setting stores all server application settings	Package setting stores all server application settings
manager/index/handler
manager/index/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
manager/index/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
manager/index/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
manager/index/service Package service manages the main logic of server.	Package service manages the main logic of server.
manager/index/usecase
meta/cassandra/config Package setting stores all server application settings	Package setting stores all server application settings
meta/cassandra/handler
meta/cassandra/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
meta/cassandra/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
meta/cassandra/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
meta/cassandra/service Package service manages the main logic of server.	Package service manages the main logic of server.
meta/cassandra/usecase
meta/redis/config Package setting stores all server application settings	Package setting stores all server application settings
meta/redis/handler
meta/redis/handler/grpc Package grpc provides grpc server logic Package grpc provides grpc server logic	Package grpc provides grpc server logic Package grpc provides grpc server logic
meta/redis/handler/rest Package rest provides rest api logic Package rest provides rest api logic	Package rest provides rest api logic Package rest provides rest api logic
meta/redis/router Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func	Package router provides implementation of Go API for routing http Handler wrapped by rest.Func Package router provides implementation of Go API for routing http Handler wrapped by rest.Func
meta/redis/service Package service manages the main logic of server.	Package service manages the main logic of server.
meta/redis/usecase