The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Cisco Fog Director Apps pages provide information about Cisco IOx apps, and provide access to features for managing these apps and performing related operations.
When you log in to Cisco Fog Director, the Apps View page displays, If no apps have yet been added to Cisco Fog Director, this page displays “Welcome to Cisco Fog Director” and displays the ADD NEW APP button and the IMPORT APPS button.
If at least one app has been added, this page includes these areas:
To access the Apps pages, log in to Cisco Fog Director as described in the “Accessing Cisco Fog Director” section, and then click the APPS tab. The Apps View page displays.
This chapter includes these sections:
The Installed Apps area on the Apps View page lists each app that is installed through Cisco Fog Director on at least one device or that is scheduled to be installed, provides information about these apps, and provides access to related features.
For an app that is scheduled to be installed, this area displays the message “ App_name is scheduled to install on # devices.” In this message, App_name is the name of the app and # is the number of devices on which the app is scheduled to be installed. You can click the number to display the Actions page, which provides detailed information about the scheduled installation and lets you perform related activities (see the “Managing Outstanding and Expired Actions for Apps” section). For information about scheduling app actions, see the “Using Action Plans” section.
For each installed app, this area includes the items that Table 4-1 describes.
Displays the name and version of the app and an app for the app. Click an app icon to display more detailed information about the app and to access features for managing the app, as described in the “Viewing Detailed Information about an Installed or Available App” section. |
|
Number of Alerts that the app has generated. Click to manage alerts. See the “Managing App Alerts” section. |
|
Click to display text and a chart that provide information about the states of an app that is installed on at least one device. App states can include the following:
The text that describes each state shows the number of devices on which the app in that state and the total number of devices on which the app is installed For example, “8/12 Running” means that the app is installed on 12 devices and is running on 8 of them. The donut chart provides a visual representation of each state of an app as a percentage of the number of devices on which the app is installed. Hover your mouse pointer over any section of a chart to see what state that section represents and the percentage of devices on which the app is in that state. Click a chart to display monitoring information for the app, as described in the “Monitoring an App” section. |
|
Click to display the hostnames of up to 5 devices on which the app has consumed the most CPU resources during the past 24 hours.The percentage value next to a hostname indicates the average amount of CPU resources the app consumed on the device during the past 24 hours. Click a hostname to display device detailed information about the device. See the “Viewing Detailed Information about a Device” section for more information. |
|
Click to display the hostnames of up to five devices on which the app has consumed the most RAM resources during the past 24 hours, and the amount of memory, in MG, consumed on each device.The percentage value next to a hostname indicates the average amount of RAM resources the app consumed on the device during the past 24 hours. Click a hostname to display device details information about the device. See the See the “Viewing Detailed Information about a Device” section for more information. |
|
Appears if an app is not currently installed on any device. Click to remove the app from the Installed Apps area. |
The Available Apps area on the Apps View page lists each app that has been published, provides information about these apps, and provides access to related features. An available app is ready to be installed on one or more devices.
You can display this area in either of these views:
The following sections provide more detailed information:
The Available Apps area displays in App Install view by default when you access the Apps View page. When this area is in the App Edit view, you can change to the App Install view by clicking the SWITCH TO APP INSTALL VIEW button or by clicking the APPS tab.
In App Install view, the Available Apps area includes the items that Table 4-2 describes.
Displays the name, version, and icon of each available app. Click an app icon to display more detailed information about the app and to access features for managing the app, as described in the “Viewing Detailed Information about an Installed or Available App” section. |
|
The Available Apps area displays in App Edit view when this area is in App Install view and you click the SWITCH TO APP EDIT VIEW button.
In App Edit view, the Available Apps area includes the items that Table 4-3 describes.
Displays the name. version, and icon of each available app. Click an app icon to display more detailed information about the app and to access features for administering the app. |
|
Click to change the Available Apps area to App Install view. See the “Available Apps Area: App Install View” section. |
|
See the “Unpublishing an App” section. |
|
See the “Removing an App” section. |
When the Available Apps area is in App Edit view and you click an app icon, a configuration page displays. The items that this page displays vary depending on the type of the app, and can include the items that Table 4-4 describes.
The icon that displays in Cisco Fog Director for the app. This icon comes from an image file that you specify. You can click Edit Icon to select an image file as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Entity that authored the app, as specified in the app metadata. |
|
Resource profile of the app, which specifies the amount of host system CPU and memory (RAM) resources that the app requires on a device. For information about assigning resource profiles to an app, see Cisco IOx Local Manager Reference Guide . |
|
Amount of disk space, in MB, that the app requires on a device. |
|
Appears if you configured links for an app. Click a link to go to the configured resource. See the “Configuring App Links” section. |
|
Lets you upload a newer version of an app to Cisco Fog Director. See the “Upgrading an App” section. |
|
Click to publish the app, which makes the app available for installation on devices. See the “Publishing an App” section. |
|
Click to save updates that you make to the description or release notes for the app. See the “Editing an App Icon, Description, and Release Notes” section. |
|
Brief description of the app that displays when you view detailed information for the app. You can click Edit next to “Description” to enter description text as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Notes for the app that appear when you view detailed information for the app. For example, notes might include a list and descriptions of features added in an updated app. You can click Edit next to “Release Notes” to enter release note text as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Appears only for an app that provides services and lists the service APIs that the includes. This type of app includes services that are defined in the service-bundle section in the package.yaml file for a the app. These services can be consumed by other apps. |
|
Let you configure external links for an app. See the “Configuring App Links” section. |
The Unpublished Apps area on the Apps View page on the Apps View page lists each app that has been uploaded to Cisco Fog Director and is not yet published. An unpublished app must be published before it can be installed on one or more devices.
The Unpublished Apps area includes the items that Table 4-5 describes.
Lets you upload an app to Cisco Fog Director. See the “Adding an App” section. |
|
Displays the name, version, and icon of each unpublished app. Click an icon to display additional information for the app. The page that displays is the same page that the “Available Apps Area: App Edit View” section describes. |
|
Lets you publish an app, which makes it available for installation on a device. See the “Publishing an App” section. |
|
To view detailed information about an installed app or available, click its icon in the Installed Apps area or in the Available Apps area on the Apps View page. The App Configuration page displays.
This page includes information and features that apply to the app. The items that this page displays vary depending on the state of the app, and can include the items that Table 4-6 describes.
The name of the app, its version, and the date and time it was last updated. |
|
Entity that authored the app, as specified in the app metadata. |
|
Amount of disk space, in MB, that the app requires on a device. |
|
Appears if you configured links for an app. Click a link to go to the configured resource. See the “Configuring App Links” section. |
|
Lets you install an app on one or more devices. See the “Installing an App” section. |
|
Displays information about the operation of the app and its resource consumption on devices See the “Monitoring an App” section. |
|
Lets you uninstall an app from one or more devices. See the “Uninstalling an App” section. |
|
Shows the number of devices on which the app has been successfully installed. The EDIT CONFIGURATION button under this display lets you update configuration parameters that apply to an app, These items may include configuration information, resource profile, networking, and port information. See the “Reconfiguring App Parameters” section for more information. |
|
Shows the number of devices on which an installation, update, uninstall, or reconfiguration action failed for the app. Hover your mouse pointer over this area to see more detailed information about specific action failure types. You can click the RETRY NOW button retry an action. See the “Retrying a Failed Action for an App” section for more information. |
|
After you add and publish a newer version of an already-published app, this field displays the app version number (in the left column) and the number of devices on which the corresponding app version should be upgraded to the newer version (in the right column). You can click the UPGRADE button to perform the upgrade. See the “Upgrading an App” section for more information. |
|
Appears if an install, edit, upgrade, or uninstall action for the app is in Outstanding state or in Expired state as a result of an action plan, Click to display the Actions page, which provides options for managing actions that are in these states. See the “Managing Outstanding and Expired Actions for Apps” section for more information. |
|
Displays information about the devices on which the app is installing. This information includes:
or hostname of a device to see the status of the app installation process on that device. |
|
Includes a chart that provides a visual representation of the number of devices on which the app in a particular state. Hover your mouse pointer over any section of a chart to see what state that section represents and the number of devices on which the app is in that state. Click any section of the chart to display a table with detailed information about each device on which the app is in the state. This table includes the following:
|
|
Brief description of the app. See the “Editing an App Icon, Description, and Release Notes” section for related information. |
|
Release notes for the app. See the “Editing an App Icon, Description, and Release Notes” section for related information. |
Adding a Cisco IOx app uploads the app package for the app to Cisco Fog Director. When you add an app, it displays in the Unpublished area on the Apps View page and becomes available to be published.
When you add an app, you can choose to upload an app package that was created with the Cisco IOx SDK, or choose to have Cisco Fog Director create and upload an app package from a Docker image that is in the Cisco Docker registry or in a third party registry such as Docker Hub.
To add an app, perform the following steps.
Step 1 On the Apps View page, click the ADD NEW APP button.
If other apps have already been added, this button displays In the Unpublished Apps area,
Step 2 In the dialog box that displays, take either of these actions:
The app is added to Cisco Fog Director and a page with the items that Table 4-7 displays. The items in this page depend on the type of app that you added.
Step 3 If you chose to have Cisco Fog Director create an app package from a Docker image, take these actions:
1. In the Image name or ID field, enter the name or ID of the Docker image.
2. (Optional) In the Image tag field, enter a tag for the Docker image.
If you do not enter a tag name, Cisco Fog Directory uses the tag named “latest.”
3. If the Docker image is in a Docker registry other than Docker Hub, enter either of the following in the Docker Registry field:
- Hostname and optional port of the Docker registry, in the format hostname [ : port ]
- IP address and optional port of the Docker registry, in the format ip_address [ : port ]
If the Docker image is in Docker Hub, leave the Docker Registry field blank.
4. (Optional) If the Docker registry requires authentication before you can pull an image from it, and if you did not instruct Cisco Fog Director to remember your credentials for this registry when you previously added or upgraded a Docker app, take these actions:
– In the Registry Username field, enter the user name that authenticates you to the Docker Registry.
– In the Registry Password field, enter the password that authenticates you to the Docker Registry.
– Check the Remember these credentials check box if you want Cisco Fog Director to store the user name and password that you enter and automatically populate the Username and Password fields with this information the next time you add or upgrade a Docker app.
If you instructed Cisco Fog Director to remember your credentials for this registry when you previously added or upgraded a Docker app, the message “You have saved credentials ( username ). Use them?” displays below the Image requires authentication to pull check box. Click either of the following options that also appear:
– Yes, use them —Causes Cisco Fog Director to use the user name and password that have been stored.
– No, forget them —Causes Cisco Fog Director to no longer store the user name and password for this Docker registry. In you choose this option, enter the user name and password that authenticate you to the Docker registry in the User Name and Password fields that appear. If you want Cisco Fog Director to remember these credentials, check the Remember these credentials check box.
5. Click the Browse button next to Choose package.yaml and package_config.ini files and then follow the on-screen prompts to locate and select on your local drive the following files that relate to the Docker image:
– package.yaml (optional)—App descriptor file
– package_config.ini—Configuration parameters file
The files that you select are listed under the Browse button. To remove a file from this list, click the Remove icon next to the file.
Cisco Fog Director creates an app by packaging the Docker image and related files and adds the app.
A dialog box appear while the add process executes. This process can take some time.
When the app is added to Cisco Fog Director, a page with the items that Table 4-7 displays. The items in this page depend app that you added.
Click to add an icon for the app. See the “Editing an App Icon, Description, and Release Notes” section. |
|
Includes the following information
|
|
Entity that authored the app, as specified in the app metadata. |
|
Resource profile of the app, which specifies the amount of host system CPU and memory (RAM) resources that the app requires on a device. For information about assigning resource profiles to an app, see Cisco IOx Local Manager Reference Guide . |
|
Amount of disk space, in MB, that the app requires on a device. |
|
Name of another app that provides services that the app requires. |
|
Let you configure external links for an app. See the “Configuring App Links” section. |
|
Lets you upload a newer version of an app to Cisco Fog Director. See the “Upgrading an App” section. |
|
Click to publish the app, which makes the app available for installation on devices. See the “Publishing an App” section. |
|
Click to save updates that you make to the description or release notes for the app. See the “Editing an App Icon, Description, and Release Notes” section. |
|
Brief description of the app that displays when you view detailed information for the app. You can click Edit next to “Description” to enter description text as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Notes for the app that appear when you view detailed information for the app. For example, notes might include a list and descriptions of features added in an updated app. You can click Edit next to “Release Notes” to enter release note text as described in the “Editing an App Icon, Description, and Release Notes” section. |
You can publish an app after it has been added to Cisco Fog Director. A published app becomes available to install on devices.
To publish an app, take any of these actions:
After you perform the Publish action, the app moves from the Unpublished Apps area to the Available Apps area on the Apps View page.
Unpublishing an app moves the app to the unpublished area and makes it unavailable for installation on any device. Unpublishing an app does not remove it from devices on which it is installed already.
To unpublish an app, follow these steps:
Step 1 In the Available Apps area on the Apps View page, click SWITCH TO APP EDIT VIEW .
Step 2 Click the Unpublish button under the icon for the app.
You can install a published app on a device that has been added or imported to Cisco Fog Director.
The following sections provide additional information:
To view options for installing an app, click the INSTALL button on the App Configuration page for the app.
The Filter Devices page displays. This page includes the items that Table 4-8 describes.
To install an app on one or more devices, perform the following steps.
If you are installing an app on multiple devices and want to stop the installation procedure at any time, unpublish the app as described in the “Unpublishing an App” section.
Cisco Fog Director associates an action plan with each app installation procedure that you perform. An action plan instructs Cisco Fog Director to retry an installation if the installation fails due to certain conditions, or to perform the installation within a designated maintenance window. By default, the action plan causes Cisco Fog Director to perform the installation immediately and to retry a failed installation up to 10 times at 2 minute intervals. You can change these parameters as needed when you perform the app installation procedure. For more information, see the “Using Action Plans” section.
Step 1 Take either of these actions:
Step 2 In the Installed Devices table, check the check box for each device on which you want to install the app.
For detailed information about this table and locating devices, see the “Install App Options” section.
Step 3 Click the ADD SELECTED DEVICES button.
The devices that you selected and on which the app can be installed are added to the Selected Devices table. The app will be installed on the devices that this table lists. For detailed information about this table and about removing devices from this table, see the “Install App Options” section.
Step 4 Click the Next button near the bottom of the page.
The Installation Summary page displays. This page lets you review and configure operations that are performed by Cisco Fog Director on the devices on which you are installing the app.
Step 5 (Optional) In the Installation Summary page, expand Selected Devices (if it is not expanded already) to review the following information for each device that you selected:
You can click a pagination control to go to the first, next, last, previous, or specific page in the table. From the Items per page drop-down list you can choose the maximum number of devices that appear in each page of the table.
Step 6 In the Installation Summary page, take the following actions as needed:
By default, the system adds a tag with the app name to each device. You can change this name, or, if you do not want a tag to be added, delete all text in this field. See the “Managing Tags for Devices” section for related information.
– Host Name—Hostname of the device.
– IP Address—IP address of the device.
– Tags—Tags that are assigned to the device.
– Health—Icons that represent information about CPU use or memory use on the device. Hover your mouse pointer over an icon to see more detailed information.
– Incompatibility Cause—A brief description of why the app cannot be installed on the device.
You can click a pagination control to go to the first, next, last, previous, or specific page in the table. From the Items per page drop-down list you can choose the maximum number of devices that appear in each page of the table.
Step 7 (Optional) In the Installation Summary page, expand Customize Configuration to view and update configuration information for this app.
The configuration items that display are defined in the package_config.ini file for the app. The value that each field displays is the default value for that item as defined by the app. You can make updates in these fields as needed.
Step 8 (Optional) In the Installation Summary page, expand Configure Resource Profile to view and update the resource profiles that have been assigned for the app on each device.
You can update the resource profile for a specific device, some devices, or all devices.
The device squares in the box in the middle of the Configure Resource Profile area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Resource Profile dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and the resource profile that has been assigned for the app on the device. You can click the hostname and IP address in the dialog box to exit the installation and display the Device Details page for the device.
To update a resource profile on one or more devices, take these actions:
a. If you want to limit the device squares displays to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
– To change the resource profile for a specific device, hover your mouse pointer over the device square for that device, and in the Edit Resource Profile dialog box, choose a resource profile from the Select Profile drop-down list.
– To change the resource profile for all devices for which a device square displayed, click the desired profile radio button and then click the REASSIGN PROFILE button:
- Exact matching profile —Assigns the resource profile that is defined for the app in its metadata, if the resources are available on a device.
- Largest available profile —Assigns the largest resource profile that is currently available on each device on which you are installing.
- Allocate all available resources —Assigns all CPU and memory resources that are available on each device on which you are installing.
- Custom profile —On each device on which you are installing, assigns the CPU and memory resources that you specify. After you click this radio button, the CPU and the Memory fields appear. Enter the CPU resources, in units, and memory resources, in MB, to assign on each device. The Max value under each field shows the maximum value that you can enter without exceeding the available corresponding resource on at least one device. If you enter a value that exceeds this maximum value, the REASSIGN PROFILE button is dimmed and cannot be used.
Step 9 (Optional) In the Installation Summary page, expand Configure Networking to view and update network information that relates to how the app obtains its IP address or addresses on each device.
The Configure Networking area is available only if its options apply to this installation.
You can update network information for a specific device, some of devices, or all devices. If network information is not configured for a device by default, you must configure it as described in this step.
The device squares in the box at the left of the Configure Networking area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Network Details dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and network interface information for each network interface that is defined in the package_config.ini file for the app.
The Preferred Networks sub areas at the right of the Configure Networking area provide information for each network interface that is defined in the package_config.ini file for the app. You can expand a sub area to display and update options in it.
If you want to limit the device squares to one or more specific devices, take either of these actions:
To reassign network information for an app on one or more devices, take either of these actions:
a. Hover your mouse pointer over the device square for that device, and in the Edit Network Details dialog box, choose a network for the corresponding network interface from the Select Network drop-down list. Network options are:
- iox-bridge # —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- iox-nat # —App obtains its IP address from an internal network address translator
b. If you choose iox-bridge # and if you want to assign a static IP address from the DHCP pool for this network interface, check the Static Mode check box that displays. If you check this check box, the network interface uses IP addresses that are dynamically assigned from the DCHP pool.
c. If you check the Static Mode check box, configure the following fields that appear as needed:
- IPv # Address and Mask fields—Enter the static address and subnet mask to use. If the IPv6required field is set to “true” in the app descriptor file (package.yaml) for an app, you must enter an IPv6 address. Otherwise, you can enter an IPv4 or an IPv6 address. If you enter an IPv6 address but a device on which you are installing the app does not support IPv6, the app installation will fail on that device.
- DNS field—(Optional) Enter the IP address of the DNS server that the app uses for external communication.
- Default Gateway field—(Optional) Enter the IP address of the default gateway that the app uses for external communication.
a. Expand the Preferred networks sub area.
b. Choose a network from the Select Network drop-down list. Network options are:
- iox-bridge # —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- iox-nat # —App obtains its IP address from an internal network address translator
c. If you choose iox-bridge # , click one of the following radio buttons that appear:
- Static — Click to assign a static IP address from the DHCP pool for this network interface
- Dynamic —Click to use a dynamically assigned IP address from the DCHP pool for this network interface
d. If you click the Static radio button, configure the following fields that appear as needed:
- IPv # Address and Mask fields—Enter the static address and subnet mask to use. If the IPv6required field is set to “true” in the app descriptor file (package.yaml) for an app, you must enter an IPv6 address. Otherwise, you can enter an IPv4 or an IPv6 address. If you enter an IPv6 address but a device on which you are installing the app does not support IPv6, the app installation will fail on that device.
- Default Gateway field—(Optional) Enter the IP address of the default gateway that the app uses for external communication.
- DNS field—(Optional) Enter the IP address of the DNS server that the app uses for external communication.
e. After you configure each network interface that you want, click the REASSIGN NETWORKS button.
Step 10 (Optional) In the Installation Summary page, expand Configure VNC Password to set the VNC password that is required to access an app on devices via a VNC session.
The Configure VNC Password area is available only if the app requests a serial port.
The device squares in the box in the middle of the Configure VNC Password area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit VNC password dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and provides a field for entering the VNC password for the device.
To set the VNC password for an app on one or more devices, take these actions:
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
b. Take either of these actions:
– To set the VNC password for a specific device, hover your mouse pointer over the device square for that device, and in the Edit VNC Password dialog box, enter the password in the VNC Password field
– To set the VNC password for all devices for which a device square is displayed, enter the password in the VNC Password field that displays to the right of the device squares, and then click the thee Assign button.
Step 11 (Optional) In the Installation Summary page, expand Configure VCPUs to configure the number of virtual CPUs that the app requires on a device.
The Configure VCPUs area is available only if the app requests virtual CPUs.
The device squares in the box in the middle of the Configure VCPUs area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit VCPU Details dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and the number of virtual CPUs that have been assigned for the app on the device.
To configure the number of virtual CPUs that an app requires on one or more devices, take these actions:
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
b. Take either of these actions:
– To configure the number of virtual CPUs for a specific device, hover your mouse pointer over the device square for that device, and in the Edit VCPU dialog box, type or use the up or down arrow buttons to enter the desired value.
– To configure the number of virtual CPUs for all devices for which a device square is displayed, in the Select VCPU Value field that displays to the right of the device square, type or use the up or down arrow buttons to enter the desired value, and then click the REASSIGN VCPU button. The text above the Select VCPU Value field indicates the number of virtual CPUs that the descriptor file for the app specifies and the maximum number of virtual CPUs that you can designate for the app on the devices that you selected.
Step 12 (Optional) In the Installation Summary page, expand Configure Device Resource Ports to view and update the serial port that an app uses on a device.
The Configure Device Resource Ports area is available only if the app requests a serial port.
The device squares in the box in the middle of the Configure Device Resource Ports area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Serial Details dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and the serial port that has been assigned for the app on the device.
To update a serial port for an app on one or more devices, take these actions:
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
b. Hover your mouse pointer over the device square for the device that you want to update, and in the Edit Serial Details dialog box, choose a port from the Select Serial Port drop-down list.
Step 13 (Optional) In the Installation Summary page, expand Configure Action Plan to choose, view, modify or add an action plan.
The action plan designates how many times and at what interval Cisco Fog Director retries an action if the action fails on a device due to certain device reachability or network connectivity issues. If Cisco Fog Director cannot complete the app installation action after the number of retries that the action plan designates, the app installation does not complete.
When you expand Configure Action Plan , the Selected Action Plan field shows the name of the action plan that is in effect. The Details field describes the number of retries and time between retries that the selected action plan defines.
You can choose the action plan that you want from the Selected Action Plan drop-down list.
For information about modifying or adding action plans, see the “Using Action Plans” section.
Step 14 (Optional) In the Installation Summary page, expand Network Status to view network, resource, and related information for apps and devices.
The Network Status area displays the following information:
– Cartridges —Cisco cartridges that a PAAS app requires to run. These cartridges must already be uploaded to Cisco Fog Director (see Chapter 7, “Managing Cartridges”) and are installed automatically on the device as part of the app installation process.
– CPU Availability —Number of free CPU units on the device.
– Memory Availability —Amount of free RAM, in MB, on the device.
Step 15 When you are satisfied with the information on the Installation Summary page, click the DONE, LET’S GO button.
The App Configuration page displays, as described in the “Viewing Detailed Information about an Installed or Available App” section.
While the app is installing on a device, the status of the installation displays for that device. Click the device to see the progress of the installation. You can click the ABORT button under the status display to abort the installation action, as described in the “Aborting an Action” section.
If the Actions Failed display on this page indicates that the installation failed on any device, you can take any of these actions:
You can uninstall an app from any device on which it is running. Uninstalling an app removes it from the device and releases device CPU and memory (RAM) resources that were reserved for it.
You can uninstall an app that is in any state.
The following sections provide additional information:
To view options for uninstalling an app, click the UNINSTALL APP button on the App Configuration page for the app.
A page displays that includes the items that Table 4-9 describes.
Uninstalling an app removes the installed app from one or more devices.
When you uninstall a Docker app, layers that are used by that app are not deleted automatically. If you want to delete these layers, see the “Managing Layers” section. If you do not delete a layer, it is reused if you later install an app that requires it.
Cisco Fog Director associates an action plan with each app uninstallation procedure that you perform. An action plan instructs Cisco Fog Director to retry an uninstallation if the uninstallation fails due to certain conditions, or to perform the uninstallation within a designated maintenance window. By default, the action plan causes Cisco Fog Director to perform the uninstallation immediately and to retry a failed uninstallation up to 10 times at 2 minute intervals. You can change these parameters as needed when you perform the app uninstallation procedure. For more information, see the “Using Action Plans” section.
To uninstall an app, follow these steps:
Step 1 Take either of these actions:
Step 2 In the Installed Devices table, check the check box for each device from which you want to uninstall the app.
For detailed information about this table and locating devices, see the “Uninstall App Options” section.
Step 3 Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. The app will be uninstalled from devices that this table lists. For detailed information about this table and about removing devices from this table, see the “Uninstall App Options” section.
Step 4 (Optional) In the Installation Summary page, expand Configure Action Plan to choose, view, modify or add an action plan.
The action plan designates how many times and at what interval Cisco Fog Director retries an action if the action fails on a device due to certain device reachability or network connectivity issues. If Cisco Fog Director cannot complete the app uninstallation action after the number of retries that the action plan designates, the app uninstallation does not complete.
When you expand Configure Action Plan , the Selected Action Plan field shows the name of the action plan that is in effect. The Details field describes the number of retries and time between retries that the selected action plan defines.
You can choose the action plan that you want from the Selected Action Plan drop-down list.
For information about modifying or adding action plans, see the “Using Action Plans” section.
Step 5 Click the DONE, LET’S GO button.
The App Configuration page displays, as described in the “Viewing Detailed Information about an Installed or Available App” section.
While the app is uninstalling on a device, the status of the uninstallation displays for that device. Click the device to see the progress of the uninstallation. You can click the ABORT button under the status display to abort the uninstallation action, as described in the “Aborting an Action” section.
If the Actions Failed display on this page indicates that the uninstallation failed on any device, you can take any of these actions:
When an new version of an installed app becomes available, you can upgrade the app. This process includes uploading the app package for the app to Cisco Fog Director and then upgrading devices with the new app version.
When you upgrade an app, you can choose to upload an app package that was created with the Cisco IOx SDK, or choose to have Cisco Fog Director create and upload an app package from a Docker image that is in the Cisco Docker registry or in a third party registry such as Docker Hub.
When you upgrade a Docker app, layers that are used by the previous version and the upgraded version of the app are reused automatically. Layers that are not used by the upgraded version are not deleted automatically. If you want to delete these layers, see the “Managing Layers” section.
Cisco Fog Director associates an action plan with each app upgrade procedure that you perform. An action plan instructs Cisco Fog Director to retry an upgrade if the upgrade fails due to certain conditions, or to perform the upgrade within a designated maintenance window. By default, the action plan causes Cisco Fog Director to perform the upgrade immediately and to retry a failed upgrade up to 10 times at 2 minute intervals. You can change these parameters as needed when you perform the app upgrade procedure. For more information, see the “Using Action Plans” section.
To upgrade an app, perform the following steps.
If you are uploading an app package that was created with the Cisco IOx SDK, the app package must be on your local drive.
If you are creating and uploading an app package from a Docker image, the app descriptor file (package.yaml), if used, and the configuration parameters file (package_config.ini) for the Docker image must be on your local drive. In addition, you must make the configuration update as described in the “Docker Daemon Proxy Settings” section. (If you do not use a package.yaml file for a Docker app, Cisco Fog Director generates metadata from the Docker image automatically.)
If you are upgrading an app that provides services, you must first uninstall other apps that uses the services that this app provides.
Step 1 If you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for the app to upgrade.
Step 2 Click the UPGRADE PKG button.
Step 3 In the dialog box that displays, take either of these actions:
The app package that you select uploads to Cisco Fog Director. Skip to Step 5.
Step 4 If you chose to have Cisco Fog Director create an app package from a Docker image, take these actions:
a. In the Image name or ID field, enter the name or ID of the Docker image.
b. (Optional) In the Image tag field, enter a tag for the Docker image.
If you do not enter a tag name, Cisco Fog Directory uses the tag named “latest.”
c. If the Docker image is in a Docker registry other than Docker Hub, enter either of the following in the Docker Registry field:
– Hostname and optional port of the Docker registry, in the format hostname [ : port ]
– IP address and optional port of the Docker registry, in the format ip_address [ : port ]
If the Docker image is in Docker Hub, leave the Docker Registry field blank.
d. (Optional) If the Docker registry requires authentication before you can pull an image from it, and if you did not instruct Cisco Fog Director to remember your credentials for this registry when you previously added or upgraded a Docker app, take these actions:
– In the Registry Username field, enter the user name that authenticates you to the Docker Registry.
– In the Registry Password field, enter the password that authenticates you to the Docker Registry.
– Check the Remember these credentials check box if you want Cisco Fog Director to store the user name and password that you enter and automatically populate the Username and Password fields with this information the next time you add or upgrade a Docker app.
If you instructed Cisco Fog Director to remember your credentials for this registry when you previously added or upgraded a Docker app, the message “You have saved credentials ( username ). Use them?” displays below the Image requires authentication to pull check box. Click either of the following options that also appear:
– Yes, use them —Causes Cisco Fog Director to use the user name and password that have been stored.
– No, forget them —Causes Cisco Fog Director to no longer store the user name and password for this Docker registry. In you choose this option, enter the user name and password that authenticate you to the Docker registry in the User Name and Password fields that appear. If you want Cisco Fog Director to remember these credentials, check the Remember these credentials check box.
e. Click the Browse button next to Choose package.yaml and package_config.ini files and then follow the on-screen prompts to locate and select on your local drive the following files that relate to the Docker image:
– package.yaml (optional)—App descriptor file
– package_config.ini—Configuration parameters file
The files that you select are listed under the Browse button. To remove a file from this list, click the Remove icon next to the file.
Cisco Fog Director creates an app by packaging the Docker image and related files and adds the app.
A dialog box appear while the add process executes. This process can take some time.
Step 5 Click the Publish button on the Configuration page.
The app is published, which makes it available for upgrading, and the Apps View page displays.
Step 6 Take these actions to upgrade devices with the app that you uploaded:
a. In the Installed Apps area on the Apps View page, click the icon for the app to upgrade.
b. Click the UPGRADE button, which displays under the “Upgrade Required on” display.
The Filter Devices page displays. This page includes the items that Table 4-8 describes.
c. In the table, check the check box for each device on which you want to upgrade the app, and then click the ADD SELECTED DEVICES button.
The Upgrade Summary page displays.
e. (Optional) To change the list of devices that you selected, click the Back button, update information in the Selected Devices table as described earlier in this procedure, and then click the Next button again.
f. (Optional) In the Upgrade Summary page, check the Retain App Data check box cause the app upgrade process to retain existing information that the app has written to the device.
This information includes files and data that the app has written to the device, such as app log files and app property files, and that is stored in the /data directory for the app on the device.
If this check box is not checked, the app upgrade process deletes existing information that the app has written to the device.
This check box is checked by default.
g. (Optional) In the Upgrade Summary page, expand Selected Devices (if it is not expanded already) to see a table that displays the following information for each device that you selected for the app upgrade:
– Host Name—Hostname of the device.
– IP Address—IP address of the device.
– Tags—Tags that are assigned to the device.
– Health—Icons that represent information about CPU use or memory use on the device. Hover your mouse pointer over an icon to see more detailed information.
– Last Heard—How long ago Cisco Fog Director last communicated with the device, or a brief explanation of why the last attempt to communicate with the device was unsuccessful.
You can take the following actions in the Selected Devices area:
– Use the pagination controls to go to the first, next, last, previous, or specific page in the table.
– From the Items per page drop-down list, choose the maximum number of devices that appear in each page of the table.
– Displays the tag that has been assigned to each device See the “Managing Tags for Devices” section for related information.
– Click the VIEW INCOMPATIBLE DEVICES button (if this button is not dimmed) to see a table that provides information about devices that you selected but on which the app cannot be upgraded. This table includes the following items:
- Host Name—Hostname of the device.
- IP Address—IP address of the device.
- Tags—Tags that are assigned to the device.
- Health—Icons that represent information about CPU use or memory use on the device. Hover your mouse pointer over an icon to see more detailed information.
- Incompatibility Cause—A brief description of why the app cannot be upgraded on the device.
You can click a pagination control to go to the first, next, last, previous, or specific page in the table. From the Items per page drop-down list you can choose the maximum number of devices that appear in each page of the table.
h. (Optional) In the Upgrade Summary page, expand Customize Configuration to instruct Cisco Fog Director whether to retain or update existing configuration information for the app.
This area includes sub areas for each version of the app that currently is installed on a device. You can expand a sub area to display and update designated app configuration information for the corresponding app version. The information that displays is defined in the package_config.ini file for the app.
The fields that a sub area displays and the action that Cisco Fog Director takes when you upgrade the app depend on the status of the Retain app configuration changes done on selected devices and merge configuration from this version check box as follows:
– Checked—The fields that display are new configuration fields that are available in this version of the app. The value in each field is the default value for that item as defined by the app. You can make updates as needed in these fields. The upgrade process applies the configuration information in these fields but makes no changes to configuration information that exists for the current version of the app on a device.
– Unchecked—The fields that display are all configuration fields (both new in this version and existing) that are available in this version of the app. The value in each field is the default value for that item as defined by the app. You can make updates as needed in these fields. The upgrade process applies the configuration information in these fields and overwrites configuration information that exists for the current version of the app on a device.
This check box is checked by default.
i. (Optional) In the Upgrade Summary page, expand Configure Action Plan to choose, view, modify or add an action plan.
The action plan designates how many times and at what interval Cisco Fog Director retries an action if the action fails on a device due to certain device reachability or network connectivity issues. If Cisco Fog Director cannot complete the app upgrade action on a device after the number of retries that the action plan designates, the app upgrade does not complete on the device.
When you expand Configure Action Plan , the Selected Action Plan field shows the name of the action plan that is in effect. The Details field describes the number of retries and time between retries that the selected action plan defines.
You can choose the action plan that you want from the Selected Action Plan drop-down list.
For information about modifying or adding action plans, see the “Using Action Plans” section.
j. (Optional) In the Upgrade Summary page, expand Network Status to view network, resource, and related information for apps and devices.
The Network Status area displays the following information:
– How many of the devices that you selected for installation of the app are reachable. (“Reachable” means that Cisco Fog Director can communicate with the device.) Hover your mouse pointer over a graph to see more detailed information.
– The device squares in the box in the middle of the area. Each box represents a device on which you are installing the app. You can hover your mouse pointer over a device square to display the following information:
- Cartridges —Cisco cartridges that a PAAS app requires to run. These cartridges must already be uploaded to Cisco Fog Director (see Chapter 7, “Managing Cartridges”) and are installed automatically on the device as part of the app installation process.
- CPU Availability —Number of free CPU units on the device.
- Memory Availability —Amount of free RAM, in MB, on the device.
– How often the Cisco Fog Director updates the information in this area. You can choose a value from the Collect resource usage at least every drop-down list. Options are Every 15 mins , Every 1 hour , Every 4 hour , Every 8 hour , Every 16 hour , and Never ever .
k. Click the DONE, LET’S GO button.
The App Configuration page displays, as described in the “Viewing Detailed Information about an Installed or Available App” section.
While the app is upgrading on a device, the status of the upgrade displays for that device. Click the device to see the progress of the upgrade. You can click the ABORT button under the status display to abort the upgrade action, as described in the “Aborting an Action” section.
If the Actions Failed display on this page indicates that the upgrade failed on any device, you can take any of these actions:
After you upgrade an app, you can revert to the most recent previously installed version of that app, if needed.
The following sections provide additional information:
If you have upgraded an app and then published the upgraded version, you can revert to the previous version of the app.
To revert to the previous version of a published app, follow these steps:
Step 1 Uninstall the app from each device on which it is installed, as described in the “Uninstalling an App” section.
Step 2 Unpublish the app, as described in the “Unpublishing an App” section.
The previous version of the app displays in the Published area on the Apps View page.
If you have upgraded an app but not published the upgraded version, you can revert to the previous version of the app.
To revert to the previous version of an unpublished app, remove the app as described in the “Removing an App” section. The previous version of the app displays in the Unpublished area on the Apps View page.
Removing an app removes it from Cisco Fog Director.
To remove an app, follow these steps:
Step 1 Uninstall the app as described in the “Uninstalling an App” section.
The app moves to the Available Apps area on the Apps View page.
Step 2 In the Available Apps area, click SWITCH TO APP EDIT VIEW .
Step 3 Click the Remove button under the icon for the app.
The app moves to the Unpublished Apps area on the Apps View page.
Step 4 In the Unpublished Apps area, click the Remove button under the icon for the app.
You can add or update the following items for an app:
This icon comes from an image file that you specify. The image size should be 250 x 250 pixels. The system accepts images that are other sizes, but those images are scaled and may not appear as desired. The image file can in any of these formats: ai, bmp, drw, gif, ico, jpe, jpeg, jpg, pct, png, psd, psp, raw, scf, svg, svgz, tif, or tiff.
To add or update an icon, description, or release notes for an app, follow these steps:
Step 1 If you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for which you want to add or update the icon, description, or release notes.
Step 2 To add or update an icon, take these actions:
b. Follow the on-screen prompts to locate and select the image file for the icon that you want.
Step 3 To add or update a description, take these actions:
a. Click Edit next to “Description.”
b. In the edit area that displays, type the description. You can use the formatting tools at the top of the Edit area to format the text and perform related operations.
Step 4 To add or update release notes, take these actions:
a. Click Edit next to “Release Notes.”
b. In the edit area that displays, type the notes. You can use the formatting tools at the top of the Edit area to format the text and perform related operations.
You can reconfigure a variety of items that apply to an app. Depending on the app, items that you can reconfigure include:
The following sections provide additional information:
To view options for reconfiguring an app, take either of these actions:
If you clicked Edit Configuration from the App Configuration page, the Reconfigure App page displays, which displays that includes the items that Table 4-10 describes.
You can reconfigure an app from the Apps View page or the Devices View page, as described in the following sections:
If you are reconfiguring an app that provides services, you must first uninstall other apps that uses the services that this app provides.
Reconfiguring an app from the Apps View page is useful if you want to apply the reconfiguration to multiple devices.
Cisco Fog Director associates an action plan with each app reconfiguration procedure that you perform. An action plan instructs Cisco Fog Director to retry a reconfiguration if the reconfiguration fails due to certain conditions, or to perform the reconfiguration within a designated maintenance window. By default, the action plan causes Cisco Fog Director to perform the reconfiguration immediately and to retry a failed reconfiguration up to 10 times at 2 minute intervals. You can change these parameters as needed when you perform the app reconfiguration procedure. For more information, see the “Using Action Plans” section.
To reconfigure an app from the Apps View page, perform the following steps. The items that you can reconfigure depend on the app, so some configuration options that the following procedure includes may not be available for some apps.
Make sure that the app is installed as described in the “Installing an App” section .
Step 1 Take one of these actions:
Step 2 In the Installed Devices table, check the check box for each device on which you want to reconfigure the app.
For detailed information about this table and locating devices, see the “Reconfigure App Options” section.
Step 3 Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. The app can be reconfigured on devices that this table list. For detailed information about this table and about removing devices from this table, see the “Reconfigure App Options” section.
Step 4 To to change configuration information for this app, take these actions:
a. Click the Expand icon next to Customize Configuration .
The configuration items that display are defined in the package_config.ini file for the app.
b. Make updates as needed in the fields that appear.
The value that each field displays is the default value for that item as defined by the app. To see the current value of an item on a particular device, from the Devices tab, choose a device, and then click EDIT CONFIGURATION near the bottom of the page that displays for the device.
c. (Optional) Check the Restart app after configuration check box if you want the app to restart after you save the configuration updates. Some apps require a restart after a configuration change.
d. Click the DONE, LET’S GO button to complete the changes to configuration information.
Step 5 To reconfigure resource profiles that have been assigned for the app, take these actions:
a. Click the Expand icon next to Customize Resources , if this area is not expanded already.
b. Click the Expand icon next to Configure Resource Profiles .
You can update the resource profile for a specific device, some devices, or all devices.
The device squares in the box in the middle of the Configure Resource Profile area represent devices on which the app is installed. You can hover your mouse pointer over a device square to display the Edit Resource Profile dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and the resource profile that has been assigned for the app on the device. You can click the hostname and IP address in the dialog box to exit the reconfigure procedure and display the Device Details page for the device.
c. If you want to limit the device squares displays to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
– To change the resource profile for a specific device, hover your mouse pointer over the device square for that device, and in the Edit Resource Profile dialog box. choose a resource profile from the Select Profile drop-down list.
– To change the resource profile for all devices for which a device square displayed, click the desired profile radio button and then click the Reassign Profile button:
- Exact matching profile —Assigns the resource profile that is defined for the app in its metadata, if the resources are available on a device.
- Largest available profile —Assigns the largest resource profile that is currently available on a device.
- Allocate all available resources —Assigns all CPU and memory resources that are available on each device on which you are installing.
- Custom profile —On each device on which you are installing, assigns the CPU and memory resources that you specify. After you click this radio button, the CPU and the Memory fields appear. Enter the CPU resources, in units, and memory resources, in MB, to assign on each device. The Max value under each field shows the maximum value that you can enter without exceeding the available corresponding resource on at least one device. If you enter a value that exceeds this maximum value, the REASSIGN PROFILE button is dimmed and cannot be used.
e. If you are finished reconfiguring the app, click the EDIT RESOURCES button. Otherwise, continue to the following step.
Step 6 To reconfigure network information that relates to how the app obtains its IP address or addresses on each device, take these actions:
a. Click the Expand icon next to Customize Resources , if this area is not expanded already.
b. Click the Expand icon next to Configure Networking .
You can update the network for a specific device, some devices, or all devices.
The device squares in the box at the left of the Configure Networking area represent devices on which the app is installed. You can hover your mouse pointer over a device square to display the Edit Network Details dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and network interface information for each network interface that is defined in the package_config.ini file for the app.
The Preferred Networks sub areas at the right of the Configure Networking area provide information for each network interface that is defined in the package_config.ini file for the app. You can expand a sub area to display and update options in it.
If you want to limit the device squares to one or more specific devices, take either of these actions:
To update network information for an app on one or more devices, take either of these actions:
a. Hover your mouse pointer over the device square for that device, and in the Edit Network Details dialog box, choose a network for the corresponding network interface from the Select Network drop-down list. Network options are:
- iox-bridge # —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- iox-nat # —App obtains its IP address from an internal network address translator
b. If you choose iox-bridge # and if you want to assign a static IP address from the DHCP pool for this network interface, check the Static Mode check box that displays. If you check this check box, the network interface uses IP addresses that are dynamically assigned from the DCHP pool.
c. If you check the Static Mode check box, configure the following fields that appear as needed:
- IPv # Address and Mask fields—Enter the static address and subnet mask to use. If the IPv6required field is set to “true” in the app descriptor file (package.yaml) for an app, you must enter an IPv6 address. Otherwise, you can enter an IPv4 or an IPv6 address. If you enter an IPv6 address but a device on which you are installing the app does not support IPv6, the edit configuration operation will fail on that device.
- DNS field—(Optional) Enter the IP address of the DNS server that the app uses for external communication.
- Default Gateway field—(Optional) Enter the IP address of the default gateway that the app uses for external communication.
a. Expand the Preferred networks sub area.
b. Choose a network from the Select Network drop-down list. Network options are:
- iox-bridge # —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- iox-nat # —App obtains its IP address from an internal network address translator
c. If you choose iox-bridge # , click one of the following radio buttons that appear:
- Static — Click to assign a static IP address from the DHCP pool for this network interface
- Dynamic —Click to use a dynamically assigned IP address from the DCHP pool for this network interface
d. If you click the Static radio button, configure the following fields that appear as needed:
- IPv # Address and Mask fields—Enter the static address and subnet mask to use. If the IPv6required field is set to “true” in the app descriptor file (package.yaml) for an app, you must enter an IPv6 address. Otherwise, you can enter an IPv4 or an IPv6 address. If you enter an IPv6 address but a device on which you are installing the app does not support IPv6, the edit configuration operation will fail on that device.
- Default Gateway field—(Optional) Enter the IP address of the default gateway that the app uses for external communication.
- DNS field—(Optional) Enter the IP address of the DNS server that the app uses for external communication.
e. After you configure each network interface that you want, click the REASSIGN NETWORKS button.
Step 7 To reconfigure a VNC password that is required to access an app on devices via a VNC session, take these actions:
a. Click the Expand icon next to Customize Resources , if this area is not expanded already.
b. Click the Expand icon next to Configure VNC Password .
The device squares in the box in the middle of the Configure VNC Password area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit VNC password dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and provides a field for entering the VNC password for the device.
c. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
d. Take either of these actions:
– To set the VNC password for a specific device, hover your mouse pointer over the device square for that device, and in the Edit VNC Password dialog box, enter the password in the VNC Password field
– To set the VNC password for all devices for which a device square is displayed, enter the password in the VNC Password field that displays to the right of the device squares, and then click the thee Assign button.
Step 8 To reconfigure the number of virtual CPUs that the app requires on a device:
a. Click the Expand icon next to Customize Resources , if this area is not expanded already.
b. Click the Expand icon next to Configure VCPUs .
The device squares in the box in the middle of the Configure VCPUs area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit VCPU Details dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and the number of virtual CPUs that have been assigned for the app on the device.
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
b. Take either of these actions:
– To configure the number of virtual CPUs for a specific device, hover your mouse pointer over the device square for that device, and in the Edit VCPU dialog box, type or use the up or down arrow buttons to enter the desired value.
– To configure the number of virtual CPUs for all devices for which a device square is displayed, in the Select VCPU Value field that displays to the right of the device square, type or use the up or down arrow buttons to enter the desired value, and then click the REASSIGN VCPU button. The text above the Select VCPU Value field indicates the number of virtual CPUs that the descriptor file for the app specifies and the maximum number of virtual CPUs that you can designate for the app on the devices that you selected.
Step 9 To reconfigure the serial port that the app uses on a device, take these actions:
a. Click the Expand icon next to Customize Resources , if this area is not expanded already.
b. Click the Expand icon next to Configure Device Resource Ports .
The device squares in the box in the middle of the Configure Device Resource Ports area represent devices on which the app is installed. You can hover your mouse pointer over a device square to display the Edit Serial Details dialog box. This dialog box shows the hostname and IP address of the device, tags assigned to the device, and the serial port that has been assigned for the app on the device.
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based on a tag, choose a tag from the Show drop-down list.
b. Hover your mouse pointer over the device square for the device that you want to update, and in the Edit Serial Details dialog box, choose a port from the Select Serial Port drop-down list.
c. When you are finished reconfiguring resources, click the EDIT RESOURCES button.
Step 10 (Optional) To choose, view, modify or add an action plan, click the Expand icon next to Configure Action Plan .
The action plan designates how many times and at what interval Cisco Fog Director retries an action if the action fails on a device due to certain device reachability or network connectivity issues. If Cisco Fog Director cannot complete the app reconfiguration action after the number of retries that the action plan designates, the app reconfiguration does not complete.
When you expand Configure Action Plan , the Selected Action Plan field shows the name of the action plan that is in effect. The Details field describes the number of retries and time between retries that the selected action plan defines.
You can choose the action plan that you want from the Selected Action Plan drop-down list.
For information about modifying or adding action plans, see the “Using Action Plans” section.
Reconfiguring an app from the Devices View page applies the reconfiguration to a specified device.
To reconfigure an app from the Devices View page, follow these steps:
Make sure that the app is installed as described in the “Installing an App” section .
Step 1 On the Devices page, choose the device on which you want to reconfigure the app.
Step 2 Click Edit Configuration under the app that you want to reconfigure.
The configuration items that display are defined in the package_config.ini file for the app.
Step 3 Make updates as needed in the fields that appear.
The value that each field displays is the value for that item on the device that you chose.
Step 4 (Optional) Check the Restart app after configuration check box if you want the app to restart after you save the configuration updates. Some apps require a restart after a configuration change.
Step 5 Click the RECONFIGURE APP button.
You can use app links to associate links to external resources with an app. For example, you could include a link to a web site or document that provides information about an app, or you could include a link to a reference guide or configuration guide for an app. You can associate as many links as needed with an app.
After you configure a link for an app, the link displays under App Links on the App Configuration page, and in the Apps area on the Device Details page. Click a link to go to the configured resource.
The following sections describe how add, update, or delete app links.
To configure an app link, follow these steps:
Step 1 If you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for which you want to add links.
Step 2 Click the App Links button .
Step 3 In the first field, enter a name for the link.
For example, enter the name of the web page or a document that the link references.
Step 4 In the second field, enter the URL of the link.
Step 5 In the third field, enter a brief description of the linked resource.
Step 6 Take either of these actions:
To update or delete an app link, follow these steps:
Step 1 If you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for which you want to add links.
Step 2 Take either of these actions
Step 3 In the fields that display, update the name a name of the link, the URL of the link, or the description of the link as needed.
Step 4 Take either of these actions:
Cisco Fog Director provides the ability to abort a variety of actions after you start them. This feature is useful if you start an action that is to take place on several devices and you want to stop the action before it completes on all devices.
To use this feature, you select the devices on which to abort the action. Cisco Fog Director then does not perform the action on any selected device on which the action has not yet started. The action might continue on devices on which it has started already, but Cisco Fog Director stops monitoring and displaying status information about the action on those devices.
You can abort the following actions:
The following sections provide additional information:
Options for aborting actions appear in the Abort Ongoing Actions page. This page displays when you click the ABORT button on a page that displays after you start an action.
The Abort Ongoing Actions page displays. This page includes the items that Table 4-11 describes.
To abort an action, follow these steps:
Step 1 In the page that displays after you start the action, click the ABORT button.
The Abort Ongoing Actions page displays.
Step 2 In the Installed Devices table, check the check box for each device for which you want to abort the action.
For detailed information about this table and locating devices, see the “Abort Ongoing Actions Options” section.
Step 3 Click the ADD SELECTED DEVICES button.
The devices that you selected are added to the Selected Devices table. The action will be aborted on the devices that this table lists. For detailed information about this table and about removing devices from this table, see the “Abort Ongoing Actions Options” section.
Step 4 Click the SUBMIT button.
The action aborts on the devices that you selected. If the action has started on a device, the action might continue on that device, but Cisco Fog Director stops monitoring and displaying status information about the action on that device.
If any of the following actions fails on one or more devices, you can use the RETRY NOW button on the App Configuration page to retry the action:
Note If a failed action has an associated action plan that instructs Cisco Fog Director to retry an app, you also can manually retry the action by using the RETRY NOW button on the Actions page as described in the Outstanding and Expired Actions Management Procedure.
For detailed information about action plans, see the Using Action Plans.
The following sections provide additional information:
To view options for retrying a failed action, click the RETRY NOW button on the App Configuration page for the app.
The Select Retry Actions page displays. This page includes the items that Table 4-12 describes.
Click to retry the failed installation operation on the devices that you select in the Devices table in this area. |
|
Click to delete information about the action that failed on the devices that you select in the Devices table in this area and to clear the error from the system. |
|
Click to display the Actions History window for the devices that you select in the Devices table in this area. For a description of this window, see Table 4-13. |
|
Provides information about each device on which an installation action failed, and includes the following items:
|
|
Edit configuration on devices where configuration failed area |
|
Click to retry the failed configuration operation on the devices that you select in the Devices table in this area. |
|
Click to display the Actions History window for the devices that you select in the Devices table in this area. For a description of this window, see Table 4-13. |
|
Provides information about each device on which an edit configuration action failed. This table contains the information that the Devices table row in this table describes. |
|
Check this check box if you want the app to restart after the configuration operation completes. Some apps require a restart after a configuration change. |
|
Displays configuration items that are defined in the package_config.ini file for the app. You can make updates in these fields as needed. |
|
Click to retry the failed upgrade operation on the devices that you select in the Devices table in this area. |
|
Click to display the Actions History window for the devices that you select in the Devices table in this area. For a description of this window, see Table 4-13. |
|
Provides information about each device on which an upgrade action failed. This table contains the information that the Devices table row in this table describes. |
|
Click to retry the failed uninstall operation on the devices that you select in the Devices table in this area. |
|
Click to display the Actions History window for the devices that you select in the Devices table in this area. For a description of this window, see Table 4-13. |
|
Provides information about each device on which an uninstall action failed. This table contains the information that the Devices table row in this table describes. |
|
Allocate resource for app on devices where resource allocation failed area |
|
Click to retry the failed resource allocation operation on the devices that you select in the Devices table in this area. |
|
Click to display the Actions History window for the devices that you select in the Devices table in this area. For a description of this window, see Table 4-13. |
|
Provides information about each device on which a resource allocation action failed. This table contains the information that the Devices table row in this table describes. |
The Action History window displays when you click a VIEW TYPE ACTION HISTORY button for a failed action in the Select Retry Actions page. This window includes the items that Table 4-13 describes.
To retry a failed action, follow these steps:
Step 1 From the App Configuration page for the app, click the RETRY NOW button.
This button is available only if an action failed.
The Select Retry Actions page displays, as described in Table 4-12. This page includes areas that relate to the following failed actions types:
Step 2 (Optional) To view a history of failed actions on one or more devices, take these actions:
a. In the Devices table in the area for the type of failed action for which you want to view history, check the check box for each device for which you want to see information.
b. VIEW TYPE ACTION HISTORY button in the same area.
Step 3 Take the desired actions:
a. In the devices table, check the check box for each device on which you want to retry the action.
b. Click the REDEPLOY button to retry the installation operation on the devices that you selected, or click the REMOVE FOREVER button delete information about the action that failed on the devices that you select and to clear the error from the system.
a. In the devices table, check the check box for each device on which you want to retry the action.
b. If needed, edit information that displays tine the Customize Configuration fields. These fields display configuration items that are defined in the package_config.ini file for the app.
c. Check the Restart app after configuration check if you want the app to restart after the edit configuration operation completes. Some apps require a restart after a configuration change.
d. Click the EDIT CONFIGUATION button to retry the edit configuration operation on the devices that you selected.
a. In the devices table, check the check box for each device on which you want to retry the action.
b. Click the UPGRADE button to retry the upgrade operation on the devices that you selected
a. In the devices table, check the check box for each device on which you want to retry the action.
b. Click the UINSTALL button to retry the uninstall operation on the devices that you selected.
a. In the devices table, check the check box for each device on which you want to retry the action.
b. Click the EDIT RESOURCES button to retry the resource allocation operation on the devices that you selected.
The App Configuration page displays, as described in the “Viewing Detailed Information about an Installed or Available App” section.
While the system is retrying an action on a device, the status of the retry operation displays for that device. Click the device to see the progress of the operation. You can click the ABORT button under the status display to abort the abort the operation, as described in the “Aborting an Action” section.
An action plan is a Cisco Fog Director policy that instructs Cisco Fog Director to retry an app installation, configuration, upgrade, or uninstallation action if the action fails due to certain conditions, or to perform the action within a designated maintenance window.
Cisco Fog Director automatically associates an action plan with each app installation, configuration, upgrade, or uninstallation that you perform. By default, the action plan causes Cisco Fog Director to perform the action immediately and to retry a failed action up to 10 times at 2 minute intervals. You can change these parameters as needed when you perform an app installation, configuration, upgrade, or uninstallation procedure.
If you perform an action that has an action plan that instructs Cisco Fog Director to retry the action and the action does not complete successfully when you execute it, or if the action plan instructs Cisco Fog to perform the action in a designated maintenance window, the action will be in one of these states:
For more information about these states and how to manage actions that are in these states, including information about manually retrying or canceling future retries of an action, see the Managing Outstanding and Expired Actions for Apps.
The following guidelines apply to action plans:
This section describes how to manage action plans. Action plan management tasks include:
To manage an action plan, follow these steps:
Step 1 When performing an app installation, configuration, upgrade, or uninstallation procedure, expand Configure Action Plan when this option becomes available during the procedure.
Step 2 Take one of these actions:
You cannot modify an action plan when an action is in Outstanding state according to the plan. In this situation, the Edit Action Plan icon is dimmed.
The action plan is removed from Cisco Fog Director immediately and no further steps are needed, although you can complete the app installation, configuration, upgrade, or uninstallation procedure.
You cannot delete an action plan that is the current default or when an action is in Outstanding state according to the plan. In these situations, the delete icon is dimmed.
Step 3 In the Plan Name field, enter a descriptive name for the new action plan.
Step 4 (Optional) Check the Make this plan the default check box to make this action plan the default action plan.
Cisco Fog Director uses the default action plan if you do not choose another one when performing an action.
This check box does not appear if this action plan is the current default.
Step 5 Choose one of the following Action Type radio buttons ( Action identifies the type of procedure that you are performing when you access this option):
Step 6 From the Maintenance window type drop-down list, choose one of the following options to define the schedule for this action plan:
– Date field—Click the calendar icon and then choose the date on which the action plan should be in effect.
– From field—Click the clock icon and then choose the time on the selected date at which the action plan should begin to take effect.
– To field—Click the clock icon and then the time on the selected date after which the action plan should no longer be in effect.
– Time zone field—Specifies the time zone for the times in the From and To fields. By default, this field displays the time zone of your PC. We recommend that you use the time zone of the server on which Cisco Fog Director is running. To change the time zone that displays in this field, click this field, click its delete icon , and then start typing the time zone that you want. You can choose a time zone from the list that displays.
– From field—Click the clock icon and then choose the time on the selected date at which the action plan should begin to take effect.
– To field—Click the clock icon and then the time on the selected date after which the action plan should no longer be in effect.
– Time zone field—Specifies the time zone for the times in the From and To fields. By default, this field displays the time zone of your PC. We recommend that you use the time zone of the server on which Cisco Fog Director is running. To change the time zone that displays in this field, click this field, click its delete icon , and then start typing the time zone that you want. You can choose a time zone from the list that displays.
– Maintenance days field—Check the check box for each day on which the action plan should be in effect.
– From field—Click the clock icon and then choose the time on each day at which the action plan should begin to take effect.
– To field—Click the clock icon and then the time on the selected date after which the action plan should no longer be in effect.
– Time zone field—Specifies the time zone for the times in the From and To fields. By default, this field displays the time zone of your PC. We recommend that you use the time zone of the server on which Cisco Fog Director is running. To change the time zone that displays in this field, click this field, click its delete icon , and then start typing the time zone that you want. You can choose a time zone from the list that displays.
– Cron expression field—Enter a cron expression that defines date and time that the action plan should start. The expression should be in the format MinuteHourDateMonthDayYear , where:
- Minute —Minutes after the hour. Valid values are 1 through 59.
- Hour —Hour of the day, in 24-hour format. Valid values are 0 through 23.
- Date —Date of the month. Valid values are 1 through 31.
- Month —Month of the year. Valid values are 1 (January) through 12 (December).
- Day —Day of the week. Valid values are 1 (Sunday) through 7 (Saturday).
– Maintenance window duration field—Enter the number of minutes that the action plan should be in effect from the time that it starts.
Step 7 In the Number of times to retry failed installs field, enter the number of times that Cisco Fog Director retries a failed action.
If you do not want Cisco Fog Director to retry a failed action, enter 0 in this field.
Step 8 In the Minimum duration between retries field, enter the minimum number of minutes that Cisco Fog Director waits from the time that an action last failed before retrying the action.
In some situations, internal system factors can cause the system to wait for a time that is longer than the minimum.
Step 9 Complete the app installation, configuration, upgrade, or uninstallation procedure to save modifications that you made to this custom action plan.
You do not need to complete the procedure if you deleted this action plan.
If an action does not complete successfully when you execute it and it has an action plan that instructs Cisco Fog Director to retry a failed action, or if an action has an action plan that instructs Cisco Fog to perform the action in a designated maintenance window, the action will be in one of these states:
– The maximum number of retries that an action plan specifies for the action has been reached
– The maintenance window or windows that were scheduled for the action no longer exist
– You manually cancel future retries of the action
– The failure is not related to certain device reachability or network connectivity issues
You can manage actions that are in these states by using information and options on the Actions page.
The following sections provide additional information:
To view options for outstanding actions, click the View outstanding actions link on the App Configuration page. This link displays if one or more app actions are in Outstanding state. The following information displays:
To see detailed information about the install, edit, upgrade, or uninstall action that are in Outstanding state or Expired state, click the display for the action type that you want. The Actions page displays. This page includes the items that Table 4-14 describes.
This section describes how to manage actions that are in Outstanding state or Expired state. Management tasks include:
You also can manually retry an action as described in the “Retrying a Failed Action for an App” section, and cancel future retries for outstanding actions on a device as described in the “Device Details Area” section.
To view information about, manually retry, or cancel future retries of actions in Outstanding state or Expired state, follow these steps:
Step 1 On the App Configuration page, click the View outstanding actions link, and then click the Action display ( Install , Edit , Upgrade , or Uninstall ) for the action type that you want.
The Actions page displays. By default, this page shows devices on which the action that you chose is in Outstanding state. For descriptions of the items on this page, see Table 4-14.
Step 2 (Optional) To display information in the Devices table for devices that have actions of a specific type or in a specific state, take these actions:
– All —Displays devices on which one or more app install, configuration, upgrade, or uninstall actions are in Outstanding state or Expired state
– Install —Displays devices on which one or more app install actions are in Outstanding state or Expired state
– Edit —Displays devices on which one or more app configuration action is in Outstanding state or Expired state
– Upgrade —Displays devices on which one or more app upgrade actions are in Outstanding state or Expired state
– Uninstall —Displays devices on which one or more app uninstall actions are in Outstanding state or Expired state
Step 3 To manually retry an action or cancel future retries of an action, take these actions:
a. In the Installed Devices table, check the check box for each device on which you want to manually retry an action or cancel future retries of an action.
For detailed information about this table and locating devices, see the “Outstanding and Expired Actions Management Options” section.
b. Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. Actions will be retried or canceled on the devices that this table lists. For detailed information about this table and about removing devices from this table, see the “Outstanding and Expired Actions Management Options” section.
– RETRY NOW —Click to immediately retry the actions on the devices that are listed in the Selected Devices table.
– CANCEL OUTSTANDING —Click to stop Cisco Fog Director from retrying the action on the devices that are listed in the Selected Devices table.
Choosing this option cancels the action plan that is in effect for the action on this device and moves the action on this device to Expired state. In his situation, Cisco Fog Director no longer retries the action or runs it a future maintenance window.
The Cisco Fog Director export and import features let you back up and restore apps. These features can be useful for creating an archive of apps or for importing apps to another Cisco Fog Director.
The export feature saves all apps that appear in the Available and the Unpublished areas on the Apps View page to a zip file outside of Cisco Fog Director. The import feature restores apps that have been exported to a zip file.
The following sections describe these features in detail:
Exporting apps lets you save apps in an export file, which is a zip file named exportedApps.zip that is stored outside of Cisco Fog Director. This action affects all apps that appear in the Available and the Unpublished areas on the Apps View.
`To export an app, follow these steps:
Step 1 In the Available Apps area on the Apps View page, make sure that you are in App Edit view, and then click the EXPORT APPS button.
Step 2 Follow the on-screen prompts to save the app in the location of your choice.
The file is named exportedApps.zip.
When you import apps that you exported as described in the “Exporting Apps” section, the apps are added to Cisco Fog Director. If an app already exists in the Cisco Fog Director to which you are importing, the app is not restored.
To import an app, follow these steps:
Step 1 On the Apps View page, take either of these actions:
Step 2 In the Import Apps dialog box that displays, click the Select Apps Archive button.
Step 3 Follow the on-screen prompts to locate and select the exportedApps.zip export file that you want to import.
When the import process completes, the Import Apps Dialog box confirms the completion. It also provides information about any apps that could not be imported (you might need to scroll down in the dialog box to see this information).
Monitoring an app provides information about the operation of an app across all devices on which it is installed. This information can be useful for evaluating the operation of the app or for troubleshooting. The following sections describe the app monitoring features:
To view general monitoring information about an installed app, take any of these actions:
The App Monitoring page displays. This page includes information and features that apply to the app, and includes some or all of the items that Table 4-15 describes.
Shows the number of devices on which the app has been successfully installed. |
|
Click to display detailed information about the app, as described in the “Viewing Detailed Information about an Installed or Available App” section. |
|
Shows the number of devices on which the app has been in Running state or in Stopped state during the designated time period. Hover your mouse pointer over any part of the chart to see detailed information about a data point. You can click Day , Week , or Month above this graph to designate the time period for the information. |
|
Show information about devices on which an app is running and on which an app is stopped. For each state, a chart shows the name of the state, and the number of devices on which the app is in that state, and the percentage of devices on which the app is installed that the app is in that state. You can click the following buttons under a status chart:
Note You also can start and stop an app from the Devices View page as described in the “Starting or Stopping an App on a Device” section. |
|
Appears if Cisco Fog Director has detected one or more alerts for the app and you have not yet responded to the alerts. This area includes these items:
See the “Managing App Alerts” section. |
|
Appears if you click Critical Issue s, Warnings , or Info Events in the Alert Information area and provides information about each active alert for the app. Includes the following items:
|
|
Displays the following charts, which provide information about device resources that the app consumes:
You can click Day , Week , or Month above these charts to designate the time period for the information that the charts display. Hover your mouse pointer over any part of a chart to see detailed information about a data point. Click a chart to display a table with detailed information about the corresponding resource consumption for individual devices. The tables include the following items:
|
To view general monitoring information about an installed app, click either of these buttons on the App Monitoring page:
This button is dimmed if the app is not in the Running state on at least one device.
This button is dimmed if the app is not in the Stopped state on at least one device.
The Running Devices or Stopped devices tab in the table provide information for devices on which the app is in the corresponding state. The Error tab provides information about devices on which the app is in an error state of some kind.
This table includes the items that Table 4-5 describes.
Type all or part of a hostname or IP address of a device to display information for devices with matching information. The table display updates as you type. |
|
Hostname of the device on which the app is in the state. Click a hostname to display device details information for the device. See the “Viewing Detailed Information about a Device” section . |
|
IP Address of the device on which the app is in the state. Click an IP address to display device details information for the device. See the “Viewing Detailed Information about a Device” section . |
|
Tags that have been assigned to the device. See the “Managing Tags for Devices” section. |
|
Icons that represent information about CPU use or memory use on the device. Hover your mouse pointer over an icon to see more detailed information. |
|
View App Log
button |
Click to display log information that is generated by the app on a device. |
Click a control to go to the first, next, last, previous, or specific page in the table. From the Items per page drop-down list, choose the maximum number of devices that appear in each page of the table. |
Cisco Fog Director generates alerts in various situations. An alert is information that the system collects and provides when it detects certain issues with an app or device.
Each alert has one of the following types, depending on the situation that caused Cisco Fog Director to generate the alert:
In addition, each app has one of the following severity levels, which helps you determine the importance of the alert:
Cisco Fog Director provides detailed alert information on the Alerts page and on the App Monitoring page. An alert that Cisco Fog Director displays on these pages is an active alert . You can choose to ignore any alert, which permanently removes if from the display on these pages and from Cisco Fog Director.
The following sections provide additional information:
To display options for viewing and ignoring alerts for an app take either of these actions:
The Alerts page displays. This page includes the items that Table 4-17 describes.
If you accessed this page from the Apps View page, the App Alerts table shows by default all active alerts. If you accessed this page from the App Monitoring page, the App Alerts table shows by default only alerts that match the severity that you chose (critical, warning, or info).
You remove an app alert from Cisco Fog Director by choosing to ignore it. When you ignore an app, it is removed from the Alerts page, from the alert counters on the Apps View page, and from the Alert Information area and the Alerts table on the App Monitoring page.
To ignore an app alert, follow these steps:
Step 1 Take either of these actions:
The Alerts page displays. If you accessed this page from the Apps View page, the App Alerts table shows by default all active alerts. If you accessed this page from the App Monitoring page, the App Alerts table shows by default only alerts that match the severity that you chose (Critical Issues, Warning, or Info Events).
Step 2 In the App Alerts table, check the check box for each alert that you want to ignore.
For detailed information about this table and locating alerts, see the “App Alert Options” section.
Step 3 Click the ADD SELECTED ALERTS button.
The alerts that you selected are added to the Selected Alerts table. You can ignore the alerts that this table lists. For detailed information about this table and about removing alerts from this table, see the “App Alert Options” section.
Step 4 Click the IGNORE button, which appears under the Selected Alerts table