Skip to content

Commit 40f1d2f

Browse files
authored
Updates ClickHouse checksums for new build, adds notes to README (#206)
1 parent 9f7831a commit 40f1d2f

File tree

2 files changed

+31
-6
lines changed

2 files changed

+31
-6
lines changed

README.adoc

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Alternatively, you can follow the https://www.cockroachlabs.com/docs/stable/inst
6767
The test suite expects a running instance of the ClickHouse database server.
6868
The script `./tools/ci_download_clickhouse` can be used to download a pre-built binary for illumos, Linux, or macOS platforms. Once complete, you must manually add the binary (located at `clickhouse/clickhouse`) to your PATH.
6969
You may also install ClickHouse manually; instructions can be found https://clickhouse.tech/docs/en/getting-started/install[here].
70+
See <<_configuring_clickhouse>> for details on ClickHouse's setup and configuration files.
7071
+
7172
. Additional software requirements:
7273
+
@@ -86,7 +87,7 @@ You can **run the https://github.com/rust-lang/rust-clippy[Clippy linter]** usin
8687
To **run Omicron** you need to run four programs:
8788

8889
* a CockroachDB cluster. For development, you can use the `omicron-dev` tool in this repository to start a single-node CockroachDB cluster **that will delete the database when you shut it down.**
89-
* a ClickHouse server. You may use the `omicron-dev` tool for this as well, see below, and as with CockroachDB,
90+
* a ClickHouse server. You should use the `omicron-dev` tool for this as well, see below, and as with CockroachDB,
9091
the database files will be deleted when you stop the program.
9192
* `nexus`: the guts of the control plane
9293
* `sled-agent-sim`: a simulator for the component that manages a single sled
@@ -152,8 +153,6 @@ Note that as the output indicates, this cluster will be available to anybody tha
152153

153154
2. Start the ClickHouse database server:
154155
+
155-
Note that this expects the directory `/opt/oxide` to exist and be writable by the user running the database.
156-
+
157156
[source,text]
158157
----
159158
$ cargo run --bin omicron-dev -- ch-run
@@ -542,3 +541,29 @@ See also `log.if_exists`.
542541
|If `log.mode` is `"file"`, this property specifies what to do if the destination log file already exists. Valid values include `"append"` (which appends to the existing file), `"truncate"` (which truncates the existing file and then uses it as though it had just been created), and `"fail"` (which causes the server to exit immediately with an error).
543542

544543
|===
544+
545+
=== Configuring ClickHouse
546+
547+
The ClickHouse binary uses several sources for its configuration. The binary expects an XML
548+
config file, usually named `config.xml` to be available, or one may be specified with the
549+
`-C` command-line flag. The binary also includes a minimal configuration _embedded_ within
550+
it, which will be used if no configuration file is given or present in the current directory.
551+
The server also accepts command-line flags for overriding the values of the configuration
552+
parameters.
553+
554+
The packages downloaded by `ci_download_clickhouse` include a `config.xml` file with them.
555+
You should probably run ClickHouse via the `omicron-dev` tool, but if you decide to run it
556+
manually, you can start the server with:
557+
558+
[source,text]
559+
$ /path/to/clickhouse server --config-file /path/to/config.xml
560+
561+
The configuration file contains a large number of parameters, but most of them are described
562+
with comments in the included `config.xml`, or you may learn more about them
563+
https://clickhouse.tech/docs/en/operations/server-configuration-parameters/settings/[here]
564+
and https://clickhouse.tech/docs/en/operations/settings/[here]. Parameters may be updated
565+
in the `config.xml`, and the server will automatically reload them. You may also specify
566+
many of them on the command-line with:
567+
568+
[source,text]
569+
$ /path/to/clickhouse server --config-file /path/to/config.xml -- --param_name param_value ...

tools/clickhouse_checksums

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
CIDL_MD5_DARWIN="d4e46f2fa545a24f5b668ea9f67c9a72"
2-
CIDL_MD5_LINUX="2536950320df5b7b80f536ca8fd9f8c7"
3-
CIDL_MD5_ILLUMOS="dc1e2f5fb17d5ace0b97c8b54a093d48"
1+
CIDL_MD5_DARWIN="66026aa7ebbc43b36c6b8c7c9ec0e03e"
2+
CIDL_MD5_LINUX="61d70935476b7bf1f6e073bc07eec531"
3+
CIDL_MD5_ILLUMOS="66026aa7ebbc43b36c6b8c7c9ec0e03e"

0 commit comments

Comments
 (0)