Golden ISO Workflow

The following image shows the workflow for building and installing golden ISO.

Build Golden ISO

The customized ISO is built using Cisco Golden ISO (GISO) build script gisobuild.py available on the github location https://github.com/ios-xr/gisobuild.

The GISO build script supports automatic dependency management, and provides these functionalities:

Builds RPM database of all the packages present in package repository.
Skips and removes Cisco RPMs that do not match the mini-x.iso version.
Skips and removes third-party RPMs that are not SMUs of already existing third-party base package in mini-x.iso.
Displays an error and exits build process if there are multiple base RPMs of same release but different versions.
Performs compatibility check and dependency check for all the RPMs. For example, the child RPM is dependent on the parent RPM . If only the child RPM is included, the Golden ISO build fails.

To build GISO, provide the following input parameters to the script:

Base mini-x.iso (mandatory)
XR configuration file (optional)
one or more Cisco-specific SMUs for host, XR and System admin (mandatory)
one or more third-party SMUs for host, XR and System admin (mandatory)
Label for golden ISO (optional)

Note

Golden ISO can be built only from mini ISO. The full or fullk9 bundle ISO is not supported.

Use the following naming convention when building GISO:


GISO Build	Format	Example
GISO without k9sec RPM	`<platform-name>-golden-x.iso-<version>.<label>` `<platform-name>-golden-x-<version>.iso.<label>`	<platform-name>-golden-x64.iso-<version>.v1 <platform-name>-golden-x64-<version>.iso.v1
GISO with k9sec RPM	`<platform-name>-goldenk9-x.iso-<version>.<label>` `<platform-name>-goldenk9-x-<version>.iso.<label>`	<platform-name>-goldenk9-x64.iso-<version>.v1 <platform-name>-goldenk9-x64-<version>.iso.v1

Note

To successfully add k9sec RPM to GISO, change the permission of the file to 644 using the chmod command.

chmod 644 [k9 sec rpm]

To build GISO, perform the following steps:

Before you begin

To upgrade from non-GISO to GISO version, it is mandatory to first upgrade to mini ISO with GISO support.
The system where GISO is built must meet the following requirements:
- System must have Python version 2.7 and later.
- System must have free disk space of minimum 3 to 4 GB.
- Verify that the Linux utilities mount, rm, cp, umount, zcat, chroot, mkisofs are present in the system. These utilities will be used by the script. Ensure privileges are available to execute all of these Linux commands.
- Kernel version of the system must be later than 3.16 or later than the version of kernel of Cisco ISO.
- Verify that a libyaml rpm supported by the Linux kernel is available to successfully import yaml in the tool.
- User should have proper permission for security rpm(k9sec-rpm) in rpm repository, else security rpm would be ignored for Golden ISO creation.
The system from where the gisobuild script is executed must have root credentials.

Procedure

Step 1

Copy the script gisobuild.py from the github location https://github.com/ios-xr/gisobuild to an offline system or external server where the GISO will be built. Ensure that this system meets the pre-requisites described above in the Before You Begin section.

Step 2

Run the script gisobuild.py and provide parameters to build the golden ISO off the router. Ensure that all RPMs and SMUs are present in the same directory. The number of RPMs and SMUs that can be used to build the Golden ISO is 128.

Note

The -i option is mandatory, and either or both -r or -c options must be provided.

[directory-path]$ gisobuild.py [-h] [-i <mini-x.iso>] [-r <rpm repository>] 
[-c <config-file>] [-l <giso label>] [-m] [-v]

The following example shows the script output:

where:

-i is the path to mini-x.iso
-r is the path to RPM repository
-c is the path to XR config file
-l is the golden ISO label
-h shows the help message
-v is the version of the build tool gisobuild.py
-m is to build the migration tar to migrate from IOS XR to IOS XR 64 bit

GISO is built with the RPMs placed in respective folders in the specified directory and also includes the log files giso_summary.txt and gisobuild.log-<timestamp>. The XR configuration file is placed as router.cfg in the directory.

Note

The GISO script does not support verification of XR configuration.

What to do next

Install the golden ISO on the router.

Install Golden ISO

Golden ISO (GISO) automatically performs the following actions:

Installs host and system admin RPMs.
Partitions repository and TFTP boot on RP.
Creates software profile in system admin and XR modes.
Installs XR RPMs. Use show instal active command to see the list of RPMs.
Applies XR configuration. Use show running-config command in XR mode to verify.

Procedure

Step 1

Download GISO image to the router using one of the following options:

PXE boot: when the router is booted, the boot mode is identified. After detecting PXE as boot mode, all available ethernet interfaces are brought up, and DHClient is run on each interface. DHClient script parses HTTP or TFTP protocol, and GISO is downloaded to the box.
When you bring up a router using the PXE boot mode, existing configurations are removed. To recover smart licensing configurations like Permanent License Reservation (PLR), enable these configurations after the router comes up.
```
Router# configure
Router(config)# license smart reservation
Router(config)# commit
```
USB boot or Disk Boot: when the USB mode is detected during boot, and GISO is identified, the additional RPMs and XR configuration files are extracted and installed.

System Upgrade when the system is upgraded, GISO can be installed using install add , install activate , or using install replace commands.

Important

To replace the current version and packages on the router with the version from GISO, note the change in command and format.

In versions prior to Cisco IOS XR Release 6.3.3, 6.4.x and 6.5.1, use the install update command:
```
install update source <source path> <Golden-ISO-name> replace
```
In Cisco IOS XR Release 6.5.2 and later, use the install replace command.
```
install replace <absoulte-path-of-Golden-ISO>
```

The options to upgrade the system are as follows:

system upgrade from a non-GISO (image that does not support GISO) to GISO image: If a system is running a version1 with an image that does not support GISO, the system cannot be upgraded directly to version2 of an image that supports GISO. Instead, the version1 must be upgraded to version2 mini ISO, and then to version2 GISO.
system upgrade in a release from version1 GISO to version2 GISO: If both the GISO images have the same base version but different labels, install add and install activate commands does not support same version of two images. Instead, using install update command installs only the delta RPMs. System reload is based on restart type of the delta RPMs.
system upgrade across releases from version1 GISO to version2 GISO: Both the GISO images have different base versions. Use install add and install activate commands, or install replace command to perform the system upgrade. The router reloads after the upgrade with the version2 GISO image.

Step 2

Run the show install repository all command in System Admin mode to view the RPMs and base ISO for host, system admin and XR.

Step 3

Run the show install package <golden-iso> command to display the list of RPMs, and packages built in GISO.

The ISO, SMUs and packages in GISO are installed on the router.

Install Replace with Golden ISO

Golden ISO (GISO) upgrades the router to a version that has a predefined list of software maintenance update (SMUs) with a single operation. However, to update to the same version with a different set of SMUs requires a two-step process.

To avoid this two-step process, use the install replace command to replace the currently active version with the full package including the image an SMUs from the newly added GISO.

The process involves upgrading the GISO to add the delta SMUs, and manually deactivating the SMUs that are not in use. In addition, this is the only method to upgrade to GISO containing different optional RPMs, which is a subset of the running set of optional RPMs. For example, consider V1 of GISO is the running version with V1 mini and optional RPMs V1 mpls, V1 mpls-te, V1 mgbl, and V1 k9sec. If V2 of GISO does not contain V2 k9sec, then use install replace to upgrade to the optional RPMs in V2.

Important

To replace the current version and packages on the router with the version from GISO, note the change in command and format.

In versions prior to Cisco IOS XR Release 6.3.3, 6.4.x and 6.5.1, use the install update command:
```
install update source <source path> <Golden-ISO-name> replace
```
In Cisco IOS XR Release 6.5.2 and later, use the install replace command.
```
install replace <absoulte-path-of-Golden-ISO>
```

Note

The replace keyword in install update command is supported only with GISO, but not with .mini and .rpm packages directly.

Procedure

Step 1

install replace <GISO-location> [commit| noprompt]

Example:

Router#install replace harddisk:/<dir>/<giso-image>.iso
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Install operation 11 started by root:
exec-timeout is suspended.
No install operation in progress at this moment
Label = More_Pkgs
ISO <giso-iso-image>.iso in input package list. Going to upgrade the system to 

version <new-giso-image>.
System is in committed state
Current full-label: <giso-image>_R_Commit
Current only-label: R_Commit
Current label: R_Commit
Updating contents of golden ISO
Scheme : localdisk
Hostname : localhost
Username : None
SourceDir : /ws
Collecting software state..
Getting platform
Getting supported architecture
Getting active packages from XR
Getting inactive packages from XR
Getting list of RPMs in local repo
Getting list of provides of all active packages
Getting provides of each rpm in repo
Getting requires of each rpm in repo
Fetching .... <giso-image>.iso
Label within GISO: More_Pkgs
Skipping <platform>-mgbl-3.0.0.0-<release>.x86_64.rpm from GISO as it's active 
Adding packages 
        <platform>-golden-x-<release>-<Label>.iso
RP/0/RP0/CPU0:Jun 20 14:43:59.349 UTC: sdr_instmgr[1164]: %INSTALL-INSTMGR-2-OPERATION_SUCCESS : 

Install operation 12 finished successfully 
Install add operation successful
Activating <platform>-golden-x-<release>-<Label>
Jun 20 14:44:05 Install operation 13 started by root:
  install activate pkg <platform>-golden-x-<release>-<Label> replace noprompt 
Jun 20 14:44:05 Package list:
Jun 20 14:44:05     <platform>-golden-x-<release>-<Label>.iso
Jun 20 14:44:29 Install operation will continue in the background
exec-timeout is resumed.
Router# Install operation 13 finished successfully
Router: sdr_instmgr[1164]: %INSTALL-INSTMGR-2-OPERATION_SUCCESS : 

Install operation 13 finished successfully

For Cisco IOS XR Release 7.1.1, use the command install replace harddisk:/<dir>/<giso-image>.iso.

Important

For versions earlier than Cisco IOS XR Release 6.5.2, use the following command:

install update source <absolute-path-of-Golden-ISO> replace

For example,

Router#install update source harddisk:/ <giso-image>.iso replace

The version and label of the newly added GISO is compared with the version and label of the currently active version. If a mismatch is identified, a new partition is created and the full package is installed. After installation, the system reloads with the image and packages from the newly added GISO.

Note

Activating or deactivating on a system that has a valid label invalidates the label. This action is irreversible. For example, running show version command on the system displays the label 6.3.3_633rev1005. If any SMU is activated or deactivated on the system, the label 633rev1005 is invalidated, and the show version command displays only 6.3.3 as the label.

Step 2

show version

Example:


Router#show version
Wed Jun 20 15:06:37.915 UTC
Cisco IOS XR Software, Version <new-giso-image>
Copyright (c) 2013-2018 by Cisco Systems, Inc.

Build Information:
Built By     : <user>
Built On     : <date>
Build Host   : <host-name>
Workspace    : <workspace-name>
Version      : <version>
Location    : <path>
Label        : <label-name>

cisco <platform> () processor 
System uptime is 3 hours 51 minutes

The system loads with the image and packages from the newly added GISO.

System Setup and Software Installation Guide for Cisco NCS 540 Series Routers, IOS XR Release 7.2.x

Book Title

Chapter Title

Results

Chapter: Golden ISO Workflow

Golden ISO Workflow

Build Golden ISO

Before you begin

Procedure

What to do next

Install Golden ISO

Procedure

Install Replace with Golden ISO

Procedure

Example:

Example:

Was this Document Helpful?

Contact Cisco

Related Cisco Community Discussions