layout | title | tagline |
---|---|---|
page |
Create a Custom Application |
NOTE: This build process works, but has been streamlined in a different guide. Please refer to the new page for Creating Apps. The old instructions will be kept below for reference.
You can find Agave applications ("apps") in the SD2E catalog by using the apps-list
command described previously. What if the app you are
looking for is not available? Using the Agave CLI, you can create your own.
#### Components of an app
The essential components you need to create your own app are:
- A Docker image containing the executable and all runtime dependencies
- A wrapper script (generally written in bash) that runs the executable
- A test script (also written in bash) for testing the executable outside of the Agave environment
Several example apps exist and all components are visible. For example, visit the SD2E Docker Hub to view existing app containers. And, example app bundles can be viewed on the SD2E GitHub page.
#### Create your own by example
The best way to demonstrate the creation of a custom app is by example. The following sub-pages will go through the process:
- Clone an example app
- Containerize your executable
- Build wrapper and test scripts
- Add your app to the SD2E tenant
- Best practices and next steps
Return to the API Documentation Overview