Split clickhouse admin server #6837
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,56 +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 clickhouse_admin_types::{ | ||
| ClickhouseKeeperClusterMembership, KeeperConf, KeeperConfig, | ||
| KeeperConfigurableSettings, Lgif, RaftConfig, ReplicaConfig, | ||
| ServerConfigurableSettings, | ||
| }; | ||
| use dropshot::{ | ||
| HttpError, HttpResponseCreated, HttpResponseOk, RequestContext, TypedBody, | ||
| }; | ||
|
|
||
| /// API interface for our clickhouse-admin-keeper server | ||
| /// | ||
| /// We separate the admin interface for the keeper and server APIs because they | ||
| /// are completely disjoint. We only run a clickhouse keeper *or* clickhouse | ||
| /// server in a given zone, and therefore each admin api is only useful in one | ||
| /// of the zones. Using separate APIs and clients prevents us from having to | ||
| /// mark a given endpoint `unimplemented` in the case of it not being usable | ||
| /// with one of the zone types. | ||
| /// | ||
| /// Nonetheless, the interfaces themselves are small and serve a similar | ||
| /// purpose. Therfore we combine them into the same crate. | ||
| #[dropshot::api_description] | ||
| pub trait ClickhouseAdminKeeperApi { | ||
| type Context; | ||
|
|
||
| /// Generate a ClickHouse configuration file for a keeper node on a specified | ||
| /// directory and enable the SMF service if not currently enabled. | ||
| /// | ||
| /// Note that we cannot start the keeper service until there is an initial | ||
| /// configuration set via this endpoint. | ||
| #[endpoint { | ||
| method = PUT, | ||
| path = "/config", | ||
| }] | ||
| async fn generate_config( | ||
| rqctx: RequestContext<Self::Context>, | ||
| body: TypedBody<KeeperConfigurableSettings>, | ||
| ) -> Result<HttpResponseCreated<KeeperConfig>, HttpError>; | ||
|
|
@@ -95,3 +79,30 @@ pub trait ClickhouseAdminApi { | |
| rqctx: RequestContext<Self::Context>, | ||
| ) -> Result<HttpResponseOk<ClickhouseKeeperClusterMembership>, HttpError>; | ||
| } | ||
|
|
||
| /// API interface for our clickhouse-admin-server server | ||
| /// | ||
| /// We separate the admin interface for the keeper and server APIs because they | ||
|
There was a problem hiding this comment. Done in 0a2e28b |
||
| /// are completely disjoint. We only run a clickhouse keeper *or* clickhouse | ||
| /// server in a given zone, and therefore each admin api is only useful in one | ||
| /// of the zones. Using separate APIs and clients prevents us from having to | ||
| /// mark a given endpoint `unimplemented` in the case of it not being usable | ||
| /// with one of the zone types. | ||
| /// | ||
| /// Nonetheless, the interfaces themselves are small and serve a similar | ||
| /// purpose. Therfore we combine them into the same crate. | ||
| #[dropshot::api_description] | ||
andrewjstone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| pub trait ClickhouseAdminServerApi { | ||
| type Context; | ||
|
|
||
| /// Generate a ClickHouse configuration file for a server node on a specified | ||
| /// directory and enable the SMF service. | ||
| #[endpoint { | ||
| method = PUT, | ||
| path = "/config" | ||
| }] | ||
| async fn generate_config( | ||
| rqctx: RequestContext<Self::Context>, | ||
| body: TypedBody<ServerConfigurableSettings>, | ||
| ) -> Result<HttpResponseCreated<ReplicaConfig>, HttpError>; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // 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/. | ||
|
|
||
| //! Executable program to run the Omicron ClickHouse admin interface for | ||
| //! clickhouse servers. | ||
|
|
||
| use anyhow::anyhow; | ||
| use camino::Utf8PathBuf; | ||
| use clap::Parser; | ||
| use omicron_clickhouse_admin::{ClickhouseCli, Clickward, Config}; | ||
| use omicron_common::cmd::fatal; | ||
| use omicron_common::cmd::CmdError; | ||
| use std::net::{SocketAddr, SocketAddrV6}; | ||
|
|
||
| #[derive(Debug, Parser)] | ||
| #[clap( | ||
| name = "clickhouse-admin-server", | ||
| about = "Omicron ClickHouse cluster admin server for replica servers" | ||
| )] | ||
| enum Args { | ||
| /// Start the 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, | ||
|
|
||
| /// Address on which the clickhouse server or keeper is listening on | ||
| #[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 clickward = Clickward::new(); | ||
| let clickhouse_cli = | ||
| ClickhouseCli::new(binary_path, listen_address); | ||
|
|
||
| let server = omicron_clickhouse_admin::start_server_admin_server( | ||
| clickward, | ||
| clickhouse_cli, | ||
| config, | ||
| ) | ||
| .await | ||
| .map_err(|err| CmdError::Failure(anyhow!(err)))?; | ||
| server.await.map_err(|err| { | ||
| CmdError::Failure(anyhow!( | ||
| "server failed after starting: {err}" | ||
| )) | ||
| }) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
First paragraph of doc comments should be short (a lint for this is coming in Rust 1.83.) Could you just add something simple?
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.
Thanks for the tip! Done in 0a2e28b