Single node clickhouse init #6903
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at https://mozilla.org/MPL/2.0/. | ||
|
|
||
| //! Single-node ClickHouse database admin binary. | ||
|
|
||
| use anyhow::anyhow; | ||
| use camino::Utf8PathBuf; | ||
| use clap::Parser; | ||
| use omicron_clickhouse_admin::{ClickhouseCli, Config}; | ||
| use omicron_common::cmd::fatal; | ||
| use omicron_common::cmd::CmdError; | ||
| use std::net::{SocketAddr, SocketAddrV6}; | ||
|
|
||
| #[derive(Debug, Parser)] | ||
| #[clap( | ||
| name = "clickhouse-admin-single", | ||
| about = "Single-node ClickHouse admin server" | ||
| )] | ||
| enum Args { | ||
| /// Start the single-node ClickHouse admin server | ||
| Run { | ||
| /// Address on which this server should run | ||
| #[clap(long, short = 'a', action)] | ||
| http_address: SocketAddrV6, | ||
|
|
||
| /// Path to the server configuration file | ||
| #[clap(long, short, action)] | ||
| config: Utf8PathBuf, | ||
karencfv marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /// Address of the ClickHouse single-node database server | ||
| #[clap(long, short = 'l', action)] | ||
| listen_address: SocketAddrV6, | ||
|
|
||
| /// Path to the clickhouse binary | ||
| #[clap(long, short, action)] | ||
| binary_path: Utf8PathBuf, | ||
| }, | ||
| } | ||
|
|
||
| #[tokio::main] | ||
| async fn main() { | ||
| if let Err(err) = main_impl().await { | ||
| fatal(err); | ||
| } | ||
| } | ||
|
|
||
| async fn main_impl() -> Result<(), CmdError> { | ||
| let args = Args::parse(); | ||
|
|
||
| match args { | ||
| Args::Run { http_address, config, listen_address, binary_path } => { | ||
| let mut config = Config::from_file(&config) | ||
| .map_err(|err| CmdError::Failure(anyhow!(err)))?; | ||
| config.dropshot.bind_address = SocketAddr::V6(http_address); | ||
| let clickhouse_cli = | ||
| ClickhouseCli::new(binary_path, listen_address); | ||
|
|
||
| let server = omicron_clickhouse_admin::start_single_admin_server( | ||
| clickhouse_cli, | ||
| config, | ||
| ) | ||
| .await | ||
| .map_err(|err| CmdError::Failure(anyhow!(err)))?; | ||
| server.await.map_err(|err| { | ||
| CmdError::Failure(anyhow!( | ||
| "server failed after starting: {err}" | ||
| )) | ||
| }) | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,31 +2,40 @@ | |
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at https://mozilla.org/MPL/2.0/. | ||
|
|
||
| use crate::context::{ServerContext, SingleServerContext}; | ||
| use clickhouse_admin_api::*; | ||
| use clickhouse_admin_types::{ | ||
| ClickhouseKeeperClusterMembership, DistributedDdlQueue, KeeperConf, | ||
| KeeperConfig, KeeperConfigurableSettings, Lgif, RaftConfig, ReplicaConfig, | ||
| ServerConfigurableSettings, | ||
| }; | ||
| use dropshot::{ | ||
| ApiDescription, HttpError, HttpResponseCreated, HttpResponseOk, | ||
| HttpResponseUpdatedNoContent, RequestContext, TypedBody, | ||
| }; | ||
| use illumos_utils::svcadm::Svcadm; | ||
| use omicron_common::address::CLICKHOUSE_TCP_PORT; | ||
| use oximeter_db::{Client as OximeterClient, OXIMETER_VERSION}; | ||
| use slog::debug; | ||
| use std::net::SocketAddrV6; | ||
| use std::sync::Arc; | ||
|
|
||
| pub fn clickhouse_admin_server_api() -> ApiDescription<Arc<ServerContext>> { | ||
| clickhouse_admin_server_api_mod::api_description::<ClickhouseAdminServerImpl>() | ||
| .expect("registered entrypoints") | ||
| } | ||
|
|
||
| pub fn clickhouse_admin_keeper_api() -> ApiDescription<Arc<ServerContext>> { | ||
| clickhouse_admin_keeper_api_mod::api_description::<ClickhouseAdminKeeperImpl>() | ||
| .expect("registered entrypoints") | ||
| } | ||
|
|
||
| pub fn clickhouse_admin_single_api() -> ApiDescription<Arc<SingleServerContext>> | ||
| { | ||
| clickhouse_admin_single_api_mod::api_description::<ClickhouseAdminSingleImpl>() | ||
| .expect("registered entrypoints") | ||
| } | ||
|
|
||
| enum ClickhouseAdminServerImpl {} | ||
|
|
||
| impl ClickhouseAdminServerApi for ClickhouseAdminServerImpl { | ||
|
|
@@ -110,3 +119,49 @@ impl ClickhouseAdminKeeperApi for ClickhouseAdminKeeperImpl { | |
| Ok(HttpResponseOk(output)) | ||
| } | ||
| } | ||
|
|
||
| enum ClickhouseAdminSingleImpl {} | ||
|
|
||
| impl ClickhouseAdminSingleApi for ClickhouseAdminSingleImpl { | ||
| type Context = Arc<SingleServerContext>; | ||
|
|
||
| async fn init_db( | ||
| rqctx: RequestContext<Self::Context>, | ||
| ) -> Result<HttpResponseUpdatedNoContent, HttpError> { | ||
| let log = &rqctx.log; | ||
| let ctx = rqctx.context(); | ||
| let initialized = ctx.db_initialized(); | ||
| let mut initialized = initialized.lock().await; | ||
| if !*initialized { | ||
|
There was a problem hiding this comment. What happens if we want to update the schema? Is there any harm in just letting initialization run through every time? It's supposed to be idempotent, right? CC @bnaecker There was a problem hiding this comment.
Yeah, schema updates are idempotent, and also a no-op if the version in the database is at least as high as that on the client side. There was a problem hiding this comment. We talked a little about this in an update meeting a few weeks ago; my understanding was that letting initialization run each time and therefore update the schema would represent a change to our current policy of not performing automatic schema updates. This was one of the reasons for preferring a server-side approach rather than initializing the database on every client connection. I'm fine either way; it's a trivial change to the code, but a potentially less trivial change in policy. There was a problem hiding this comment.
Thanks for reminding me of that discussion Alex. However:
I think what we'll want to do in a follow up is to make schema updates part of the planner, and then only execute them when the plan changes. There was a problem hiding this comment. Oh, and the API call should then take the schema version to update from the executor. There was a problem hiding this comment. Ok, those are excellent points; you've convinced me. 012b6a1 does unconditional (but still serialized) database initialization. We'll have to take explicit versioning as a follow-up. |
||
| let http_address = ctx.clickhouse_cli().listen_address; | ||
| let native_address = SocketAddrV6::new( | ||
| *http_address.ip(), | ||
| CLICKHOUSE_TCP_PORT, | ||
| 0, | ||
| 0, | ||
| ); | ||
|
|
||
| let client = OximeterClient::new( | ||
| http_address.into(), | ||
| native_address.into(), | ||
| log, | ||
| ); | ||
| debug!( | ||
| log, | ||
| "initializing single-node ClickHouse \ | ||
| at {http_address} to version {OXIMETER_VERSION}" | ||
| ); | ||
| client | ||
| .initialize_db_with_version(false, OXIMETER_VERSION) | ||
| .await | ||
| .map_err(|e| { | ||
| HttpError::for_internal_error(format!( | ||
| "can't initialize single-node ClickHouse \ | ||
| at {http_address} to version {OXIMETER_VERSION}: {e}", | ||
| )) | ||
| })?; | ||
| *initialized = true; | ||
| } | ||
| Ok(HttpResponseUpdatedNoContent()) | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: I'd probably avoid speculating here about implementation time and detail and only state that multi-node clusters must implement a similar interface through
clickhouse-admin-serverThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, fixed in 2ddcbd9.