From ce9c5631e507fc23817d8c589666fb7487c65214 Mon Sep 17 00:00:00 2001 From: Jay Faulkner Date: Fri, 10 Jun 2016 16:58:47 -0700 Subject: [PATCH] Add basic information on using these examples --- README.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.rst b/README.rst index 2cc23b4..088b91a 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,9 @@ ipa-example-hardware-managers Example hardware managers for use with the `ironic python agent `_. +Examples and Use Cases Provided +=============================== + Example Device Hardware Manager ------------------------------- @@ -30,3 +33,15 @@ Use Cases include: * Asserting truths about the node; such as number of disks or total RAM. * Reporting metrics about the node's hardware state. * Overriding logic of get_os_install_device(). + + +Make your own Manager based on these +==================================== +To make your own hardware manager based on these examples, copy or fork the +relevant examples out of this repository. Modify classnames and entrypoints +in setup.cfg to be not-examples. + +Since the entrypoints are defined in setup.cfg, simply installing your new +python package alongside IPA in a custom ramdisk should be enough to enable +the new hardware manager. +