Managing Your Apps
Installing Apps
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). |
-
Click
Projects from the primary navigation menu.
Your project library opens, listing the existing projects. -
Click a project in the list.
The project opens on its job library. -
Click
Apps from the secondary navigation menu to open the project’s app library.
-
Click New app to install a new app.
The Install App from Catalog page opens. -
You can choose between:
-
Locate the correct repository.
It can be the official Saagie repository or a custom repository. -
OPTIONAL: Select a context from the list if the app has several available.
-
OPTIONAL: Some apps require additional configuration to work. Click Read me
to display and read the README help file directly in Saagie before installing your app.
-
Click Install on the app’s card to install it.
The
Overview page of your app opens, and a message appears saying that your app has been created.
Your app is ready to go!
-
Click Create custom app.
The New custom app page opens.
-
Enter a name and add a description.
-
Click Continue.
-
Specify the Docker image URL of your app.
Click the switch to add Docker credentials. -
Click Continue.
-
Define the HTTP Ports to use for the app.
Only the HTTP protocol is allowed. -
Click Continue.
-
Add an existing storage location or create a new one.
You cannot change the storage size once created. -
Click Continue
-
Configure resources, email alerts, and add a release note. For more information, see App Settings.
The
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:
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
-
Click
Projects from the primary navigation menu.
Your project library opens, listing the existing projects. -
Click a project in the list.
The project opens on its job library. -
Click
Apps from the secondary navigation menu to open the project’s app library.
-
Click the app card, that you created earlier, to access its details.
The appOverview page opens.
-
To stop your app, click Stop
.
Your app is no longer running. The Stop button became a Run button and theStarted
badge became aStopped
badge. -
To restart your app, click Run
.
Similarly, as in the previous step, the Run button became a Stop button and theStopped
badge became aStarted
badge again.You can also access this command at the bottom of the secondary navigation menu from the Overview,
History,
Versions, and
Storage page.
-
Click the
History page of your app to view the changes that have been made.
Modifying App Settings
-
Click
Projects from the primary navigation menu.
Your project library opens, listing the existing projects. -
Click a project in the list.
The project opens on its job library. -
Click
Apps from the secondary navigation menu to open the project’s app library.
-
Click the app card, that you created earlier, to access its details.
The appOverview page opens.
-
From the
Overview page, click the desired setting to edit it:
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 Starting
The app’s run has been requested and is being executed.
Started
The app is up and running.
Rolling back
The app is rolling back to a requested version.
Upgrading
The application has been updated and is upgrading.
Recovering
The app has restarted itself and is doing so.
Restarting
The app is restarting.
Stopping
The app is stopping.
Stopped
The app has stopped running.
Failed
The app has crashed.
A failed app can go into an Out Of Memory
(OOM) state, which is an extension of theFailed
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 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).
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).
Modifying CPU and RAM resources automatically restarts your app. -
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
-
Click
Projects from the primary navigation menu.
Your project library opens, listing the existing projects. -
Click a project in the list.
The project opens on its job library. -
Click
Apps from the secondary navigation menu to open the project’s app library.
-
Click the app card, that you created earlier, to access its details.
The appOverview page opens.
-
From the
History,
Versions, or
Storage page, click Upgrade app
.
You can also click Edit from the
Overview page.
The Upgrade app page opens.
-
Depending on whether it is an app from the Saagie catalog or a custom app, you can:
-
Modify the context of the app. Select the desired context from the list.
We recommend you to upgrade your app with the Recommended context. -
Modify the access settings for the HTTP ports used for the app.
-
Manage app storage spaces. You can delete, add, and create storage locations.
-
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.
-
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 updatedOverview page of your app, which restarts automatically.
-
Modify the Docker information of your app.
-
Manage the access settings for the HTTP ports used for the app. You can delete, add, and create HTTP ports.
-
Manage app storage spaces. You can delete, add, and create storage locations.
-
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.
-
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 updatedOverview page of your app, which restarts automatically.
-
Your upgraded app is ready to go!