Managing Apps and Service Instances Using Apps Manager

Page last updated:

This topic discusses how to view and manage apps and service instances associated with a space using Apps Manager.

To perform the following steps, you must first log in to Apps Manager with an account that has adequate permissions. See the Understanding Permissions topic for more information.

Manage an App

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

Global search

From the app page, you can scale apps, bind apps to services, manage environment variables and routes, view logs and usage information, start and stop apps, and delete apps.

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 or Stop an App

  1. To stop an app, click the stop button next to the name of the app. Click Stop in the pop-up to confirm.

  2. To restart a stopped app, click the play button next to the name of the app.

  3. To restart a running app, click the restart button next to the name of the app. Click Restart in the pop-up to confirm.

Scale an App

From the app Overview pane, Space Developers can scale an app manually or configure App Autoscaler to scale it automatically.

Scale an App Manually

In the 'Processes and Instances' section of the 'Overview' pane, find the 'Scale' button to the right of each process.

  1. Click Scale to open the “Scale App” dialog. A dialog titled 'Scale App' lists each process with corresponding 'Instances', 'Memory Limit', and 'Disk Limit' fields. A 'Usage Total' section at the bottom of the dialog tallies the total entered in each field. Find an 'Apply Changes' button to the bottom right of the dialog.

  2. Adjust the number of Instances, the Memory Limit, and the Disk Limit as desired.

  3. Click Apply Changes.

Configure App Autoscaler

In the 'Processes and Instances' section of the 'Overview' pane, find 'Autoscaling' two rows below the title of each process.

  1. Use Autoscaling to enable App Autoscaler.

  2. Click Manage Autoscaling to open App Autoscaler.

  3. See the Configure Autoscaling for an App section of the Scaling an Application Using Autoscaler topic for how to configure your App Autoscaler to scale automatically based on rules or a schedule.

Bind or Unbind a Service

  1. Click Services.

  2. To bind your app to a service, click Bind Service. Bound services

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

    1. Click Bind Service.
      Bind service
    2. Under Service to Bind, select the service instance from the dropdown menu.
    3. (Optional) Enter a binding name under Binding Name in all lowercase letters. For example, bind-usr-serv.
    4. (Optional) Specify additional parameters under Add Parameters.
    5. Click Bind.
  4. To bind your app to a new service instance, do the following:

    1. Click New Service.
      New service.

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

    2. Click the service.
      Select plan
    3. Select a plan and click Select Plan.
      Instance name
    4. Under Instance Name, enter a name for the instance.
    5. (Optional) Enter a binding name under Binding Name in all lowercase letters. For example, bind-autoscaler.
    6. (Optional) Specify additional parameters under Add Parameters. For a list of supported configuration parameters, consult the documentation for the service.
    7. Click Create.
  5. To unbind your app from a service instance, locate the service instance in the Bound Services list and click the three-dot icon on the far right. Select Unbind from the dropdown menu.

Map or Unmap Routes

  1. Click Routes.

  2. The page displays the routes associated with the app. To add a new route, click Map a Route. Routes

  3. Enter the route and click Map.

  4. To unmap a route, locate the route from the list and click the red x. 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.

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 PCF administrator.

  1. Click Networking. The page displays any container networking policies associated with the app. The Container Networking Policies tab shows a Create Policy button, and a Add a network policy link. There is an empty list of network policies.

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

  3. 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.
  4. Click Save.

For more information about container-to-container networking in PCF, see Understanding Container-to-Container Networking.

View Logs

  1. Click Logs to view the logs for the app. Logs

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

View Tasks

  1. Click the Tasks tab within Apps Manager.

  2. This page displays a table containing Task ID, State, Start Time, Task Name, and Command. Task window resize

Run a Task

  1. Click Run Task to create a task. Run task

  2. (Optional) Enter a Task Name.

  3. Enter the Task Command.

  4. Click Run.

Enable Task Scheduling

In the Tasks tab, click Enable Scheduling to bind the PCF Scheduler service to your app. For more about the PCF 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

  1. Navigate to the Tasks tab. Create job

  2. Click Create Job to schedule a task.

  3. Enter a Job Name.
    Create job window

  4. Enter a Command.

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

  6. Click Create Job.

View Settings

Click the Settings tab. In this tab, you can do the following:

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

Apps man settings

Configure Health Checks

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

  1. Click the Settings tab.

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

  3. Complete the fields that appear with your selection.

    • For port, optionally complete the Invocation timeout (seconds) field. Health check port
    • For http, complete the Endpoint field. Optionally, complete the Timeout (seconds) and Invocation timeout (seconds) fields. Health check http
    • For process, there are no additional fields. Health check process
  4. Click Update.

For more information, see the Using Application Health Checks topic.

View or Add Environment Variables

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

  1. Click the Settings tab.

  2. Click Reveal User Provided Env Vars.

  3. Enter the Name and Value of the variable. Alternatively, enter your variable using the Enter JSON toggle.

  4. Click Save. User env vars

To view all environment variables, click Reveal Env Vars. Env vars

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.

Manage a Service Instance

From the Services tab on the space page, you can bind or unbind apps, bind or unbind routes, view or change your service plan, manage service keys, and rename or delete your service instance.

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.

Bind an App

  1. From the space page Services tab, click the service instance you want to bind to an app.

    Services binding

  2. Click Bind App. A popup appears.

  3. In the Bind App popup, select the app you want to bind to your service instance.

    Services binding popup

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

  5. Click Bind.

Unbind an App

  1. From the space page Services tab, click the service instance you want to unbind from an app.

    Services binding

  2. Locate the app under Bound Apps and click the red × on the right. An Unbind App popup appears.

    Services unbinding popup

  3. Click Unbind to confirm.

View or Change Your Service Plan

  1. From the space page Services tab, click the service instance you want to view or change the plan for.

  2. Click Plan.

    Services 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

  1. From the space page Services tab, click the service instance you want to rename or delete.

  2. Click Settings.

    Services settings

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

Manage Service Keys

On the space page, click Services, then click the service instance that you want to manage service keys for. This directs you to the service instance Overview page, where you can generate a new service key, get the credentials for a service key, and delete a service key.

Keys list

Generate a Service Key

Follow the steps below to generate a service key.

  1. In the Service Key Credentials section, click Create Service Key.

  2. Edit the Service Key Name.

    Keys create

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

    Keys create adv

  4. Click Create to generate the service key.

View Credentials for a Service Key

Follow the steps below to view the credentials for a service key.

  1. To view the credentials for a particular service instance, click the service instance name under Service Key Credentials. The JSON object containing the credentials appears.

    Keys creds

  2. Click Close.

Delete Service Key

To delete a service key, click the red x next to the service instance name. Keys delete

Manage Route Services

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

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.

Bind a New Service Instance to a Route

Follow the steps below to bind a new service instance to a route.

  1. Select the service from the Marketplace. Bind route new

  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

Follow the steps below to bind an existing service instance to a route.

  1. On the space page, click Services.

  2. Click the service instance that you want to manage route services for.

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

  3. To bind the service instance to a route, click Bind Route. Bind route old

  4. Select an existing route under Select a route to bind or enter a new route under Create Custom Route.

  5. Click Bind.

To unbind a route from a service instance, click the red x next to the name of the route under Bound Routes.

Create a pull request or raise an issue on the source for this page in GitHub