Skip to content

Commit

Permalink
Updates ClickHouse checksums for new build, adds notes to README (#206)
Browse files Browse the repository at this point in the history
  • Loading branch information
bnaecker authored Aug 27, 2021
1 parent 9f7831a commit 40f1d2f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 6 deletions.
31 changes: 28 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Alternatively, you can follow the https://www.cockroachlabs.com/docs/stable/inst
The test suite expects a running instance of the ClickHouse database server.
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.
You may also install ClickHouse manually; instructions can be found https://clickhouse.tech/docs/en/getting-started/install[here].
See <<_configuring_clickhouse>> for details on ClickHouse's setup and configuration files.
+
. Additional software requirements:
+
Expand All @@ -86,7 +87,7 @@ You can **run the https://github.com/rust-lang/rust-clippy[Clippy linter]** usin
To **run Omicron** you need to run four programs:

* 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.**
* a ClickHouse server. You may use the `omicron-dev` tool for this as well, see below, and as with CockroachDB,
* a ClickHouse server. You should use the `omicron-dev` tool for this as well, see below, and as with CockroachDB,
the database files will be deleted when you stop the program.
* `nexus`: the guts of the control plane
* `sled-agent-sim`: a simulator for the component that manages a single sled
Expand Down Expand Up @@ -152,8 +153,6 @@ Note that as the output indicates, this cluster will be available to anybody tha

2. Start the ClickHouse database server:
+
Note that this expects the directory `/opt/oxide` to exist and be writable by the user running the database.
+
[source,text]
----
$ cargo run --bin omicron-dev -- ch-run
Expand Down Expand Up @@ -542,3 +541,29 @@ See also `log.if_exists`.
|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).

|===

=== Configuring ClickHouse

The ClickHouse binary uses several sources for its configuration. The binary expects an XML
config file, usually named `config.xml` to be available, or one may be specified with the
`-C` command-line flag. The binary also includes a minimal configuration _embedded_ within
it, which will be used if no configuration file is given or present in the current directory.
The server also accepts command-line flags for overriding the values of the configuration
parameters.

The packages downloaded by `ci_download_clickhouse` include a `config.xml` file with them.
You should probably run ClickHouse via the `omicron-dev` tool, but if you decide to run it
manually, you can start the server with:

[source,text]
$ /path/to/clickhouse server --config-file /path/to/config.xml

The configuration file contains a large number of parameters, but most of them are described
with comments in the included `config.xml`, or you may learn more about them
https://clickhouse.tech/docs/en/operations/server-configuration-parameters/settings/[here]
and https://clickhouse.tech/docs/en/operations/settings/[here]. Parameters may be updated
in the `config.xml`, and the server will automatically reload them. You may also specify
many of them on the command-line with:

[source,text]
$ /path/to/clickhouse server --config-file /path/to/config.xml -- --param_name param_value ...
6 changes: 3 additions & 3 deletions tools/clickhouse_checksums
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
CIDL_MD5_DARWIN="d4e46f2fa545a24f5b668ea9f67c9a72"
CIDL_MD5_LINUX="2536950320df5b7b80f536ca8fd9f8c7"
CIDL_MD5_ILLUMOS="dc1e2f5fb17d5ace0b97c8b54a093d48"
CIDL_MD5_DARWIN="66026aa7ebbc43b36c6b8c7c9ec0e03e"
CIDL_MD5_LINUX="61d70935476b7bf1f6e073bc07eec531"
CIDL_MD5_ILLUMOS="66026aa7ebbc43b36c6b8c7c9ec0e03e"

0 comments on commit 40f1d2f

Please sign in to comment.