Managing Apps

Use these tutorials to install, run, modify, and upgrade your apps.

Installing Apps

You can either install existing apps from the Saagie catalog or create custom ones.

Apps of the Saagie catalog can be found in the official Saagie repository. Custom apps, however, are not located in a repository. They are based on a Docker image. You can add and manage custom apps using our Software Development Kit (SDK).

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    By default, the The "All Projects" page icon is a folder and the same as the "Projects" module. All Projects page opens with the list of existing projects.

  2. Click a project in the list to open it.
    By default, the The "Jobs" page icon is a 3D pyramid of three squares. Jobs page opens with the list of existing jobs.

    Navigate to your project

  3. Click The "Apps" page icon is a PC screen with a star in the middle. Apps from the secondary navigation menu to open the project’s app library.

  4. Click Install an app to install a new app.
    The Install an app from the catalog page opens.

    Create a new app

  5. You can choose between:

    • Installing an app from the Saagie catalog

    • Creating a custom app

    1. Locate the correct repository.

    2. OPTIONAL: Select a context from the list if the app has several available.

    3. OPTIONAL: Some apps require additional configuration to work. Click Read me info circle to display and read the README help file directly in Saagie before installing your app. It will also be available afterwards on the The "Environment variables" module icon is a rectangle with the "VAR" written in it. Environment Variables page of the app.

    4. Click Install on the app card to install it.

      Choose the repository and technology for the app installation

      Your app’s The "Overview" page icon is a square divided into several other squares. Overview page opens, and a message appears telling you that your app has been created.

    Your app is ready to go!

    1. Click Create custom app.

      Click "Create custom app" in the upper right corner of the application screen

      The New custom app page opens.

    2. Enter a name and add a description.

    3. Click Continue.

    4. Specify the Docker image URL of your app.

      Click the switch to add Docker credentials.

    5. Click Continue.

    6. Define the HTTP Ports to use for the app.

      Only the HTTP protocol is allowed.

    7. Click Continue.

    8. Add an existing storage space or create a new one. For more information, see the Storage Spaces section.

    9. Click Continue

    10. Configure settings to set your app resources, and send email alerts. You can also add a release note.

      Your app’s The "Overview" page icon is a square divided into several other squares. Overview page opens, and a message appears telling you that your app has been created.

    Your custom app is ready to go!

Deleting an App

  1. To delete an app, you can either:

    • Click the kebab menu The kebab menu icon is three vertical dots.  delete Delete from the The "Overview" page icon is a square divided into several other squares. Overview page of the corresponding app.

    • Click delete Delete app at the bottom of the secondary navigation menu from any other page of the corresponding app.

    A pop-up window opens. It asks you to manually enter a confirmation message.

  2. Type in the requested message for confirmation. The message is case sensitive.

  3. Click Delete to confirm the deletion.

    app delete confirmation message

Running and Stopping Apps

Apps are designed to stay up and running, but you always have the option to do it manually. For the purpose of this tutorial, let’s manually stop and restart your app.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    By default, the The "All Projects" page icon is a folder and the same as the "Projects" module. All Projects page opens with the list of existing projects.

  2. Click a project in the list to open it.
    By default, the The "Jobs" page icon is a 3D pyramid of three squares. Jobs page opens with the list of existing jobs.

    Navigate to your project

  3. Click project apps Apps from the secondary navigation menu to open the project’s app library.

  4. Click an app card in the list to access its details.
    The app The "Overview" page icon is a square divided into several other squares. Overview page opens.

  5. To stop your app, click Stop Stop from the The "Overview" page icon is a square divided into several other squares. Overview page.
    Your app is no longer running. The Stop button became a Run button and the Started badge became a Stopped badge.

  6. To restart your app, click Run Run from the The "Overview" page icon is a square divided into several other squares. Overview page.
    Similarly, as in the previous step, the Run button became a Stop button and the Stopped badge became a Started badge again.

    You can also access this command at the bottom of the secondary navigation menu from the The "History" page icon is a counterclockwise arrow. History, The "Versions" page icon is a folder with an arrow pointing up. Versions, and The "Storage" page icon is a database. Storage page.

  7. Click the The "History" page icon is a counterclockwise arrow. History page of your app to view the changes that have been made.

Modifying App Settings

After its creation, you can always modify your app settings. You can access the settings from your app’s The "Overview" page icon is a square divided into several other squares. Overview page.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    By default, the The "All Projects" page icon is a folder and the same as the "Projects" module. All Projects page opens with the list of existing projects.

  2. Click a project in the list to open it.
    By default, the The "Jobs" page icon is a 3D pyramid of three squares. Jobs page opens with the list of existing jobs.

    Navigate to your project

  3. Click project apps Apps from the secondary navigation menu to open the project’s app library.

  4. Click an app card in the list to access its details.
    The app The "Overview" page icon is a square divided into several other squares. Overview page opens.

  5. Click the desired setting from the The "Overview" page icon is a square divided into several other squares. Overview page to edit it:

    Job settings from the "Overview" page.

    • 1 – Name

    • 2 – Description

    • 3 – Email Alerts

    • 4 – Resources

    Names are mandatory. They can be up to 255 characters long and must be unique within a project.

    Descriptions are optional and not restricted. However, it is a good practice to add them. Keep them short and to the point.

    Click the switch in the side panel of the setting to enable or disable it.

    Alerts are optional and can be set to receive an email when the status of your app changes. They can be sent to multiple email addresses to notify you of the following status changes:

    Status Description

    circle Starting

    The app’s run has been requested and is being executed.

    circle Started

    The app is up and running.

    history Rolling back

    The app is rolling back to a requested version.

    arrow up Upgrading

    The application has been updated and is upgrading.

    ambulance Recovering

    The app has restarted itself and is doing so.

    circle Restarting

    The app is restarting.

    stop Stopping

    The app is stopping.

    stop Stopped

    The app has stopped running.

    fail Failed

    The app has crashed.

    A failed app can go into an out of memory Out Of Memory (OOM) state, which is an extension of the Failed state. The OOM state can be due to a lack of memory (RAM).
    Click the switch in the side panel of the setting to enable or disable it.

    The consumption of your app can be managed by guaranteed resources, that is, the minimum amount of resource requested, and limited resources, that is, the maximum amount of resource that can be consumed.

    When you create your app, CPU and RAM resource management is enabled by default with predefined values. In other words, based on the default values defined at technology level, Saagie automatically assigns resource requests and limits to your app. These values can be adjusted to suit your needs.

    Default values are already set by Saagie at the technology level. These values are mandatory. They also exist at the technology context level, where they can override the values defined at the technology level. You can configure them when you create your app, or by modifying the Resources Icon for CPU and RAM resources. setting of the app.

    If the resource capacity is not defined, the defaults that are defined at the technology level will be assigned at the technology context level.

    Automatic adjustments can be made to avoid inconsistent configurations. If you try to set a guaranteed value that is greater than the limit value, a note appears to inform you that the guaranteed value has been adjusted. If you try to set a limit value smaller than the guaranteed value, a note appears to inform you that the limit value has been adjusted (a).

    RAM limit adjustment message.

    In addition, if the guaranteed value and the limit value are not optimal, a message is displayed with the appropriate values for an optimal configuration (b).

    CPU recommendation message.

  6. Saving is automatic. You can just press Enter to validate the app name change, click anywhere nearby to confirm the description change, and close de side panel to validate the email alert, and resource changes.

Upgrading Apps

You can upgrade your apps to always get the most out of them. By upgrading your app, you create a new version of it.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    By default, the The "All Projects" page icon is a folder and the same as the "Projects" module. All Projects page opens with the list of existing projects.

  2. Click a project in the list to open it.
    By default, the The "Jobs" page icon is a 3D pyramid of three squares. Jobs page opens with the list of existing jobs.

    Navigate to your project

  3. Click project apps Apps from the secondary navigation menu to open the project’s app library.

  4. Click an app card in the list to access its details.
    The app The "Overview" page icon is a square divided into several other squares. Overview page opens.

  5. Click edit Edit from the The "Overview" page icon is a square divided into several other squares. Overview page.
    The Upgrade app page opens.

  6. Depending on whether it is an app from the Saagie catalog or a custom app, you can:

    • For apps from the Saagie catalog

    • For custom apps

    1. Modify the context of the app. Select the desired context from the list.

      We recommend you to upgrade your app with a context that is indicated as Stable STABLE and Recommended RECOMMENDED.

    2. Modify the access settings for the HTTP ports used for the app.

    3. Manage the storage spaces of the app. You can delete, add, and create storage spaces. For more information, see Managing Storage Spaces.

    4. Add a release note describing the changes you have made. Select the Add a release note for this app version option and write a few sentences that will be displayed on the app The "Overview" page icon is a square divided into several other squares. Overview page.

    1. Modify the Docker information of your app.

    2. Manage the access settings for the HTTP ports used for the app. You can delete, add, and create HTTP ports.

    3. Manage the storage spaces of the app. You can delete, add, and create storage spaces. For more information, see Managing Storage Spaces.

    4. Add a release note describing the changes you have made. Select the Add a release note for this app version option and write a few sentences that will be displayed on the app The "Overview" page icon is a square divided into several other squares. Overview page.

  7. Click Save to save your changes and exit the app upgrade settings.
    A new version of your app has been created. You are returned to the updated The "Overview" page icon is a square divided into several other squares. Overview page of your app, which restarts automatically.

Your upgraded app is ready to go!

See also