Crate runtara_management_sdk

Crate runtara_management_sdk 

Source
Expand description

Runtara Management SDK

High-level SDK for managing Runtara Environment instances and images.

This crate provides an ergonomic client for interacting with runtara-environment’s API over QUIC. It is the single entry point for all management operations.

§Architecture

The Management SDK talks ONLY to runtara-environment:

  • Image management (register, list, delete)
  • Instance lifecycle (start, stop, resume, status)
  • Signals (pause, cancel - proxied to runtara-core by Environment)

§Example

use runtara_management_sdk::{ManagementSdk, StartInstanceOptions};

// Create SDK for local development
let sdk = ManagementSdk::localhost()?;

// Connect to runtara-environment
sdk.connect().await?;

// Check health
let health = sdk.health_check().await?;
println!("Server version: {}", health.version);

// Start an instance
let options = StartInstanceOptions::new("my-image-id", "tenant-1")
    .with_input(serde_json::json!({"key": "value"}));
let result = sdk.start_instance(options).await?;
println!("Started instance: {}", result.instance_id);

// Get instance status
let status = sdk.get_instance_status(&result.instance_id).await?;
println!("Status: {:?}", status.status);

Structs§

AgentInfo
Information about an agent.
CapabilityField
Information about a capability input field.
CapabilityInfo
Information about a capability.
Checkpoint
Full checkpoint with data.
CheckpointSummary
Summary of a checkpoint (for list results).
EventSummary
Summary of an event (for list results).
GetTenantMetricsOptions
Options for getting tenant metrics.
HealthStatus
Health status of runtara-core.
ImageSummary
Summary of an image (used in list results).
InstanceInfo
Instance status response with full details.
InstanceSummary
Summary of an instance (used in list results).
ListCheckpointsOptions
Options for listing checkpoints.
ListCheckpointsResult
Result of listing checkpoints.
ListEventsOptions
Options for listing events.
ListEventsResult
Result of listing events.
ListImagesOptions
Options for listing images.
ListImagesResult
Result of listing images.
ListInstancesOptions
Options for listing instances.
ListInstancesResult
Result of listing instances.
ManagementSdk
High-level SDK for managing runtara-environment instances and images.
MetricsBucket
A single time bucket of aggregated metrics.
RegisterImageOptions
Options for registering an image.
RegisterImageResult
Result of registering an image.
RegisterImageStreamOptions
Options for streaming image registration.
SdkConfig
Configuration for the ManagementSdk.
StartInstanceOptions
Options for starting an instance.
StartInstanceResult
Result of starting an instance.
StopInstanceOptions
Options for stopping an instance.
TenantMetricsResult
Result of tenant metrics aggregation.
TestCapabilityOptions
Options for testing a capability.
TestCapabilityResult
Result of testing a capability.

Enums§

InstanceStatus
Instance status.
ListInstancesOrder
Sort order for listing instances.
MetricsGranularity
Granularity for metrics aggregation buckets.
RunnerType
Runner type for images.
SdkError
Errors that can occur when using the management SDK.
SignalType
Signal type for controlling instances.

Type Aliases§

Result
Result type using SdkError.