Use the same default paths for clickhouse_keeper (symlink) as for clickhouse_keeper (executable) #52861

vitlibar · 2023-08-01T11:51:21Z

Changelog category:

Improvement

Changelog entry:

Use the same default paths for clickhouse_keeper (symlink) as for clickhouse_keeper (executable).

Before this PR the default paths were different:

	clickhouse_keeper (executable)	clickhouse_keeper (symlink)	clickhouse-server
storage_path (default)	/var/lib/clickhouse-keeper	/var/lib/clickhouse-keeper	-
state_storage_disk (default)	/var/lib/clickhouse-keeper	/var/lib/clickhouse/coordination	/var/lib/clickhouse/coordination
log_storage_path (default)	/var/lib/clickhouse-keeper/logs	/var/lib/clickhouse/coordination/logs	/var/lib/clickhouse/coordination/logs
snapshot_storage_path (default)	/var/lib/clickhouse-keeper/snapshots	/var/lib/clickhouse/coordination/snapshots	/var/lib/clickhouse/coordination/snapshots

After this PR the default paths for clickhouse_keeper (executable) and clickhouse_keeper (symlink) will be the same:

	clickhouse_keeper (executable)	clickhouse_keeper (symlink)	clickhouse-server
storage_path (default)	/var/lib/clickhouse-keeper	/var/lib/clickhouse-keeper	-
state_storage_disk (default)	/var/lib/clickhouse-keeper	/var/lib/clickhouse-keeper	/var/lib/clickhouse/coordination
log_storage_path (default)	/var/lib/clickhouse-keeper/logs	/var/lib/clickhouse-keeper/logs	/var/lib/clickhouse/coordination/logs
snapshot_storage_path (default)	/var/lib/clickhouse-keeper/snapshots	/var/lib/clickhouse-keeper/snapshots	/var/lib/clickhouse/coordination/snapshots

This PR allows to run integration tests with keeper built even without -DBUILD_STANDALONE_KEEPER=1

robot-ch-test-poll · 2023-08-01T11:54:53Z

This is an automated comment for commit f55fe91 with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🟡 pending

Check name	Description	Status
AST fuzzer	Runs randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help	🟢 success
CI running	A meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR	🟡 pending
ClickHouse build check	Builds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process	🟢 success
Compatibility check	Checks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help	🟢 success
Docker image for servers	The check to build and optionally push the mentioned image to docker hub	🟢 success
Fast test	Normally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here	🟢 success
Flaky tests	Checks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc	🟢 success
Install packages	Checks that the built packages are installable in a clear environment	🟢 success
Integration tests	The integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests	🟢 success
Mergeable Check	Checks if all other necessary checks are successful	🟢 success
Performance Comparison	Measure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests	🟢 success
Push to Dockerhub	The check for building and pushing the CI related docker images to docker hub	🟢 success
SQLancer	Fuzzing tests that detect logical bugs with SQLancer tool	🟢 success
Sqllogic	Run clickhouse on the sqllogic test set against sqlite and checks that all statements are passed	🟢 success
Stateful tests	Runs stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	🟢 success
Stateless tests	Runs stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	🟢 success
Stress test	Runs stateless functional tests concurrently from several clients to detect concurrency-related errors	🟢 success
Style Check	Runs a set of checks to keep the code style clean. If some of tests failed, see the related log from the report	🟢 success
Unit tests	Runs the unit tests for different release types	🟢 success
Upgrade check	Runs stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts	🟢 success

vitlibar · 2023-08-01T13:03:21Z

programs/keeper/Keeper.cpp

@@ -330,6 +330,7 @@ try
    auto global_context = Context::createGlobal(shared_context.get());

    global_context->makeGlobalContext();
+    global_context->setApplicationType(Context::ApplicationType::KEEPER);


The main fix is here because Context::initializeKeeperDispatcher() checks the application type and then passes is_standalone_app = (application_type == ApplicationType::KEEPER) to KeeperContext which uses it to calculate the default paths.

vitlibar · 2023-08-01T13:10:09Z

programs/keeper/Keeper.cpp

@@ -365,7 +366,7 @@ try
    }

    /// Initialize keeper RAFT. Do nothing if no keeper_server in config.
-    global_context->initializeKeeperDispatcher(/* start_async = */ true);
+    global_context->initializeKeeperDispatcher(/* start_async = */ false);


The Keeper class can be used either by clickhouse-keeper executable or by clickhouse-keeper symlink. It's not used by clickhouse-server, so asynchronous starting is not required here. See also the assert in Context::initializeKeeperDispatcher().

pufit · 2023-08-02T13:42:55Z

I'm a little bit concerned about changing the default storage path. If someone runs Keeper with default configs and then updates to the newest version, they will probably see it as a data loss (if they don't know about these changes).

pufit

Looks good (except for my concern above)

…ckhouse_keeper (executable), i.e. "/var/lib/clickhouse-keeper/.."

…figuration ('path' must be reserved for clickhouse-server).

vitlibar · 2023-08-04T14:04:29Z

I'm a little bit concerned about changing the default storage path. If someone runs Keeper with default configs and then updates to the newest version, they will probably see it as a data loss (if they don't know about these changes).

You're right, that can be not expected. I decided to show an error message if the setting keeper_server.storage_path is not specified explicitly and the disk contains a directory corresponding to the old default /var/lib/clickhouse/coordination:
https://github.com/ClickHouse/ClickHouse/pull/52861/files#diff-9c0097002f06f6692193efbf2c2dcfc5fc1a2b61ad41fca522922fd783728f44R294-R299

tavplubix · 2023-08-17T18:57:27Z

programs/keeper/Keeper.cpp

    if (config().has("keeper_server.storage_path"))
+    {
        path = config().getString("keeper_server.storage_path");
+    }
+    else if (std::filesystem::is_directory(std::filesystem::path{config().getString("path", DBMS_DEFAULT_PATH)} / "coordination"))
+    {
+        throw Exception(ErrorCodes::NO_ELEMENTS_IN_CONFIG,
+                        "By default 'keeper.storage_path' could be assigned to {}, but the directory {} already exists. Please specify 'keeper.storage_path' in the keeper configuration explicitly",
+                        KEEPER_DEFAULT_PATH, String{std::filesystem::path{config().getString("path", DBMS_DEFAULT_PATH)} / "coordination"});
+    }
    else if (config().has("keeper_server.log_storage_path"))
+    {
        path = std::filesystem::path(config().getString("keeper_server.log_storage_path")).parent_path();


The order of checks is weird. It will throw the exception if we have keeper_server.log_storage_path and keeper_server.snapshot_storage_path set, but don't have keeper_server.storage_path. But it doesn't make sense to require keeper_server.storage_path in this case, there's no ambiguity

@pufit, would you like to make a follow-up PR with a fix? (Vitaly is on vacation right now)

robot-ch-test-poll added the pr-improvement Pull request with some product improvements label Aug 1, 2023

vitlibar requested a review from alesapin August 1, 2023 11:56

vitlibar commented Aug 1, 2023

View reviewed changes

vitlibar force-pushed the clickhouse-keeper-same-default-paths branch from a8ef34b to f813be1 Compare August 1, 2023 14:03

vitlibar removed the request for review from alesapin August 1, 2023 14:18

pufit self-assigned this Aug 2, 2023

pufit approved these changes Aug 3, 2023

View reviewed changes

vitlibar added 2 commits August 4, 2023 13:38

Use the same default paths for clickhouse_keeper (symlink) as for cli…

552331f

…ckhouse_keeper (executable), i.e. "/var/lib/clickhouse-keeper/.."

Revert extracting the root keeper path from the 'path' key in the con…

89c99e4

…figuration ('path' must be reserved for clickhouse-server).

vitlibar force-pushed the clickhouse-keeper-same-default-paths branch from d7665f3 to ca71590 Compare August 4, 2023 13:57

Throw an exception if wrong default path is going to be used.

f55fe91

vitlibar force-pushed the clickhouse-keeper-same-default-paths branch from ca71590 to f55fe91 Compare August 4, 2023 14:13

vitlibar merged commit 80254c4 into ClickHouse:master Aug 5, 2023
267 of 269 checks passed

vitlibar deleted the clickhouse-keeper-same-default-paths branch August 5, 2023 11:49

tavplubix reviewed Aug 17, 2023

View reviewed changes

pufit mentioned this pull request Aug 18, 2023

Fix keeper default path check #53539

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use the same default paths for clickhouse_keeper (symlink) as for clickhouse_keeper (executable) #52861

Use the same default paths for clickhouse_keeper (symlink) as for clickhouse_keeper (executable) #52861

vitlibar commented Aug 1, 2023 •

edited

robot-ch-test-poll commented Aug 1, 2023 •

edited by robot-ch-test-poll1

vitlibar Aug 1, 2023

vitlibar Aug 1, 2023

pufit commented Aug 2, 2023

pufit left a comment

vitlibar commented Aug 4, 2023

tavplubix Aug 17, 2023

tavplubix Aug 17, 2023

Use the same default paths for clickhouse_keeper (symlink) as for clickhouse_keeper (executable) #52861

Use the same default paths for clickhouse_keeper (symlink) as for clickhouse_keeper (executable) #52861

Conversation

vitlibar commented Aug 1, 2023 • edited

Changelog category:

Changelog entry:

robot-ch-test-poll commented Aug 1, 2023 • edited by robot-ch-test-poll1

vitlibar Aug 1, 2023

Choose a reason for hiding this comment

vitlibar Aug 1, 2023

Choose a reason for hiding this comment

pufit commented Aug 2, 2023

pufit left a comment

Choose a reason for hiding this comment

vitlibar commented Aug 4, 2023

tavplubix Aug 17, 2023

Choose a reason for hiding this comment

tavplubix Aug 17, 2023

Choose a reason for hiding this comment

vitlibar commented Aug 1, 2023 •

edited

robot-ch-test-poll commented Aug 1, 2023 •

edited by robot-ch-test-poll1