Metadata-Version: 2.4
Name: jumpstarter_driver_corellium
Version: 0.8.2.dev113+gb19d6327f
Project-URL: Homepage, https://jumpstarter.dev
Project-URL: source_archive, https://github.com/jumpstarter-dev/repo/archive/b19d6327fda749bdd72caf050a458788ab29375f.zip
Author-email: Leonardo Rossetti <lrossett@redhat.com>
License-Expression: Apache-2.0
Requires-Python: >=3.11
Requires-Dist: click>=8.1.7.2
Requires-Dist: jumpstarter-driver-composite==0.8.2.dev113+gb19d6327f
Requires-Dist: jumpstarter-driver-network==0.8.2.dev113+gb19d6327f
Requires-Dist: jumpstarter-driver-power==0.8.2.dev113+gb19d6327f
Requires-Dist: jumpstarter-driver-pyserial==0.8.2.dev113+gb19d6327f
Requires-Dist: jumpstarter==0.8.2.dev113+gb19d6327f
Description-Content-Type: text/markdown

# Corellium Driver

`jumpstarter-driver-corellium` provides functionality for interacting with
[Corellium](https://corellium.com) virtualization platform.

## Installation

```{code-block} console
:substitutions:
$ pip3 install --extra-index-url {{index_url}} jumpstarter-driver-corellium
```

## Configuration

Example configuration:

```yaml
export:
  corellium:
    type: jumpstarter_driver_corellium.driver.Corellium
    config:
      project_id: "778f00af-5e9b-40e6-8e7f-c4f14b632e9c"
      device_name: "jmp-rd1ae"
      device_flavor: "kronos"
      # Optional parameters
      # device_os: "1.0"
      # device_build: "Critical Application Monitor (Baremetal)"
```

### ExporterConfig Example

You can run an exporter by running: `jmp exporter shell -c $file`:

```yaml
apiVersion: jumpstarter.dev/v1alpha1
kind: ExporterConfig
# endpoint and token are intentionally left empty
metadata:
  namespace: default
  name: corellium-demo
endpoint: ""
token: ""
export:
  rd1ae:
    type: jumpstarter_driver_corellium.driver.Corellium
    config:
      project_id: "778f00af-5e9b-40e6-8e7f-c4f14b632e9c"
      device_name: "jmp-rd1ae"
      device_flavor: "kronos"
```

```yaml
apiVersion: jumpstarter.dev/v1alpha1
kind: ExporterConfig
# endpoint and token are intentionally left empty
metadata:
  namespace: default
  name: corellium-demo
endpoint: ""
token: ""
export:
  rd1ae:
    type: jumpstarter_driver_corellium.driver.Corellium
    config:
      project_id: "778f00af-5e9b-40e6-8e7f-c4f14b632e9c"
      device_name: "jmp-rd1ae"
      device_flavor: "kronos"
      device_os: "1.0"
      device_build: "Critical Application Monitor (Baremetal)"
```
