|
Resources title
|
Click to expand or collapse this page.
|
|
ActivateApp / DeactivateApp toggle button
|
Click to activate an app using the configuration settings on this
page, or to deactivate an app. See the Activating an App section and the Deactivating an App section.
|
|
Activate using resource payload link
|
Displays for an app that has the status of DEPLOYED. Click to activate the app
using a resource payload instead of the configuration settings on this page. See the
Activating an App section.
A resource payload is a JSON file that designates resource, network, and related
information for the app.
Here is a sample resource payload file:
{
"resources": {
"network": [{
"intf-matched": true,
"network-name": "iox-bridge0",
"default_net_required": true,
"interface-name": "eth0"
}],
"auto_remove": false,
"disk": 10,
"profile": "c1.small"
}
}
|
|
Download activation resource payload link
|
Displays for an app that is not in the DEPLOYED state. Click to save the settings
on this page in a resource payload JSON file.
Download a resource payload file if you want to use it when activating an app after
upgrading the app, or if you want to use it when activating another app.
Cisco Local Manager saves the file in the default download directory on your local
computer. The file is named App-Name_activation_rescources.json, where
App-Name is the name of this app. You can rename this file after you
download it.
|
|
debug
mode check box
|
Available before you click the Activate
App button and only for Docker type apps when the host system does not support native Docker, and for PAAS type apps. Check this
check box to activate the app in debug mode.
If an app that is running in debug mode shuts down unexpectedly, the app does not go to STOPPED state. Instead, the app remains
in RUNNING state so that you can use an SSH client to access the app and troubleshoot.
If you want to enable or disable the debug mode of an app that has been activated, you must first deactivate the app.
|
|
Resource
Profile
area
|
|
Profile drop-down list
|
Provides options for designating the resource profile for an app. A resource profile designates the amount of host system CPU and memory (RAM) resources that the app requires
to run, as follows.
-
c1.tiny , c1.small , c1.medium , c1.large , or c1.xlarge —Assigns the CPU and memory resources that the options display. These values are based on the host system hardware.
-
default —Assigns CPU and memory resources based on the requirement that is specified in the metadata for the app.
-
Custom —Lets you enter your own CPU, RAM, and disk space values in the CPU, Memory, and Disk fields.
-
Exclusive —Allocates all resources on the host system to the apps.
See the Activating an App section for more information.
|
|
CPU field
|
CPU units that the app requires on the host system.
If you choose Custom from the Profile
drop-down list, enter a value in this field. To enter a
value, click the cpu-unit radio button and enter the
number of CPU units required, or click the % button and
enter the percentage of total host system CPU units required.
If you choose an option other than Custom , the system
enters a value in the CPU field for you.
|
|
Memory field
|
Amount of RAM, in MB, that the app requires on the host system.
If you choose Custom from the Profile drop-down list, enter a value in this field. If you choose another option, the system enters a value in this field for you.
|
|
Disk field
|
Amount of disk space, in MB, that the app requires on the host system.
You can enter a value in this field for any option that you choose from the Profile drop-down list. The value that you enter must be greater than the existing value; you cannot decrease the disk space value.
|
|
Vcpu field
|
Appears only for VM-based apps. Enter the number of virtual CPUs that the app requires on the system.
If you choose Custom from the Profile drop-down list, enter a value in this field. If you choose another option, the system enters a value in this field for you.
|
|
Avail.
CPU field
|
Number of available CPU units on the host system.
The system does not allow you to activate an app if the value in the CPU field exceeds this available CPU value.
|
|
Avail.
Memory field
|
Amount of available RAM, in MB, on the host system.
The system does not allow you to activate an app if the value in the Memory field exceeds this available memory value.
|
|
Max
VCPU/App field
|
Appears only for VM-based apps. Number of virtual CPUs that are available on the host system.
|
|
Advanced
Settings
area
Appears only if the app type is Docker and the host system supports native Docker.
|
|
Docker options
|
Enter one or more Docker run options to be used when you activate the app.
This field includes the --rm option by default. For related information, see the following row in this table.
|
|
Auto delete container instance
|
Check this check box to add the --rm run option to the Docker Options field and to use this option when you activate the app.
When you stop an app that you activated and started with the --rm option, the app container instance is deleted automatically
and the app goes to DEPLOYED state (rather than STOPPED state).
This check box is checked by default.
|
|
Network
Configuration
area
|
|
Network Configuration table
|
Displays the following for each app network interface that has been configured for the app:
-
Name —Name of the interface
-
Network
Config —Name of the network
-
Description —Description of the interface
-
Action —The following links can appear in this field:
-
details —Displays after you click the Activate
App
button for an app. Click to display detailed information about the interface.
-
edit —Displays before you click the Activate
App
button for an app. Click to update information that you have configured for the interface.
-
delete —Displays before you click the Activate
App
button for an app. Click to delete the interface.
|
|
Add
App
Network
Interface button
|
Click to access options for adding and configuring an interface for the app. See the Activating an App section.
The following options display after you click the Add
App
Network
Interface button:
The following options display after enter a name in the Interface Name field and click OK :
-
Network name drop-down list—Networks the are available for the corresponding
interface.
-
Port
Mapping link or Interface
Setting link—Link name depends on the interface type that you choose. Click to access options for mapping ports or configuring interface
settings.
-
Description field—Displays after you click the Add
App
Network
Interface button. Optionally enter a description for the interface.
-
Add button—Click to save the interface that you are configuring.
-
Cancel button—Click to discard the interface that you are configuring.
|
|
Peripheral
Configuration
area
Appears only if the host system can provide this information and if the app metadata requests that a serial port, USB device,
or USB port on the host system be assigned for use by the app.
|
|
Peripheral table
|
Displays the following for each peripheral device that the app requires:
-
Device
Type —Type of the peripheral device.
-
Name —Name of the peripheral device.
-
Label —ID that the app uses to identify the peripheral device
-
Status —Displays one of the one of the following strings to indicate the state of the peripheral device. If the state of a peripheral
device changes, this field updates only if you close and then reopen the App Resources page.
-
Present —The peripheral device is plugged in to the host device and available for use. Each device in Peripherals table must be in
this state for you to be able to activate the app.
-
Not
Present —The peripheral device is not plugged in to the host device.
-
Used
by
name—The peripheral device is being used by the app that name indicates. While a device is in this state, it is unavailable for use by any other app.
-
Action —The following links can appear in this field:
-
details —Displays after you click the Activate
App button for an app. Click to display detailed information about the peripheral device.
-
edit —Displays before you click the Activate
App button for an app. Click to update information that you have configured for the device.
-
delete —Displays before you click the Activate
App button for an app. Click to delete device.
|
|
Add
Peripherals button
|
Click to access options for adding and configuring a peripheral device.
The following options display after you click the Add
Peripherals button, depending on what the host system supports:
-
Device
Type drop-down list—Choose the type of peripheral device
you are adding (serial ,
USB_storage , USB_serial ,
or USB_port ). Options that display depend on ports or
devices that are available on the host system for the app to use.
-
Device
Name drop-down list—Displays only if you choose serial from the Device
Type drop-down list and contains options based on the device
-
Device radio buttons—Display if you choose USB_storage , USB_serial , or USB_port from the Device
Type drop-down list and vary depend on the device
-
pid and vid fields—Display if you choose USB_storage , USB_serial , or USB_port from the Device
Type drop-down list and show the Product ID and the Vendor ID, respectively, of the device
-
fs-uuid field—Displays if you choose USB_storage from the Device
Type drop-down list and shows the Universally unique ID of the device
-
label field—Enter a unique ID that the app uses to identify the peripheral device
-
Add button—Click to save the peripheral device that you are configuring
-
cancel button—Click to discard the peripheral configuring information that you entered for the device
|
|
VNC
Options
area
Appears only if the host system supports this functionality.
|
|
Password field
|
Enter a password for accessing an app via a VNC session.
Use this password in the VNC client that you use to access the app.
|
|
Port field
|
Enter a port number to be used for accessing the app via a VNC session.
If you do not enter a port number, the system assigns a value.
Valid port numbers are 5900 through 65535.
|
to delete the corresponding snapshot file from the host system. See the
section.
.
Feedback