LICENSE Documentation

{/* ===== INTERNAL TAB: Basic ===== */}
<Tabs defaultValue="basic">
  <TabItem value="basic" label="Basic">
    Select **Your Own Machines** in the deployment destination.

    

    Specify the name and IP addresses of your servers. Example:

    

    :::warning
    Please note that at least 3 servers are required to ensure high availability.
    :::

    Select authentication method.

    

    Optionally, specify an IP address to provide a single entry point for client access to databases in the cluster. Example:

    

    :::info
    This must be an IP address that is currently unused on your network. The address will be assigned to the cluster after deployment.
      :::note
      Not for cloud environments. Because VIP-based solutions like `keepalived` or `vip-manager` may not works in such environments.
    :::

    Optionally, check the box for "HAProxy load balancer".

    

    :::tip
    This feature supports load balancing for read operations, facilitating effective scale-out strategies through the use of read-only replicas.
    See the details on the [Architecture](https://postgresql-cluster.org/overview/architecture#2-postgresql-high-availability-with-load-balancing) page
    :::

    Choose which environment your database cluster belongs to.

    

    Specify a name for your cluster.

    

    Optionally, specify a description.

    

    Select the PostgreSQL version to install.

    

    Review the summary and click the "Create Cluster" button.

    
  </TabItem>

{/* ===== INTERNAL TAB: Expert ===== */}
  <TabItem value="expert" label="Expert Mode">
    This mode unlocks advanced settings for fine-tuning clusters, including options hidden in standard mode. \
    Designed for experienced users.

    :::info
    To use **Expert Mode**, go to the **Settings** page and turn on “Enable expert mode”.
    :::

    Select **Your Own Machines** in the deployment destination.

    

    Specify the name and IP addresses of your servers. Example:

    

    :::warning
    Please note that at least 3 servers are required to ensure high availability.
    
    This requirement applies to the number of DCS servers (see [RAFT](http://thesecretlivesofdata.com/raft/) protocol), the database cluster itself may consist of two servers.
    :::

    :::tip
    We also support converting standalone PostgreSQL installation into a high-availability cluster.
    To do this, check the box "Postgres exists" above the server where the database is already present.
    :::

    Select the DCS type (etcd or consul) and where it will be installed, or use an existing DCS cluster.

    

    Select authentication method.

    

    Optionally, specify an IP address to provide a single entry point for client access to databases in the cluster. Example:

    

    :::info
    This must be an IP address that is currently unused on your network. The address will be assigned to the cluster after deployment.
      :::note
      Not for cloud environments. Because VIP-based solutions like `keepalived` or `vip-manager` may not works in such environments.
    :::

    Optionally, check the box for "HAProxy load balancer". Choose where to install — on DB servers or dedicated ones.

    

    :::tip
    This feature supports load balancing for read operations, facilitating effective scale-out strategies through the use of read-only replicas.
    See the details on the [Architecture](https://postgresql-cluster.org/overview/architecture#2-postgresql-high-availability-with-load-balancing) page
    :::

    Choose which environment your database cluster belongs to.

    

    Specify a name for your cluster.

    

    Optionally, specify a description.

    

    Select the PostgreSQL version to install.

    

    Optionally, specify the custom path to the data directory.

    


    Specify the desired database name, username, and user password.

    

    Optionally, specify connection pools for your databases, its size and mode.

    

    :::info Available pool modes
      - **session** - Server is released back to pool after client disconnects.
      - **transaction** - Server is released back to pool after transaction finishes. Recomended.
      - **statement** - Server is released back to pool after query finishes. Transactions spanning multiple statements are disallowed in this mode.
    :::

    Enable the necessary extensions for your databases.

    

    :::tip
    This list includes all contrib extensions and some popular third-party ones. However, [more than 400 extensions are available](/docs/extensions/list). \
    To install others, specify the [installation parameters](/docs/extensions/install) manually on the **YAML** tab.
    :::

    Configure backup settings.

    

    :::info
    Click **Configure** button and specify them in the usual key=value format.
      :::note
      For pgBackRest, you can specify the global section options — the stanza section will be populated automatically.
    :::

    Optionally, specify the Postgres and kernel parameters.

    

    :::info
    By default, Autobase automatically configures these parameters. See the default settings for [Postgres](https://github.com/autobase-tech/autobase/blob/2.10.0/automation/roles/common/defaults/main.yml#L331) and the [kernel](https://github.com/autobase-tech/autobase/blob/2.10.0/automation/roles/common/defaults/main.yml#L889). \
    If you prefer to set the parameters manually, click **Configure** button and specify them in the usual key=value format.
    :::

    Example for Postgres parameters:

    

    Example for Kernel parameters:

    

    Optionally, specify the Additional settings.

    

    :::tip
    Use the hint (?) icon for a more detailed description of each option.
    :::

    Review the summary and click the "Create Cluster" button.

    
  </TabItem>

{/* ===== INTERNAL TAB: YAML ===== */}
  <TabItem value="yaml" label="YAML tab">
    The YAML editor allows you to specify any parameters that were previously available only in command-line mode. \
    Designed for experienced users.

    :::info
    To use the **YAML** tab, go to the **Settings** page and turn on “Enable expert mode” and “Enable YAML editor”.
    :::

    

    Autobase offers a wide range of functionality, and not all options can be fully represented in UI forms. That’s why we added a YAML editor — it allows you to set any parameters supported by Autobase. You can see available parameters [here](https://github.com/autobase-tech/autobase/blob/2.10.0/automation/roles/common/defaults/main.yml).

    Make the necessary changes and click the **"Create Cluster"** button.
  </TabItem>
</Tabs>

{/* ===== COMMON BLOCK (Basic / Expert / YAML) ===== */}

    Wait until deployment is complete. This process takes about 10 minutes.

    :::info
    You can see the deployment log in the "Operations" section. To do this, select the relevant event with the "deploy" type and click "Show details" under the Actions tab.
    :::

    :::tip
    After a successful deployment, you can obtain the connection info on the cluster page. To do this, click on the name of your cluster on the "Clusters" page.
    :::

    

    Example of a cluster page:

/* Detailed source-code truncated for AI context efficiency. */

/* Detailed source-code truncated for AI context efficiency. */

/* Detailed source-code truncated for AI context efficiency. */

/* Detailed source-code truncated for AI context efficiency. */

/* Detailed source-code truncated for AI context efficiency. */

/* Detailed source-code truncated for AI context efficiency. */

# By default, the cron jobs is created on the database server.
# If 'repo_host' is defined, the cron jobs will be created on the pgbackrest server.
pgbackrest_cron_jobs:
  - name: "pgBackRest: Full Backup"
    file: "/etc/cron.d/pgbackrest-{{ patroni_cluster_name }}"
    user: "postgres"
    minute: "00"
    hour: "3"
    day: "*"
    month: "*"
    weekday: "0"
    job: "if [ $(psql -tAXc 'select pg_is_in_recovery()') = 'f' ]; then pgbackrest --stanza={{ pgbackrest_stanza }} --type=full backup; fi"
  - name: "pgBackRest: Diff Backup"
    file: "/etc/cron.d/pgbackrest-{{ patroni_cluster_name }}"
    user: "postgres"
    minute: "00"
    hour: "3"
    day: "*"
    month: "*"
    weekday: "1-6"
    job: "if [ $(psql -tAXc 'select pg_is_in_recovery()') = 'f' ]; then pgbackrest --stanza={{ pgbackrest_stanza }} --type=diff backup; fi"
  - name: "pgBackRest: Incr Backup"
    file: "/etc/cron.d/pgbackrest-{{ patroni_cluster_name }}"
    user: "postgres"
    minute: "00"
    hour: "*/4"
    day: "*"
    month: "*"
    weekday: "1-6"
    job: "if [ $(psql -tAXc 'select pg_is_in_recovery()') = 'f' ]; then pgbackrest --stanza={{ pgbackrest_stanza }} --type=incr backup; fi"

# An example of a configuration using S3 (Minio)

wal_g_install: true
wal_g_version: "3.0.5"
wal_g_path: "/usr/local/bin/wal-g --config {{ postgresql_home_dir }}/.walg.json"
wal_g_json:
  - { option: "AWS_ACCESS_KEY_ID", value: "YOUR_MINIO_ACCESS_KEY_ID" }  # change this value
  - { option: "AWS_SECRET_ACCESS_KEY", value: "YOUR_MINIO_SECRET_ACCESS_KEY" }  # change this value
  - { option: "AWS_ENDPOINT", value: "http://YOUR_MINIO_ADDRESS:9000" }  # change this value
  - { option: "AWS_S3_FORCE_PATH_STYLE", value: "true" }
  - { option: "WALG_S3_PREFIX", value: "s3://YOUR_MINIO_BUCKET" }  # change this value
  - { option: "WALG_COMPRESSION_METHOD", value: "brotli" }  # or "lz4", "lzma", "zstd"
  - { option: "WALG_DELTA_MAX_STEPS", value: "6" }  # determines how many delta backups can be between full backups
  - { option: "WALG_UPLOAD_CONCURRENCY", value: "2" }
  - { option: "WALG_UPLOAD_DISK_CONCURRENCY", value: "2" }
  - { option: "WALG_DOWNLOAD_CONCURRENCY", value: "4" }
  - { option: "WALG_ALIVE_CHECK_INTERVAL", value: "1m" }
  - { option: "PGDATA", value: "{{ postgresql_data_dir }}" }
  - { option: "PGHOST", value: "{{ postgresql_unix_socket_dir }}" }
  - { option: "PGPORT", value: "{{ postgresql_port }}" }
  - { option: "PGUSER", value: "{{ patroni_superuser_username }}" }

wal_g_archive_command: "{{ wal_g_path }} wal-push %p"

# An example of a configuration using AWS S3

wal_g_install: true
wal_g_version: "3.0.5"
wal_g_path: "/usr/local/bin/wal-g --config {{ postgresql_home_dir }}/.walg.json"
wal_g_json:
  - { option: "AWS_ACCESS_KEY_ID", value: "YOUR_AWS_ACCESS_KEY_ID" }  # change this value
  - { option: "AWS_SECRET_ACCESS_KEY", value: "YOUR_AWS_SECRET_ACCESS_KEY" }  # change this value
  - { option: "AWS_REGION", value: "YOUR_AWS_REGION" }  # change this value (e.g., us-east-1)
  - { option: "WALG_S3_PREFIX", value: "s3://YOUR_AWS_BUCKET" }  # change this value
  - { option: "WALG_COMPRESSION_METHOD", value: "brotli" }  # or "lz4", "lzma", "zstd"
  - { option: "WALG_DELTA_MAX_STEPS", value: "6" }  # determines how many delta backups can be between full backups
  - { option: "WALG_UPLOAD_CONCURRENCY", value: "2" }
  - { option: "WALG_UPLOAD_DISK_CONCURRENCY", value: "2" }
  - { option: "WALG_DOWNLOAD_CONCURRENCY", value: "4" }
  - { option: "WALG_ALIVE_CHECK_INTERVAL", value: "1m" }
  - { option: "PGDATA", value: "{{ postgresql_data_dir }}" }
  - { option: "PGHOST", value: "{{ postgresql_unix_socket_dir }}" }
  - { option: "PGPORT", value: "{{ postgresql_port }}" }
  - { option: "PGUSER", value: "{{ patroni_superuser_username }}" }

wal_g_archive_command: "{{ wal_g_path }} wal-push %p"

# An example of a configuration using Hetzner Object Storage (S3 bucket)

wal_g_install: true
wal_g_version: "3.0.5"
wal_g_path: "/usr/local/bin/wal-g --config {{ postgresql_home_dir }}/.walg.json"
wal_g_json:
  - { option: "AWS_ACCESS_KEY_ID", value: "YOUR_ACCESS_KEY" }  # change this value
  - { option: "AWS_SECRET_ACCESS_KEY", value: "YOUR_SECRET_KEY" }  # change this value
  - { option: "AWS_ENDPOINT", value: "https://fsn1.your-objectstorage.com" }  # change this value (region)
  - { option: "AWS_REGION", value: "fsn1" }  # change this value
  - { option: "WALG_S3_PREFIX", value: "s3://YOUR_BUCKET_NAME" }  # change this value
  - { option: "AWS_S3_FORCE_PATH_STYLE", value: "true" }
  - { option: "WALG_COMPRESSION_METHOD", value: "brotli" }  # or "lz4", "lzma", "zstd"
  - { option: "WALG_DELTA_MAX_STEPS", value: "6" }  # determines how many delta backups can be between full backups
  - { option: "WALG_UPLOAD_CONCURRENCY", value: "2" }
  - { option: "WALG_UPLOAD_DISK_CONCURRENCY", value: "2" }
  - { option: "WALG_DOWNLOAD_CONCURRENCY", value: "4" }
  - { option: "WALG_ALIVE_CHECK_INTERVAL", value: "1m" }
  - { option: "PGDATA", value: "{{ postgresql_data_dir }}" }
  - { option: "PGHOST", value: "{{ postgresql_unix_socket_dir }}" }
  - { option: "PGPORT", value: "{{ postgresql_port }}" }
  - { option: "PGUSER", value: "{{ patroni_superuser_username }}" }

wal_g_archive_command: "{{ wal_g_path }} wal-push %p"

# An example of a configuration using GCS

wal_g_install: true
wal_g_version: "3.0.5"
wal_g_path: "/usr/local/bin/wal-g --config {{ postgresql_home_dir }}/.walg.json"
wal_g_json:
  - { option: "GOOGLE_APPLICATION_CREDENTIALS", value: "{{ postgresql_home_dir }}/gcs-key.json" }  # change this value (path to GCS service account key file)
  - { option: "WALG_GS_PREFIX", value: "gs://YOUR_GCS_BUCKET" }  # change this value
  - { option: "WALG_COMPRESSION_METHOD", value: "brotli" }  # or "lz4", "lzma", "zstd"
  - { option: "WALG_DELTA_MAX_STEPS", value: "6" }  # determines how many delta backups can be between full backups
  - { option: "WALG_UPLOAD_CONCURRENCY", value: "2" }
  - { option: "WALG_UPLOAD_DISK_CONCURRENCY", value: "2" }
  - { option: "WALG_DOWNLOAD_CONCURRENCY", value: "4" }
  - { option: "WALG_ALIVE_CHECK_INTERVAL", value: "1m" }
  - { option: "PGDATA", value: "{{ postgresql_data_dir }}" }
  - { option: "PGHOST", value: "{{ postgresql_unix_socket_dir }}" }
  - { option: "PGPORT", value: "{{ postgresql_port }}" }
  - { option: "PGUSER", value: "{{ patroni_superuser_username }}" }

wal_g_archive_command: "{{ wal_g_path }} wal-push %p"

# An example of a configuration using Azure Blob Storage

wal_g_install: true
wal_g_version: "3.0.5"
wal_g_path: "/usr/local/bin/wal-g --config {{ postgresql_home_dir }}/.walg.json"
wal_g_json:
  - { option: "AZURE_STORAGE_ACCOUNT", value: "YOUR_AZURE_STORAGE_ACCOUNT" }  # change this value
  - { option: "AZURE_STORAGE_ACCESS_KEY", value: "YOUR_AZURE_STORAGE_ACCOUNT_KEY" }  # change this value
  - { option: "WALG_AZ_PREFIX", value: "azure://YOUR_AZURE_STORAGE_CONTAINER" }  # change this value
  - { option: "WALG_COMPRESSION_METHOD", value: "brotli" }  # or "lz4", "lzma", "zstd"
  - { option: "WALG_DELTA_MAX_STEPS", value: "6" }  # determines how many delta backups can be between full backups
  - { option: "WALG_UPLOAD_CONCURRENCY", value: "2" }
  - { option: "WALG_UPLOAD_DISK_CONCURRENCY", value: "2" }
  - { option: "WALG_DOWNLOAD_CONCURRENCY", value: "4" }
  - { option: "WALG_ALIVE_CHECK_INTERVAL", value: "1m" }
  - { option: "PGDATA", value: "{{ postgresql_data_dir }}" }
  - { option: "PGHOST", value: "{{ postgresql_unix_socket_dir }}" }
  - { option: "PGPORT", value: "{{ postgresql_port }}" }
  - { option: "PGUSER", value: "{{ patroni_superuser_username }}" }

wal_g_archive_command: "{{ wal_g_path }} wal-push %p"

# Define job_parts outside of wal_g_cron_jobs
# Ensure there is a space at the beginning of each part to prevent commands from concatenating.
wal_g_backup_command:
  - "curl -I -s http://{{ inventory_hostname }}:{{ patroni_restapi_port }} | grep 200"
  - " && {{ wal_g_path }} backup-push {{ postgresql_data_dir }} > {{ postgresql_log_dir }}/walg_backup.log 2>&1"
wal_g_delete_command:
  - "curl -I -s http://{{ inventory_hostname }}:{{ patroni_restapi_port }} | grep 200"
  - " && {{ wal_g_path }} delete retain FULL 4 --confirm > {{ postgresql_log_dir }}/walg_delete.log 2>&1"

wal_g_cron_jobs:
  - name: "WAL-G: Create daily backup"
    user: "postgres"
    file: /etc/cron.d/walg
    minute: "00"
    hour: "3"
    day: "*"
    month: "*"
    weekday: "*"
    job: "{{ wal_g_backup_command | join('') }}"
  - name: "WAL-G: Delete old backups"
    user: "postgres"
    file: /etc/cron.d/walg
    minute: "30"
    hour: "6"
    day: "*"
    month: "*"
    weekday: "*"
    job: "{{ wal_g_delete_command | join('') }}"