Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initialization of the database only once in Docker. #50724

Merged
merged 3 commits into from Oct 16, 2023

Conversation

AlexNik
Copy link
Contributor

@AlexNik AlexNik commented Jun 8, 2023

Changelog category:

  • Build/Testing/Packaging Improvement

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

If the database is already initialized, it doesn't need to be initialized again upon subsequent launches. This can potentially fix the issue of infinite container restarts when the database fails to load within 1000 attempts (relevant for very large databases and multi-node setups).

@CLAassistant
Copy link

CLAassistant commented Jun 8, 2023

CLA assistant check
All committers have signed the CLA.

@AlexNik AlexNik force-pushed the docker-initialization-once branch 14 times, most recently from 8af12ee to 7ca9f56 Compare June 14, 2023 13:32
@AlexNik AlexNik force-pushed the docker-initialization-once branch from 568c3fc to 4766f22 Compare June 22, 2023 08:42
@den-crane den-crane added the can be tested Allows running workflows for external contributors label Jun 22, 2023
@den-crane
Copy link
Contributor

wdyt @Felixoid

@robot-ch-test-poll robot-ch-test-poll added the pr-build Pull request with build/testing/packaging improvement label Jun 22, 2023
@robot-ch-test-poll
Copy link
Contributor

robot-ch-test-poll commented Jun 22, 2023

This is an automated comment for commit 3ed7cff with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
AST fuzzerRuns 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 runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR✅ success
ClickHouse build checkBuilds 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 checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker image for serversThe check to build and optionally push the mentioned image to docker hub✅ success
Fast testNormally 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 testsChecks 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 packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
Performance ComparisonMeasure 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 DockerhubThe check for building and pushing the CI related docker images to docker hub✅ success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool✅ success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ success
Style CheckRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Upgrade checkRuns 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
Check nameDescriptionStatus
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure

@Felixoid
Copy link
Member

It makes sense to implement it similarly to mysql and postgresql images, so it requires some refactoring to make it nices

@AlexNik AlexNik force-pushed the docker-initialization-once branch 3 times, most recently from 6ab6d41 to 3f135fb Compare June 23, 2023 09:30
@AlexNik
Copy link
Contributor Author

AlexNik commented Jun 23, 2023

@Felixoid is it OK now?
I'va added DATABASE_ALREADY_EXISTS variable and shift for if body.

Copy link
Member

@Felixoid Felixoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks OK to me, asking for another pair of eyes though

@Felixoid Felixoid self-assigned this Jun 26, 2023
@qoega
Copy link
Member

qoega commented Jun 26, 2023

BTW do we have at least some trivial tests that use this docker images? Maybe it is time to add some...

@clickhouse-ci clickhouse-ci bot added manual approve Manual approve required to run CI labels Jun 26, 2023
@Felixoid
Copy link
Member

1 time-out test for the debug build looks ok, it succeeded everywhere else

@Felixoid Felixoid merged commit a4fb143 into ClickHouse:master Oct 16, 2023
273 of 274 checks passed
robot-ch-test-poll1 added a commit that referenced this pull request Oct 16, 2023
…1b8e9b171067944199bc6b1eb8b32

Cherry pick #50724 to 23.3: Initialization of the database only once in Docker.
robot-ch-test-poll1 added a commit that referenced this pull request Oct 16, 2023
…1b8e9b171067944199bc6b1eb8b32

Cherry pick #50724 to 23.8: Initialization of the database only once in Docker.
@robot-ch-test-poll1 robot-ch-test-poll1 added the pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore label Oct 16, 2023
Felixoid added a commit that referenced this pull request Oct 17, 2023
Backport #50724 to 23.8: Initialization of the database only once in Docker.
Felixoid added a commit that referenced this pull request Oct 19, 2023
Backport #50724 to 23.3: Initialization of the database only once in Docker.
@Alesh
Copy link

Alesh commented Nov 9, 2023

Couldn't you have left the previous option for developer mode? It was convenient to immediately add the creation of new entities to the initialization script. Now we have to come up with workarounds.

@vincentbernat
Copy link
Contributor

This change is inconvenient if we still need to add some init steps even if the database exists. I am using it to:

  • update ClickHouse configuration
  • install Protobuf schemas

vincentbernat added a commit to akvorado/akvorado that referenced this pull request Nov 12, 2023
Recent versions of ClickHouse do not execute the provided entrypoint
script when the database exists. Workaround this by using our own
entrypoint and use it in place of the official one.

See ClickHouse/ClickHouse#50724.
@alexey-milovidov
Copy link
Member

alexey-milovidov commented Nov 12, 2023

Ok, looking forward to another PR with improvement.

@Felixoid Felixoid added v23.9-must-backport and removed pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore labels Nov 28, 2023
robot-ch-test-poll4 added a commit that referenced this pull request Nov 28, 2023
…1b8e9b171067944199bc6b1eb8b32

Cherry pick #50724 to 23.9: Initialization of the database only once in Docker.
@robot-ch-test-poll4 robot-ch-test-poll4 added the pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore label Nov 28, 2023
Felixoid added a commit that referenced this pull request Nov 28, 2023
Backport #50724 to 23.9: Initialization of the database only once in Docker.
vincentbernat added a commit to akvorado/akvorado that referenced this pull request Dec 11, 2023
Recent versions of ClickHouse do not execute the provided entrypoint
script when the database exists. Workaround this by using our own
entrypoint and use it in place of the official one.

See ClickHouse/ClickHouse#50724.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors manual approve Manual approve required to run CI pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore pr-build Pull request with build/testing/packaging improvement v23.3-must-backport v23.8-must-backport v23.9-must-backport
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet