Skip to content

Commit

Permalink
chore: txt to md
Browse files Browse the repository at this point in the history
  • Loading branch information
erayarslan committed Nov 30, 2024
1 parent 8354128 commit bc9a710
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ concurrency:

jobs:
build:
if: "!contains(github.event.commits[0].message, 'chore:')"
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ concurrency:

jobs:
test:
if: "!contains(github.event.commits[0].message, 'chore:')"
runs-on: ubuntu-latest
steps:
- name: Install Multipass
Expand Down
37 changes: 31 additions & 6 deletions README.txt → README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,69 @@
# Multiverse (WARNING, this is a work in progress)
## Multiverse (this is a work in progress)

## Introduction
Effortless Cluster Management with Multipass

Multiverse is a multi node Multipass manager which is designed to create a cluster of Multipass.
It is aim to provide a simple way to create, start, stop, delete, shell and manage Multipass instances from any machine.
It is looks like a kubectl but for Multipass.
Multiverse is a robust, user-friendly tool designed to streamline the creation and management of multi-node virtual environments using Multipass. Perfect for developers and system administrators, Multiverse simplifies handling distributed setups by offering powerful features such as:

- **Cluster Creation**: Quickly spin up and configure multi-node clusters with ease.
- **Cache Synchronization**: Seamlessly sync resources between master and worker nodes for smooth operation.
- **Comprehensive CLI**: Efficiently manage nodes and instances with intuitive command-line tools.
- **Enhanced Usability**: Enjoy features like terminal resizing, shell integration, and detailed resource monitoring.

Built for scalability and flexibility, Multiverse is ideal for developing, testing, or running distributed systems in a virtualized environment. Whether you're working on a microservices architecture, experimenting with Kubernetes clusters, or running parallel workloads, Multiverse makes multi-node management straightforward and efficient.

Discover the future of simplified virtualization with Multiverse :rocket:

## Test

λ go run cmd/main.go --help
```shell
go run cmd/main.go --help
```

## Example Usage

```text
λ multipass start
Launched: primary
Mounted '/Users/username' into 'primary:Home'
```

```text
λ multiverse -master
master.go: master addr: localhost:1337
master.go: api server addr: localhost:1338
```

```text
λ multiverse -worker
worker.go: master to connect addr: localhost:1337
client.go: joined with uuid: $uuid
```

```text
λ multiverse -client -shell -shell-instance-name=primary
ubuntu@primary:~$
```

```text
λ multiverse -client -nodes
Node Name IPv4 Cpu Mem Disk Last Sync
hostname 127.0.0.1:***** 1 1Gb 4Gb 2024-01-01 00:00:00 UTC
```

```text
λ multiverse -client -instances
Node Name Instance Name State IPv4 Image
hostname primary Running xxx.xxx.xxx.xxx ??.?? ???
```

```text
λ multiverse -client -info
Node Name Instance Name Cpu Load Disk Memory
hostname primary 1 0.07 0.02 0.00 2.5GiB out of 4.0GiB 1.3GiB out of 4.0GiB
```

## Architecture
```text
┌───────────────────────────────────┐
│ multiverse client cli │
│ │
Expand Down Expand Up @@ -72,3 +96,4 @@ hostname primary 1 0.07 0.02 0.00 2.5GiB out of 4.0Gi
└────────┼▶│ cluster server │ │
│ └───────────────────────────────┘ │
└───────────────────────────────────┘
```

0 comments on commit bc9a710

Please sign in to comment.