Line data Source code
1 : use aws_config::environment::EnvironmentVariableCredentialsProvider;
2 : use aws_config::imds::credentials::ImdsCredentialsProvider;
3 : use aws_config::meta::credentials::CredentialsProviderChain;
4 : use aws_config::meta::region::RegionProviderChain;
5 : use aws_config::profile::ProfileFileCredentialsProvider;
6 : use aws_config::provider_config::ProviderConfig;
7 : use aws_config::web_identity_token::WebIdentityTokenCredentialsProvider;
8 : use futures::future::Either;
9 : use proxy::auth;
10 : use proxy::auth::backend::AuthRateLimiter;
11 : use proxy::auth::backend::MaybeOwned;
12 : use proxy::cancellation::CancelMap;
13 : use proxy::cancellation::CancellationHandler;
14 : use proxy::config::remote_storage_from_toml;
15 : use proxy::config::AuthenticationConfig;
16 : use proxy::config::CacheOptions;
17 : use proxy::config::HttpConfig;
18 : use proxy::config::ProjectInfoCacheOptions;
19 : use proxy::console;
20 : use proxy::context::parquet::ParquetUploadArgs;
21 : use proxy::http;
22 : use proxy::http::health_server::AppMetrics;
23 : use proxy::metrics::Metrics;
24 : use proxy::rate_limiter::EndpointRateLimiter;
25 : use proxy::rate_limiter::RateBucketInfo;
26 : use proxy::redis::cancellation_publisher::RedisPublisherClient;
27 : use proxy::redis::connection_with_credentials_provider::ConnectionWithCredentialsProvider;
28 : use proxy::redis::elasticache;
29 : use proxy::redis::notifications;
30 : use proxy::serverless::cancel_set::CancelSet;
31 : use proxy::serverless::GlobalConnPoolOptions;
32 : use proxy::usage_metrics;
33 :
34 : use anyhow::bail;
35 : use proxy::config::{self, ProxyConfig};
36 : use proxy::serverless;
37 : use std::net::SocketAddr;
38 : use std::pin::pin;
39 : use std::sync::Arc;
40 : use tokio::net::TcpListener;
41 : use tokio::sync::Mutex;
42 : use tokio::task::JoinSet;
43 : use tokio_util::sync::CancellationToken;
44 : use tracing::info;
45 : use tracing::warn;
46 : use tracing::Instrument;
47 : use utils::{project_build_tag, project_git_version, sentry_init::init_sentry};
48 :
49 : project_git_version!(GIT_VERSION);
50 : project_build_tag!(BUILD_TAG);
51 :
52 : use clap::{Parser, ValueEnum};
53 :
54 : #[global_allocator]
55 : static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;
56 :
57 20 : #[derive(Clone, Debug, ValueEnum)]
58 : enum AuthBackend {
59 : Console,
60 : #[cfg(feature = "testing")]
61 : Postgres,
62 : Link,
63 : }
64 :
65 : /// Neon proxy/router
66 4 : #[derive(Parser)]
67 : #[command(version = GIT_VERSION, about)]
68 : struct ProxyCliArgs {
69 : /// Name of the region this proxy is deployed in
70 2 : #[clap(long, default_value_t = String::new())]
71 0 : region: String,
72 : /// listen for incoming client connections on ip:port
73 : #[clap(short, long, default_value = "127.0.0.1:4432")]
74 0 : proxy: String,
75 2 : #[clap(value_enum, long, default_value_t = AuthBackend::Link)]
76 0 : auth_backend: AuthBackend,
77 : /// listen for management callback connection on ip:port
78 : #[clap(short, long, default_value = "127.0.0.1:7000")]
79 0 : mgmt: String,
80 : /// listen for incoming http connections (metrics, etc) on ip:port
81 : #[clap(long, default_value = "127.0.0.1:7001")]
82 0 : http: String,
83 : /// listen for incoming wss connections on ip:port
84 : #[clap(long)]
85 : wss: Option<String>,
86 : /// redirect unauthenticated users to the given uri in case of link auth
87 : #[clap(short, long, default_value = "http://localhost:3000/psql_session/")]
88 0 : uri: String,
89 : /// cloud API endpoint for authenticating users
90 : #[clap(
91 : short,
92 : long,
93 : default_value = "http://localhost:3000/authenticate_proxy_request/"
94 : )]
95 0 : auth_endpoint: String,
96 : /// path to TLS key for client postgres connections
97 : ///
98 : /// tls-key and tls-cert are for backwards compatibility, we can put all certs in one dir
99 : #[clap(short = 'k', long, alias = "ssl-key")]
100 : tls_key: Option<String>,
101 : /// path to TLS cert for client postgres connections
102 : ///
103 : /// tls-key and tls-cert are for backwards compatibility, we can put all certs in one dir
104 : #[clap(short = 'c', long, alias = "ssl-cert")]
105 : tls_cert: Option<String>,
106 : /// path to directory with TLS certificates for client postgres connections
107 : #[clap(long)]
108 : certs_dir: Option<String>,
109 : /// timeout for the TLS handshake
110 : #[clap(long, default_value = "15s", value_parser = humantime::parse_duration)]
111 0 : handshake_timeout: tokio::time::Duration,
112 : /// http endpoint to receive periodic metric updates
113 : #[clap(long)]
114 : metric_collection_endpoint: Option<String>,
115 : /// how often metrics should be sent to a collection endpoint
116 : #[clap(long)]
117 : metric_collection_interval: Option<String>,
118 : /// cache for `wake_compute` api method (use `size=0` to disable)
119 : #[clap(long, default_value = config::CacheOptions::CACHE_DEFAULT_OPTIONS)]
120 0 : wake_compute_cache: String,
121 : /// lock for `wake_compute` api method. example: "shards=32,permits=4,epoch=10m,timeout=1s". (use `permits=0` to disable).
122 : #[clap(long, default_value = config::ConcurrencyLockOptions::DEFAULT_OPTIONS_WAKE_COMPUTE_LOCK)]
123 0 : wake_compute_lock: String,
124 : /// lock for `connect_compute` api method. example: "shards=32,permits=4,epoch=10m,timeout=1s". (use `permits=0` to disable).
125 : #[clap(long, default_value = config::ConcurrencyLockOptions::DEFAULT_OPTIONS_CONNECT_COMPUTE_LOCK)]
126 0 : connect_compute_lock: String,
127 : /// Allow self-signed certificates for compute nodes (for testing)
128 2 : #[clap(long, default_value_t = false, value_parser = clap::builder::BoolishValueParser::new(), action = clap::ArgAction::Set)]
129 0 : allow_self_signed_compute: bool,
130 : #[clap(flatten)]
131 : sql_over_http: SqlOverHttpArgs,
132 : /// timeout for scram authentication protocol
133 : #[clap(long, default_value = "15s", value_parser = humantime::parse_duration)]
134 0 : scram_protocol_timeout: tokio::time::Duration,
135 : /// Require that all incoming requests have a Proxy Protocol V2 packet **and** have an IP address associated.
136 2 : #[clap(long, default_value_t = false, value_parser = clap::builder::BoolishValueParser::new(), action = clap::ArgAction::Set)]
137 0 : require_client_ip: bool,
138 : /// Disable dynamic rate limiter and store the metrics to ensure its production behaviour.
139 2 : #[clap(long, default_value_t = true, value_parser = clap::builder::BoolishValueParser::new(), action = clap::ArgAction::Set)]
140 0 : disable_dynamic_rate_limiter: bool,
141 : /// Endpoint rate limiter max number of requests per second.
142 : ///
143 : /// Provided in the form '<Requests Per Second>@<Bucket Duration Size>'.
144 : /// Can be given multiple times for different bucket sizes.
145 12 : #[clap(long, default_values_t = RateBucketInfo::DEFAULT_ENDPOINT_SET)]
146 2 : endpoint_rps_limit: Vec<RateBucketInfo>,
147 : /// Wake compute rate limiter max number of requests per second.
148 12 : #[clap(long, default_values_t = RateBucketInfo::DEFAULT_SET)]
149 2 : wake_compute_limit: Vec<RateBucketInfo>,
150 : /// Whether the auth rate limiter actually takes effect (for testing)
151 2 : #[clap(long, default_value_t = false, value_parser = clap::builder::BoolishValueParser::new(), action = clap::ArgAction::Set)]
152 0 : auth_rate_limit_enabled: bool,
153 : /// Authentication rate limiter max number of hashes per second.
154 12 : #[clap(long, default_values_t = RateBucketInfo::DEFAULT_AUTH_SET)]
155 2 : auth_rate_limit: Vec<RateBucketInfo>,
156 : /// The IP subnet to use when considering whether two IP addresses are considered the same.
157 2 : #[clap(long, default_value_t = 64)]
158 0 : auth_rate_limit_ip_subnet: u8,
159 : /// Redis rate limiter max number of requests per second.
160 12 : #[clap(long, default_values_t = RateBucketInfo::DEFAULT_SET)]
161 2 : redis_rps_limit: Vec<RateBucketInfo>,
162 : /// cache for `allowed_ips` (use `size=0` to disable)
163 : #[clap(long, default_value = config::CacheOptions::CACHE_DEFAULT_OPTIONS)]
164 0 : allowed_ips_cache: String,
165 : /// cache for `role_secret` (use `size=0` to disable)
166 : #[clap(long, default_value = config::CacheOptions::CACHE_DEFAULT_OPTIONS)]
167 0 : role_secret_cache: String,
168 : /// disable ip check for http requests. If it is too time consuming, it could be turned off.
169 2 : #[clap(long, default_value_t = false, value_parser = clap::builder::BoolishValueParser::new(), action = clap::ArgAction::Set)]
170 0 : disable_ip_check_for_http: bool,
171 : /// redis url for notifications (if empty, redis_host:port will be used for both notifications and streaming connections)
172 : #[clap(long)]
173 : redis_notifications: Option<String>,
174 : /// redis host for streaming connections (might be different from the notifications host)
175 : #[clap(long)]
176 : redis_host: Option<String>,
177 : /// redis port for streaming connections (might be different from the notifications host)
178 : #[clap(long)]
179 : redis_port: Option<u16>,
180 : /// redis cluster name, used in aws elasticache
181 : #[clap(long)]
182 : redis_cluster_name: Option<String>,
183 : /// redis user_id, used in aws elasticache
184 : #[clap(long)]
185 : redis_user_id: Option<String>,
186 : /// aws region to retrieve credentials
187 2 : #[clap(long, default_value_t = String::new())]
188 0 : aws_region: String,
189 : /// cache for `project_info` (use `size=0` to disable)
190 : #[clap(long, default_value = config::ProjectInfoCacheOptions::CACHE_DEFAULT_OPTIONS)]
191 0 : project_info_cache: String,
192 : /// cache for all valid endpoints
193 : #[clap(long, default_value = config::EndpointCacheConfig::CACHE_DEFAULT_OPTIONS)]
194 0 : endpoint_cache_config: String,
195 : #[clap(flatten)]
196 : parquet_upload: ParquetUploadArgs,
197 :
198 : /// interval for backup metric collection
199 : #[clap(long, default_value = "10m", value_parser = humantime::parse_duration)]
200 0 : metric_backup_collection_interval: std::time::Duration,
201 : /// remote storage configuration for backup metric collection
202 : /// Encoded as toml (same format as pageservers), eg
203 : /// `{bucket_name='the-bucket',bucket_region='us-east-1',prefix_in_bucket='proxy',endpoint='http://minio:9000'}`
204 : #[clap(long, default_value = "{}")]
205 0 : metric_backup_collection_remote_storage: String,
206 : /// chunk size for backup metric collection
207 : /// Size of each event is no more than 400 bytes, so 2**22 is about 200MB before the compression.
208 : #[clap(long, default_value = "4194304")]
209 0 : metric_backup_collection_chunk_size: usize,
210 : /// Whether to retry the connection to the compute node
211 : #[clap(long, default_value = config::RetryConfig::CONNECT_TO_COMPUTE_DEFAULT_VALUES)]
212 0 : connect_to_compute_retry: String,
213 : /// Whether to retry the wake_compute request
214 : #[clap(long, default_value = config::RetryConfig::WAKE_COMPUTE_DEFAULT_VALUES)]
215 0 : wake_compute_retry: String,
216 : }
217 :
218 4 : #[derive(clap::Args, Clone, Copy, Debug)]
219 : struct SqlOverHttpArgs {
220 : /// timeout for http connection requests
221 : #[clap(long, default_value = "15s", value_parser = humantime::parse_duration)]
222 0 : sql_over_http_timeout: tokio::time::Duration,
223 :
224 : /// Whether the SQL over http pool is opt-in
225 2 : #[clap(long, default_value_t = true, value_parser = clap::builder::BoolishValueParser::new(), action = clap::ArgAction::Set)]
226 0 : sql_over_http_pool_opt_in: bool,
227 :
228 : /// How many connections to pool for each endpoint. Excess connections are discarded
229 2 : #[clap(long, default_value_t = 20)]
230 0 : sql_over_http_pool_max_conns_per_endpoint: usize,
231 :
232 : /// How many connections to pool for each endpoint. Excess connections are discarded
233 2 : #[clap(long, default_value_t = 20000)]
234 0 : sql_over_http_pool_max_total_conns: usize,
235 :
236 : /// How long pooled connections should remain idle for before closing
237 : #[clap(long, default_value = "5m", value_parser = humantime::parse_duration)]
238 0 : sql_over_http_idle_timeout: tokio::time::Duration,
239 :
240 : /// Duration each shard will wait on average before a GC sweep.
241 : /// A longer time will causes sweeps to take longer but will interfere less frequently.
242 : #[clap(long, default_value = "10m", value_parser = humantime::parse_duration)]
243 0 : sql_over_http_pool_gc_epoch: tokio::time::Duration,
244 :
245 : /// How many shards should the global pool have. Must be a power of two.
246 : /// More shards will introduce less contention for pool operations, but can
247 : /// increase memory used by the pool
248 2 : #[clap(long, default_value_t = 128)]
249 0 : sql_over_http_pool_shards: usize,
250 :
251 2 : #[clap(long, default_value_t = 10000)]
252 0 : sql_over_http_client_conn_threshold: u64,
253 :
254 2 : #[clap(long, default_value_t = 64)]
255 0 : sql_over_http_cancel_set_shards: usize,
256 : }
257 :
258 : #[tokio::main]
259 0 : async fn main() -> anyhow::Result<()> {
260 0 : let _logging_guard = proxy::logging::init().await?;
261 0 : let _panic_hook_guard = utils::logging::replace_panic_hook_with_tracing_panic_hook();
262 0 : let _sentry_guard = init_sentry(Some(GIT_VERSION.into()), &[]);
263 0 :
264 0 : info!("Version: {GIT_VERSION}");
265 0 : info!("Build_tag: {BUILD_TAG}");
266 0 : let neon_metrics = ::metrics::NeonMetrics::new(::metrics::BuildInfo {
267 0 : revision: GIT_VERSION,
268 0 : build_tag: BUILD_TAG,
269 0 : });
270 0 :
271 0 : let jemalloc = match proxy::jemalloc::MetricRecorder::new() {
272 0 : Ok(t) => Some(t),
273 0 : Err(e) => {
274 0 : tracing::error!(error = ?e, "could not start jemalloc metrics loop");
275 0 : None
276 0 : }
277 0 : };
278 0 :
279 0 : let args = ProxyCliArgs::parse();
280 0 : let config = build_config(&args)?;
281 0 :
282 0 : info!("Authentication backend: {}", config.auth_backend);
283 0 : info!("Using region: {}", config.aws_region);
284 0 :
285 0 : let region_provider = RegionProviderChain::default_provider().or_else(&*config.aws_region); // Replace with your Redis region if needed
286 0 : let provider_conf =
287 0 : ProviderConfig::without_region().with_region(region_provider.region().await);
288 0 : let aws_credentials_provider = {
289 0 : // uses "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY"
290 0 : CredentialsProviderChain::first_try("env", EnvironmentVariableCredentialsProvider::new())
291 0 : // uses "AWS_PROFILE" / `aws sso login --profile <profile>`
292 0 : .or_else(
293 0 : "profile-sso",
294 0 : ProfileFileCredentialsProvider::builder()
295 0 : .configure(&provider_conf)
296 0 : .build(),
297 0 : )
298 0 : // uses "AWS_WEB_IDENTITY_TOKEN_FILE", "AWS_ROLE_ARN", "AWS_ROLE_SESSION_NAME"
299 0 : // needed to access remote extensions bucket
300 0 : .or_else(
301 0 : "token",
302 0 : WebIdentityTokenCredentialsProvider::builder()
303 0 : .configure(&provider_conf)
304 0 : .build(),
305 0 : )
306 0 : // uses imds v2
307 0 : .or_else("imds", ImdsCredentialsProvider::builder().build())
308 0 : };
309 0 : let elasticache_credentials_provider = Arc::new(elasticache::CredentialsProvider::new(
310 0 : elasticache::AWSIRSAConfig::new(
311 0 : config.aws_region.clone(),
312 0 : args.redis_cluster_name,
313 0 : args.redis_user_id,
314 0 : ),
315 0 : aws_credentials_provider,
316 0 : ));
317 0 : let regional_redis_client = match (args.redis_host, args.redis_port) {
318 0 : (Some(host), Some(port)) => Some(
319 0 : ConnectionWithCredentialsProvider::new_with_credentials_provider(
320 0 : host,
321 0 : port,
322 0 : elasticache_credentials_provider.clone(),
323 0 : ),
324 0 : ),
325 0 : (None, None) => {
326 0 : warn!("Redis events from console are disabled");
327 0 : None
328 0 : }
329 0 : _ => {
330 0 : bail!("redis-host and redis-port must be specified together");
331 0 : }
332 0 : };
333 0 : let redis_notifications_client = if let Some(url) = args.redis_notifications {
334 0 : Some(ConnectionWithCredentialsProvider::new_with_static_credentials(url))
335 0 : } else {
336 0 : regional_redis_client.clone()
337 0 : };
338 0 :
339 0 : // Check that we can bind to address before further initialization
340 0 : let http_address: SocketAddr = args.http.parse()?;
341 0 : info!("Starting http on {http_address}");
342 0 : let http_listener = TcpListener::bind(http_address).await?.into_std()?;
343 0 :
344 0 : let mgmt_address: SocketAddr = args.mgmt.parse()?;
345 0 : info!("Starting mgmt on {mgmt_address}");
346 0 : let mgmt_listener = TcpListener::bind(mgmt_address).await?;
347 0 :
348 0 : let proxy_address: SocketAddr = args.proxy.parse()?;
349 0 : info!("Starting proxy on {proxy_address}");
350 0 : let proxy_listener = TcpListener::bind(proxy_address).await?;
351 0 : let cancellation_token = CancellationToken::new();
352 0 :
353 0 : let cancel_map = CancelMap::default();
354 0 :
355 0 : let redis_publisher = match ®ional_redis_client {
356 0 : Some(redis_publisher) => Some(Arc::new(Mutex::new(RedisPublisherClient::new(
357 0 : redis_publisher.clone(),
358 0 : args.region.clone(),
359 0 : &config.redis_rps_limit,
360 0 : )?))),
361 0 : None => None,
362 0 : };
363 0 : let cancellation_handler = Arc::new(CancellationHandler::<
364 0 : Option<Arc<tokio::sync::Mutex<RedisPublisherClient>>>,
365 0 : >::new(
366 0 : cancel_map.clone(),
367 0 : redis_publisher,
368 0 : proxy::metrics::CancellationSource::FromClient,
369 0 : ));
370 0 :
371 0 : let mut endpoint_rps_limit = args.endpoint_rps_limit.clone();
372 0 : RateBucketInfo::validate(&mut endpoint_rps_limit)?;
373 0 : let endpoint_rate_limiter = Arc::new(EndpointRateLimiter::new(endpoint_rps_limit));
374 0 :
375 0 : // client facing tasks. these will exit on error or on cancellation
376 0 : // cancellation returns Ok(())
377 0 : let mut client_tasks = JoinSet::new();
378 0 : client_tasks.spawn(proxy::proxy::task_main(
379 0 : config,
380 0 : proxy_listener,
381 0 : cancellation_token.clone(),
382 0 : cancellation_handler.clone(),
383 0 : endpoint_rate_limiter.clone(),
384 0 : ));
385 0 :
386 0 : // TODO: rename the argument to something like serverless.
387 0 : // It now covers more than just websockets, it also covers SQL over HTTP.
388 0 : if let Some(serverless_address) = args.wss {
389 0 : let serverless_address: SocketAddr = serverless_address.parse()?;
390 0 : info!("Starting wss on {serverless_address}");
391 0 : let serverless_listener = TcpListener::bind(serverless_address).await?;
392 0 :
393 0 : client_tasks.spawn(serverless::task_main(
394 0 : config,
395 0 : serverless_listener,
396 0 : cancellation_token.clone(),
397 0 : cancellation_handler.clone(),
398 0 : endpoint_rate_limiter.clone(),
399 0 : ));
400 0 : }
401 0 :
402 0 : client_tasks.spawn(proxy::context::parquet::worker(
403 0 : cancellation_token.clone(),
404 0 : args.parquet_upload,
405 0 : ));
406 0 :
407 0 : // maintenance tasks. these never return unless there's an error
408 0 : let mut maintenance_tasks = JoinSet::new();
409 0 : maintenance_tasks.spawn(proxy::handle_signals(cancellation_token.clone()));
410 0 : maintenance_tasks.spawn(http::health_server::task_main(
411 0 : http_listener,
412 0 : AppMetrics {
413 0 : jemalloc,
414 0 : neon_metrics,
415 0 : proxy: proxy::metrics::Metrics::get(),
416 0 : },
417 0 : ));
418 0 : maintenance_tasks.spawn(console::mgmt::task_main(mgmt_listener));
419 0 :
420 0 : if let Some(metrics_config) = &config.metric_collection {
421 0 : // TODO: Add gc regardles of the metric collection being enabled.
422 0 : maintenance_tasks.spawn(usage_metrics::task_main(metrics_config));
423 0 : client_tasks.spawn(usage_metrics::task_backup(
424 0 : &metrics_config.backup_metric_collection_config,
425 0 : cancellation_token.clone(),
426 0 : ));
427 0 : }
428 0 :
429 0 : if let auth::BackendType::Console(api, _) = &config.auth_backend {
430 0 : if let proxy::console::provider::ConsoleBackend::Console(api) = &**api {
431 0 : match (redis_notifications_client, regional_redis_client.clone()) {
432 0 : (None, None) => {}
433 0 : (client1, client2) => {
434 0 : let cache = api.caches.project_info.clone();
435 0 : if let Some(client) = client1 {
436 0 : maintenance_tasks.spawn(notifications::task_main(
437 0 : client,
438 0 : cache.clone(),
439 0 : cancel_map.clone(),
440 0 : args.region.clone(),
441 0 : ));
442 0 : }
443 0 : if let Some(client) = client2 {
444 0 : maintenance_tasks.spawn(notifications::task_main(
445 0 : client,
446 0 : cache.clone(),
447 0 : cancel_map.clone(),
448 0 : args.region.clone(),
449 0 : ));
450 0 : }
451 0 : maintenance_tasks.spawn(async move { cache.clone().gc_worker().await });
452 0 : }
453 0 : }
454 0 : if let Some(regional_redis_client) = regional_redis_client {
455 0 : let cache = api.caches.endpoints_cache.clone();
456 0 : let con = regional_redis_client;
457 0 : let span = tracing::info_span!("endpoints_cache");
458 0 : maintenance_tasks.spawn(
459 0 : async move { cache.do_read(con, cancellation_token.clone()).await }
460 0 : .instrument(span),
461 0 : );
462 0 : }
463 0 : }
464 0 : }
465 0 :
466 0 : let maintenance = loop {
467 0 : // get one complete task
468 0 : match futures::future::select(
469 0 : pin!(maintenance_tasks.join_next()),
470 0 : pin!(client_tasks.join_next()),
471 0 : )
472 0 : .await
473 0 : {
474 0 : // exit immediately on maintenance task completion
475 0 : Either::Left((Some(res), _)) => break proxy::flatten_err(res)?,
476 0 : // exit with error immediately if all maintenance tasks have ceased (should be caught by branch above)
477 0 : Either::Left((None, _)) => bail!("no maintenance tasks running. invalid state"),
478 0 : // exit immediately on client task error
479 0 : Either::Right((Some(res), _)) => proxy::flatten_err(res)?,
480 0 : // exit if all our client tasks have shutdown gracefully
481 0 : Either::Right((None, _)) => return Ok(()),
482 0 : }
483 0 : };
484 0 :
485 0 : // maintenance tasks return Infallible success values, this is an impossible value
486 0 : // so this match statically ensures that there are no possibilities for that value
487 0 : match maintenance {}
488 0 : }
489 :
490 : /// ProxyConfig is created at proxy startup, and lives forever.
491 0 : fn build_config(args: &ProxyCliArgs) -> anyhow::Result<&'static ProxyConfig> {
492 0 : let tls_config = match (&args.tls_key, &args.tls_cert) {
493 0 : (Some(key_path), Some(cert_path)) => Some(config::configure_tls(
494 0 : key_path,
495 0 : cert_path,
496 0 : args.certs_dir.as_ref(),
497 0 : )?),
498 0 : (None, None) => None,
499 0 : _ => bail!("either both or neither tls-key and tls-cert must be specified"),
500 : };
501 :
502 0 : if args.allow_self_signed_compute {
503 0 : warn!("allowing self-signed compute certificates");
504 0 : }
505 0 : let backup_metric_collection_config = config::MetricBackupCollectionConfig {
506 0 : interval: args.metric_backup_collection_interval,
507 0 : remote_storage_config: remote_storage_from_toml(
508 0 : &args.metric_backup_collection_remote_storage,
509 0 : )?,
510 0 : chunk_size: args.metric_backup_collection_chunk_size,
511 : };
512 :
513 0 : let metric_collection = match (
514 0 : &args.metric_collection_endpoint,
515 0 : &args.metric_collection_interval,
516 : ) {
517 0 : (Some(endpoint), Some(interval)) => Some(config::MetricCollectionConfig {
518 0 : endpoint: endpoint.parse()?,
519 0 : interval: humantime::parse_duration(interval)?,
520 0 : backup_metric_collection_config,
521 : }),
522 0 : (None, None) => None,
523 0 : _ => bail!(
524 0 : "either both or neither metric-collection-endpoint \
525 0 : and metric-collection-interval must be specified"
526 0 : ),
527 : };
528 0 : if !args.disable_dynamic_rate_limiter {
529 0 : bail!("dynamic rate limiter should be disabled");
530 0 : }
531 :
532 0 : let auth_backend = match &args.auth_backend {
533 : AuthBackend::Console => {
534 0 : let wake_compute_cache_config: CacheOptions = args.wake_compute_cache.parse()?;
535 0 : let project_info_cache_config: ProjectInfoCacheOptions =
536 0 : args.project_info_cache.parse()?;
537 0 : let endpoint_cache_config: config::EndpointCacheConfig =
538 0 : args.endpoint_cache_config.parse()?;
539 :
540 0 : info!("Using NodeInfoCache (wake_compute) with options={wake_compute_cache_config:?}");
541 0 : info!(
542 0 : "Using AllowedIpsCache (wake_compute) with options={project_info_cache_config:?}"
543 : );
544 0 : info!("Using EndpointCacheConfig with options={endpoint_cache_config:?}");
545 0 : let caches = Box::leak(Box::new(console::caches::ApiCaches::new(
546 0 : wake_compute_cache_config,
547 0 : project_info_cache_config,
548 0 : endpoint_cache_config,
549 0 : )));
550 :
551 : let config::ConcurrencyLockOptions {
552 0 : shards,
553 0 : permits,
554 0 : epoch,
555 0 : timeout,
556 0 : } = args.wake_compute_lock.parse()?;
557 0 : info!(permits, shards, ?epoch, "Using NodeLocks (wake_compute)");
558 0 : let locks = Box::leak(Box::new(console::locks::ApiLocks::new(
559 0 : "wake_compute_lock",
560 0 : permits,
561 0 : shards,
562 0 : timeout,
563 0 : epoch,
564 0 : &Metrics::get().wake_compute_lock,
565 0 : )?));
566 0 : tokio::spawn(locks.garbage_collect_worker());
567 :
568 0 : let url = args.auth_endpoint.parse()?;
569 0 : let endpoint = http::Endpoint::new(url, http::new_client());
570 0 :
571 0 : let mut wake_compute_rps_limit = args.wake_compute_limit.clone();
572 0 : RateBucketInfo::validate(&mut wake_compute_rps_limit)?;
573 0 : let wake_compute_endpoint_rate_limiter =
574 0 : Arc::new(EndpointRateLimiter::new(wake_compute_rps_limit));
575 0 : let api = console::provider::neon::Api::new(
576 0 : endpoint,
577 0 : caches,
578 0 : locks,
579 0 : wake_compute_endpoint_rate_limiter,
580 0 : );
581 0 : let api = console::provider::ConsoleBackend::Console(api);
582 0 : auth::BackendType::Console(MaybeOwned::Owned(api), ())
583 : }
584 : #[cfg(feature = "testing")]
585 : AuthBackend::Postgres => {
586 0 : let url = args.auth_endpoint.parse()?;
587 0 : let api = console::provider::mock::Api::new(url);
588 0 : let api = console::provider::ConsoleBackend::Postgres(api);
589 0 : auth::BackendType::Console(MaybeOwned::Owned(api), ())
590 : }
591 : AuthBackend::Link => {
592 0 : let url = args.uri.parse()?;
593 0 : auth::BackendType::Link(MaybeOwned::Owned(url), ())
594 : }
595 : };
596 :
597 : let config::ConcurrencyLockOptions {
598 0 : shards,
599 0 : permits,
600 0 : epoch,
601 0 : timeout,
602 0 : } = args.connect_compute_lock.parse()?;
603 0 : info!(permits, shards, ?epoch, "Using NodeLocks (connect_compute)");
604 0 : let connect_compute_locks = console::locks::ApiLocks::new(
605 0 : "connect_compute_lock",
606 0 : permits,
607 0 : shards,
608 0 : timeout,
609 0 : epoch,
610 0 : &Metrics::get().proxy.connect_compute_lock,
611 0 : )?;
612 :
613 0 : let http_config = HttpConfig {
614 0 : request_timeout: args.sql_over_http.sql_over_http_timeout,
615 0 : pool_options: GlobalConnPoolOptions {
616 0 : max_conns_per_endpoint: args.sql_over_http.sql_over_http_pool_max_conns_per_endpoint,
617 0 : gc_epoch: args.sql_over_http.sql_over_http_pool_gc_epoch,
618 0 : pool_shards: args.sql_over_http.sql_over_http_pool_shards,
619 0 : idle_timeout: args.sql_over_http.sql_over_http_idle_timeout,
620 0 : opt_in: args.sql_over_http.sql_over_http_pool_opt_in,
621 0 : max_total_conns: args.sql_over_http.sql_over_http_pool_max_total_conns,
622 0 : },
623 0 : cancel_set: CancelSet::new(args.sql_over_http.sql_over_http_cancel_set_shards),
624 0 : client_conn_threshold: args.sql_over_http.sql_over_http_client_conn_threshold,
625 0 : };
626 0 : let authentication_config = AuthenticationConfig {
627 0 : scram_protocol_timeout: args.scram_protocol_timeout,
628 0 : rate_limiter_enabled: args.auth_rate_limit_enabled,
629 0 : rate_limiter: AuthRateLimiter::new(args.auth_rate_limit.clone()),
630 0 : rate_limit_ip_subnet: args.auth_rate_limit_ip_subnet,
631 0 : };
632 0 :
633 0 : let mut redis_rps_limit = args.redis_rps_limit.clone();
634 0 : RateBucketInfo::validate(&mut redis_rps_limit)?;
635 :
636 0 : let config = Box::leak(Box::new(ProxyConfig {
637 0 : tls_config,
638 0 : auth_backend,
639 0 : metric_collection,
640 0 : allow_self_signed_compute: args.allow_self_signed_compute,
641 0 : http_config,
642 0 : authentication_config,
643 0 : require_client_ip: args.require_client_ip,
644 0 : disable_ip_check_for_http: args.disable_ip_check_for_http,
645 0 : redis_rps_limit,
646 0 : handshake_timeout: args.handshake_timeout,
647 0 : region: args.region.clone(),
648 0 : aws_region: args.aws_region.clone(),
649 0 : wake_compute_retry_config: config::RetryConfig::parse(&args.wake_compute_retry)?,
650 0 : connect_compute_locks,
651 0 : connect_to_compute_retry_config: config::RetryConfig::parse(
652 0 : &args.connect_to_compute_retry,
653 0 : )?,
654 : }));
655 :
656 0 : tokio::spawn(config.connect_compute_locks.garbage_collect_worker());
657 0 :
658 0 : Ok(config)
659 0 : }
660 :
661 : #[cfg(test)]
662 : mod tests {
663 : use std::time::Duration;
664 :
665 : use clap::Parser;
666 : use proxy::rate_limiter::RateBucketInfo;
667 :
668 : #[test]
669 2 : fn parse_endpoint_rps_limit() {
670 2 : let config = super::ProxyCliArgs::parse_from([
671 2 : "proxy",
672 2 : "--endpoint-rps-limit",
673 2 : "100@1s",
674 2 : "--endpoint-rps-limit",
675 2 : "20@30s",
676 2 : ]);
677 2 :
678 2 : assert_eq!(
679 2 : config.endpoint_rps_limit,
680 2 : vec![
681 2 : RateBucketInfo::new(100, Duration::from_secs(1)),
682 2 : RateBucketInfo::new(20, Duration::from_secs(30)),
683 2 : ]
684 2 : );
685 2 : }
686 : }
|
