Managing Your Apps

Use these tutorials to install, modify, stop, run, 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 and other custom repositories in your Technology Catalog.
Custom apps, however, are not located in a repository: they are based on a Docker image. You can add and managed custom apps according to our Software Development Kit (SDK).

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    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 New app to install a new app.
    The Install App from 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.

      It can be the official Saagie repository or a custom 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.

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

      Choose the repository and technology for the app installation

      The The "Overview" page icon is a square divided into several other squares. Overview page of your app opens, and a message appears saying 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 location or create a new one.

      You cannot change the storage size once created.

    9. Click Continue

    10. Configure resources, email alerts, and add a release note. For more information, see App Settings.

      The The "Overview" page icon is a square divided into several other squares. Overview page of your app opens, and a message appears saying that your app has been created.

    Your custom app is ready to go!

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 in the secondary navigation menu from any other page of your app.

A confirmation message appears; Click Delete again to confirm the deletion. Be careful, there is no progress bar to cancel the deletion once it is confirmed.

Stopping and Running 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.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

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

  4. Click the app card, that you created earlier, 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.
    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.
    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 "Overview" page icon is a square divided into several other squares. Overview, 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 the The "Overview" page icon is a square divided into several other squares. Overview page of the app.

  1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

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

  4. Click the app card, that you created earlier, to access its details.
    The app The "Overview" page icon is a square divided into several other squares. Overview page opens.

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

    Job settings from the "Overview" page.

    • 1 - Name

    • 2 - Description

    • 3 - Email Alerts

    • 4 - Resources

    Names are mandatory, with a maximum of 255 characters, and unique within a project.

    Descriptions are optional and have no restrictions, but it is a good practice to add them and keep them short and informative.

    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.

    CPU and RAM resources are optional but recommended, and can be specified for optimal execution.

    This works the same way for CPU and RAM resources, except that for RAM you can choose between GB and MB units of measure.

    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.

    Default values are already defined by Saagie at the technology level, except for external technologies. These values are mandatory. They also exist at the technology context level, and can override the values defined at the technology level. You can configure them when creating a job or app, or by modifying the Resources Icon for CPU and RAM resources. setting of your job or app.

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

    If no resource capacity is defined, the default values defined at the technology level are assigned at the technology context level.

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

    RAM limit adjustment message.

    Besides, when the guaranteed value and the limit value are not optimal, a recommendation notification appears with the appropriate values for an optimal configuration (b).

    CPU recommendation message.

    Modifying CPU and RAM resources automatically restarts your app.

  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.
    Your project library opens, listing the existing projects.

  2. Click a project in the list.
    The project opens on its job library.

    Navigate to your project

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

  4. Click the app card, that you created earlier, to access its details.
    The app The "Overview" page icon is a square divided into several other squares. Overview page opens.

  5. From the The "History" page icon is a counterclockwise arrow. History, The "Versions" page icon is a folder with an arrow pointing up. Versions, or The "Storage" page icon is a database. Storage page, click Upgrade app Upgrade app button.

    You can also 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 the Recommended context.

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

    3. Manage app storage spaces. You can delete, add, and create storage locations.

    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’s overview page.

    5. 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.

    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 app storage spaces. You can delete, add, and create storage locations.

    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’s overview page.

    5. 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!