Saagie apps

Use these tutorials to install, modify, stop, and run a Saagie app.

Apps—​designed for data teams in test and exploration phases—​are in an experimental stage and are not production-ready. Lab icon

1. Install a Saagie app

Together, let’s install a Jupyter Notebook from the Saagie Technology Catalog.

Let’s assume that:

  • you’ve completed the tutorial Create a Saagie project where you created the project Dunder Mifflin Paper Sales, and

  • you have rights to install an app.

1.1. Navigate to project and begin installing app

Start by navigating to the example project.

  1. Go to the Projects module from the primary navigation menu.

  2. Go to the Dunder Mifflin Paper Sales project.

    Navigate to your project
  3. Go to the Apps homepage from the secondary navigation menu.

  4. Select the New app button.

    Verify location and start creating new app

1.2. Choose app repository and technology

A page will open where you will choose which app to install and from which repository.

  1. Locate the correct repository.

    In this image, we use the repository Dunder Mifflin - URL. You might use the default Saagie repository or a custom repository.
  2. Select anywhere on the Jupyter Notebook card to start installing.

Choose repository and technology for app install

1.3. Enter app name and description

  1. Enter the name of your app: Scranton

  2. Enter a description of your app: Scranton Branch data

  3. Select the Continue button.

Enter name and description for app

1.4. Configure app

Now let’s configure your authentication and authorization and persistent storage.

1.4.1. Choose authentication type

For the purposes of this tutorial, let’s say that you need to access your app using a non-Saagie API:

  1. Change the authentication and authorization setting to public.

  2. Review the text about the public setting.

    Apps provide direct access to your data. When choosing public, make sure that your app requires its own authentication.
Choose authentication type

1.4.2. Determine persistent storage size

Persistent storage cannot be upgraded later. If you need more persistent storage after installing the app, you’ll have to install a new app.
  1. Increase the persistent storage to 100.0 MB.

  2. Review the text about apps.

  3. Select the Continue button.

Determine persistent storage size

1.5. App settings

Finally, let’s choose the settings for this app.

  1. Enable email alerts for when the pipeline status changes to down.

  2. Add this release note to your pipeline: Created Scranton notebook with 100.0 MB of persistent storage.

  3. Select Auto run app after creation so that your app will run on its own.

  4. Select the Save button.

App settings

Your app is ready to go!

2. Stop and run an app

Now that you’ve installed and modified an app on the Saagie platform, let’s stop and restart it.

Let’s assume that:

  • you’ve completed the tutorial Install a Saagie app where you installed the Jupyter Notebook Scranton, and

  • your app is Up.

2.1. Navigate to app details

  1. Go to the Projects module from the primary navigation menu.

  2. Go to the Dunder Mifflin Paper Sales project.

    Navigate to your project
  3. Go to the Apps homepage from the secondary navigation menu.

  4. Select the Scranton card to navigate to the app’s details.

    Navigate to app details

2.2. Stop the app

Apps are designed to stay up and running. For the purposes of this tutorial, let’s manually stop your app.

  1. Select the Stop button located near the bottom of the side navigation menu.

    You can stop and run an app from all pages concerning that app: overview, instances, and versions.
  2. After about a minute, refresh your page.

    • Notice that the Stop button became a Run button.

    • The Up badge above the Run button becomes a Stopped badge.

      Changes once an app is stopped
Stop an app

Did you notice the changes to the secondary navigation panel after selecting Stop?

  • The status area changes as the app stops.

  • The Stop button becomes a progress indicator.

    App stop in progress

2.3. Run the app

  1. To restart the app, select the Run button.

  2. The status area changes as the app starts running.

  3. The Run button becomes a Stop button again.

  4. After about a minute, refresh your page.

  5. You’ll see an Up badge above the Stop button.

3. Modify an app

Together, let’s modify the Jupyter Notebook Scranton in the project Dunder Mifflin Paper Sales. We’ll also review how to add content to your app.

Let’s assume that:

  • you’ve completed the tutorial Install a Saagie app where you created the Jupyter Notebook Scranton,

  • you’re logged in, and

  • you’re on a platform where you have rights to modify an app.

3.1. Navigate to app details

  1. Go to the Projects module from the primary navigation menu.

  2. Go to the Dunder Mifflin Paper Sales project.

    Navigate to your project
  3. Go to the Apps homepage from the secondary navigation menu.

  4. Select the Scranton card to navigate to the app’s details.

    Navigate to app details

3.2. Go to settings

  1. Notice the section on the app’s overview page displaying the current settings, specifically the name, description, and alerts. We will modify some of this information.

  2. Go to App settings.

    You can access an app’s settings from all pages concerning that app: overview, instances, and versions.
Navigate to app settings

3.3. Change name and description

We won’t actually change the name or description of the app, but note that you can change either of these at any time.

Leave app name and description

3.4. Change email alerts

Alerts are already enabled for this app. Let’s add an alert when this app stops running.

  1. Select the Stopped checkbox.

  2. Select the Save button.

Modify email alerts

Notice that you can view information about your app’s persistent storage in app settings, but it cannot be modified.

View but cannot modify persistent storage

3.5. Manage app content

Let’s review how to open the actual app so that you can add and manage content.

  1. Return to the Apps homepage from the secondary navigation menu.

  2. Select Open Notebook underneath the Scranton card.

    The text Open Notebook will change based on the type of app.
    Open app in new window
  3. Your app will open in a new window, where you’ll be able to manage its contents.

We won’t dive in adding or managing actual content in this tutorial, but you might find some of our how-to guides helpful.

4. Upgrade app

Let’s upgrade the app Scranton in the project Dunder Mifflin Paper Sales.

Let’s assume that:

  • you’ve completed the tutorial Create a Saagie project where you created the project Dunder Mifflin Paper Sales, and

  • you’ve completed the tutorial Create a Saagie app where you created the Jupyter Notebook Scranton.

4.1. Navigate to app details

  1. Go to the Projects module from the primary navigation menu.

  2. Go to the Dunder Mifflin Paper Sales project.

    Navigate to your project
  3. Go to the Apps homepage from the secondary navigation menu.

  4. Select the Scranton card to navigate to the app’s details.

    Navigate to app details

4.2. Begin app upgrade

  1. Notice some of the information displayed about this app version, specifically the authentication type and this version’s release note. Some of this information will change with the app upgrade, which will pass this app from version 1 to version 2.

  2. Select the Upgrade app button.

    You can upgrade an app from all pages concerning that app: overview, instances, and versions.
Upgrade app

4.3. Select pipeline upgrades

Authentication is the only customizable upgrade for apps. It turns out that you need to restrict access to your app by changing the app authentication from public to project.

  1. Change the authentication and authorization setting to project.

  2. Review the text about the project setting.

  3. Select the Continue button.

Change authentication type

4.4. Add a new release note

Finally, let’s add a release note to describe what changed with this upgrade.

  1. Select the Add a release note for this pipeline version checkbox.

  2. Enter the release note text: Change authentication and authorization from public to project.

  3. Select Restart app with new version after upgrade so that your app will run the upgraded version after saving the upgrade.

  4. Select the Save button.

Add release note to app upgrade

Your upgraded app is ready to run. Nice!