A catalog item combines a number of components in order to create a pre-configured turn-key workspace for a collaboration (CO).
See the section Catalog Introduction to learn the difference between component and catalog item.
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 and components.
If you want to create a new catalog item, click on the “Catalog items”.
Your browser will show a list of the catalog items that are available to you. "Available" means that either you are a member of a collaborative organisation that is allowed to use a particular catalog item or that you are a member of a collaborative organisation that "owns" a catalog item.
If you are one of the owners of a catalog item, it will be shown with extra actions: "edit", “clone”, "disable" and "delete".
But let's assume that you do not "own" any catalog items yet.
(More precisely: "None of the collaborative organisations you are a developer in owns any catalog items.”)
Being a developer in a collaborative organisation means that you can create a new catalog item for that collaborative organisation.
Click on the "+" symbol in the upper right corner of the page:
Clicking the "+" starts the "Add catalog item" wizard:
Step 1: Select and order components
This is where you can compose the catalog item.
Below, all available components are shown. You can select the components that will compose your catalog item.
When a workspace for this catalog item is started, the components will be run in the order you specify here. You can arrange the order by drag and drop.
When the list is ready, click the “Continue” button to attach the list to the catalog item.
In order to get started just inspect the component lists of other catalog items and take over the first few components in your own catalog item. This will give you a solid base to build the catalog item that you need.
Whenever you use one or more components that are not a "SRC-" component, make sure that you list the "SRC-External" component before any non-SRC component is listed. This makes sure that these non-SURF components get executed.
Step 2: Name and describe your catalog item
Name, subtitle, description
In this step, give a clear and descriptive name and subtitle to your catalog item. The description is a good place for the technical prerequisites and other details about the catalog item (for others and for yourself).
Uploading an image for an icon helps to identify and find your catalog item. You can provide a variety of image formats, max. 100KB, displayed with 40 or 32px.
Step 3: Define owner and support
Catalog item owner collaborative organisation
You can choose from the collaborations that you are a developer in (see also Appoint a CO-member an admin).
Choose the collaboration that will use the catalog item to be its "home-collaboration".
Specify where users and developer-colleagues can find information and support.
The name of a person (or a team) that can help.
Support e-mail address
An e-mail address to send questions and requests to.
Step 4: Choose organisations that can use the catalog item
Choose whether your catalog item should be available for anyone on Research Cloud or just for members of particular collaborations.
Step 5: Select cloud provider(s) and settings
On this step, you can choose cloud providers that can be used to run your catalog item. Click on the "+" symbol next to the “Cloud providers” choose relevant could providers from the drop-down menu.
Then select which operating systems and sizes of RAM or GPU are compatible with your catalog item.
Note, that you can add more than one cloud provider to your catalog item.
Step 6: Choose parameter settings
The use of parameters is explained on an extra page: Using parameters.
On this step you can change overwritable parameters by choosing an action from the drop-down menu on the left.
You do not necessarily need parameters when creating a basic catalog item.
Step 7: Choose workspace settings
On this step you can fill in the properties of your new catalog item:
Boot disk size: size of a disk to which OS will be installed.
Workspace access button behaviour: this field specifies how a workspace with this catalog item can be accessed. A typical choice for a "headless" Linux server catalog item could be "Command line login (ssh:)". A workspace with a desktop could be accessed with "Remote Desktop Protocol (rdp:)". A catalog item with a builtin Nginx server like Jupyter or RStudio typically has a "Webinterface (https:)" access.
Access rules (open ports): in this block you can configure access to and from your catalog item and add extra ports if needed.
To open an extra port, click on the "+" symbol next to "Access rules (open ports)":
In the panel that opens, you can specify the following details about a port that you would like to open:
- From port number: start of the port range that will accept packets.
- To port number: end port of the port range that will accept packets. In order to define 1 port choose the same "From port" and "To port".
- IP address(es): Define 1 address or an address range in CIDR format.
- Traffic direction: Select direction "In" or "Out"
- Network protocol: Select TCP (Transmission Control Protocol) or UDP (User Datagram Protocol).
When port details are filled in, press "SAVE".
Click on "Submit" to save the new catalog item. Make sure that it now appears in the total list of catalog items and that you can see an "Edit" and a "Delete" icon for it.
You can change all the properties of the catalog item, later on. Just click on its “Actions” icon and select “Edit” in the list.