Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 2931ad2

Browse files
vbwagnervbwagner
committed
Removed RDMA-related stuff from docs
1 parent 369b41d commit 2931ad2

File tree

4 files changed

+0
-207
lines changed

4 files changed

+0
-207
lines changed

‎doc/src/sgml/config.sgml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -635,20 +635,6 @@ include_dir 'conf.d'
635635
</listitem>
636636
</varlistentry>
637637

638-
<varlistentry id="listen-rdma-addresses" xreflabel="listen_rdma_addresses">
639-
<term><varname>listen_rdma_addresses</varname> (<type>string</type>)
640-
<indexterm>
641-
<primary><varname>listen_rdma_addresses</> configuration parameter</primary>
642-
</indexterm>
643-
</term>
644-
<listitem>
645-
<para>
646-
Specifies the TCP/IP address(es) on which the server is to listen for new remote direct memory access (<literal>RDMA</literal>) connections via <literal>rsocket</literal> from client applications. The value takes the form of a comma-separated list of host names
647-
and/or numeric IP addresses. The special entry <literal>*</>
648-
corresponds to all available IP interfaces.
649-
</para>
650-
</listitem>
651-
</varlistentry>
652638

653639
<varlistentry id="guc-port" xreflabel="port">
654640
<term><varname>port</varname> (<type>integer</type>)

‎doc/src/sgml/installation.sgml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -765,15 +765,6 @@ su - postgres
765765
</varlistentry>
766766

767767

768-
<varlistentry>
769-
<term><option>--with-rsocket</option></term>
770-
<listitem>
771-
<para>
772-
Enable <literal>rsocket</literal> API support for remote direct memory access (<acronym>RDMA</acronym>).
773-
You must also set the <xref linkend="listen-rdma-addresses"> variable for your server to enable <acronym>RDMA</acronym> connections via <literal>rsocket</literal>.
774-
</para>
775-
</listitem>
776-
</varlistentry>
777768

778769
<varlistentry>
779770
<term><option>--with-openssl</option>

‎doc/src/sgml/libpq.sgml

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,15 +1106,6 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
11061106
</listitem>
11071107
</varlistentry>
11081108

1109-
<varlistentry id="libpq-with-rsocket" xreflabel="libpq_with_rsocket">
1110-
<term><literal>with_rsocket</literal></term>
1111-
<listitem>
1112-
<para>
1113-
Connects to the server using <literal>rsocket</literal> API.
1114-
You must also set the <xref linkend="listen-rdma-addresses"> variable for your server to enable <acronym>RDMA</acronym> connections via <literal>rsocket</literal>.
1115-
</para>
1116-
</listitem>
1117-
</varlistentry>
11181109

11191110

11201111
<varlistentry id="libpq-connect-application-name" xreflabel="application_name">
@@ -7161,14 +7152,6 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough)
71617152
</para>
71627153
</listitem>
71637154

7164-
<listitem>
7165-
<para>
7166-
<indexterm>
7167-
<primary><envar>WITH_RSOCKET</envar></primary>
7168-
</indexterm>
7169-
<envar>WITH_RSOCKET</envar> behaves the same as the <xref linkend="libpq-with-rsocket"> connection parameter.
7170-
</para>
7171-
</listitem>
71727155

71737156
</itemizedlist>
71747157
</para>

‎doc/src/sgml/runtime.sgml

Lines changed: 0 additions & 167 deletions
Original file line numberDiff line numberDiff line change
@@ -2463,173 +2463,6 @@ ssh -L 63333:db.foo.com:5432 joe@shell.foo.com
24632463

24642464
</sect1>
24652465

2466-
<sect1 id="rdma-connections">
2467-
<title>RDMA Connections</title>
2468-
2469-
<para><productname>&productname;</productname> provides support for client/server connections that use remote direct memory access (<acronym>RDMA</acronym>) technology. You must have an <acronym>RDMA</acronym> implementation set up on both client and server systems.</para>
2470-
<para>With <acronym>RDMA</acronym>, data can be sent directly into the memory of the remote system, bypassing the operating system kernel. As a result, this reduces the CPU load, ensures low network latency in distributed systems, and yields better performance.
2471-
</para>
2472-
2473-
<sect2 id="rdma-setup">
2474-
<title>Enabling <productname>&productname;</productname> Client/Server <acronym>RDMA</acronym> Connections</title>
2475-
2476-
<para>For client/server <acronym>RDMA</acronym> connections, <productname>&productname;</productname> uses <application>libpq</application> with <literal>rsocket</literal> API.
2477-
To enable <acronym>RDMA</acronym> connections for your <productname>&productname;</productname> database via <literal>rsocket</literal>, you must configure both client and server systems, as follows:
2478-
</para>
2479-
2480-
<orderedlist>
2481-
<listitem>
2482-
<para>On the server side, add the <xref linkend="listen-rdma-addresses"> GUC variable to the <filename>postgresql.conf</filename> configuration file to specify TCP/IP address(es) on which the server is to listen for new <acronym>RDMA</acronym> connections via <literal>rsocket</literal> from client applications. For example:
2483-
<programlisting>
2484-
listen_rdma_addresses = 'server1,172.17.3.21'
2485-
</programlisting>
2486-
You can specify a comma-separated list of host names and/or numeric IP addresses. If set to <literal>*</>, this variable will enable <acronym>RDMA</acronym> connections via <literal>rsocket</literal> to all the available IP interfaces.
2487-
</para>
2488-
<important>
2489-
<para>Since all connections use the same port specified in the <varname>port</varname> variable, make sure to specify different IP addresses in <varname>listen_addresses</varname> and <varname>listen_rdma_addresses</varname> to avoid conflicts.
2490-
</para>
2491-
</important>
2492-
</listitem>
2493-
2494-
<listitem>
2495-
<para>
2496-
On the client side, modify the <application>libpq</application> connection parameters to use <literal>rsocket</literal> API. This can be done in one of the following ways:
2497-
</para>
2498-
<itemizedlist>
2499-
<listitem>
2500-
<para>Add the following <literal>rsocket</literal> settings to the <application>libpq</application> <link linkend="libpq-pgservice">connection service file</link> <filename>pg_service.conf</filename>:
2501-
<programlisting>
2502-
# rsocket configuration
2503-
[rsocket]
2504-
host=<replaceable>hostname</>
2505-
port=5433
2506-
user=<replaceable>username</>
2507-
with_rsocket=true
2508-
</programlisting>
2509-
When the client is connecting to the server via <application>libpq</application>, the name of the service provided in square brackets in the <filename>pg_service.conf</filename> file must be specified in the <link linkend="LIBPQ-PARAMKEYWORDS"><option>service</option></link> parameter keyword, or in the corresponding <link linkend="libpq-envars"><envar>PGSERVICE</envar></link> environment variable. This approach enables you to dynamically control client/server connection type.
2510-
</para>
2511-
</listitem>
2512-
2513-
<listitem>
2514-
<para>Alternatively, you can set the <envar>WITH_RSOCKET</envar> environment variable:
2515-
<programlisting>
2516-
export WITH_RSOCKET=true
2517-
</programlisting>
2518-
In this case, all the client/server connections will use <literal>rsocket</literal> API.
2519-
</para>
2520-
</listitem>
2521-
</itemizedlist>
2522-
</listitem>
2523-
</orderedlist>
2524-
2525-
</sect2>
2526-
2527-
<sect2>
2528-
<title>Using <acronym>RDMA</acronym> with <application>pg_dump</application></title>
2529-
<para>To connect <application>pg_dump</application> to the server over <acronym>RDMA</acronym> via <literal>rsocket</literal>:</para>
2530-
<orderedlist>
2531-
<listitem>
2532-
<para>Set up the server as described in <xref linkend="rdma-setup">.
2533-
</para>
2534-
</listitem>
2535-
<listitem>
2536-
<para>Set the <envar>WITH_RSOCKET</envar> environment variable:
2537-
<programlisting>
2538-
export WITH_RSOCKET=true
2539-
</programlisting>
2540-
</para>
2541-
</listitem>
2542-
</orderedlist>
2543-
<para>Once the setup is complete, launch <application>pg_dump</application> as usual. For example:
2544-
</para>
2545-
<programlisting>
2546-
pg_dump <replaceable>dbname</> -h <replaceable>hostname</> > db.sql
2547-
</programlisting>
2548-
2549-
</sect2>
2550-
2551-
<sect2>
2552-
<title>Using <acronym>RDMA</acronym> for Master-Slave Replication</title>
2553-
<para>To enable master-slave replication over <acronym>RDMA</acronym> connections via <literal>rsocket</literal>, you need to configure master and slave nodes. For example, to allow client connections to the server 172.17.3.21 from 172.17.3.0/24 addresses on behalf of the <literal>postgres</> user, follow the steps below:</para>
2554-
2555-
<para><emphasis role="strong">To set up the master node for replication over <acronym>RDMA</acronym> connections via <literal>rsocket</literal>:</emphasis>
2556-
</para>
2557-
<orderedlist>
2558-
<listitem>
2559-
<para>Edit the <filename>pg_hba.conf</filename> file to allow client connections and replication from the specified IP addresses:
2560-
<programlisting>
2561-
host all postgres 172.17.3.0/24 md5
2562-
host replication postgres 172.17.3.0/24 md5
2563-
</programlisting>
2564-
</para>
2565-
</listitem>
2566-
<listitem>
2567-
<para>
2568-
Edit the <filename>postgresql.conf</filename> file:
2569-
<programlisting>
2570-
listen_rdma_addresses = '172.17.3.21'
2571-
wal_level = hot_standby
2572-
hot_standby = on
2573-
max_wal_senders = 1
2574-
</programlisting>
2575-
The <varname>listen_rdma_addresses</varname> variable specifies the TCP/IP address(es) on which the server is to listen for new <acronym>RDMA</acronym> connections via <literal>rsocket</literal>.
2576-
</para>
2577-
</listitem>
2578-
<listitem>
2579-
<para>Restart the master node.
2580-
</para>
2581-
</listitem>
2582-
</orderedlist>
2583-
2584-
<tip>
2585-
<para>If you set <varname>log_connections</varname> and <varname>log_disconnections</varname> GUC variables, the log file will include detailed information on each client connection and disconnection, respectively. For example:
2586-
<programlisting>
2587-
LOG: connection received: host=172.17.3.22 port=37709 with_rsocket=true
2588-
LOG: disconnection: session time: 0:00:00.622 user=postgres database= host=172.17.3.22 port=37709 with_rsocket=true
2589-
</programlisting>
2590-
</para>
2591-
</tip>
2592-
2593-
<para><emphasis role="strong">To set up the slave node:</emphasis>
2594-
</para>
2595-
<orderedlist>
2596-
<listitem>
2597-
<para>Set the <envar>WITH_RSOCKET</envar> environment variable:
2598-
<programlisting>
2599-
export WITH_RSOCKET=true
2600-
</programlisting>
2601-
</para>
2602-
</listitem>
2603-
<listitem>
2604-
<para>Copy the data from the master node using <application>pg_basebackup</application>:
2605-
<programlisting>
2606-
pg_basebackup -D <replaceable>datadir</> -x -R -h 172.17.3.21 -U postgres
2607-
</programlisting>
2608-
All the data appears on the slave node under the specified <replaceable>datadir</> directory.
2609-
</para>
2610-
</listitem>
2611-
<listitem>
2612-
<para>Make sure the <filename><replaceable>datadir</>/recovery.conf</filename> contains the <literal>with_rsocket</literal> parameter.
2613-
<programlisting>
2614-
standby_mode = 'on'
2615-
primary_conninfo = 'user=postgres host=172.17.3.21 port=5432 with_rsocket=true'
2616-
</programlisting>
2617-
</para>
2618-
</listitem>
2619-
<listitem>
2620-
<para>In the <filename>postgresql.conf</filename> file, clear the <varname>listen_rdma_addresses</varname> parameter:
2621-
<programlisting>
2622-
listen_rdma_addresses = ''
2623-
</programlisting>
2624-
</para>
2625-
</listitem>
2626-
</orderedlist>
2627-
2628-
<para>Once the setup is complete, start the slave node. The streaming replication is now performed over the <acronym>RDMA</acronym> connections using <literal>rsocket</literal> API.</para>
2629-
2630-
</sect2>
2631-
2632-
</sect1>
26332466

26342467
<sect1 id="event-log-registration">
26352468
<title>Registering <application>Event Log</> on <systemitem

0 commit comments

Comments
 (0)