pg_autoctl disable maintenance(1)

pg_autoctl disable maintenance

Section 1 pg-auto-failover-cli bookworm source

Description

PG_AUTOCTL DISABLE MAINTENANCE

NAME

pg_autoctl disable maintenance - pg_autoctl disable maintenance

pg_autoctl disable maintenance - Disable Postgres maintenance mode on this node

SYNOPSIS

A pg_auto_failover can be put to a maintenance state. The Postgres node is then still registered to the monitor, and is known to be unreliable until maintenance is disabled. A node in the maintenance state is not a candidate for promotion.

Typical use of the maintenance state include Operating System or Postgres reboot, e.g. when applying security upgrades.

usage: pg_autoctl disable maintenance [ --pgdata --allow-failover ]

--pgdata path to data directory

OPTIONS

--pgdata

Location of the Postgres node being managed locally. Defaults to the environment variable PGDATA. Use --monitor to connect to a monitor from anywhere, rather than the monitor URI used by a local Postgres node managed with pg_autoctl.

--formation

Target formation where to disable secondary feature.

ENVIRONMENT

PGDATA

Postgres directory location. Can be used instead of the --pgdata option.

PG_AUTOCTL_MONITOR

Postgres URI to connect to the monitor node, can be used instead of the --monitor option.

XDG_CONFIG_HOME

The pg_autoctl command stores its configuration files in the standard place XDG_CONFIG_HOME. See the XDG Base Directory Specification.

XDG_DATA_HOME

The pg_autoctl command stores its internal states files in the standard place XDG_DATA_HOME, which defaults to ˜/.local/share. See the XDG Base Directory Specification.

EXAMPLES

$ pg_autoctl show state
Name | Node | Host:Port | LSN | Connection | Current State | Assigned State
------+-------+----------------+-----------+--------------+---------------------+--------------------
node1 | 1 | localhost:5501 | 0/4000810 | read-write | primary | primary
node2 | 2 | localhost:5502 | 0/4000810 | read-only | secondary | secondary
node3 | 3 | localhost:5503 | 0/4000810 | none | maintenance | maintenance

$ pg_autoctl disable maintenance --pgdata node3
12:06:37 47542 INFO Listening monitor notifications about state changes in formation "default" and group 0
12:06:37 47542 INFO Following table displays times when notifications are received
Time | Name | Node | Host:Port | Current State | Assigned State
---------+-------+-------+----------------+---------------------+--------------------
12:06:37 | node3 | 3 | localhost:5503 | maintenance | catchingup
12:06:37 | node3 | 3 | localhost:5503 | catchingup | catchingup
12:06:37 | node3 | 3 | localhost:5503 | catchingup | secondary
12:06:37 | node3 | 3 | localhost:5503 | secondary | secondary

$ pg_autoctl show state
Name | Node | Host:Port | LSN | Connection | Current State | Assigned State
------+-------+----------------+-----------+--------------+---------------------+--------------------
node1 | 1 | localhost:5501 | 0/4000848 | read-write | primary | primary
node2 | 2 | localhost:5502 | 0/4000848 | read-only | secondary | secondary
node3 | 3 | localhost:5503 | 0/4000000 | read-only | secondary | secondary

AUTHOR

Microsoft

COPYRIGHT

Copyright (c) Microsoft Corporation. All rights reserved.