An application combines a number of plugins in order to create a pre-configured turn-key workspace for a collaboration (CO).
See the section Catalog Introduction in order to see what the different categories of catalog items mean (plugin, application, subscription, application offering).
Login to the Research Cloud portal.
When you are a developer-member in one of your collaborations (COs) you will see a downward arrow next to the "Catalog" tab.
(If you are not a developer, yet, see the Working Together section for more information on that.)
Clicking on this arrow renders a drop-down list:
You can choose to activate the conventional "Catalog" tab, but you can also choose to view and edit the different catalog items.
If you want to create a new application, click on the "Maintain applications" item.
Your browser will show a list of the applications that are available to you. "Available" means that either you are a member of a CO, that is allowed to use a particular application or that you are a member of a CO that "owns" an application.
The applications you are one of the owners of will be shown with an extra "edit" and "delete" option (marked red):
But let's assume that you do not "own" any applications, yet.
(More precisely: "None of the COs you are a developer in owns any applications.")
Being a developer in a CO, you can create a new application for that CO.
Click on the "+" symbol in the upper right of the page:
An "Add application" mask is displayed within the existing list:
Here, you can fill in the properties of your new Application.
- Name: A short and significant name that reflects the purpose of the application.
- Subtitle: A still short complement to the name. The subtitle will often be displayed along with the name.
- Description: A (possibly extended) description of the application.
- Access format: A text-pattern (with placeholders) that specifies how a workspace with this application can be accessed. A typical value for a "headless" Linux server application could be "ssh://==USERNAME==@==IP==". A workspace with a desktop could be accessed with "rdp://==IP==". An application with a builtin nginx server like Jupyter or RStudio typically has an access format of "https://==REVERSE_PROXY==".
- Icon: The base64-string-representation of the icon for your application. Please take the effort to enter a recognizable icon - it helps you and your users. You can convert image files to base64 strings with online-tools like base64-image.de or base64encoder.io .
- Contact name: Persons(s) to contact for questions and requests.
- Contact e-mail: e-mail addresses for questions and requests.
- Contact website: the url of a public site for documentation and support for the application. Especially when your app has a sizeable user base, a good support page will both enhance your user's experience and lower the support-load for you.
- Type: For now, always use "COMPUTE".
- CO owner: Select the CO from which you want to further develop, maintain and share this application. All members of the owner CO, also non-developers will be able to see and use the application.
- Allowed COs: From the COs you are a developer in, compose a list of COs that are allowed to see and use the application. The owner CO is a part of this list, automatically.
- Application status: This should be "active". Under normal circumstances, you wouldn't want it to be "disabled".
When you click on the "Edit" icon next to "Application plugins" a list composition dialog will appear:
This is where you can compose the actual application.
Below, all available plugins are shown. From here, you can drag plugins to the right part of the dialog in order to assemble this application's list of plugins.
The plugins will be run in order from left to right. You can arrange the order by drag and drop.
When a workspace for this application is started, the plugins will we be run in the order you specify here.
When the list is ready, click the "SAVE" button to attach the list to the application.
In order to get started just inspect the plugin-lists of other applications and take over the first few plugins in your own application. This will give you a solid base to build the application that you need.
The usage of parameters is explained on an extra page: Using parameters.
You do not necessarily need parameters when starting to create applications.
Finish with "SUBMIT"
Click on "Submit" to save the new application. Make sure that it now appears in the total list of applications and that you can see an "Edit" and a "Delete" icon for it.
You can change all the properties of the application, later on. Just click on its "Edit" icon in the list.