README
¶
stolon - PostgreSQL cloud native High Availability
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...)
For an introduction to stolon you can also take a look at this post
Features
- Leverages PostgreSQL streaming replication.
- Resilient to any kind of partitioning. While trying to keep the maximum availability, it prefers consistency over availability.
- kubernetes integration letting you achieve postgreSQL high availability.
- Uses a cluster store like etcd, consul or kubernetes API server as an high available data store and for leader election
- Asynchronous (default) and synchronous replication.
- Full cluster setup in minutes.
- Easy cluster administration
- Can do point in time recovery integrating with your preferred backup/restore tool.
- Standby cluster (for multi site replication and near zero downtime migration).
- Automatic service discovery and dynamic reconfiguration (handles postgres and stolon processes changing their addresses).
- Can use pg_rewind for fast instance resynchronization with current master.
Architecture
Stolon is composed of 3 main components
- keeper: it manages a PostgreSQL instance converging to the clusterview computed by the leader sentinel.
- sentinel: it discovers and monitors keepers and proxies and computes the optimal clusterview.
- proxy: the client's access point. It enforce connections to the right PostgreSQL master and forcibly closes connections to old masters.
For more details and requirements see Stolon Architecture and Requirements
Documentation
Installation
Stolon is available in brew. It is unofficial and not supported by the project.
So check the version before installing using brew.
Quick start and examples
Project Status
Stolon is under active development and used in different environments. Probably its on disk format (store hierarchy and key contents) will change in future to support new features. If a breaking change is needed it'll be documented in the release notes and an upgrade path will be provided.
Anyway it's quite easy to reset a cluster from scratch keeping the current master instance working and without losing any data.
Requirements
-
PostgreSQL 15, 14, 13, 12, 11, 10, 9.6
-
etcd2 >= v2.0, etcd3 >= v3.0, consul >= v0.6 or kubernetes >= 1.8 (based on the store you're going to use)
-
OS: currently stolon is tested on GNU/Linux (with reports of people using it also on Solaris, *BSD and Darwin)
build
To build stolon we usually test and support the latest two major versions of Go like in the Go release policy.
make
High availability
Stolon tries to be resilient 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
FAQ
See here for a list of faq. If you have additional questions please ask.
Contributing to stolon
stolon is an open source project under the Apache 2.0 license, and contributions are gladly welcomed! To submit your changes please open a pull request.
Contacts
- For general discussion about using and developing stolon, join the stolon forum
- For bugs and feature requests file an issue
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v0
Package v0 holds the v0 api of the cluster info
|
Package v0 holds the v0 api of the cluster info |
|
v1
Package v1 defines all resources for version v1
|
Package v1 defines all resources for version v1 |
|
Package cmd is a package which provides utilities that underlie the specific command
|
Package cmd is a package which provides utilities that underlie the specific command |
|
keeper
command
Package main is a package that provides functionality concerning postgresSQL lifecycles
|
Package main is a package that provides functionality concerning postgresSQL lifecycles |
|
keeper/cmd
Package cmd holds all CLI code for the keeper
|
Package cmd holds all CLI code for the keeper |
|
proxy
command
Package main is a package that provides functionality concerning postgresSQL lifecycles
|
Package main is a package that provides functionality concerning postgresSQL lifecycles |
|
proxy/cmd
Package cmd holds all CLI code for the keeper
|
Package cmd holds all CLI code for the keeper |
|
sentinel
command
Package main is a package that provides functionality concerning postgresSQL lifecycles
|
Package main is a package that provides functionality concerning postgresSQL lifecycles |
|
sentinel/cmd
Package cmd holds all CLI code for the keeper
|
Package cmd holds all CLI code for the keeper |
|
stolonctl
command
Package main is a package that provides functionality concerning postgresSQL lifecycles
|
Package main is a package that provides functionality concerning postgresSQL lifecycles |
|
stolonctl/cmd
Package cmd is a package which provides utilities that underly the specific command
|
Package cmd is a package which provides utilities that underly the specific command |
|
stolonctl/cmd/internal/mock/register
Package mock_register is a generated GoMock package.
|
Package mock_register is a generated GoMock package. |
|
stolonctl/cmd/register
Package register will register all components for stolon-ctl
|
Package register will register all components for stolon-ctl |
|
internal
|
|
|
common
Package common contains some common constants and structures for stolon
|
Package common contains some common constants and structures for stolon |
|
flagutil
Package flagutil implements all commandline flags
|
Package flagutil implements all commandline flags |
|
logging
Package logging brings a generic logging interface
|
Package logging brings a generic logging interface |
|
mock/postgresql
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
mock/store
Package mock_store is a generated GoMock package.
|
Package mock_store is a generated GoMock package. |
|
postgresql
Package postgresql has all stolon specific postgresql code
|
Package postgresql has all stolon specific postgresql code |
|
store
Package store contains all code regarding consensus stores
|
Package store contains all code regarding consensus stores |
|
timer
Package timer is used as a generic interface for time and timing operations
|
Package timer is used as a generic interface for time and timing operations |
|
util
Package util has all kind of util functions to support stolon
|
Package util has all kind of util functions to support stolon |
|
Package main is a package that provides functionality concerning postgresSQL lifecycles
|
Package main is a package that provides functionality concerning postgresSQL lifecycles |
|
tests
|
|