README
¶
vine
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
client
|
|
|
api
Package api is an API Gateway
|
Package api is an API Gateway |
|
bot
Package bot is a Hubot style bot that sits a vineservice environment
|
Package bot is a Hubot style bot that sits a vineservice environment |
|
cli
Package cli is a command line interface
|
Package cli is a command line interface |
|
cli/new
Package new generates vine service templates
|
Package new generates vine service templates |
|
cli/util
Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread
|
Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread |
|
proxy
Package proxy is a cli proxy
|
Package proxy is a cli proxy |
|
web
Package web is a web dashboard
|
Package web is a web dashboard |
|
cmd
|
|
|
protoc-gen-vine
protoc-gen-vine is a plugin for the Google protocol buffer compiler to generate Go code.
|
protoc-gen-vine is a plugin for the Google protocol buffer compiler to generate Go code. |
|
protoc-gen-vine/generator
The code generator for the plugin for the Google protocol buffer compiler.
|
The code generator for the plugin for the Google protocol buffer compiler. |
|
vine/service
Package service provides a vine service
|
Package service provides a vine service |
|
vine/service/broker
Package broker is the vine broker
|
Package broker is the vine broker |
|
vine/service/debug
Package debug implements metrics/logging/introspection/...
|
Package debug implements metrics/logging/introspection/... |
|
vine/service/debug/stats
Package handler is the handler for the `vine debug stats` service
|
Package handler is the handler for the `vine debug stats` service |
|
vine/service/debug/trace
Package handler is the handler for the `vineadm debug trace` service
|
Package handler is the handler for the `vineadm debug trace` service |
|
vine/service/health
Package health is a healthchecking sidecar
|
Package health is a healthchecking sidecar |
|
vine/service/network
package network implements vine network node
|
package network implements vine network node |
|
vine/service/network/api
Package api is the network api
|
Package api is the network api |
|
vine/service/network/dns
Package dns provides a DNS registration service for autodiscovery of core network nodes.
|
Package dns provides a DNS registration service for autodiscovery of core network nodes. |
|
vine/service/network/dns/handler
Package handler is the handler for the `vine network dns` command
|
Package handler is the handler for the `vine network dns` command |
|
vine/service/network/dns/provider
Package provider lets you abstract away any number of DNS providers
|
Package provider lets you abstract away any number of DNS providers |
|
vine/service/network/dns/provider/cloudflare
Package cloudflare is a dns Provider for cloudflare
|
Package cloudflare is a dns Provider for cloudflare |
|
vine/service/network/handler
Package handler implements network RPC handler
|
Package handler implements network RPC handler |
|
vine/service/registry
Package registry is the vine registry
|
Package registry is the vine registry |
|
vine/service/runtime
Package runtime is the vine runtime Package runtime is the vine runtime
|
Package runtime is the vine runtime Package runtime is the vine runtime |
|
vine/service/runtime/profile
Package profile is for specific profiles @todo this package is the definition of cruft and should be rewritten in a more elegant way
|
Package profile is for specific profiles @todo this package is the definition of cruft and should be rewritten in a more elegant way |
|
vine/service/runtime/scheduler
Package scheduler is a file server notifer
|
Package scheduler is a file server notifer |
|
proto
|
|
|
Package vine is a pluggable framework for vine services
|
Package vine is a pluggable framework for vine services |
|
agent/command
Package command is an interface for defining bot commands
|
Package command is an interface for defining bot commands |
|
agent/input
Package input is an interface for bot inputs
|
Package input is an interface for bot inputs |
|
auth
Package auth provides authentication and authorization capability
|
Package auth provides authentication and authorization capability |
|
broker
Package broker is an interface used for asynchronous messaging Package http provides a http based message broker
|
Package broker is an interface used for asynchronous messaging Package http provides a http based message broker |
|
client/selector
Package selector is a way to pick a list of service nodes
|
Package selector is a way to pick a list of service nodes |
|
client/selector/dns
Package dns provides a dns SRV selector
|
Package dns provides a dns SRV selector |
|
client/selector/router
Package router is a network/router selector
|
Package router is a network/router selector |
|
client/selector/static
Package static provides a static resolver which returns the name/ip passed in without any change
|
Package static provides a static resolver which returns the name/ip passed in without any change |
|
config/loader
Package loader manages loading from multiple sources
|
Package loader manages loading from multiple sources |
|
config/secrets
Package secrets is an interface for encrypting and decrypting secrets
|
Package secrets is an interface for encrypting and decrypting secrets |
|
config/secrets/box
Package box is an asymmetric implementation of config/secrets using nacl/box
|
Package box is an asymmetric implementation of config/secrets using nacl/box |
|
config/secrets/secretbox
Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification
|
Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification |
|
config/source/file
Package file is a file source.
|
Package file is a file source. |
|
config/source/memory
Package memory is a memory source
|
Package memory is a memory source |
|
debug
Package service provides the service log
|
Package service provides the service log |
|
debug/handler
Package handler implements service debug handler embedded in vine services
|
Package handler implements service debug handler embedded in vine services |
|
logger
Package log provides a log interface
|
Package log provides a log interface |
|
network
Package network is for creating internetworks
|
Package network is for creating internetworks |
|
plugin
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins
|
Package plugin provides the ability to load plugins Package plugin provides the ability to load plugins |
|
proxy
Package proxy is a transport proxy built on the vine/server Package proxy is a transport proxy built on the vine/server
|
Package proxy is a transport proxy built on the vine/server Package proxy is a transport proxy built on the vine/server |
|
proxy/grpc
Package grpc transparently forwards the grpc protocol using a vine client.
|
Package grpc transparently forwards the grpc protocol using a vine client. |
|
proxy/http
Package http provides a vine rpc to http proxy Package http provides a vine rpc to http proxy
|
Package http provides a vine rpc to http proxy Package http provides a vine rpc to http proxy |
|
proxy/mucp
Package mucp transparently forwards the incoming request using a vine client.
|
Package mucp transparently forwards the incoming request using a vine client. |
|
registry/grpc
Package service uses the registry service
|
Package service uses the registry service |
|
registry/mdns
Package mdns provides a multicast dns registry
|
Package mdns provides a multicast dns registry |
|
registry/memory
Package memory provides an in-memory registry
|
Package memory provides an in-memory registry |
|
runtime
Package runtime is a service runtime manager
|
Package runtime is a service runtime manager |
|
runtime/local
Package local provides a local runtime
|
Package local provides a local runtime |
|
runtime/local/build
Package build builds a vine runtime package
|
Package build builds a vine runtime package |
|
runtime/local/build/docker
Package docker builds docker images
|
Package docker builds docker images |
|
runtime/local/build/go
Package golang is a go package manager
|
Package golang is a go package manager |
|
runtime/local/process
Package process executes a binary
|
Package process executes a binary |
|
runtime/local/process/os
Package os runs processes locally Package os runs processes locally
|
Package os runs processes locally Package os runs processes locally |
|
runtime/local/source
Package source retrieves source code
|
Package source retrieves source code |
|
runtime/local/source/git
Package git provides a git source
|
Package git provides a git source |
|
runtime/local/source/go
Package golang is a source for Go
|
Package golang is a source for Go |
|
server/mucp
Package mucp provides an mucp server
|
Package mucp provides an mucp server |
|
store
Package store is an interface for distributed data storage.
|
Package store is an interface for distributed data storage. |
|
store/bolt
Package local is a bolt system backed store
|
Package local is a bolt system backed store |
|
store/cache
Package cache implements a faulting style read cache on top of multiple vine stores
|
Package cache implements a faulting style read cache on top of multiple vine stores |
|
store/cli
Package cli implements the `vine store` subcommands for example: vine store snapshot vine store restore vine store sync
|
Package cli implements the `vine store` subcommands for example: vine store snapshot vine store restore vine store sync |
|
store/grpc
Package service implements the store service interface
|
Package service implements the store service interface |
|
store/memory
Package memory is a in-memory store store
|
Package memory is a in-memory store store |
|
store/postgres
Package postgres implements the postgres store
|
Package postgres implements the postgres store |
|
web
Package web provides web based micro services
|
Package web provides web based micro services |
|
util
|
|
|
api/handler
Package handler provides http handlers
|
Package handler provides http handlers |
|
api/handler/api
Package api provides an http-rpc handler which provides the entire http request over rpc
|
Package api provides an http-rpc handler which provides the entire http request over rpc |
|
api/handler/event
Package event provides a handler which publishes an event
|
Package event provides a handler which publishes an event |
|
api/handler/http
Package http is a http reverse proxy handler
|
Package http is a http reverse proxy handler |
|
api/handler/rpc
Package rpc is a vine rpc handler.
|
Package rpc is a vine rpc handler. |
|
api/handler/web
Package web contains the web handler including websocket support
|
Package web contains the web handler including websocket support |
|
api/resolver
Package resolver resolves a http request to an endpoint
|
Package resolver resolves a http request to an endpoint |
|
api/resolver/grpc
Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
|
Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service |
|
api/resolver/host
Package host resolves using http host
|
Package host resolves using http host |
|
api/resolver/path
Package path resolves using http path
|
Package path resolves using http path |
|
api/resolver/vpath
Package vpath resolves using http path and recognised versioned urls
|
Package vpath resolves using http path and recognised versioned urls |
|
api/router
Package router provides api service routing
|
Package router provides api service routing |
|
api/router/registry
Package registry provides a dynamic api service router
|
Package registry provides a dynamic api service router |
|
api/server
Package server provides an API gateway server which handles inbound requests
|
Package server provides an API gateway server which handles inbound requests |
|
api/server/acme
Package acme abstracts away various ACME libraries
|
Package acme abstracts away various ACME libraries |
|
api/server/acme/autocert
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.
|
Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config. |
|
api/server/acme/certmagic
Package certmagic is the ACME provider from github.com/caddyserver/certmagic
|
Package certmagic is the ACME provider from github.com/caddyserver/certmagic |
|
api/server/http
Package http provides a http server with features; acme, cors, etc
|
Package http provides a http server with features; acme, cors, etc |
|
auth/provider
Package provider is an external auth provider e.g oauth
|
Package provider is an external auth provider e.g oauth |
|
codec/bytes
Package bytes provides a bytes codec which does not encode or decode anything
|
Package bytes provides a bytes codec which does not encode or decode anything |
|
codec/grpc
Package grpc provides a grpc codec
|
Package grpc provides a grpc codec |
|
context/metadata
Package metadata is a way of defining message headers
|
Package metadata is a way of defining message headers |
|
debug/log
Package log provides debug logging
|
Package log provides debug logging |
|
debug/log/memory
Package memory provides an in memory log buffer
|
Package memory provides an in memory log buffer |
|
debug/profile
Package profile is for profilers
|
Package profile is for profilers |
|
debug/profile/http
Package http enables the http profiler
|
Package http enables the http profiler |
|
debug/profile/pprof
Package pprof provides a pprof profiler
|
Package pprof provides a pprof profiler |
|
debug/stats
Package stats provides runtime stats
|
Package stats provides runtime stats |
|
debug/trace
Package trace provides an interface for distributed tracing
|
Package trace provides an interface for distributed tracing |
|
jsonpb
Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON.
|
Package jsonpb provides marshaling and unmarshaling between protocol buffers and JSON. |
|
muxer
Package mux provides proxy muxing
|
Package mux provides proxy muxing |
|
network/resolver
Package resolver resolves network names to addresses
|
Package resolver resolves network names to addresses |
|
network/resolver/dns
Package dns resolves names to dns records
|
Package dns resolves names to dns records |
|
network/resolver/dnssrv
Package dns srv resolves names to dns srv records
|
Package dns srv resolves names to dns srv records |
|
network/resolver/http
Package http resolves names to network addresses using a http request
|
Package http resolves names to network addresses using a http request |
|
network/resolver/registry
Package registry resolves names using the vine registry
|
Package registry resolves names using the vine registry |
|
network/resolver/static
Package static is a static resolver
|
Package static is a static resolver |
|
network/transport
Package transport is an interface for synchronous connection based communication
|
Package transport is an interface for synchronous connection based communication |
|
network/transport/grpc
Package grpc provides a grpc transport
|
Package grpc provides a grpc transport |
|
network/transport/memory
Package memory is an in-memory transport
|
Package memory is an in-memory transport |
|
network/transport/quic
Package quic provides a QUIC based transport
|
Package quic provides a QUIC based transport |
|
network/tunnel
Package tunnel provides gre network tunnelling
|
Package tunnel provides gre network tunnelling |
|
network/tunnel/broker
Package broker is a tunnel broker
|
Package broker is a tunnel broker |
|
network/tunnel/transport
Package transport provides a tunnel transport
|
Package transport provides a tunnel transport |
|
platform
Package platform manages the runtime services as a platform
|
Package platform manages the runtime services as a platform |
|
plugins
Package plugins includes the plugins we want to load
|
Package plugins includes the plugins we want to load |
|
plugins/store/cloudflare
Package cloudflare is a store implementation backed by cloudflare workers kv Note that the cloudflare workers KV API is eventually consistent.
|
Package cloudflare is a store implementation backed by cloudflare workers kv Note that the cloudflare workers KV API is eventually consistent. |
|
proto
Package proto contains utility functions for working with protobufs
|
Package proto contains utility functions for working with protobufs |
|
qson
Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags).
|
Package qson implmenets decoding of URL query params into JSON and Go values (using JSON struct tags). |
|
resolver/api
Package vine provides a vine rpc resolver which prefixes a namespace
|
Package vine provides a vine rpc resolver which prefixes a namespace |
|
ring
Package ring provides a simple ring buffer for storing local data
|
Package ring provides a simple ring buffer for storing local data |
|
socket
Package socket provides a pseudo socket
|
Package socket provides a pseudo socket |
|
sync
Package sync is an interface for distributed synchronization
|
Package sync is an interface for distributed synchronization |
|
sync/memory
Package memory provides a sync.Mutex implementation of the lock for local use
|
Package memory provides a sync.Mutex implementation of the lock for local use |
|
usage
Package usage tracks vine usage
|
Package usage tracks vine usage |
|
version
Package version
|
Package version |
Click to show internal directories.
Click to hide internal directories.