README
¶
This project is no longer under active development and has been superseded by the Crunchy Container Suite which can be found link:https://github.com/CrunchyData/crunchy-containers
Crunchy Postgresql Manager (v1.0.2)
Crunchy Postgresql Manager (CPM) is a Docker-based solution which provides an on-premise PostgreSQL-as-a-Service platform. CPM utilizes Docker Swarm for multi-host scaling.
CPM allows for the quick provisioning of PostgreSQL databases and streaming replication clusters.
CPM also allows you to monitor and administer PostgreSQL databases. Currently CPM only works with databases that have been provisioned by CPM.
A user guide is available at: docs/htmldoc/user-guide.html
A developer-installation guide is available at: docs/htmldoc/doc.html
A description of the REST API is at: docs/htmldoc/rest-api.html
CPM consists of the following containers:
-
cpm - cpm.crunchy.lab - the nginx server that hosts the CPM web app, http://cpm.crunchy.lab:13001
-
cpm-admin - cpm-admin.crunchy.lab - the REST API for CPM, http://cpm-admin.crunchy.lab:13001
-
cpm-task - cpm-task.crunchy.lab - the task scheduler process used by CPM to schedule and run administrative task jobs
-
cpm-collect - cpm-collect.crunchy.lab - the monitoring process used to collect metrics, these metrics are collected by the Prometheus server running as cpm-prometheus
-
cpm-promdash - cpm-promdash.crunchy.lab - the Prometheus dashboard that can be used to view/query collected CPM metrics , graphs from this dashboard are displayed within the CPM user interface, the user interface is found at http://cpm-promdash:3000
-
cpm-prometheus - cpm-prometheus.crunchy.lab - the Prometheus database is found at http://cpm-prometheus:9090
-
cpm-server - cpm-yourserver.crunchy.lab - the server agent, one of these is run on each CPM server, the name of the container is important, it needs to match the server name you define in CPM
Directories
¶
| Path | Synopsis |
|---|---|
|
Package adminapi is the implementation of the CPM Administration REST API.
|
Package adminapi is the implementation of the CPM Administration REST API. |
|
Package admindb is the implementation of most of the database access code that CPM uses to control and get metadata out of the CPM administrative database.
|
Package admindb is the implementation of most of the database access code that CPM uses to control and get metadata out of the CPM administrative database. |
|
Package collect is the implementation of the CPM metrics collection process.
|
Package collect is the implementation of the CPM metrics collection process. |
|
example of calling one of these
|
example of calling one of these |
|
example of calling one of these
|
example of calling one of these |
|
Package dummy is a do-nothing REST API that allows for a form of development testing, only use this if you want to keep a container running while doing development and hot-swapping on the containers real server.
|
Package dummy is a do-nothing REST API that allows for a form of development testing, only use this if you want to keep a container running while doing development and hot-swapping on the containers real server. |
|
Package logit is small wrapper around the source code level logging used in CPM.
|
Package logit is small wrapper around the source code level logging used in CPM. |
|
Package sec is the security implementation used by the CPM application.
|
Package sec is the security implementation used by the CPM application. |
|
Package swarmapi is a wrapper around the docker api We use this package to interact with the Swarm manager which proxies docker API calls to the various nodes in the Swarm of docker nodes
|
Package swarmapi is a wrapper around the docker api We use this package to interact with the Swarm manager which proxies docker API calls to the various nodes in the Swarm of docker nodes |
|
example of calling one of these
|
example of calling one of these |
|
Package template is the templating package used by CPM to generate various postgresql configuration files, for example, the pg_hba.conf and postgresql.conf files are generated from templates.
|
Package template is the templating package used by CPM to generate various postgresql configuration files, for example, the pg_hba.conf and postgresql.conf files are generated from templates. |
|
Package types is the main set of data types defined within CPM and used across all tiers.
|
Package types is the main set of data types defined within CPM and used across all tiers. |
|
Package util is a collection of utility functions used within CPM.
|
Package util is a collection of utility functions used within CPM. |