@@ -20,9 +20,9 @@ Installation Guide installation will probably be easiest on FreeBSD. Before attempting to build the package, you need to install any missing - prerequisites. Note that the Python code requires Python version 2.5. - rpkid et al are mostly self-contained, but do require a small number of - external packages to run. + prerequisites. Note that the Python code requires Python version 2.5 or + 2.6. rpkid et al are mostly self-contained, but do require a small + number of external packages to run. * If your Python installation does not already include the sources files needed to compile new Python extension modules, you will need @@ -34,14 +34,14 @@ Installation Guide If you get compilation errors trying to build the POW code (below) and the error message says something about the file "Python.h" being missing, this is almost certainly your problem. - * http://codespeak.net/lxml/. lxml in turn requires the Gnome LibXML2 - C libraries. + * http://codespeak.net/lxml/, a Pythonic interface to the Gnome + LibXML2 libraries. lxml in turn requires the LibXML2 C libraries. + FreeBSD: /usr/ports/devel/py-lxml + Fedora: python-lxml.i386 + Ubuntu: python-lxml - * http://sourceforge.net/projects/mysql-python/. MySQLdb in turn - requires MySQL client and server. rpkid et al have been tested with - MySQL 5.0 and 5.1. + * http://sourceforge.net/projects/mysql-python/, the Python "db" + interface to MySQL. MySQLdb in turn requires MySQL client and + server. rpkid et al have been tested with MySQL 5.0 and 5.1. + FreeBSD: /usr/ports/databases/py-MySQLdb + Fedora: MySQL-python.i386 + Ubuntu: python-mysqldb @@ -66,19 +66,17 @@ Installation Guide library to provide RFC 3779 support. If you get errors building POW, see the above discussion of Python development sources. - You will also need a MySQL installation. This code was developed using - MySQL 5.1 and has been tested with MySQL 5.0 and 5.1. - The architecture is intended to support hardware signing modules (HSMs), but the code to support them has not been written. - At this point, you should have all the necessary software installed. - You will probably want to test it. All tests should be run from the - rpkid/ directory. The test suite requires a few more external packages, - only one of which is Python code. + At this point, you should have all the necessary software installed to + run the core programs, but you will probably want to test it. The test + suite requires a few more external packages, only one of which is + Python code. - * http://pyyaml.org/. testpoke.py (an up-down protocol command line - test client) and testbed.py (a test harness) use PyYAML. + * http://pyyaml.org/. Several of the test programs use PyYAML to + parse a YAML description of a simulated allocation hierarchy to + test. + FreeBSD: /usr/ports/devel/py-yaml + Ubuntu: python-yaml * http://xmlsoft.org/XSLT/. Some of the test code uses xsltproc, from @@ -86,6 +84,8 @@ Installation Guide + FreeBSD: /usr/ports/textproc/libxslt + Ubuntu: xsltproc + All tests should be run from the rpkid/ or myrpki/ directories. + Some of the tests require MySQL databases to store their data. To set up all the databases that the tests will need, run the SQL commands in rpkid/testbed.setup.sql. The MySQL command line client is usually the @@ -122,8 +122,11 @@ Installation Guide a description of it as Graphviz input. SQL Fairy in turn requires Perl. + FreeBSD: /usr/ports/databases/p5-SQL-Translator + + Once you've finished with installation, the next thing you should read + is the Operation Guide. __________________________________________________________________ - Generated on Tue Apr 13 21:06:48 2010 for RPKI Engine by doxygen + Generated on Tue Apr 13 22:26:15 2010 for RPKI Engine by doxygen 1.6.3 @@ -474,5 +474,5 @@ Error handling __________________________________________________________________ - Generated on Tue Apr 13 21:06:48 2010 for RPKI Engine by doxygen + Generated on Tue Apr 13 22:26:16 2010 for RPKI Engine by doxygen 1.6.3 @@ -32,36 +32,40 @@ Operation Guide calls into this to perform lookups via the left-right protocol. * irbe_cli.py: A command-line client for the left-right control - protocol. - - * cross_certify.py: A BPKI cross-certification tool. - - * cronjob.py: A trivial HTTP client used to drive rpkid cron events. + protocol. Very obscure syntax, badly needs rewriting. * testbed.py: A test tool for running a collection of rpkid and irdb instances under common control, driven by a unified test script. + * yamltest.py: Another test tool which takes the same input format as + testbed.py, but with slightly different purpose. testbed.py is + intended to support regression tests, while yamltest.py is intended + for automated testing of something closer to a real operational + environment. There's a fair amount of code duplication between the + two, and at some point they will probably be merged into a single + program that supports both modes of operation. + * testpoke.py: A simple client for the up-down protocol, mostly compatable with APNIC's rpki_poke.pl tool. Most of these programs take configuration files in a common format similar to that used by the OpenSSL command line tool. The test programs also take input in YAML format to drive the tests. Runs of the - testbed.py test tool will generate a fairly complete set configuration + yamltest.py test tool will generate a fairly complete set configuration files which may be useful as examples. Basic operation consists of creating the appropriate MySQL databases, - starting rpkid, pubd, rootd, and irdbd, using the left-right control - protocol to set up rpkid's internal state, and setting up a cron job to - invoke rpkid's cron action at regular intervals. All other operations - should occur either as a result of cron events or as a result of - incoming left-right and up-down protocol requests. - - Note that the full event-driven model for rpkid hasn't yet been - implemented. The design is intended to allow an arbitrary number of - hosted RPKI engines to run in a single rpkid instance, but without the - event-driven tasking model one must set up a separate rpkid instance - for each hosted RPKI engine. + configuring relationships between parents and children and between + publication clients and repositories, starting rpkid, pubd, rootd, and + irdbd, and using the left-right and publication control protocols to + set up rpkid's and pubd's internal state. All other operations should + occur either as a result of cron events or as a result of incoming + left-right and up-down protocol requests. + + The core programs are all event-driven, and are (in theory) capable of + supporting an arbitrary number of hosted RPKI engines to run in a + single rpkid instance, up to the performance limits of the underlying + hardware. At present the daemon programs all run in foreground, that is, if one wants them to run in background one must do so manually, eg, using @@ -693,5 +697,5 @@ testpoke.py __________________________________________________________________ - Generated on Tue Apr 13 21:06:48 2010 for RPKI Engine by doxygen + Generated on Tue Apr 13 22:26:15 2010 for RPKI Engine by doxygen 1.6.3 @@ -220,5 +220,5 @@ Additional access control considerations. __________________________________________________________________ - Generated on Tue Apr 13 21:06:48 2010 for RPKI Engine by doxygen + Generated on Tue Apr 13 22:26:16 2010 for RPKI Engine by doxygen 1.6.3 | 