git.ozlabs.org Git - petitboot/blob - doc/func/plugins.rst

   1 .. _plugins:
   2
   3 Plugins
   4 =======
   5
   6 Petitboot "plugins" provide a convenient way to package and run binaries in the Petitboot shell that would be difficult to distribute in the Linux image due to size, dependency, or licensing constraints.
   7
   8 Plugin usage and the plugin ABI are well documented in the OpenPOWER docs repository here:
   9
  10 `Plugin Usage & Construction <https://github.com/open-power/docs/blob/master/opal/petitboot-plugins.txt>`_
  11
  12 `Plugin Specification & ABI <https://github.com/open-power/docs/blob/master/opal/petitboot-plugin-spec.txt>`_
  13
  14 Petitboot will scan local devices for pb-plugin files, and will also recognise the "plugin" label in PXE network files, eg:
  15
  16 .. code-block:: none
  17
  18    label Install Ubuntu 18.04
  19         kernel tftp://server/ubuntu-18.04-ppc64el/vmlinux
  20         initrd tftp://server/ubuntu-18.04-ppc64el/initrd.gz
  21         append tasks=standard pkgsel/language-pack-patterns= pkgsel/install-language-support=false
  22
  23    plugin RAID Setup
  24         tarball http://server/path/to/plugin-raid-1.0.pb-plugin
  25
  26 Discovered plugins will be listed in the Plugin screen and can be installed and run from there, or run manually from the shell.
  27