About Apps

The The "Apps" page icon is a PC screen with a star in the middle. Apps page of a project selected from the The "Projects" module icon is a folder. Projects module library gives you access to this project’s app library.

What is an app?

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

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

Focused screenshot of an app card.

The apps available in a project are specified in your organization’s Technology Catalog.

  • 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 about your app.

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

The first part of the page (1) provides general information about the app, such as the name and description, the last instance status, the start date of the app, the version used, and app settings.

The second part of the page (2) provides details about the runtime, and information about the app consumption through different graphic resources. Use these graphs to check your app consumption during its execution.

  • Hover over the legend to see on which node the job has been executed.

  • Select a range on the graph to zoom in on the selected part of the line. Click close Reset range to display the entire graph again.

graph consumption overview page

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 for your app, it 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) provides information about the logs of the app. You can choose to display All logs, Only standard logs or Only error logs, and you can download them.

app overview logs display

The fourth part of the page (4) provides information about the exposed ports, persistent storage, and the technology used.

Screenshot of the "Overview" page of an app.

History Page

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

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

The second part of the page (2) provides a timeline of the app activities. You can see the different steps your app has gone through and who initiated actions, such as launching, stopping, or upgrading the app.
You can view the logs for each step by clicking See logs (3). A window opens displaying the logs for the selected action. From here you can choose to display All logs, Only standard logs or Only error logs, and you can download them.

Screenshot of the "History" page of an app.

Versions Page

The The "Versions" page icon is a folder with an arrow pointing up. Versions page provides information about the current version of the app, but also keeps track of its previous versions.

What is a version?

A version is a single iteration of a job, pipeline, or app. Each new update is stored as a version, enabling you to roll back to previous iterations and keep track of successive changes.

Whenever you upgrade an app (1), a new version of that app is created and 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). You can view the information of a version by selecting it in the list.
You can switch back and forth between versions as required by selecting a version from the list and clicking Rollback to this version (3). This action of rolling back to another version of the app will make the selected version the new Current Badge for the "Current" status version.

You can also define a version as major to highlight the most stable version of an app.
Select a version from the list and click Set as major version (4) to label the version as Major version. Sparks will appear in front of the major version. Similarly, click Unset as a major version to remove the label from a version.
Screenshot of the "Versions" page of an app.

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

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

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

Storage Page

The The "Storage" page icon is a database. Storage page provides information about the storage allocated to your app allowing you to manage storage independently.

What is a storage?

A storage is persistent and can be allocated to an app to retain data in a defined volume path.

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

Storage can be unlinked or deleted by clicking the kebab menu The kebab menu icon  is three vertical dots. (1). However, you cannot unlink or delete a storage attached to a version of an app that is in use and displays the Current Badge for the "Current" status status.

If you want to roll back to a version of an app that was using an unlinked or deleted storage, you will have to reattach it to a storage. To do this, click the desired version of the app from its Versions page and follow the instructions provided by Saagie.

New storage can be allocated by upgrading your app (2): this will create a new version of the app linked to the added storage.

Screenshot of the "Storage" page of an app.
You can also access and manage all project storage from the Storage page of the project.
See also