1PG_AUTOCTL CREATE COORDINATOR(1)pg_auto_failoverPG_AUTOCTL CREATE COORDINATOR(1)
2
3
4

NAME

6       pg_autoctl create coordinator - pg_autoctl create coordinator
7
8       pg_autoctl create coordinator - Initialize a pg_auto_failover coordina‐
9       tor node
10

SYNOPSIS

12       The   command   pg_autoctl    create    coordinator    initializes    a
13       pg_auto_failover  Coordinator node for a Citus formation. The coordina‐
14       tor is special in a Citus formation: that's where the  client  applica‐
15       tion connects to either to manage the formation and the sharding of the
16       tables, or for its normal SQL traffic.
17
18       The coordinator also has to register every worker in the formation.
19
20          usage: pg_autoctl create coordinator
21
22            --pgctl           path to pg_ctl
23            --pgdata          path to data directory
24            --pghost          PostgreSQL's hostname
25            --pgport          PostgreSQL's port number
26            --hostname        hostname by which postgres is reachable
27            --listen          PostgreSQL's listen_addresses
28            --username        PostgreSQL's username
29            --dbname          PostgreSQL's database name
30            --name            pg_auto_failover node name
31            --formation       pg_auto_failover formation
32            --monitor         pg_auto_failover Monitor Postgres URL
33            --auth            authentication method for connections from monitor
34            --skip-pg-hba     skip editing pg_hba.conf rules
35            --citus-secondary when used, this worker node is a citus secondary
36            --citus-cluster   name of the Citus Cluster for read-replicas
37            --ssl-self-signed setup network encryption using self signed certificates (does NOT protect against MITM)
38            --ssl-mode        use that sslmode in connection strings
39            --ssl-ca-file     set the Postgres ssl_ca_file to that file path
40            --ssl-crl-file    set the Postgres ssl_crl_file to that file path
41            --no-ssl          don't enable network encryption (NOT recommended, prefer --ssl-self-signed)
42            --server-key      set the Postgres ssl_key_file to that file path
43            --server-cert     set the Postgres ssl_cert_file to that file path
44

DESCRIPTION

46       This commands works the same as the pg_autoctl create postgres  command
47       and implements the following extra steps:
48
49          1. adds shared_preload_libraries = citus to the local PostgreSQL in‐
50             stance configuration.
51
52          2. enables the whole local area network to connect to the  coordina‐
53             tor, by adding an entry for e.g. 192.168.1.0/24 in the PostgreSQL
54             HBA configuration.
55
56          3. creates the extension citus in the target database.
57
58       IMPORTANT:
59          The default --dbname is the same as the current  system  user  name,
60          which  in many case is going to be postgres. Please make sure to use
61          the --dbname option with the actual database that  you're  going  to
62          use with your application.
63
64          Citus does not support multiple databases, you have to use the data‐
65          base where Citus is created. When using Citus, that is essential  to
66          the well behaving of worker failover.
67

OPTIONS

69       See  the  manual page for pg_autoctl create postgres for the common op‐
70       tions. This section now lists the options that are specific  to  pg_au‐
71       toctl create coordinator:
72
73       --citus-secondary
74              Use  this  option  to  create a coordinator dedicated to a Citus
75              Secondary cluster.
76
77              See Citus Secondaries and read-replica for more information.
78
79       --citus-cluster
80              Use this option to name the Citus Secondary  cluster  that  this
81              coordinator node belongs to. Use the same cluster name again for
82              the worker nodes that are part of this cluster.
83
84              See Citus Secondaries and read-replica for more information.
85

AUTHOR

87       Microsoft
88

90       Copyright (c) Microsoft Corporation. All rights reserved.
91
92
93
94
952.0                              Sep 13, 2023 PG_AUTOCTL CREATE COORDINATOR(1)
Impressum