Managing cartridges on the platform

A cartridge is a deployable, pluggable piece of software that provides functionality and content to be consumed by the requesting application or service on an IOx node.

Refer cartridge documentation for more details

Cartridge management commands:

~$ ioxclient  cartridge
NAME:
   ioxclient cartridge - Create/Delete/List cartridges

USAGE:
   ioxclient cartridge command [command options] [arguments...]

COMMANDS:
   list, li		List all existing cartridges
   install, in		Install a cartridge from its archive
   uninstall, unin	Uninstall a cartridge
   upgrade, upgr	Upgrade a cartridge
   info, inf		View information of a cartridge
   help, h		Shows a list of commands or help for one command

OPTIONS:
   --help, -h			show help
   --generate-bash-completion

List cartridges installed on the system

~$ ioxclient  cartridge list
Currently using profile :  d829
Command Name: cartridge-list
List of installed cartridges :
 1. Python_2.7_1.0_x86_64 : Python 2.7, Python 2.7 language runtime bundle
 2. Yocto_1.7.2_for_IR800_1.0_x86_64 : Yocto 1.7.2 for IR800, Yocto 1.7.2 iox-core-image-minimal rootfs

Installing a cartridge

~$ ioxclient  cartridge install ~/Downloads/cartridges/ir800_yocto-1.7.2_zre1.8.0_65.8.10.0.1.tar
Currently using profile :  d829
Command Name: cartridge-install
Installation Successful. Cartridge is available at :  https://10.78.106.63:8443/iox/api/v2/hosting/cartridges/Azul_Java_1.8_for_IR800_1.0_x86_64

Get cartridge information

~$ ioxclient  cartridge info Azul_Java_1.8_for_IR800_1.0_x86_64
Currently using profile :  d829
Command Name: cartridge-info
Details of Cartridge : Azul_Java_1.8_for_IR800_1.0_x86_64
-----------------------------
{
 "author": "Cisco Systems",
 "authorLink": "http://www.cisco.com",
 "cpuarch": "x86_64",
 "dependson": [
  {
   "id": "urn:cisco:system:cartridge:baserootfs:yocto",
   "version": "1.7.2"
  }
 ],
 "description": "Java 1.8 language runtime bundle 1.8.0_65-8.10.0.1",
 "handleas": [
  "overlay",
  "mountable"
 ],
 "id": "Azul_Java_1.8_for_IR800_1.0_x86_64",
 "name": "Azul Java 1.8 for IR800",
 "payload": "ir800_yocto-1.7.2_zre1.8.0_65.8.10.0.1.ext2",
 "provides_info": [
  {
   "id": "urn:cisco:system:cartridge:language-runtime:java",
   "used_by": [],
   "version": "1.8"
  }
 ],
 "runtime": "None",
 "runtime_version": "None",
 "type": "language-runtime",
 "version": "1.0"
}

Uninstalling a cartridge

~$ ioxclient  cartridge uninstall Azul_Java_1.8_for_IR800_1.0_x86_64
Currently using profile :  d829
Command Name: cartridge-uninstall
Successfully uninstalled cartridge Azul_Java_1.8_for_IR800_1.0_x86_64

Upgrading a cartridge

~$ ioxclient  cartridge upgrade
NAME:
   upgrade - Upgrade a cartridge

USAGE:
   command upgrade <cartridge_id> <cartridge_archive>