MCPcopy
hub / github.com/autobase-tech/autobase

github.com/autobase-tech/autobase @2.8.0 sqlite

repository ↗ · DeepWiki ↗ · release 2.8.0 ↗
797 symbols 2,541 edges 421 files 58 documented · 7%
README

Autobase for PostgreSQL® :elephant: :sparkling_heart:

Ansible-lint Yamllint Flake8 Molecule GitHub license

Autobase is an internal PostgreSQL platform — giving you full control as a powerful alternative to cloud-managed databases (DBaaS).

This automated database platform enables you to create and manage production-ready, highly available PostgreSQL clusters. It simplifies the deployment process, reduces operational costs, and makes database management accessible—even for teams without specialized expertise.

Automate deployment, failover, backups, restore, upgrades, scaling, and more with ease.

Say goodbye to manual database management 👋

Documentation

Autobase documentation can be found here.

Support

Autobase support packages are described here.

Quick start

You have the option to deploy Postgres clusters using the Console (UI), command line, or GitOps.

Console (UI)

The Autobase Console (UI) is the recommended method for most users. It is designed to be user-friendly, minimizing the risk of errors and making it easier than ever to set up your PostgreSQL clusters. This method is suitable for both beginners and those who prefer a visual interface for managing their PostgreSQL clusters.

To run the autobase console, execute the following command:

docker run -d --name autobase-console \
  --publish 80:80 \
  --env PG_CONSOLE_AUTHORIZATION_TOKEN=secret_token \
  --env PG_CONSOLE_DOCKER_IMAGE=autobase/automation:latest \
  --volume console_postgres:/var/lib/postgresql \
  --volume /var/run/docker.sock:/var/run/docker.sock \
  --volume /tmp/ansible:/tmp/ansible \
  --restart=unless-stopped \
  autobase/console:latest

[!NOTE] It is recommended to run the console in the same network as your database servers to enable monitoring of the cluster status.

Alternatively, you can use Docker Compose.

Open the Console UI:

Go to http://localhost:80 (or the address of your server) and use secret_token for authorization.

Cluster creation demo

Refer to the Deployment section to learn more about the different deployment methods.

Command line

Click here to expand... if you prefer the command line.

The command line mode is suitable for advanced users who require greater flexibility and control over the deployment and management of their PostgreSQL clusters. While the Console (UI) is designed for ease of use and is suitable for most users, the command line provides powerful options for those experienced in automation and configuration.

Note: All dependencies and source code are bundled into the autobase/automation docker image. This means the deployment process comes down to simply launching a container with a few variable overrides.

  1. Prepare your inventory
curl -fsSL https://raw.githubusercontent.com/autobase-tech/autobase/refs/heads/main/automation/inventory.example \
  --output ./inventory

Specify IP addresses and appropriate connection settings for your environment, such as ansible_user, ansible_ssh_pass, or ansible_ssh_private_key_file.

nano ./inventory
  1. Prepare your variables

Refer to the default variables for all configurable options. Override them as needed using group_vars, host_vars, or directly in the inventory file.

mkdir -p ./group_vars
nano ./group_vars/all.yml
  1. Run the deployment command
docker run --rm -it \
  -e ANSIBLE_SSH_ARGS="-F none" \
  -e ANSIBLE_INVENTORY=/project/inventory \
  -v $PWD:/project \
  -v $HOME/.ssh:/root/.ssh \
  autobase/automation:latest \
    ansible-playbook deploy_pgcluster.yml

Tip: Start with deploy_pgcluster for initial provisioning, then use config_pgcluster for further configuration changes.

Alternatively, you can use Ansible Collection

How to start from scratch

If you need to start from the very beginning, you can use the remove_cluster playbook.

Available variables:

  • remove_postgres: stop the PostgreSQL service and remove data
  • remove_etcd: stop the ETCD service and remove data
  • remove_consul: stop the Consul service and remove data

⚠️ Caution: Only use this in non-production or when you’re absolutely sure.

[!TIP] 📩 Contact us at info@autobase.tech, and our team will help you implement Autobase into your infrastructure.

Supported setups of Postgres Cluster

For a detailed description of the cluster components, visit the Architecture page.

pg_cluster_scheme pg_cluster_scheme

Compatibility

RedHat and Debian based distros.

Supported Linux Distributions:
  • Debian: 11, 12, 13
  • Ubuntu: 22.04, 24.04, 26.04
  • CentOS Stream: 9, 10
  • Oracle Linux: 8, 9, 10
  • Rocky Linux: 8, 9, 10
  • AlmaLinux: 8, 9, 10

Architecture: x86_64 (amd64), aarch64 (arm64).

PostgreSQL versions:

all supported PostgreSQL versions

:white_check_mark: tested, works fine: PostgreSQL 10, 11, 12, 13, 14, 15, 16, 17, 18

Table of results of daily automated testing of cluster deployment: | Distribution | Test result | |--------------|:----------:| | Debian 12 | GitHub Workflow Status | | Debian 13 | GitHub Workflow Status | | Ubuntu 24.04 | GitHub Workflow Status | | Ubuntu 26.04 | GitHub Workflow Status | | CentOS Stream 9 | GitHub Workflow Status | | CentOS Stream 10 | GitHub Workflow Status | | Oracle Linux 9 | GitHub Workflow Status | | Oracle Linux 10 | GitHub Workflow Status | | Rocky Linux 9 | GitHub Workflow Status | | Rocky Linux 10 | GitHub Workflow Status | | AlmaLinux 9 | GitHub Workflow Status | | AlmaLinux 10 | GitHub Workflow Status |

Project Status

Autobase has been actively developed for over 5 years (since 2019) and is trusted by companies worldwide, including in production environments with high loads and demanding reliability requirements. Our mission is to provide an open-source DBaaS that delivers reliability, flexibility, and cost-efficiency.

The project will remain open-source forever, but to ensure its continuous growth and development, we rely on sponsorship and support packages, you gain access to personalized support from the project authors and PostgreSQL experts.

Star us

If you find our project helpful, consider giving it a star on GitHub! Your support helps us grow and motivates us to keep improving. Starring the project is a simple yet effective way to show your appreciation and help others discover it.

<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=autobase-tech/autobase&type=Date" />

License

Licensed under the MIT License. See the LICENSE file for details.

Author

Vitaliy Kukharik (PostgreSQL Expert, Founder Autobase.tech) \ vitaliy@autobase.tech

Extension points exported contracts — how you extend this code

LogWatcher (Interface)
(no doc) [2 implementers]
console/service/internal/watcher/log_watcher.go
LoginFormValues (Interface)
(no doc)
console/ui/src/pages/login/model/types.ts
IClient (Interface)
(no doc) [1 implementers]
console/service/pkg/patroni/client.go
ClustersTableButtonsProps (Interface)
(no doc)
console/ui/src/features/clusters-table-buttons/model/types.ts
IService (Interface)
(no doc) [1 implementers]
console/service/internal/service/service.go
AddSecretFormValues (Interface)
(no doc)
console/ui/src/features/add-secret/model/types.ts
IStorage (Interface)
(no doc) [1 implementers]
console/service/internal/storage/istorage.go
ProjectFormValues (Interface)
(no doc)
console/ui/src/features/add-project/model/types.ts

Core symbols most depended-on inside this repo

get
called by 19
automation/plugins/modules/yedit.py
generateAbsoluteRouterPath
called by 15
console/ui/src/shared/lib/functions.ts
requiredField
called by 12
console/ui/src/features/add-secret/model/validation.ts
handleRequestErrorCatch
called by 12
console/ui/src/shared/lib/functions.ts
convertTimestampToReadableTime
called by 9
console/ui/src/shared/lib/functions.ts
onChange
called by 9
console/ui/src/shared/ui/slider-box/ui/index.tsx
convertModalParametersToArray
called by 8
console/ui/src/shared/lib/clusterValuesTransformFunctions.ts
configValidationSchema
called by 8
console/ui/src/shared/model/validation.ts

Shape

Function 396
Method 213
Interface 102
Struct 81
Class 3
TypeAlias 2

Languages

TypeScript49%
Go46%
Python5%

Modules by API surface

console/service/internal/storage/db_storage.go48 symbols
console/service/internal/storage/istorage.go46 symbols
console/service/internal/storage/models.go31 symbols
automation/plugins/modules/yedit.py29 symbols
console/ui/src/shared/api/api/secrets.ts18 symbols
console/ui/src/shared/lib/clusterValuesTransformFunctions.ts14 symbols
console/service/internal/watcher/dbdesk.go14 symbols
console/service/internal/watcher/cluster_watcher.go13 symbols
console/service/internal/watcher/log_watcher.go11 symbols
console/service/internal/watcher/log_collector.go11 symbols
automation/plugins/callback/json_log.py11 symbols
console/service/internal/controllers/cluster/post_cluster.go10 symbols

Dependencies from manifests, versioned

github.com/Microsoft/go-winiov0.6.2 · 1×
github.com/cespare/xxhash/v2v2.3.0 · 1×
github.com/containerd/errdefsv1.0.0 · 1×
github.com/containerd/errdefs/pkgv0.3.0 · 1×
github.com/containerd/logv0.1.0 · 1×
github.com/distribution/referencev0.6.0 · 1×
github.com/docker/dockerv28.5.2+incompatible · 1×
github.com/docker/go-connectionsv0.7.0 · 1×
github.com/docker/go-unitsv0.5.0 · 1×
github.com/felixge/httpsnoopv1.0.4 · 1×
github.com/gdex-lab/go-renderv1.0.1 · 1×
github.com/go-logr/logrv1.4.3 · 1×

For agents

$ claude mcp add autobase \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact