README
¶
stolon - PostgreSQL cloud native HA replication manager
stolon is a cloud native PostgreSQL manager for PostgreSQL high availability. It's cloud native because it'll let you keep an high available PostgreSQL inside your containers (kubernetes integration) but also on every other kind of infrastructure (cloud IaaS, old style infrastructures etc...)
Features
- Leverages PostgreSQL streaming replication.
- kubernetes integration letting you achieve postgreSQL high availability.
- Uses etcd as an high available data store and for leader election
- Asynchronous (default) and synchronous replication.
- Full cluster setup in minutes.
- Easy cluster admininistration
Architecture
Stolon is composed of 3 main components
- keeper: it manages a PostgreSQL instance converging to the clusterview provided by the sentinel(s).
- sentinel: it discovers and monitors keepers and calculates the optimal clusterview.
- proxy: the client's access point. It enforce connections to the right PostgreSQL master and forcibly closes connections to unelected masters.
Project Status
Stolon is under active development and used in different environments. But its on disk format (etcd hierarchy and key contents) is not stable and will change for introducing new features. We hope that at the end of the year (2015) the most breaking changes will be merged and we can commit to a stable on disk format.
Requirements
- PostgreSQL >= 9.4
- etcd >= 2.0
build
./build
Quick start and examples
Documentation
High availability
Stolon tries to be resilent to any partitioning problem. The cluster view is computed by the leader sentinel and is useful to avoid data loss (one example over all avoid that old dead masters coming back are elected as the new master).
There can be tons of different partitioning cases. The primary ones are covered (and in future more will be added) by various integration tests
Contributing to stolon
stolon is an open source project under the Apache 2.0 license, and contributions are gladly welcomed!
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/coreos/etcd/client
Package client provides bindings for the etcd APIs.
|
Package client provides bindings for the etcd APIs. |
|
_workspace/src/github.com/coreos/go-systemd/journal
Package journal provides write bindings to the systemd journal
|
Package journal provides write bindings to the systemd journal |
|
_workspace/src/github.com/coreos/rkt/pkg/lock
Package lock implements simple locking primitives on a regular file or directory using flock
|
Package lock implements simple locking primitives on a regular file or directory using flock |
|
_workspace/src/github.com/davecgh/go-spew/spew
Package spew implements a deep pretty printer for Go data structures to aid in debugging.
|
Package spew implements a deep pretty printer for Go data structures to aid in debugging. |
|
_workspace/src/github.com/gorilla/context
Package context stores values shared during a request lifetime.
|
Package context stores values shared during a request lifetime. |
|
_workspace/src/github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
|
Package gorilla/mux implements a request router and dispatcher. |
|
_workspace/src/github.com/jmoiron/jsonq
Package jsonq simplify your json usage with a simple hierarchical query.
|
Package jsonq simplify your json usage with a simple hierarchical query. |
|
_workspace/src/github.com/kballard/go-shellquote
Shellquote provides utilities for joining/splitting strings using sh's word-splitting rules.
|
Shellquote provides utilities for joining/splitting strings using sh's word-splitting rules. |
|
_workspace/src/github.com/kr/pty
Package pty provides functions for working with Unix terminals.
|
Package pty provides functions for working with Unix terminals. |
|
_workspace/src/github.com/lib/pq
Package pq is a pure Go Postgres driver for the database/sql package.
|
Package pq is a pure Go Postgres driver for the database/sql package. |
|
_workspace/src/github.com/lib/pq/listen_example
Below you will find a self-contained Go program which uses the LISTEN / NOTIFY mechanism to avoid polling the database while waiting for more work to arrive.
|
Below you will find a self-contained Go program which uses the LISTEN / NOTIFY mechanism to avoid polling the database while waiting for more work to arrive. |
|
_workspace/src/github.com/lib/pq/oid
Package oid contains OID constants as defined by the Postgres server.
|
Package oid contains OID constants as defined by the Postgres server. |
|
_workspace/src/github.com/satori/go.uuid
Package uuid provides implementation of Universally Unique Identifier (UUID).
|
Package uuid provides implementation of Universally Unique Identifier (UUID). |
|
_workspace/src/github.com/spf13/cobra
Package cobra is a commander providing a simple interface to create powerful modern CLI interfaces.
|
Package cobra is a commander providing a simple interface to create powerful modern CLI interfaces. |
|
_workspace/src/github.com/spf13/pflag
pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.
|
pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags. |
|
_workspace/src/github.com/ugorji/go/codec
High Performance, Feature-Rich Idiomatic Go codec/encoding library for binc, msgpack, cbor, json.
|
High Performance, Feature-Rich Idiomatic Go codec/encoding library for binc, msgpack, cbor, json. |
|
_workspace/src/github.com/ugorji/go/codec/codecgen
command
codecgen generates codec.Selfer implementations for a set of types.
|
codecgen generates codec.Selfer implementations for a set of types. |
|
_workspace/src/golang.org/x/net/context
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
|
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes. |
|
_workspace/src/k8s.io/kubernetes/third_party/forked/json
Package json is forked from the Go standard library to enable us to find the field of a struct that a given JSON key maps to.
|
Package json is forked from the Go standard library to enable us to find the field of a struct that a given JSON key maps to. |
|
cmd
|
|
|
keeper
command
|
|
|
proxy
command
|
|
|
sentinel
command
|
|
|
stolonctl
command
|
|
|
pkg
|
|
|
tests
|
|
Click to show internal directories.
Click to hide internal directories.