About Apps

The The "Apps" page icon is a PC screen with a star in the middle. Apps page lets you access the app library of a project.

What is an app?

An app is a Docker image that can be mounted inside projects using one of the integrated technologies. Persistent storage spaces can be assigned to an app to keep data in a defined volume path when the app is stopped.

Apps are displayed as cards. They show some basic information, such as the name (a), current status (b), and technology (c) of the app.

Focused screenshot of an app card.
  • The apps available in a project are specified in the project settings. If the app you need does not appear in the list, choose another app or modify the project settings.

  • The Saagie catalog provides default apps, which can be found in the official Saagie repository. Custom apps can also be added and managed using our Software Development Kit (SDK).

  • Click in the app name area (d) to access its:

  • Click Open [Name of the Port] The icon for external technologies is a square with an arrow pointing to the upper right corner. (e) to open the app interface.

    If your app is not running, then the button becomes a The "Run app" icon is a play. Run app button. Click it to start the app.

Overview Page

The The "Overview" page icon is a square divided into several other squares. Overview page provides general information on your app.

By default, the page opens when you click the app name of the desired card in the project’s app library.

Screenshot of the "Overview" page of an app.

The first part of the page (1) gives general information on the app, such as the last instance details, version used, name, description, and other app settings.

The second part of the page (2) gives information on app runtime and consumption through a timeline and various graphs. You can use the timeline to see your app’s up and down times and the graphs to check your app consumption.

monitoring graph consumption app
  • Hover over the legend to see on which node the app has been executed.

  • Select a range on the graph to zoom in on the selection. Click close Reset range to display all details again.

Monitoring the RAM consumption of your app can help you anticipate potential memory issues. Indeed, an app that consumes more than the available RAM limit goes into an out of memory Out Of Memory (OOM) state.

You can define a RAM limit for your app in its settings. If you have not defined a RAM limit, the app will run according to the overall RAM capacity of the node. In both cases, adjust the RAM limit for your node or app to ensure successful execution.

For more information on monitoring your platform resources, see About the Monitoring Module.

The third part of the page (3) gives information on the app logs. You can choose to view and download All logs, Only standard logs or Only error logs.

app overview logs display

The fourth part of the page (4) gives information on the exposed ports, persistent storage spaces, and the technology used.

History Page

The The "History" page icon is a counterclockwise arrow. History page gives information about the change history of your app, so you can keep track of the changes that have been made.

Screenshot of the "History" page of an app.

The first part of the page (1) gives general information on the app, such as its current status, creation date, version, release note, and runtime details.

The second part of the page (2) gives a timeline of the app activities. You can see the different stages your app has gone through and who initiated actions, such as launching, stopping, or upgrading the app. You can also view and download the logs for each step by clicking See logs (3). A pop-up window opens to display the logs for the selected action. You can then choose to display All logs, Only standard logs or Only error logs.

Versions Page

The The "Versions" page icon is a folder with an arrow pointing up. Versions page gives information on the version of your app. It also keeps track of all previous versions.

What is a version?

A version is a single iteration of a job, pipeline, or app. Each new upgrade is stored as a version, so you can roll back to previous iterations and keep track of the changes that have been made.

Each time you upgrade an app (1), you create a new version of it. This version is automatically defined as the Current Badge for the "Current" status version.

All versions are saved and remain accessible. They are listed on the right side of the page (2), and you can see the information of a version by selecting it in the list.

You can switch back and forth between versions by selecting a version from the list and clicking Rollback to this version (3). The selected version then becomes the new Current Badge for the "Current" status version.

You can define a version as major to highlight the most stable app version. Select a version from the list and click Set as major version (4). The version appears with the Major version label and sparks in front of its line. Click Unset as a major version to remove the label from a version.

By default, the page opens on the version of the app in use, tagged with the Current Badge for the "Current" status badge.

Screenshot of the "Versions" page of an app.

The first part of the page (5) gives general information about the version, such as the release note, creation date, and creator. It also gives information on the execution context if it is an app from the Saagie catalog, or on the Docker image if it is a custom app.

The second part of the page (6) gives information on exposed ports and persistent storage spaces, if one is attached to the app.

Storage Page

The The "Storage" page icon is a database. Storage page gives information on the storage space(s) allocated to your app. It allows you to manage storage spaces independently of the app.

What is a storage space?

A storage space is persistent. It can be assigned to an app to keep data in a defined volume path.

When installing an app from the Saagie catalog, a storage space is created and attached by default to the app.
When installing a custom app, a storage space is allocated to the app during the installation steps. You can choose to attach existing storage spaces to your app, or you can create it on the fly.

Screenshot of the "Storage" page of an app.
Figure 1. The storage spaces linked to the selected app are listed in its The "Storage" page icon is a database. Storage page.

Storage spaces can be edited, unlinked, duplicated, moved, and deleted by clicking the kebab menu The kebab menu icon  is three vertical dots. (1). Note that you cannot unlink, move, or delete a storage space attached to a version of an app that is in use and tagged as Current Badge for the "Current" status.

New storage spaces can be allocated by upgrading your app (2), which will create a new version of the app linked to the added storage space. You can also allocate a new storage space by creating it from the project The "Storage" page icon is a database. Storage page. This page allows you to access and manage all storage spaces of the project.

If you want to roll back to a version of an app that was using an unlinked, moved, or deleted storage space, you will have to reattach it to a storage space. To do this, click the desired app version from its The "Versions" page icon is a folder with an arrow pointing up. Versions page and follow the instructions provided by Saagie.