Key Concepts

Docker Compose

Docker Compose is a tool designed to manage the deployment of complex applications composed of multiple services and to simultaneously manage multiple Docker containers that form a single application.

Patroni Cluster

Patroni is a Python application for creating highly available database clusters based on streaming replication. It enables transforming a primary-replica system into a highly available cluster supporting both controlled (switchover) and emergency (failover) failover. Patroni allows easy addition of new replicas to an existing cluster, supports dynamic reconfiguration of the DBMS across all cluster nodes simultaneously, and provides numerous other features such as synchronous replication, customizable node-switching actions, REST API, the ability to run custom commands for replica creation instead of pg_basebackup, and integration with Kubernetes, among others.

PostgreSQL

PostgreSQL is a free, open-source object-relational database management system based on SQL.

Agent

An agent is a software tool required for managing tasks when working with PostgreSQL databases. Its primary purpose is to collect metrics from the database, host, network, and other sources for transmission to Platform.

System Owner

An employee of the Customer’s organization who has been granted access to Platform. This user is the owner of the entire system, including all Platform namespaces and their respective instances. The system administrator has full administrative rights to Platform instance after installation.

Tenant Owner

An employee of the Customer’s organization who has been granted access to Platform. This user has full access to one or multiple tenants and their respective namespaces and instances. Within other tenants, this user may be granted different permissions: Namespace Administrator or Viewer (read-only).

Namespace Admin

An employee of the Customer’s organization who has been granted access to Platform. This user has full or partial administrative rights to manage Platform instances after installation. Unlike the System Owner, a Namespace Admin does not have access to the entire system but only to specific namespace(s) and their associated instances. Within other namespaces, this user may be granted Viewer permissions.

Viewer

An employee of the Customer’s organization who has been granted access to Platform. This user has read-only access to information within a namespace. Within other namespaces, this user may be granted Namespace Administrator permissions.

User

Any individual from the Customer’s side who has been granted access to Platform and possesses certain permissions for managing Platform instances.

Customer

A legal entity that has acquired a non-exclusive license to use Platform.

Cluster

A database cluster is a set of databases managed by a single PostgreSQL server instance.

Platform

A fully functional, modular administration and monitoring platform for PostgreSQL clusters, designed to ensure long-term, reliable operation of PostgreSQL-based DBMS.

Developer

The rights holder of Platform — Awide.

Tenant

A logical entity reflected in the web interface, designed to manage namespaces and the PostgreSQL server instances contained within them.

Namespace

A logical entity reflected in the web interface, designed to manage PostgreSQL server instances and control access via user groups.

Instance

A PostgreSQL server instance is designed to manage one or multiple databases.

Ansible

A Python-based application for automating IT processes. Ansible simplifies configuration management and application deployment across various devices and servers (including virtual machines).

Ansible Playbook

A YAML-formatted file containing a set of instructions to automate various system tasks. It describes the required state of the system.

Prometheus

A monitoring and alerting system that collects metrics from various sources such as servers, containers, and other nodes. It enables defining and capturing relevant metrics and provides data visualization capabilities.

Grafana

A data visualization tool that enables the creation of charts and dashboards based on metrics collected from Prometheus and other metric sources.

Instance Family

The DBMS name (postgres) plus its major version, e.g., “PostgreSQL 11”, “PostgreSQL 14”, etc.

System Parameter Group

A group containing default parameters for a specific instance family.