https://github.com/golemfactory/ya-runtime-dbg

A debugging tool for yagna runtimes based on runtime API
https://github.com/golemfactory/ya-runtime-dbg

golem ya-runtime

Last synced: about 1 month ago
JSON representation

A debugging tool for yagna runtimes based on runtime API

• Host: GitHub
• URL: https://github.com/golemfactory/ya-runtime-dbg
• Owner: golemfactory
• Created: 2021-02-18T12:51:58.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-04T08:47:23.000Z (over 2 years ago)
• Last Synced: 2024-10-08T10:03:30.514Z (4 months ago)
• Topics: golem, ya-runtime
• Language: Rust
• Homepage:
• Size: 57.6 KB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ya-runtime-dbg

A debugging tool for [yagna](https://github.com/golemfactory/yagna) runtimes based on [runtime API](https://github.com/golemfactory/yagna/tree/master/exe-unit/runtime-api).

**Runtimes** are execution environments for applications built on `yagna`; e.g. `ya-runtime-vm` executes user-built images in a Virtual Machine environment. 

A tutorial on building an app can be found [here](https://handbook.golem.network/requestor-tutorials/create-your-own-application-on-golem).

## Installation

In order to use this tool, you need to install the runtime of your interest. To install the default runtimes, follow [this part of the handbook](https://handbook.golem.network/provider-tutorials/provider-tutorial#installation).

Check the [releases](https://github.com/golemfactory/ya-runtime-dbg/releases) page for `deb` and `tar.gz` packages (x64 and Linux only) of this tool.

## Command line

```bash

USAGE:

    ya-runtime-dbg [FLAGS] [OPTIONS] --runtime  --task-package  --workdir  [varargs]...

FLAGS:

        --no-deploy    Skip deployment phase

    -h, --help         Prints help information

    -V, --version      Prints version information

OPTIONS:

        --exec-mode           Mode to execute commands in [default: shell]  [possible values:

                                         Shell, Exec]

        --exec-shell         Execution shell (for "--exec-mode shell" or default mode) [default:

                                         bash]

    -r, --runtime               Runtime binary

    -w, --workdir               Working directory

    -t, --task-package     Task package to deploy

    -p, --protocol             Service protocol version [default: 0.1.0]

ARGS:

    ...    Additional runtime arguments

```

## Example invocation

```bash

ya-runtime-dbg --runtime /usr/lib/yagna/plugins/ya-runtime-vm/ya-runtime-vm \

    --task-package /tmp/image.gvmi \

    --workdir /tmp/runtime \

    -- --cpu-cores 2

```

## Available runtimes

Available runtimes can be discovered via [ya-runtime](https://github.com/topics/ya-runtime) topic on GH.