netmito 0.6.6

A Unified Distributed Transport Evaluation Framework
Documentation 
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

# Mitosis: A Unified Transport Evaluation Framework

[![github-repo](https://img.shields.io/badge/github-stack--rs/mitosis-f5dc23?logo=github)](https://github.com/stack-rs/mitosis)
[![Documentation](https://img.shields.io/badge/Documentation-blue?logo=mdbook&labelColor=gray&link=https%3A%2F%2Fdocs.stack.rs%2Fmitosis)](https://docs.stack.rs/mitosis)
[![crates.io/netmito](https://img.shields.io/crates/v/netmito.svg?logo=rust&label=netmito)](https://crates.io/crates/netmito)
[![crates.io/mito](https://img.shields.io/crates/v/mito.svg?logo=rust&label=mito)](https://crates.io/crates/mito)
[![docs.rs](https://img.shields.io/badge/docs.rs-netmito-34A853?logo=docsdotrs)](https://docs.rs/netmito)
[![LICENSE Apache-2.0](https://img.shields.io/github/license/stack-rs/mitosis?logo=Apache)](https://github.com/stack-rs/mitosis/blob/main/LICENSE)

**Mitosis** is a Rust library and command-line tool designed for running distributed platforms, particularly for transport research. It provides a framework for parallelizing tasks across multiple workers in a controlled, managed environment.
It is designed for transport-layer research, but it can be used for any other purpose.

## Overview

Mitosis consists of three main components:

- **Coordinator**: Central management service that schedules tasks and tracks execution
- **Worker**: Task execution nodes that fetch and run jobs
- **Client**: Interface for submitting tasks, managing users, and monitoring progress

The system uses a user-group-based access control model where users can delegate tasks to groups, which are then executed by workers that have been configured to serve those groups.

You can view the full documentation and guidelines at [docs.stack.rs/mitosis](https://docs.stack.rs/mitosis).

## Quick Start

### Prerequisites

- Rust 1.76 or later
- PostgreSQL database
- S3-compatible storage (e.g., MinIO)
- Redis (optional, for enhanced monitoring)

### Installation

**Using pre-compiled binaries:**

```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/stack-rs/mitosis/releases/latest/download/mito-installer.sh | sh
```

**From source:**

```bash
git clone https://github.com/stack-rs/mitosis.git
cd mitosis
cargo build --release
```

**From crates.io:**

```bash
cargo install mito
```

Now you can execute the `mito` command to enter the interactive client mode or use subcommands directly.

```bash
# Enter interactive mode:
mito client -i
# directly execute a command:
mito client tasks submit -- echo "Hello, Mitosis!"
```

For setting up the whole service (including the Coordinator and the Worker), please refer to our full [guidelines](https://docs.stack.rs/mitosis).

## Key Features

- **Distributed Task Execution**: Scale workloads across multiple workers
- **Role-Based Access Control**: Fine-grained permissions for users and groups
- **Tag-Based Worker Selection**: Target specific worker capabilities
- **Artifact Management**: Automatic collection and storage of task outputs
- **Batch Operations**: Efficiently manage multiple tasks, workers, and artifacts at once (v0.6.5+)
- **Shared Rolling Logs**: Centralized logging for multiple workers with automatic rotation (v0.6.5+)
- **Interactive Client**: User-friendly CLI with both interactive and batch modes
- **SDK Support**: Rust and Python library for programmatic integration

## Architecture

Mitosis follows a coordinator-worker pattern:

1. **Client** submits tasks to the **Coordinator**
2. **Coordinator** stores tasks and makes them available to **Workers**
3. **Workers** poll for tasks, execute them, and report results back
4. Results and artifacts are stored and can be retrieved through the **Client**

## Documentation

- **[User Guide](https://docs.stack.rs/mitosis)** - Complete documentation
- **[API Reference](https://docs.rs/netmito)** - Rust SDK documentation
- **[Contributing Guide](CONTRIBUTING.md)** - Development setup and guidelines
- **[OpenAPI Spec](openapi.yaml)** - The API specification for the Coordinator's HTTP endpoints

## Use Cases

- **Research Computing**: Distribute computational workloads across lab resources
- **CI/CD Pipelines**: Execute build and test tasks on dedicated workers
- **Data Processing**: Parallel processing of large datasets
- **Network Testing**: Transport layer protocol evaluation and benchmarking
- **General Distributed Computing**: Any scenario requiring managed task distribution

## Community & Support

- **GitHub Issues**: [Report bugs and request features](https://github.com/stack-rs/mitosis/issues)
- **Discussions**: [Community discussions and Q&A](https://github.com/stack-rs/mitosis/discussions)
- **Contributing**: We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

Licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.