1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
.. _pg_autoctl_create_coordinator:
pg_autoctl create coordinator
=============================
pg_autoctl create coordinator - Initialize a pg_auto_failover coordinator node
Synopsis
--------
The command ``pg_autoctl create coordinator`` initializes a pg_auto_failover
Coordinator node for a Citus formation. The coordinator is special in a
Citus formation: that's where the client application connects to either to
manage the formation and the sharding of the tables, or for its normal SQL
traffic.
The coordinator also has to register every worker in the formation.
::
usage: pg_autoctl create coordinator
--pgctl path to pg_ctl
--pgdata path to data directory
--pghost PostgreSQL's hostname
--pgport PostgreSQL's port number
--hostname hostname by which postgres is reachable
--listen PostgreSQL's listen_addresses
--username PostgreSQL's username
--dbname PostgreSQL's database name
--name pg_auto_failover node name
--formation pg_auto_failover formation
--monitor pg_auto_failover Monitor Postgres URL
--auth authentication method for connections from monitor
--skip-pg-hba skip editing pg_hba.conf rules
--citus-secondary when used, this worker node is a citus secondary
--citus-cluster name of the Citus Cluster for read-replicas
--ssl-self-signed setup network encryption using self signed certificates (does NOT protect against MITM)
--ssl-mode use that sslmode in connection strings
--ssl-ca-file set the Postgres ssl_ca_file to that file path
--ssl-crl-file set the Postgres ssl_crl_file to that file path
--no-ssl don't enable network encryption (NOT recommended, prefer --ssl-self-signed)
--server-key set the Postgres ssl_key_file to that file path
--server-cert set the Postgres ssl_cert_file to that file path
Description
-----------
This commands works the same as the :ref:`pg_autoctl_create_postgres`
command and implements the following extra steps:
1. adds ``shared_preload_libraries = citus`` to the local PostgreSQL
instance configuration.
2. enables the whole local area network to connect to the coordinator,
by adding an entry for e.g. ``192.168.1.0/24`` in the PostgreSQL
HBA configuration.
3. creates the extension ``citus`` in the target database.
.. important::
The default ``--dbname`` is the same as the current system user name,
which in many case is going to be ``postgres``. Please make sure to use
the ``--dbname`` option with the actual database that you're going to use
with your application.
Citus does not support multiple databases, you have to use the database
where Citus is created. When using Citus, that is essential to the well
behaving of worker failover.
Options
-------
See the manual page for :ref:`pg_autoctl_create_postgres` for the common
options. This section now lists the options that are specific to
``pg_autoctl create coordinator``:
--citus-secondary
Use this option to create a coordinator dedicated to a Citus Secondary
cluster.
See :ref:`citus_secondaries` for more information.
--citus-cluster
Use this option to name the Citus Secondary cluster that this coordinator
node belongs to. Use the same cluster name again for the worker nodes that
are part of this cluster.
See :ref:`citus_secondaries` for more information.
|
