Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Editorial change: export to extract and extraction #136

Merged
merged 1 commit into from
Jun 29, 2023
Merged

Editorial change: export to extract and extraction #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions guidelines/monai-application-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,13 +608,13 @@ A MAP is a single container supporting the following defined behaviors when star

When a MAP is started from the CLI or other means without any parameters, the MAP shall execute the contained application. The MAP internally may use `Entrypoint`, `CMD`, or a combination of both.

#### Manifest Export
#### Manifest Extraction

A MAP SHOULD provide at least one method to access the _embedded application_, _models_, _licenses_, _README_, or _manifest files_, namely, `app.json` and `package.json`.

- The Method SHOULD provide a container command, _`show`_, to print one or more manifest files to the console.

- The Method SHOULD provide a container command, _`export`_, to copy one or more manifest files to a mounted volume path, as described below
- The Method SHOULD provide a container command, _`extract`_, to copy one or more manifest files to a mounted volume path, as described below

- `/var/run/holoscan/export/app/`: when detected, the Method copies the contents of `/opt/holoscan/app/` to the folder.

Expand All @@ -641,10 +641,10 @@ Since a MAP is an OCI compliant container, a user can also run a MAP and log in
| `/var/holoscan/` | Default working directory. |
| `/var/holoscan/input/` | Default input directory. |
| `/var/holoscan/output/` | Default output directory. |
| `/var/run/holoscan/export/` | Special case folder, causes the Script to export contents related to the app. (see: [Manifest Export](#manifest-export)) |
| `/var/run/holoscan/export/app/` | Special case folder, causes the Script to export the contents of `/opt/holoscan/app/` to the folder. |
| `/var/run/holoscan/export/config/` | Special case folder, causes the Script to export `/etc/holoscan/app.json` and `/etc/holoscan/pkg.json` to the folder. |
| `/var/run/holoscan/export/models/` | Special case folder, causes the Script to export the contents of `/opt/holoscan/models/` to the folder. |
| `/var/run/holoscan/export/` | Special case folder, causes the Script to extract contents related to the app. (see: [Manifest Extraction](#manifest-extraction)) |
| `/var/run/holoscan/export/app/` | Special case folder, causes the Script to extract the contents of `/opt/holoscan/app/` to the folder. |
| `/var/run/holoscan/export/config/` | Special case folder, causes the Script to extract `/etc/holoscan/app.json` and `/etc/holoscan/pkg.json` to the folder. |
| `/var/run/holoscan/export/models/` | Special case folder, causes the Script to extract the contents of `/opt/holoscan/models/` to the folder. |

## Package Layout Diagram

Expand Down