.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PG_AUTOCTL CREATE COORDINATOR" "1" "Nov 06, 2022" "2.0" "pg_auto_failover"
.SH NAME
pg_autoctl create coordinator \- pg_autoctl create coordinator
.sp
pg_autoctl create coordinator \- Initialize a pg_auto_failover coordinator node
.SH SYNOPSIS
.sp
The command \fBpg_autoctl create coordinator\fP initializes a pg_auto_failover
Coordinator node for a Citus formation. The coordinator is special in a
Citus formation: that\(aqs where the client application connects to either to
manage the formation and the sharding of the tables, or for its normal SQL
traffic.
.sp
The coordinator also has to register every worker in the formation.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: pg_autoctl create coordinator

  \-\-pgctl           path to pg_ctl
  \-\-pgdata          path to data directory
  \-\-pghost          PostgreSQL\(aqs hostname
  \-\-pgport          PostgreSQL\(aqs port number
  \-\-hostname        hostname by which postgres is reachable
  \-\-listen          PostgreSQL\(aqs listen_addresses
  \-\-username        PostgreSQL\(aqs username
  \-\-dbname          PostgreSQL\(aqs 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\(aqt 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
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
This commands works the same as the \fI\%pg_autoctl create postgres\fP
command and implements the following extra steps:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
adds \fBshared_preload_libraries = citus\fP to the local PostgreSQL
instance configuration.
.IP 2. 3
enables the whole local area network to connect to the coordinator,
by adding an entry for e.g. \fB192.168.1.0/24\fP in the PostgreSQL
HBA configuration.
.IP 3. 3
creates the extension \fBcitus\fP in the target database.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
The default \fB\-\-dbname\fP is the same as the current system user name,
which in many case is going to be \fBpostgres\fP\&. Please make sure to use
the \fB\-\-dbname\fP option with the actual database that you\(aqre going to use
with your application.
.sp
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.
.UNINDENT
.UNINDENT
.SH OPTIONS
.sp
See the manual page for \fI\%pg_autoctl create postgres\fP for the common
options. This section now lists the options that are specific to
\fBpg_autoctl create coordinator\fP:
.INDENT 0.0
.TP
.B  \-\-citus\-secondary
Use this option to create a coordinator dedicated to a Citus Secondary
cluster.
.sp
See \fI\%Citus Secondaries and read\-replica\fP for more information.
.TP
.B  \-\-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.
.sp
See \fI\%Citus Secondaries and read\-replica\fP for more information.
.UNINDENT
.SH AUTHOR
Microsoft
.SH COPYRIGHT
Copyright (c) Microsoft Corporation. All rights reserved.
.\" Generated by docutils manpage writer.
.