You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+28-3Lines changed: 28 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,7 @@ Alternatively, you can follow the https://www.cockroachlabs.com/docs/stable/inst
67
67
The test suite expects a running instance of the ClickHouse database server.
68
68
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.
69
69
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.
70
71
+
71
72
. Additional software requirements:
72
73
+
@@ -86,7 +87,7 @@ You can **run the https://github.com/rust-lang/rust-clippy[Clippy linter]** usin
86
87
To **run Omicron** you need to run four programs:
87
88
88
89
* 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,
90
91
the database files will be deleted when you stop the program.
91
92
* `nexus`: the guts of the control plane
92
93
* `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
152
153
153
154
2. Start the ClickHouse database server:
154
155
+
155
-
Note that this expects the directory `/opt/oxide` to exist and be writable by the user running the database.
156
-
+
157
156
[source,text]
158
157
----
159
158
$ cargo run --bin omicron-dev -- ch-run
@@ -542,3 +541,29 @@ See also `log.if_exists`.
542
541
|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).
543
542
544
543
|===
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
0 commit comments