New config types in restate-types

crates/invoker-impl/src/options.rs

@@ -97,7 +97,9 @@ impl Default for Options {
             retry_policy: RetryPolicy::exponential(
                 Duration::from_millis(50),
                 2.0,
-                usize::MAX,
+                // Practically no limit, but toml fails on loading anything higher than i64::MAX
+                // See https://github.com/toml-rs/toml/issues/705 for details
+                i64::MAX as usize,
                 Some(Duration::from_secs(10)),
             ),
             inactivity_timeout: Duration::from_secs(60).into(),

crates/types/Cargo.toml

@@ -11,7 +11,6 @@ publish = false
 default = []
 
 test-util = []
-schemars = ["dep:schemars"]
 local_loglet = []
 memory_loglet = []
 
@@ -23,10 +22,12 @@ arc-swap = { workspace = true }
 base64 = { workspace = true }
 bytes = { workspace = true }
 bytestring = { workspace = true }
-clap = { workspace = true, optional = true }
+clap = { workspace = true, features = ["std", "derive", "env"], optional = true }
+derive_builder = { workspace = true }
 derive_more = { workspace = true }
 enum-map = { workspace = true }
 enumset = { workspace = true, features = ["serde"] }
+hostname = { version = "0.4" }
 http = { workspace = true }
 humantime = { workspace = true }
 once_cell = { workspace = true }
@@ -41,6 +42,7 @@ strum_macros = { workspace = true }
 sync_wrapper = { workspace = true }
 thiserror = { workspace = true }
 tokio = { workspace = true, default-features = false, features = ["time", "sync"]}
+toml = { version = "0.8.12" }
 tracing = { workspace = true }
 tracing-opentelemetry = { workspace = true }
 ulid = { workspace = true }

crates/types/src/config/admin.rs

@@ -0,0 +1,52 @@
+// Copyright (c) 2024 -  Restate Software, Inc., Restate GmbH.
+// All rights reserved.
+//
+// Use of this software is governed by the Business Source License
+// included in the LICENSE file.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0.
+
+use serde::{Deserialize, Serialize};
+use serde_with::serde_as;
+use std::net::SocketAddr;
+use std::path::PathBuf;
+
+use super::{data_dir, QueryEngineOptions};
+
+/// # Admin server options
+#[serde_as]
+#[derive(Debug, Clone, Serialize, Deserialize, derive_builder::Builder)]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+#[cfg_attr(feature = "schemars", schemars(rename = "AdminOptions", default))]
+#[serde(rename_all = "kebab-case")]
+#[builder(default)]
+pub struct AdminOptions {
+    /// # Endpoint address
+    ///
+    /// Address to bind for the Admin APIs.
+    pub bind_address: SocketAddr,
+
+    /// # Concurrency limit
+    ///
+    /// Concurrency limit for the Admin APIs.
+    pub concurrent_api_requests_limit: usize,
+    pub query_engine: QueryEngineOptions,
+}
+
+impl AdminOptions {
+    pub fn data_dir(&self) -> PathBuf {
+        data_dir("registry")
+    }
+}
+
+impl Default for AdminOptions {
+    fn default() -> Self {
+        Self {
+            bind_address: "0.0.0.0:9070".parse().unwrap(),
+            concurrent_api_requests_limit: i64::MAX as usize,
+            query_engine: Default::default(),
+        }
+    }
+}

crates/types/src/config/aws.rs

@@ -0,0 +1,33 @@
+// Copyright (c) 2024 -  Restate Software, Inc., Restate GmbH.
+// All rights reserved.
+//
+// Use of this software is governed by the Business Source License
+// included in the LICENSE file.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0.
+
+use serde::{Deserialize, Serialize};
+use serde_with::serde_as;
+
+/// # AWS options
+#[serde_as]
+#[derive(Debug, Default, Clone, Serialize, Deserialize, derive_builder::Builder)]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+#[cfg_attr(feature = "schemars", schemars(rename = "AwsClientOptions", default))]
+#[builder(default)]
+pub struct AwsOptions {
+    /// # AWS Profile
+    ///
+    /// Name of the AWS profile to select. Defaults to 'AWS_PROFILE' env var, or otherwise
+    /// the `default` profile.
+    pub aws_profile: Option<String>,
+
+    /// # AssumeRole external ID
+    ///
+    /// An external ID to apply to any AssumeRole operations taken by this client.
+    /// https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
+    /// Can be overridden by the `AWS_EXTERNAL_ID` environment variable.
+    pub aws_assume_role_external_id: Option<String>,
+}

crates/types/src/config/bifrost.rs

@@ -0,0 +1,112 @@
+// Copyright (c) 2024 -  Restate Software, Inc., Restate GmbH.
+// All rights reserved.
+//
+// Use of this software is governed by the Business Source License
+// included in the LICENSE file.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0.
+
+use std::path::PathBuf;
+use std::time::Duration;
+
+use enum_map::Enum;
+use serde::{Deserialize, Serialize};
+use serde_with::serde_as;
+
+use super::{data_dir, RocksDbOptions, RocksDbOptionsBuilder};
+
+/// # Bifrost options
+#[derive(Debug, Clone, Serialize, Deserialize, derive_builder::Builder)]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+#[cfg_attr(feature = "schemars", schemars(rename = "BifrostOptions", default))]
+#[serde(rename_all = "kebab-case")]
+#[builder(default)]
+pub struct BifrostOptions {
+    /// # The default kind of loglet to be used
+    #[cfg_attr(feature = "schemars", schemars(with = "String"))]
+    pub default_provider: ProviderKind,
+    #[cfg_attr(feature = "schemars", schemars(with = "String"))]
+    /// Configuration of local loglet provider
+    pub local: LocalLogletOptions,
+}
+
+impl Default for BifrostOptions {
+    fn default() -> Self {
+        Self {
+            default_provider: ProviderKind::Local,
+            local: LocalLogletOptions::default(),
+        }
+    }
+}
+
+/// An enum with the list of supported loglet providers.
+/// For each variant we must have a corresponding implementation of the
+/// [`crate::loglet::Loglet`] trait
+#[derive(
+    Debug,
+    Clone,
+    Hash,
+    Eq,
+    PartialEq,
+    Copy,
+    serde::Serialize,
+    serde::Deserialize,
+    Enum,
+    strum_macros::EnumIter,
+    strum_macros::Display,
+)]
+#[serde(rename_all = "kebab-case")]
+pub enum ProviderKind {
+    /// A local rocksdb-backed loglet.
+    Local,
+    /// An in-memory loglet, primarily for testing.
+    InMemory,
+}
+
+#[serde_as]
+#[derive(Debug, Clone, Serialize, Deserialize, derive_builder::Builder)]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+#[cfg_attr(feature = "schemars", schemars(rename = "LocalLoglet", default))]
+#[serde(rename_all = "kebab-case")]
+#[builder(default)]
+pub struct LocalLogletOptions {
+    #[serde(flatten)]
+    pub rocksdb: RocksDbOptions,
+
+    /// Trigger a commit when the batch size exceeds this threshold. Set to 0 or 1 to commit the
+    /// write batch on every command.
+    pub writer_commit_batch_size_threshold: usize,
+    /// Trigger a commit when the time since the last commit exceeds this threshold.
+    #[serde_as(as = "serde_with::DisplayFromStr")]
+    #[cfg_attr(feature = "schemars", schemars(with = "String"))]
+    pub writer_commit_time_interval: humantime::Duration,
+    /// The maximum number of write commands that can be queued.
+    pub writer_queue_len: usize,
+    /// If true, rocksdb flushes follow writing record batches, otherwise, we
+    /// fallback to rocksdb automatic WAL flushes.
+    pub flush_wal_on_commit: bool,
+}
+
+impl LocalLogletOptions {
+    pub fn data_dir(&self) -> PathBuf {
+        data_dir("local-loglet")
+    }
+}
+
+impl Default for LocalLogletOptions {
+    fn default() -> Self {
+        let rocksdb = RocksDbOptionsBuilder::default()
+            .rocksdb_disable_wal(Some(false))
+            .build()
+            .unwrap();
+        Self {
+            rocksdb,
+            writer_commit_batch_size_threshold: 200,
+            writer_commit_time_interval: Duration::from_millis(13).into(),
+            writer_queue_len: 200,
+            flush_wal_on_commit: true,
+        }
+    }
+}