db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-11-06 08:49:29 +02:00
Code Issues Releases Activity

Add hint and documentation for protocol version mismatches.

Browse Source 
Update the documentation to explicitly state that versions must match across hosts when running remotely.

Add a hint to the protocol version mismatch error to help the user identify the problem.
This commit is contained in:
David Steele
2020-09-25 10:30:29 -04:00
committed by GitHub
parent b096a25b49
commit 31962377d9
4 changed files with 39 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
doc/xml/release.xml
View File

@@ -70,6 +70,17 @@
<p>Add hint about starting the stanza when WAL segment not found.</p>
</release-item>
<release-item>
<commit subject="Add hint and documentation for protocol version mismatches."/>
<release-item-contributor-list>
<release-item-ideator id="loop-evgeny"/>
<release-item-reviewer id="cynthia.shang"/>
</release-item-contributor-list>
<p>Add hint for protocol version mismatch.</p>
</release-item>
</release-improvement-list>
<release-development-list>
@@ -94,6 +105,17 @@
<release-doc-list>
<release-improvement-list>
<release-item>
<commit subject="Add hint and documentation for protocol version mismatches."/>
<release-item-contributor-list>
<release-item-ideator id="loop-evgeny"/>
<release-item-reviewer id="cynthia.shang"/>
</release-item-contributor-list>
<p>Add note that <backrest/> versions must match when running remotely.</p>
</release-item>
<release-item>
<release-item-contributor-list>
<release-item-contributor id="heath.lord"/>
@@ -9020,6 +9042,11 @@
<contributor-id type="github">L30Bola</contributor-id>
</contributor>
<contributor id="loop-evgeny">
<contributor-name-display>loop-evgeny</contributor-name-display>
<contributor-id type="github">loop-evgeny</contributor-id>
</contributor>
<contributor id="luca.ferrari">
<contributor-name-display>Luca Ferrari</contributor-name-display>
<contributor-id type="github">fluca1978</contributor-id>

2
doc/xml/user-guide.xml
View File

@@ -2337,6 +2337,8 @@
<p>A new host named <host>repository</host> is created to store the cluster backups.</p>
<admonition type="note">The <backrest/> version installed on the <host>repository</host> host must exactly match the version installed on the <postgres/> host.</admonition>
<host-add id="{[host-repo1-id]}" name="{[host-repo1]}" user="{[host-repo1-user]}" image="{[host-repo1-image]}" os="{[os-type]}" mount="{[host-repo1-mount]}" option="{[host-option]}"/>
<p>The <user>{[br-user]}</user> user is created to own the <backrest/> repository. Any user can own the repository but it is best not to use <user>postgres</user> (if it exists) to avoid confusion.</p>

6
src/protocol/client.c
View File

@@ -118,8 +118,10 @@ protocolClientNew(const String *name, const String *service, IoRead *read, IoWri
if (!strEq(varStr(actualValue), expectedValue))
{
THROW_FMT(
ProtocolError, "expected value '%s' for greeting key '%s' but got '%s'", strZ(expectedValue),
strZ(expectedKey), strZ(varStr(actualValue)));
ProtocolError,
"expected value '%s' for greeting key '%s' but got '%s'\n"
"HINT: is the same version of " PROJECT_NAME " installed on the local and remote host?",
strZ(expectedValue), strZ(expectedKey), strZ(varStr(actualValue)));
}
}
}

9
test/src/module/protocol/protocolTest.c
View File

@@ -507,13 +507,16 @@ testRun(void)
"unable to find greeting key 'name'");
TEST_ERROR(
protocolClientNew(strNew("test client"), strNew("test"), read, write), ProtocolError,
"expected value 'pgBackRest' for greeting key 'name' but got 'bogus'");
"expected value 'pgBackRest' for greeting key 'name' but got 'bogus'\n"
"HINT: is the same version of " PROJECT_NAME " installed on the local and remote host?");
TEST_ERROR(
protocolClientNew(strNew("test client"), strNew("test"), read, write), ProtocolError,
"expected value 'test' for greeting key 'service' but got 'bogus'");
"expected value 'test' for greeting key 'service' but got 'bogus'\n"
"HINT: is the same version of " PROJECT_NAME " installed on the local and remote host?");
TEST_ERROR(
protocolClientNew(strNew("test client"), strNew("test"), read, write), ProtocolError,
"expected value '" PROJECT_VERSION "' for greeting key 'version' but got 'bogus'");
"expected value '" PROJECT_VERSION "' for greeting key 'version' but got 'bogus'\n"
"HINT: is the same version of " PROJECT_NAME " installed on the local and remote host?");
// Correct greeting
ProtocolClient *client = NULL;