| 1 |
|
| 2 |
INTRODUCTION |
| 3 |
|
| 4 |
This package provides a suite of modules for managing NetApp's NAS |
| 5 |
devices, commonly referred to as "filers". |
| 6 |
|
| 7 |
Although I consider the code to be very stable, the API should be |
| 8 |
considered experimental. The convention I will be following regarding |
| 9 |
non-compatible API changes is as follows. I'm using a major.minor |
| 10 |
release naming convention, and I will promise to NOT make |
| 11 |
non-backwards compatible changes between patches to a given |
| 12 |
major.minor release. |
| 13 |
|
| 14 |
However, in order to allow the API to evolve, it is entirely possible |
| 15 |
that non-backwards compatible changes will be made between minor |
| 16 |
releases. There is no guarantee that 2.003 will be 100% backwards |
| 17 |
compatible with 2.002, although such changes will be made only when |
| 18 |
justified. The author does not believe in infinite backwards |
| 19 |
compatibility. |
| 20 |
|
| 21 |
INSTALLATION |
| 22 |
|
| 23 |
To install this module, run the following commands: |
| 24 |
|
| 25 |
perl Makefile.PL |
| 26 |
make |
| 27 |
make test |
| 28 |
make install |
| 29 |
|
| 30 |
SSH vs TELNET |
| 31 |
|
| 32 |
This module is designed to be used with a password-free ssh |
| 33 |
configuration, which means you must have configured your filers with |
| 34 |
an ssh key such that you can run remote commands using: |
| 35 |
|
| 36 |
ssh [ ssh options ] $hostname $command |
| 37 |
|
| 38 |
without entering a password. In order to configure this, you need to |
| 39 |
install the public half of your ssh key on the filers directly. |
| 40 |
|
| 41 |
You can use this module with telnet, but this is less secure, since |
| 42 |
you have to find a way to access the plain text password from your |
| 43 |
code, and that usually means either embedding the password in the |
| 44 |
source code (the worst idea) or embedding it into a file somewhere. |
| 45 |
In addition, the error checking with telnet is far less robust, and |
| 46 |
there can only be one concurrent telnet session to a filer, so we |
| 47 |
recommend against using telnet for anything other than installing the |
| 48 |
ssh key. |
| 49 |
|
| 50 |
In a future release, the author hopes to provide a utility to automate |
| 51 |
the installation of the ssh key, using the telnet protocol, as both an |
| 52 |
example of using the API, and a means of helping others wean |
| 53 |
themselves from the use of telnet. |
| 54 |
|
| 55 |
TESTING |
| 56 |
|
| 57 |
The test suite is broken down into two separate sections: 10_passive |
| 58 |
and 20_active. The passive tests will change absolutely nothing on |
| 59 |
the filers. The goal of the passive tests is to run the query methods |
| 60 |
and the parsing code through as much input as possible, and these |
| 61 |
tests will walk through every aggregate, volume and qtree, among other |
| 62 |
object types, on each filer that has been configured for testing. As |
| 63 |
a result, they can be somewhat time consuming, depending on the number |
| 64 |
of filers, and the size of their configuration. |
| 65 |
|
| 66 |
The active tests, which are not yet implemented, will be destructive, |
| 67 |
and will test creating, modifying and destroying objects such as |
| 68 |
aggregates, volumes, qtrees, etc. The author expects to start adding |
| 69 |
active tests in one of the upcoming releases of this API. |
| 70 |
|
| 71 |
The tests are configured by specifying one or more filers to query in |
| 72 |
the file: |
| 73 |
|
| 74 |
./t/lib/NetApp/Test.pm |
| 75 |
|
| 76 |
Please see that file for examples and documentation on how to |
| 77 |
customize the configuration. To summarize, you can either hack that |
| 78 |
file, or you can export a number of environment variables to control |
| 79 |
the test externally (this is what the author does, for example). |
| 80 |
|
| 81 |
DEPENDENCIES |
| 82 |
|
| 83 |
A bunch... See Makefile.PL, which will tell you about them anyway |
| 84 |
when it doesn't find them. |
| 85 |
|
| 86 |
Note that if you want to use the caching feature of the NetApp::Filer |
| 87 |
objects, this requires a patched version of Memoize::Expire. I have |
| 88 |
tried to get the owner of that code to accept a patch, but have been |
| 89 |
unable to get a response from him. Email me directly, and I'll be |
| 90 |
happy to provide the code. |
| 91 |
|
| 92 |
COPYRIGHT AND LICENCE |
| 93 |
|
| 94 |
Copyright (C) 2008, Phillip Moore <[email protected]> |
| 95 |
All rights reserved. |
| 96 |
|
| 97 |
This code is released under the same license as perl itself. |
| 98 |
|
| 99 |
CREDITS |
| 100 |
|
| 101 |
The following people helped to make this release happen: |
| 102 |
|
| 103 |
Baldwin Sung <[email protected]> |
| 104 |
Chibo Qian <[email protected]> |
| 105 |
Ugur Tigli <[email protected]> |
| 106 |
Ed Dabagian-Paul <[email protected]> |
| 107 |
Robert Benoit <[email protected]> |
| 108 |
|