1PG_AUTOCTL ENABLE MONITOR(1)   pg_auto_failover   PG_AUTOCTL ENABLE MONITOR(1)
2
3
4

NAME

6       pg_autoctl enable monitor - pg_autoctl enable monitor
7
8       pg_autoctl  enable  monitor  - Enable a monitor for this node to be or‐
9       chestrated from
10

SYNOPSIS

12       It is possible to disable the pg_auto_failover monitor  and  enable  it
13       again  online in a running pg_autoctl Postgres node. The main use-cases
14       where this operation is useful is when the monitor node has to  be  re‐
15       placed,  either after a full crash of the previous monitor node, of for
16       migrating to a new monitor node (hardware replacement, region  or  zone
17       migration, etc).
18
19           usage: pg_autoctl enable monitor  [ --pgdata --allow-failover ] postgres://autoctl_node@new.monitor.add.ress/pg_auto_failover
20
21          --pgdata      path to data directory
22

OPTIONS

24       --pgdata
25              Location of the Postgres node being managed locally. Defaults to
26              the environment variable PGDATA. Use --monitor to connect  to  a
27              monitor from anywhere, rather than the monitor URI used by a lo‐
28              cal Postgres node managed with pg_autoctl.
29

ENVIRONMENT

31       PGDATA
32          Postgres directory location. Can be used instead of the --pgdata op‐
33          tion.
34
35       PG_AUTOCTL_MONITOR
36          Postgres  URI to connect to the monitor node, can be used instead of
37          the --monitor option.
38
39       XDG_CONFIG_HOME
40          The pg_autoctl command stores its configuration files in  the  stan‐
41          dard  place  XDG_CONFIG_HOME.  See the XDG Base Directory Specifica‐
42          tion.
43
44       XDG_DATA_HOME
45          The pg_autoctl command stores its internal states files in the stan‐
46          dard  place XDG_DATA_HOME, which defaults to ~/.local/share. See the
47          XDG Base Directory Specification.
48

EXAMPLES

50          $ pg_autoctl show state
51           Name |  Node |      Host:Port |       LSN |   Connection |       Current State |      Assigned State
52          ------+-------+----------------+-----------+--------------+---------------------+--------------------
53          node1 |     1 | localhost:5501 | 0/4000760 |   read-write |             primary |             primary
54          node2 |     2 | localhost:5502 | 0/4000760 |    read-only |           secondary |           secondary
55
56
57          $ pg_autoctl enable monitor --pgdata node3 'postgres://autoctl_node@localhost:5500/pg_auto_failover?sslmode=require'
58          12:42:07 43834 INFO  Registered node 3 (localhost:5503) with name "node3" in formation "default", group 0, state "wait_standby"
59          12:42:07 43834 INFO  Successfully registered to the monitor with nodeId 3
60          12:42:08 43834 INFO  Still waiting for the monitor to drive us to state "catchingup"
61          12:42:08 43834 WARN  Please make sure that the primary node is currently running `pg_autoctl run` and contacting the monitor.
62
63          $ pg_autoctl show state
64           Name |  Node |      Host:Port |       LSN |   Connection |       Current State |      Assigned State
65          ------+-------+----------------+-----------+--------------+---------------------+--------------------
66          node1 |     1 | localhost:5501 | 0/4000810 |   read-write |             primary |             primary
67          node2 |     2 | localhost:5502 | 0/4000810 |    read-only |           secondary |           secondary
68          node3 |     3 | localhost:5503 | 0/4000810 |    read-only |           secondary |           secondary
69

AUTHOR

71       Microsoft
72

74       Copyright (c) Microsoft Corporation. All rights reserved.
75
76
77
78
792.0                              Sep 13, 2023     PG_AUTOCTL ENABLE MONITOR(1)
Impressum