-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Hi Russ, thank you for valuable input. I will speak just for LMI
metacommand and leave the rest to Peter H.
See my notes embedded below.
On 10/01/2014 06:02 PM, Russell Doty wrote:
First of all, I'm extremely impressed with the documentation
overhaul! I apologize for not responding sooner; as a feeble excuse
I was on PTO last week.
These comments cover LMIShell and LMI Metacommand. I will look at
the other sections later.
Notes on LMIShell
*
http://docs.openlmi.org/en/latest/openlmi-tools/shell/classes.html
"Each class in LMIShell represents a class provided by a CIMOM" -
I think of the class as being implemented in a Provider and
accessed through the CIMOM. The CIMOM is basically an access method
to get to Providers.
Under Synchronous Methods should we mention that most methods we
have implemented are asynchronous, and that you can launch them and
then do other things while waiting for the method to finish?
Perhaps add a section on this before the Synchronous Methods
section?
*
http://docs.openlmi.org/en/latest/openlmi-tools/shell/associated_objects....
Would it be worthwhile having a brief discussion of what
associations are and how you use them to navigate the CIM object
model?
*
http://docs.openlmi.org/en/latest/openlmi-tools/shell/indications.html
We should mention that an Indicator is an event or alert that
signals a change on the managed system. Explain that an Indication
is produced by a Provider and received by a Listener or indication
handler. Mention that indications are built into Providers and that
you can find them in the Provider documentation.
General notes:
It would be nice to mention the standard scripts - what they are
intended for and where they live. Perhaps choose one as an example
and show how to use it and describe the various sections. Mention
that these scripts represent examples of recommended best practices
for LMIShell scripts. Mention that these scripts are also intended
to be copied and modified for specific purposes.
Notes on LMI Metacommand
Should this chapter come before the LMIShell chapter? LMI
Metacommands are likely to be the entry point into OpenLMI for most
sysadmins.
You've got a point here. Command-line interface is more easily
accessible indeed.
*
http://docs.openlmi.org/en/latest/openlmi-tools/scripts/commands/logicalf...
We should mention that goals of the file command. Specifically,
that it is not intended to be a general purpose file manipulation
command, and that it does not have the ability to create, delete,
or copy individual files.
Sound reasonable. I'll try to explain it there. Maybe
it would be
worth to mention it directly in the command's usage.
*
http://docs.openlmi.org/en/latest/openlmi-tools/scripts/commands/powerman...
Note that the lmi power command is running inside the OS of the
managed system. Thus, it does not have the ability to power-on a
system. Power-on can be done manually or by accessing a BMC or
managed power switch. Power-on is currently out of scope for
OpenLMI and the LMI metacommand.
Hmm, it may be not obvious to someone. I'll
mention it as well.
*
http://docs.openlmi.org/en/latest/openlmi-tools/scripts/commands/realmd/c...
Unlike the previous commands, realmd isn't available by default.
Mention what needs to be done to install realmd and the realmd
metacommand.
I think it would be better to make a new release of openlmi-scripts
with realmd included. I have it at the top of my TODO list. Maybe a
note about being 'fresh stuff' would be appropriate.
*
http://docs.openlmi.org/en/latest/openlmi-tools/scripts/commands/service/...
Should we mention it when we expect a command to take a
significant amount of time to complete? Something like "It may take
30-60 seconds to return a list of all available services."
This is fixed with
the newest release of openlmi-providers. I don't
see a reason for its inclusion.
*
http://docs.openlmi.org/en/latest/openlmi-tools/scripts/commands/software...
Mention that the software metacommand is built on yum and that
some operations may be slow. Notably, that a "lmi software list" of
all software packages may require over five minutes to return a
list of several thousand packages. We recommend using targeted
searches instead of full lists. Provide some examples of searching
for packages.
The SHOW and LIST commands are documented; should the SEARCH
command also be documented? It looks like you need to use SEARCH to
get lists of packages (like openlmi) and then use the LIST and SHOW
commands. It would be helpful to have some examples for how to use
the SW metacommand. I found it a bit confusing that you need to use
"sw list files openlmi-realmd" but "sw show pkg openlmi-realmd".
I agree. Software's command is missing this information. I'll document
it better. Thanks for suggestions.
SSSD Command
Mention that SSSD is optional and must be installed before the
metacommand can be used.
Again, the new release of openlmi-scripts shall have it.
STORAGE Command
It would be helpful to start out by identifying the commands that
provide information on storage vs. those that can modify storage.
The storage list, show, and tree commands display information.
These are likely to be the starting point for using the storage
command.
Under LUKS mention that this is the encrypted file system.
Under THINLV and THINPOOL mention what thin provisioning is and how
it is used.
I'll leave this up to Jan S.
COMMAND DEVELOPMENT
*
http://docs.openlmi.org/en/latest/openlmi-tools/scripts/development.html
Is there an easy way to get the descriptions in the
Term/Description table to line wrap?
I see - that's really not good. This is
not the way it was supposed to
look. I'll try to fix it.
This section is excellent - something I've been looking for! I need
to spend some quality time with it before providing comments.
_______________________________________________ openlmi-devel
mailing list openlmi-devel(a)lists.fedorahosted.org
https://lists.fedorahosted.org/mailman/listinfo/openlmi-devel
These are very good points. I'll try to do my best to fix the issues.
Best regards,
Michal
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1
iQEcBAEBAgAGBQJULWBRAAoJEPezUylxRFUDufgH/AgdI+E6RnsmzPkqrfOkIFxG
MhBTVX0pQq8hcNJH+bQBZWaYRNRDpXb16sq5ppixlkzOSg+5Y61AO1PW++ToCink
XWKest7Ly50gen2cH5iG3fSSBB04Gx0Zll4RHGRVPgxmWAdhOGxXF79qHUY3u6eM
HW9PprlWMIeqVOv8l+YcdTnce6IDeNEvQgD/usaNr7X4Yt/piOnitz5dywyJds05
tJKvPpWnnr8h1+f8Ecavhddid1S2kEWwfUk5FkxUz9dkdthQ6jwdfpxOFSp5JJTb
fJLrWmP+loGr48ipo2pQkvdI0Zoa9uZ8W6ohRf58n4B6VAXPPU2AX7jamj5g0Z4=
=ltmZ
-----END PGP SIGNATURE-----