risingwave_ctl/common/
meta_service.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::env;
16
17use anyhow::{Result, bail};
18use risingwave_common::config::MetaConfig;
19use risingwave_common::util::addr::HostAddr;
20use risingwave_pb::common::WorkerType;
21use risingwave_pb::common::worker_node::Property;
22use risingwave_rpc_client::MetaClient;
23
24pub struct MetaServiceOpts {
25    pub meta_addr: String,
26}
27
28impl MetaServiceOpts {
29    /// Recover meta service options from env variable
30    ///
31    /// Currently, we will read these variables for meta:
32    ///
33    /// * `RW_META_ADDR`: meta service address
34    pub fn from_env() -> Result<Self> {
35        let meta_addr = match env::var("RW_META_ADDR") {
36            Ok(url) => {
37                tracing::info!("using meta addr from `RW_META_ADDR`: {}", url);
38                url
39            }
40            Err(_) => {
41                const MESSAGE: &str = "env variable `RW_META_ADDR` not found.
42
43For `./risedev d` use cases, please do the following:
44* use `./risedev ctl` to use risectl.
45
46For `./risedev apply-compose-deploy` users,
47* `RW_META_ADDR` will be printed out when deploying. Please copy the bash exports to your console.
48
49Note: the default value of `RW_META_ADDR` is 'http://127.0.0.1:5690'.";
50                bail!(MESSAGE);
51            }
52        };
53        Ok(Self { meta_addr })
54    }
55
56    /// Create meta client from options, and register as rise-ctl worker
57    pub async fn create_meta_client(&self) -> Result<MetaClient> {
58        let (client, _) = MetaClient::register_new(
59            self.meta_addr.parse()?,
60            WorkerType::RiseCtl,
61            &get_new_ctl_identity(),
62            Property::default(),
63            &MetaConfig::default(),
64        )
65        .await;
66        let worker_id = client.worker_id();
67        tracing::info!("registered as RiseCtl worker, worker_id = {}", worker_id);
68        Ok(client)
69    }
70}
71
72fn get_new_ctl_identity() -> HostAddr {
73    HostAddr {
74        host: format!("risectl-{}", uuid::Uuid::new_v4()),
75        port: 0,
76    }
77}
risingwave_ctl/common/meta_service.rs

risingwave_ctl/common/
meta_service.rs
