1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
use std::collections::HashMap;
use std::net::SocketAddr;
use std::sync::Arc;
use anyhow::Result;
use async_trait::async_trait;
use hydroflow_crate::tracing_options::TracingOptions;
use hydroflow_deploy_integration::ServerBindConfig;
pub mod deployment;
pub use deployment::Deployment;
pub mod progress;
pub mod localhost;
pub use localhost::LocalhostHost;
pub mod ssh;
pub mod gcp;
pub use gcp::GcpComputeEngineHost;
pub mod azure;
pub use azure::AzureHost;
pub mod hydroflow_crate;
pub use hydroflow_crate::HydroflowCrate;
pub mod custom_service;
pub use custom_service::CustomService;
use tokio::sync::{mpsc, oneshot};
use crate::hydroflow_crate::build::BuildOutput;
pub mod terraform;
pub mod util;
#[derive(Default)]
pub struct ResourcePool {
pub terraform: terraform::TerraformPool,
}
pub struct ResourceBatch {
pub terraform: terraform::TerraformBatch,
}
impl ResourceBatch {
fn new() -> ResourceBatch {
ResourceBatch {
terraform: terraform::TerraformBatch::default(),
}
}
async fn provision(
self,
pool: &mut ResourcePool,
last_result: Option<Arc<ResourceResult>>,
) -> Result<ResourceResult> {
Ok(ResourceResult {
terraform: self.terraform.provision(&mut pool.terraform).await?,
_last_result: last_result,
})
}
}
#[derive(Debug)]
pub struct ResourceResult {
pub terraform: terraform::TerraformResult,
_last_result: Option<Arc<ResourceResult>>,
}
#[async_trait]
pub trait LaunchedBinary: Send + Sync {
fn stdin(&self) -> mpsc::UnboundedSender<String>;
/// Provides a oneshot channel to handshake with the binary,
/// with the guarantee that as long as deploy is holding on
/// to a handle, none of the messages will also be broadcast
/// to the user-facing [`LaunchedBinary::stdout`] channel.
fn deploy_stdout(&self) -> oneshot::Receiver<String>;
fn stdout(&self) -> mpsc::UnboundedReceiver<String>;
fn stderr(&self) -> mpsc::UnboundedReceiver<String>;
fn exit_code(&self) -> Option<i32>;
/// Wait for the process to stop on its own. Returns the exit code.
async fn wait(&mut self) -> Result<i32>;
/// If the process is still running, force stop it. Then run post-run tasks.
async fn stop(&mut self) -> Result<()>;
}
#[async_trait]
pub trait LaunchedHost: Send + Sync {
/// Given a pre-selected network type, computes concrete information needed for a service
/// to listen to network connections (such as the IP address to bind to).
fn server_config(&self, strategy: &ServerStrategy) -> ServerBindConfig;
async fn copy_binary(&self, binary: &BuildOutput) -> Result<()>;
async fn launch_binary(
&self,
id: String,
binary: &BuildOutput,
args: &[String],
perf: Option<TracingOptions>,
) -> Result<Box<dyn LaunchedBinary>>;
async fn forward_port(&self, addr: &SocketAddr) -> Result<SocketAddr>;
}
/// Types of connections that a host can make to another host.
pub enum ServerStrategy {
UnixSocket,
InternalTcpPort,
ExternalTcpPort(
/// The port number to bind to, which must be explicit to open the firewall.
u16,
),
Demux(HashMap<u32, ServerStrategy>),
Merge(Vec<ServerStrategy>),
Tagged(Box<ServerStrategy>, u32),
Null,
}
/// Like BindType, but includes metadata for determining whether a connection is possible.
pub enum ClientStrategy<'a> {
UnixSocket(
/// Unique identifier for the host this socket will be on.
usize,
),
InternalTcpPort(
/// The host that this port is available on.
&'a dyn Host,
),
ForwardedTcpPort(
/// The host that this port is available on.
&'a dyn Host,
),
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum HostTargetType {
Local,
Linux,
}
pub type HostStrategyGetter = Box<dyn FnOnce(&dyn std::any::Any) -> ServerStrategy>;
pub trait Host: Send + Sync {
fn target_type(&self) -> HostTargetType;
fn request_port(&self, bind_type: &ServerStrategy);
/// An identifier for this host, which is unique within a deployment.
fn id(&self) -> usize;
/// Configures the host to support copying and running a custom binary.
fn request_custom_binary(&self);
/// Makes requests for physical resources (servers) that this host needs to run.
///
/// This should be called before `provision` is called.
fn collect_resources(&self, resource_batch: &mut ResourceBatch);
/// Connects to the acquired resources and prepares the host to run services.
///
/// This should be called after `collect_resources` is called.
fn provision(&self, resource_result: &Arc<ResourceResult>) -> Arc<dyn LaunchedHost>;
fn launched(&self) -> Option<Arc<dyn LaunchedHost>>;
/// Identifies a network type that this host can use for connections if it is the server.
/// The host will be `None` if the connection is from the same host as the target.
fn strategy_as_server<'a>(
&'a self,
connection_from: &dyn Host,
) -> Result<(ClientStrategy<'a>, HostStrategyGetter)>;
/// Determines whether this host can connect to another host using the given strategy.
fn can_connect_to(&self, typ: ClientStrategy) -> bool;
/// Returns a reference to the host as a trait object.
fn as_any(&self) -> &dyn std::any::Any;
}
#[async_trait]
pub trait Service: Send + Sync {
/// Makes requests for physical resources server ports that this service needs to run.
/// This should **not** recursively call `collect_resources` on the host, since
/// we guarantee that `collect_resources` is only called once per host.
///
/// This should also perform any "free", non-blocking computations (compilations),
/// because the `deploy` method will be called after these resources are allocated.
fn collect_resources(&self, resource_batch: &mut ResourceBatch);
/// Connects to the acquired resources and prepares the service to be launched.
async fn deploy(&mut self, resource_result: &Arc<ResourceResult>) -> Result<()>;
/// Launches the service, which should start listening for incoming network
/// connections. The service should not start computing at this point.
async fn ready(&mut self) -> Result<()>;
/// Starts the service by having it connect to other services and start computations.
async fn start(&mut self) -> Result<()>;
/// Stops the service by having it disconnect from other services and stop computations.
async fn stop(&mut self) -> Result<()>;
}
pub trait ServiceBuilder {
type Service: Service + 'static;
fn build(self, id: usize) -> Self::Service;
}
impl<S: Service + 'static, T: FnOnce(usize) -> S> ServiceBuilder for T {
type Service = S;
fn build(self, id: usize) -> Self::Service {
self(id)
}
}