This topic describes how to view and manage apps and service instances with Apps Manager.
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](../operating/configure-multi-foundation.html).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 in Getting Started with Apps Manager.
This section describes how to manage an app in Apps Manager.
You can do the following tasks to manage apps in Apps Manager:
The Overview page for an app includes app summary information, such as app processes and instances, app memory and disk space, and app events.
There are two ways to navigate to an app Overview page:
The following image shows an example of an app Overview page.
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.
For more information about starting, stopping, and restaging apps with the Cloud Foundry Command Line Interface (cf CLI), see Starting, Restarting, and Restaging Apps.
From the app Overview page, you can scale an app manually or configure App Autoscaler to scale it automatically.
To manually scale an app:
Navigate to the app Overview page.
Under Processes and Instances, click Scale to open the Scale app dialog.
Edit the number of Instances, the Memory Limit, and the Disk Limit as desired.
Click Apply Changes.
You can enable App Autoscaler to automatically scale your apps. For information about how to configure App Autoscaler to scale an app automatically, see Configure Autoscaling for an App in Scaling an App Using App Autoscaler.
To enable App Autoscaler for an app:
Navigate to the app Overview page.
Under Processes and Instances, click Enable Autoscaling to enable App Autoscaler.
Click Manage Autoscaling to open App Autoscaler.
You can view the sidecar processes associated with your app from the app Overview page.
To view sidecar processes associated with your apps:
Navigate to the app Overview page.
Under Processes and Instances, see Sidecars. This section only appears if your app has any sidecar processes.
For more information about sidecar processes, see Pushing Apps with Sidecar Processes.
If Metric Store is installed, you can view the following key metrics for an app in the Key Metrics section of the app Overview page:
For more information about each metric, see Interpret Metrics in Monitoring and Troubleshooting Apps with Metrics.
For each metric, the app Overview page includes a graph that shows metric behavior over the past three hours. You can hover over the data points on the graph to view the value of the metric. The page also includes the average value for the metric over the past three hours.
Metric Store is required for Apps Manager to display the Key Metrics section. For information about installing and configuring Metric Store, see Metric Store.
The following image is an example of an app Overview page, showing key metrics for the app.
You can bind your app to new or existing service instances. You can also unbind your app from service instances.
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:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Services.
Click Bind Service.
For Service to Bind, select the service instance from the dropdown.
(Optional) For Binding Name, enter a binding name in all lowercase letters. For example, bind-usr-serv
.
(Optional) For Add Parameters, specify additional parameters.
Click Bind.
To bind your app to a new service instance:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Services.
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.
Click the service.
Select a plan and click Select Plan.
Under Instance Name, enter a name for the instance.
(Optional) For Binding Name, enter a binding name in all lowercase letters. For example, bind-usr-serv
.
(Optional) For Add Parameters, specify additional parameters. For a list of supported configuration parameters, consult the documentation for the service.
Click Create.
To unbind your app from a service instance:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Services.
Locate the service instance in the Bound Services list.
Click the three-dot icon on the far right.
Select Unbind from the dropdown.
The Routes page displays the routes associated with your app. You can use this page to map and unmap routes for your app, or change the destination protocol for routes to your app.
To map routes to your app:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Networking, click Routes.
To add a new route, click Map a Route.
Enter the route and click Map.
Under Choose Protocol, select either HTTP1 or HTTP2.
To unmap a route from your app:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Networking, click Routes.
Locate the route from the list and click the x.
Click Unmap in the pop-up to confirm.
To change the destination app protocol for a route:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Networking, click Routes.
To change the destination protocol for a route, under App Protocol, select either HTTP1 or HTTP2.
Click Save.
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 Ops Manager, 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 Ops Manager administrator.
To create container-to-container networking policies:
Navigate to the app Overview page.
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.
To add a new network policy, click Create Policy or Add a network policy.
In the Add Policy window, configure the following:
1
to 65535
. You can specify a single port, such as 8080
, or a range of ports, such as 8080-8090
.Click Save.
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 Ops Manager.
You can view revisions, list environment variables associated with revisions, and re-deploy previous revisions in the Revisions tab.
For more information about app revisions in Ops Manager, see App Revisions.
To list revisions for an app:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Revisions.
View app revisions in the Revisions table.
To list environment variables associated with an app revision:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Revisions.
In the Revisions table, select the row that contains the revision. The row expands to reveal metadata and environment variables associated with the revision.
To roll back an app to a previous revision:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Revisions.
In the Revisions table, select the row that contains the revision you want to roll back to. The row expands to reveal metadata.
Click Redeploy.
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:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Observability, click Logs.
Click the play button to view a live version of the logs.
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.
You can view tasks for an app on the Tasks page in Apps Manager.
To access the Tasks page:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Tasks.
To run a task for an app:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Tasks.
Click Run Task to create a task.
(Optional) Enter a Task Name.
Enter the Task Command.
Select a Memory Limit and a Disk Limit for the task.
Click Run.
In the Tasks tab, click Enable Scheduling to bind the Scheduler service to your app. For more about Scheduler, see Scheduling Jobs in the Scheduler documentation.
To schedule a task:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Tasks.
Click Create Job to schedule a task.
Enter a Job Name.
Enter a Command.
Enter one or more Cron Expressions for your desired task schedule or schedules. For more information on cron expression syntax, see Schedule a Job in Scheduling Jobs in the Scheduler documentation.
Click Create Job.
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:
To configure health checks for your app:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Settings.
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.
For Type, select port, http, or process.
Complete the fields that appear based on your selection.
Click Update.
For more information, see Using App Health Checks.
To view all environment variables for an app:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Settings.
Under User Provided Environment Variables, click Reveal Env Vars.
To add a user-provided environment variable:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Settings.
Click Reveal User Provided Env Vars.
Click Add Environment Variable.
Enter the key and value of the variable. Alternatively, toggle Enter as JSON to enter the variable in JSON.
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.
You can add metadata, including labels and annotations, to apps and spaces using Apps Manager.
For more information about adding metadata to objects in VMware Tanzu Application Service for VMs (TAS for VMs), see Using Metadata.
To add labels or annotations to an app using Apps Manager:
Navigate to the app Overview page.
In the panel on the left side of the screen, under Application, click Settings.
For Labels, provide a name and value pair. Or, select Enter JSON to enter the label in JSON.
For Annotations, provide a name and value pair. Or, select Enter JSON to enter the annotation in JSON.
To add more labels or annotations, click + next to the Labels or Annotations field.
Click Update Metadata.
This section describes how to manage service instances in Apps Manager.
You can do the following tasks to manage service instances in Apps Manager:
Note: For services that use on-demand brokers, the service broker creates, updates, or deletes the service instance in the background and notifies you when it finishes.
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:
Navigate to the landing page for the space of the service instance.
In the panel on the left side of the screen, under Space, click Services.
On the Services page, click on the name of the service instance.
The following image shows an example of a service instance Overview page.
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:
On the service Overview page, click Bind App.
In the Bind App popup, select the app to bind to the service instance.
(Optional) To attach parameters to the binding, click Show Advanced Options. Under Arbitrary Parameters, enter any additional service-specific configuration.
Click Bind.
To unbind an app from a service instance:
On the service Overview page, under Bound Apps, click the × to the right of the app name. An Unbind App popup appears.
Click Unbind to confirm.
From the service Overview page, you can share your service instance across spaces.
To share a service instance:
On the service Overview page, click Share Service Instance.
Select the spaces with which you want to share your service instance.
Click Share.
To view or change your service plan:
Navigate to the service Overview page.
In the panel on the left side of the screen, under Service, click Plan.
Review your current plan information.
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.
To rename or delete your service instance:
Navigate to the service Overview page.
In the panel on the left side of the screen, under Service, click Settings.
Do one of these steps:
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.
For Spring Cloud Services (SCS) Config Server instances, Apps Manager lets you:
See the Git repos that the SCS Config Server uses to configure the client apps that it serves. For more information, see Configuring with Git in the SCS documentation.
Update client app configurations, by updating the local mirrors of their configuration repos.
See the current status and configuration of the SCS Config Server itself.
To see and update this configuration and status information for an SCS Config Server instance:
Navigate to the service Overview page.
In the panel on the left side of the screen, under Service, click Config.
Note: The Configuration pane only appears for Spring Cloud Services instances.
The Config pane includes:
The current status of the SCS Config Server.
The JSON object that configures settings for the SCS Config Server itself.
-c
flag to cf create-service
and cf update-service
.A Synchronize Mirrors button for the app configurations that the SCS Config Server serves.
A Manage link to the SCS Config Server dashboard, at the /dashboard
URL endpoint of the SCS service instance.
You can create a user-provided service instance from the Marketplace. For more information, see User-Provided Service Instances.
To configure settings for a user-provided service instance:
Navigate to the service Overview page.
In the panel on the left side of the screen, under Service, click Configuration.
Note: The Configuration pane only appears for user-provided service instances.
Enter the Credential Parameters, Syslog Drain Url, and Route Service Url.
Breaking Change: In TAS for VMs v2.10, aggregate syslog drains contain only logs by default, and do not contain metrics. If you rely on metrics sent through aggregate syslog drains, you must add ?include-metrics-deprecated=true
to your aggregate drain URLs to continue to receive metrics in the drains.
For more information, see Aggregate Syslog Drains Contain Logs Only in the TAS for VMs v2.10 Release Notes.
Click Update Service.
To manage service keys:
Navigate to the service Overview page.
Under Service Key Credentials, generate a new service key, get the credentials for a service key, or delete a service key.
To generate a new service key:
Navigate to the service Overview page.
Under Service Key Credentials, click Create Service Key.
Enter a Service Key Name.
(Optional) Click Show Advanced Options. Under Arbitrary Parameters, enter any additional service-specific configuration in the Name and Value fields.
Click Create to generate the service key.
To view the credentials for a service key:
Navigate to the service Overview page.
Under Service Key Credentials, click the service instance name. The JSON object containing the credentials appears.
Click Close.
To delete a service key:
Navigate to the service Overview page.
Under Service Key Credentials, click the x next to the service instance name.
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 Route Services.
To bind a new service instance to a route:
Select the service from the Marketplace.
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.
Complete the remaining fields and click Add to create the service instance.
To bind an existing service instance to a route:
Navigate to the service Overview page.
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.
Do one of these steps:
Click Bind.
To unbind a route from a service instance:
Navigate to the service Overview page.
Under Bound Routes, click the x next to the name of the route.