Configuration Guide for Cisco NCS 1004, IOS XR Release 25.x.x

PDF

Configuration Guide for Cisco NCS 1004, IOS XR Release 25.x.x

Third party RPMs installation using App Manager install UI

Want to summarize with AI?

Log in

Explains how third party RPMs add new capabilities to your system by utilizing App Manager's install interface.


A third party RPM is a package file that

  • provides additional software features or capabilities not included with the base system,
  • enables integration of external applications and tools, and
  • extends system functionality through easy installation in App Manager at runtime.
App Manager's install user interface allows you to install third party RPMs during runtime while the router is operational. This feature simplifies the addition of new capabilities to your system. To install a third party RPM, select the desired package in the App Manager install UI and follow the installation steps as prompted.

Limitations for installing third-party RPMs

These limitations apply to installing third-party RPMs with the App Manager:
  • RPM must not have “scriptlets”. Scriptlets allow packages to run code on installation and removal.

  • RPM must not be already installed via XR Install UI.

  • RPM must not be already installed via App manager UI.

  • TP RPMs must install files only to the /var/lib/docker/appmgr/ filesystem location.

  • RPM Signature verification is not enforced by App Manager Install UI. It supports unsigned TP RPMs.


Install third party RPMs using App Manager install UI

Enable installation of third-party applications packaged as RPMs onto the device using the App Manager Install UI.
Use this task when you need to deploy custom or third-party Docker container applications on your device through App Manager.

Use this task to install third party RPMs using App Manager install UI.

Procedure

SUMMARY STEPS

  1. Create an RPM containing the application (in the form of a docker container image).
  2. Use App manager RPM build tool to generate TP RPMs. See https://github.com/ios-xr/xr-appmgr-build/blob/main/README.md.
  3. Install the TP RPM using the App Manager Install UI command.

DETAILED STEPS

1.

Create an RPM containing the application (in the form of a docker container image).

2.

Use App manager RPM build tool to generate TP RPMs. See https://github.com/ios-xr/xr-appmgr-build/blob/main/README.md.

3.

Install the TP RPM using the App Manager Install UI command.

Example:

RP/0/RP0/CPU0:ios# appmgr package install rpm /harddisk\:/alpine-0.1.0-XR_7.3.1.x86_64.rpm
The third-party RPM package is successfully installed, making the application available through App Manager.

Uninstall third party RPMs using App Manager install UI

Remove third party RPMs to maintain system cleanliness and ensure optimal performance.
You can uninstall third party RPMs (TP RPMs) from your system using the App Manager install UI. This feature enables you to safely remove applications while NCS 1004 is running. Uninstallation can be performed in two ways: by specifying either the source name or the package name.

App Manager uninstall CLI uninstalls the TP RPM at runtime, ensuring continuous operation of the NCS 1004 device.

Procedure

SUMMARY STEPS

  1. Decide whether you want to uninstall the RPM using the source name or the package name.
  2. If uninstalling by source name, enter this command:
  3. If uninstalling by package name, enter this command:
  4. Confirm the removal as prompted by the CLI. The application will be uninstalled at runtime without interrupting other system operations.

DETAILED STEPS

1.

Decide whether you want to uninstall the RPM using the source name or the package name.

2.

If uninstalling by source name, enter this command:

Example:

RP/0/RP0/CPU0:ios# appmgr package uninstall source alpine
3.

If uninstalling by package name, enter this command:

Example:

RP/0/RP0/CPU0:ios# appmgr package uninstall package alpine-0.1.0-XR_7.3.1.x86_64
4.

Confirm the removal as prompted by the CLI. The application will be uninstalled at runtime without interrupting other system operations.