Managing Apps and Service Instances Using Apps Manager

Page last updated:

This topic explains how to view and manage apps and service instances with Apps Manager.

Overview

You can use Apps Manager to manage apps, service instances, service keys, and route services. This includes tasks such as scaling apps, binding apps to services, generating services keys, and more.

For information about managing orgs and spaces, see Managing Orgs and Spaces Using Apps Manager.

You can manage apps and service instances across multiple foundations. For more information, see Configuring Multi-Foundation Support in Apps Manager.

Prerequisite

To view and manage apps and service instances with Apps Manager, you must log in to Apps Manager with an account that has adequate permissions.

For more information, see About Permissions.

Manage an App

This section describes how to manage an app in Apps Manager.

You can do the following tasks to manage apps in Apps Manager:

  • View app summary information
  • Start and stop apps
  • Scale apps
  • Bind apps to services
  • Manage environment variables and routes
  • View logs and usage information
  • Enable and view app revisions
  • Re-deploy app revisions
  • Delete apps
  • Terminate specific instances of apps

View App Overview

The Overview page for an app includes information about app processes and instances, app memory and disk space, and app events.

To navigate to an app Overview page, do one of the following:

  • On the space page, click the app you want to manage.
  • Search for an app by entering its name in the search bar.

The following image shows an example of an app Overview page.

The example Apps Manager dashboard shows at the top heading the name of the example app, 'cf-nodejs', with a stop and refresh button to the right. A green status icon says 'Running'. Below shows a horizontal series of tabs with the 'Overview' tab selected. Below, the 'Overview' pane shows an 'Events' section, 'App Summary' section, and 'Processes and Instances' section.

Start, Stop, or Restage an App

You can start, stop, and restage from the Overview page of the app. The start, stop, and restage buttons are located on the app Overview page next to the name of the app.

The following image shows the location of the start, stop, and restage buttons.

The app name is shown to the left as a header 2 called 'app-0001-0000'.
              To the right of the app name is three buttons: one with a 'stop' icon, another with a 'restart' icon, and the last with
              a 'restage' icon.

For more information about starting, stopping, and restaging apps with the Cloud Foundry Command Line Interface (cf CLI), see Starting, Restarting, and Restaging Applications.

Scale an App

From the app Overview page, you can scale an app manually or configure App Autoscaler to scale it automatically.

Scale an App Manually

To manually scale an app, do the following:

  1. Navigate to the app Overview page.

  2. Under Processes and Instances, click Scale to open the Scale app dialog. In the 'Processes and Instances' section of the 'Overview' pane, find the 'Scale' button to the right of each process.

  3. Edit the number of Instances, the Memory Limit, and the Disk Limit as desired.

  4. Click Apply Changes.

Enable App Autoscaler

You can enable App Autoscaler to automatically scale your apps. For information about how to configure App Autoscaler to scale an app automatically, see the Configure Autoscaling for an App section of the Scaling an Application Using Autoscaler topic.

To enable App Autoscaler for an app, do the following:

  1. Navigate to the app Overview page.

  2. Under Processes and Instances, click Enable Autoscaling to enable App Autoscaler. In the 'Processes and Instances' section of the 'Overview' pane, find 'Enable Autoscaling' two rows below the title of each process.

  3. Click Manage Autoscaling to open App Autoscaler.

Bind or Unbind Services

You can bind your app to new or existing service instances. You can also unbind your app from service instances.

Bind an App to an Existing Service

Note: For services that use asynchronous bindings, Apps Manager displays the status of the service while the bind is still pending. Asynchronous bindings provide more flexibility for services that require additional time before returning a successful bind response.

To bind your app to an existing service, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Services.

  3. Click Bind Service.

  4. For Service to Bind, select the service instance from the dropdown.

  5. (Optional) For Binding Name, enter a binding name in all lowercase letters. For example, bind-usr-serv.

  6. (Optional) For Add Parameters, specify additional parameters.

  7. Click Bind.

Bind an App to a New Service

To bind your app to a new service instance, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Services.

  3. Click New Service.
    .

    Note: If you prefer to create the new service instance in the Marketplace, you can click View in Marketplace at any time.

  4. Click the service.

  5. Select a plan and click Select Plan.

  6. Under Instance Name, enter a name for the instance.

  7. (Optional) For Binding Name, enter a binding name in all lowercase letters. For example, bind-usr-serv.

  8. (Optional) For Add Parameters, specify additional parameters. For a list of supported configuration parameters, consult the documentation for the service.

  9. Click Create.

Unbind a Service

To unbind your app from a service instance, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Services.

  3. Locate the service instance in the Bound Services list.

  4. Click the three-dot icon on the far right.

  5. Select Unbind from the dropdown menu.

Map or Unmap Routes

The Routes page displays the routes associated with your app. You can use this page to map and unmap routes for your app.

Map Routes

To map routes to your app, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Networking, click Routes.

  3. To add a new route, click Map a Route.

  4. Enter the route and click Map.

Unmap Routes

To unmap a route from your app, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Networking, click Routes.

  3. Locate the route from the list and click the x.

  4. Click Unmap in the pop-up to confirm.

Create Container-to-Container Networking Policies

Container networking policies enable app instances to communicate with each other directly. You can create container networking policies in the Networking tab.

For more information about container-to-container networking in Pivotal Platform, see Container-to-Container Networking.

Note: To view and use the Networking tab, you must have either the network.write or network.admin UAA scope. If you do not see the Networking tab, request one of the above scopes from your Pivotal Platform administrator.

To create container-to-container networking policies, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Networking, click Container Networking. The page displays any container networking policies associated with the app.

  3. To add a new network policy, click Create Policy or Add a network policy. The Add Policy form shows dropdown menus for org, space, app, radio buttons for protocol, and a text field for ports. It includes a cancel and save button.

  4. In the Add Policy window, configure the following:

    • For Org, select the org of the destination app.
    • For Space, select the space of the destination app.
    • For App, select the destination app.
    • For Protocol, select TCP or UDP.
    • For Ports, enter the ports at which to connect to the destination app. The allowed range is from 1 to 65535. You can specify a single port, such as 8080, or a range of ports, such as 8080-8090.
  5. Click Save.

Manage App Revisions

A revision represents code and configuration used by an app at a specific time. It is a Cloud Foundry API (CAPI) object that can contain references to a droplet, custom start command, and environment variables. The most recent revision for a running app represents code and configuration currently running in Pivotal Platform.

You can enable revisions, view revisions, list environment variables associated with revisions, and re-deploy previous revisions in the Revisions tab.

For more information about app revisions in Pivotal Platform, see App Revisions.

Enable App Revisions

To enable app revisions:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Revisions.

  3. Click Enable Revisions.

View App Revisions

To list revisions for an app:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Revisions.

  3. View app revisions in the Revisions table.

List Environment Variables for an App Revision

To list environment variables associated with an app revision:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Revisions.

  3. In the Revisions table, select the row that contains the revision. The row expands to reveal metadata and environment variables associated with the revision.

Roll Back to a Previous App Revision

To roll back an app to a previous revision:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Revisions.

  3. In the Revisions table, select the row that contains the revision you want to roll back to. The row expands to reveal metadata.

  4. Click Redeploy.

View Logs

You can view logs for an app in Apps Manager. You can also use Apps Manager to view a live stream of app logs.

To view logs for an app, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Observability, click Logs.

  3. Click the play button to view a live version of the logs.

Manage Tasks

The Tasks page includes jobs and tasks associated with an app. It displays a table containing Task ID, State, Start Time, Task Name, and Command.

From the Tasks page, you can view tasks, run tasks, and enable task scheduling.

View Tasks

You can view tasks for an app on the Tasks page in Apps Manager.

To access the Tasks page, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Tasks.

Run a Task

To run a task for an app, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Tasks.

  3. Click Run Task to create a task.

  4. (Optional) Enter a Task Name.

  5. Enter the Task Command.

  6. Select a Memory Limit and a Disk Limit for the task.

  7. Click Run.

Enable Task Scheduling

In the Tasks tab, click Enable Scheduling to bind the Pivotal Platform Scheduler service to your app. For more about the Pivotal Platform Scheduler, see Scheduling Jobs.

The Apps Manager interface shows the Task tab enabled with a box beneath that says "The Scheduler Service has not been enabled yet." with an "Enable Scheduling" button beneath

Schedule a Task

To schedule a task, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Tasks.

  3. Click Create Job to schedule a task.

  4. Enter a Job Name.

  5. Enter a Command.

  6. Enter one or more Cron Expressions for your desired task schedule or schedules. See Schedule a Job for more information on cron expression syntax.

  7. Click Create Job.

View and Manage Settings

To view settings for an app, in the panel on the left side of the screen, under Application, click Settings.

You can do the following from the Settings page:

  • Rename the app.
  • View information about the buildpack(s), start command, and stack.
  • Configure health checks.
  • View or add Environment Variables associated with the app.
  • Add metadata to the app.
  • View the Application Security Groups (ASGs) associated with the app.
  • Delete the app. When you click Delete App, you also have the option to delete the app’s routes.

Configure Health Checks

To configure health checks for your app, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Settings.

  3. In the Health Check section, click the Type dropdown and select port, http, or process. Depending on which option you select, additional fields may appear.

  4. For Type, select port, http, or process.

  5. Complete the fields that appear based on your selection.

  6. Click Update.

For more information, see Using Application Health Checks.

View Environment Variables

To view all environment variables for an app, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Settings.

  3. Under User Provided Environment Variables, click Reveal Env Vars.

Add Environment Variables

To add a user-provided environment variable, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Settings.

  3. Click Reveal User Provided Env Vars.

  4. Click Add Environment Variable.

  5. Enter the key and value of the variable. Alternatively, toggle Enter as JSON to enter the variable in JSON.

  6. Click Save.

Note: Changes to environment variables, service bindings, and service unbindings require restarting the app to take effect. You can restart the app from the Apps Manager or with the Cloud Foundry Command Line Interface cf restage command.

Add Metadata

You can add metadata, including labels and annotations, to apps and spaces using Apps Manager.

For more information about adding metadata to objects in PAS, see Using Metadata.

To add labels or annotations to an app using Apps Manager, do the following:

  1. Navigate to the app Overview page.

  2. In the panel on the left side of the screen, under Application, click Settings.

  3. For Labels, provide a name and value pair. Or, select Enter JSON to enter the label in JSON.

  4. For Annotations, provide a name and value pair. Or, select Enter JSON to enter the annotation in JSON.

  5. To add more labels or annotations, click + next to the Labels or Annotations field.

  6. Click Update Metadata.

Manage a Service Instance

This section describes how to manage service instances in Apps Manager.

You can do the following tasks to manage service instances in Apps Manager:

  • Bind or unbind apps
  • Bind or unbind routes
  • View or change your service plan
  • Manage service keys
  • Rename or delete your service instance

Note: For services that use on-demand brokers, the service broker will create, update, or delete the service instance in the background and notify you when it finishes.

View Service Overview

The Overview page for a service instance includes information about bound apps, bound routes, and service key credentials for the service.

To navigate to a service instance Overview page, do the following:

  1. Navigate to the landing page for the space of the service instance.

  2. In the panel on the left side of the screen, under Space, click Services.

  3. On the Services page, click on the name of the service instance.

The following image shows an example of a service instance Overview page.

Bind an App

Note: For services that use asynchronous bindings, Apps Manager displays the status of the service while the bind is still pending. Asynchronous bindings provide more flexibility for services that require additional time before returning a successful bind response.

To bind and app to a service, do the following:

  1. On the service Overview page, click Bind App.

  2. In the Bind App popup, select the app to bind to the service instance.

  3. (Optional) To attach parameters to the binding, click Show Advanced Options. Under Arbitrary Parameters, enter any additional service-specific configuration.

  4. Click Bind.

Unbind an App

To unbind an app from a service instance, do the following:

  1. On the service Overview page, under Bound Apps, click the × to the right of the app name. An Unbind App popup appears.

  2. Click Unbind to confirm.

Share Service Instance

From the service Overview page, you can share your service instance across spaces.

To share a service instance, do the following:

  1. On the service Overview page, click Share Service Instance. The service instance button is
          located in the 'Overview' tab of a service instance. The section is at the
          bottom of the body, next to the text 'Shared with these Spaces'

  2. Select the spaces with which you want to share your service instance. The service instance slideout shows
          checkboxes next to each space and a 'Share' button and 'Cancel' button
          in the bottom right-hand corner.

  3. Click Share.

View or Change Your Service Plan

To view or change your service plan, do the following:

  1. Navigate to the service Overview page.

  2. In the panel on the left side of the screen, under Service, click Plan.

  3. Review your current plan information.

  4. To change your plan, select a new plan from the list and click Select This Plan or Upgrade Your Account.

Note: Not all services support upgrading. If your service does not support upgrading, the service plan page only displays the selected plan.

Rename or Delete Your Service Instance

To rename or delete your service instance, do the following:

  1. Navigate to the service Overview page.

  2. In the panel on the left side of the screen, under Service, click Settings.

  3. Do one of the following:

    • To change the service instance name, enter the new name and click Update.
    • To add configuration parameters to the service instance, enter the parameters in the Name and Value fields and then click Update. Alternatively, enter your configuration parameters using the Enter JSON toggle and then click Update.
    • To delete the service instance, click Delete Service Instance.

Note: The service broker supports creating, updating, and deleting service instances asynchronously. When the service broker completes one of these operations, a status banner appears in Apps Manager.

Update User-Provided Service Instance

You can create a user-provided service instance from the Marketplace. For more information, see the User-Provided Service Instances topic.

To update a user-provided service instance, do the following:

  1. Navigate to the service Overview page.

  2. In the panel on the left side of the screen, under Service, click Configuration.

    Note: The Configuration page only appears for user-provided service instances.

  3. Enter the Credential Parameters, Syslog Drain Url, and Route Service Url.

  4. Click Update Service.

Manage Service Keys

To manage service keys, do the following:

  1. Navigate to the service Overview page.

  2. Under Service Key Credentials, generate a new service key, get the credentials for a service key, or delete a service key.

Generate a Service Key

To generate a new service key, do the following:

  1. Navigate to the service Overview page.

  2. Under Service Key Credentials, click Create Service Key.

  3. Enter a Service Key Name.

  4. (Optional) Click Show Advanced Options. Under Arbitrary Parameters, enter any additional service-specific configuration in the Name and Value fields.

  5. Click Create to generate the service key.

View Credentials for a Service Key

To view the credentials for a service key, do the following:

  1. Navigate to the service Overview page.

  2. Under Service Key Credentials, click the service instance name. The JSON object containing the credentials appears.

  3. Click Close.

Delete Service Key

To delete a service key, do the following:

  1. Navigate to the service Overview page.

  2. Under Service Key Credentials, click the x next to the service instance name.

Manage Route Services

You can bind a new service instance to a route when creating the instance in the Marketplace, or you can manage route services for an existing service instance on the service instance page.

For more information about route services, see the Route Services topic.

Bind a New Service Instance to a Route

To bind a new service instance to a route, do the following:

  1. Select the service from the Marketplace.

  2. Under Bind to Route, either bind the service instance to an existing route or click Create Route to create a new custom route.

    Note: You must choose a Marketplace service compatible with route services for the Bind to Route field to appear.

  3. Complete the remaining fields and click Add to create the service instance.

Bind an Existing Service Instance to a Route

To bind an existing service instance to a route, do the following:

  1. Navigate to the service Overview page.

  2. Under Bound Routes, click Bind Route.

    Note: If the service is not compatible with route services, the text “This service does not support route binding” appears under Bound Routes.

  3. Do one of the following:

    • For Select a route to bind, select an existing route.
    • For Create Custom Route, enter a new route.
  4. Click Bind.

Unbind a Route from a Service Instance

To unbind a route from a service instance, do the following:

  1. Navigate to the service Overview page.

  2. Under Bound Routes, click the x next to the name of the route.