2005-04-11 Paul Jakma <paul.jakma@sun.com>

	* Makefile.am: README.txt to EXTRA_DIST
	* README.txt: new file, package creation, install, usage notes.

diff --git a/solaris/ChangeLog b/solaris/ChangeLog
index bf91053b8732b1a01672e19ce3ad18554cceb871..eb5d67952c4c822ae797d9bf341845134af10b55 100644 (file)
--- a/solaris/ChangeLog
+++ b/solaris/ChangeLog
@@ -11,3 +11,4 @@
        * depend.*: Solaris 10 dependencies for packages, referenced by
          prototype files.
        * .cvsignore: no idea what this is for...
+       * README.txt: new file, package creation, install, usage notes.

diff --git a/solaris/Makefile.am b/solaris/Makefile.am
index d0567fac3b08826c41413a830fa9e14dc074eb08..0fb951eed2068c92ac7f492e16a7e672970b7383 100644 (file)
--- a/solaris/Makefile.am
+++ b/solaris/Makefile.am
@@ -1,5 +1,5 @@
 # Solaris packages automake file
-# $Id: Makefile.am,v 1.1 2005/04/11 07:05:21 paul Exp $
+# $Id: Makefile.am,v 1.2 2005/04/11 07:58:35 paul Exp $
 
 .PHONY: packages
 
@@ -109,7 +109,7 @@ CLEANFILES := $(BUILT_SOURCES) $(pkg_packages)
 
 EXTRA_DIST := $(pkg_depends) $(pkg_manifests:%=%.in) $(pkg_prototypes:%=%.in) \
        $(pkg_names:%=pkginfo.%.tmpl.in) $(srcdir)/pkginfo.tmpl.in \
-       quagga.init.in options.xml r.manifest i.manifest
+       quagga.init.in options.xml r.manifest i.manifest README.txt
 
 pkg-root-install:
        (cd $(top_builddir) && \

diff --git a/solaris/README.txt b/solaris/README.txt
new file mode 100644 (file)
index 0000000..86295e0
--- /dev/null
+++ b/solaris/README.txt
@@ -0,0 +1,107 @@
+To build packages for Solaris 10:
+
+Requirements:
+-------------
+
+- Development environment including gcc (eg as shipped with Solaris 10)
+
+- The Package tools from S10
+
+- i.manifest and r.manifest scripts as supplied with Solaris Express
+  in /usr/sadm/install/scripts/ or alternatively from the
+  download/binaries/solaris/ directory on quagga.net. i.manifest must be at
+  least version 1.5. You can place these scripts in this directory if you
+  are using Solaris 10 GA (which does not ship with these scripts).
+
+
+Package creation instructions:
+------------------------------
+
+1. Configure and build Quagga in the top level build directory as per
+normal, eg:
+
+       ./configure --prefix=/usr/local/quagga \
+               --localstatedir=/var/run/quagga
+               --enable-gcc-rdynamic --enable-opaque-lsa --enable-ospf-te \
+               --enable-multipath=64 --enable-user=quagga \
+               --enable-ospfclient=yes --enable-ospfapi=yes  \
+               --enable-group=quagga --enable-nssa --enable-opaque-lsa
+
+You will need /usr/sfw/bin and /usr/ccs/bin in your path.
+
+2. make install in the top-level build directory, it's a good idea to make
+use of DESTDIR to install to an alternate root, eg:
+
+       make DESTDIR=/var/tmp/qroot install
+
+3. In this directory, run make packages, specifying DESTDIR if appropriate,
+eg:
+
+       make DESTDIR=/var/tmp/qroot packages
+
+This should result in 4 packages being created:
+
+       quagga-libs-...-$ARCH.pkg       - QUAGGAlibs
+       quagga-daemons-...-$ARCH.pkg    - QUAGGAdaemons
+       quagga-doc-...-$ARCH.pkg        - QUAGGAdoc
+       quagga-dev-...-$ARCH.pkg        - QUAGGAdev
+
+QUAGGAlibs and QUAGGAdaemons are needed for daemon runtime.
+
+
+Install and post-install configuration notes:
+---------------------------------------------
+
+- If you specified a user/group which does not exist per default on Solaris
+  (eg quagga/quagga) you *must* create these before installing these on a
+  system. The packages do *not* create the users.
+
+- The configuration files are not created. You must create the configuration
+  file yourself, either with your complete desired configuration, or else if
+  you wish to use the telnet interface for further configuration you must
+  create them containing at least:
+
+        password whatever
+
+  The user which quagga runs as must have write permissions on this file, no
+  other user should have read permissions, and you would also have to enable
+  the telnet interface (see below).
+
+- Configuration of common options are by way of SMF properties named Quagga,
+  the defaults should be inline with how you configured Quagga in Step 1
+  above, eg:
+
+       Quagga/config_file astring /usr/local/quagga/etc/zebra.conf
+       Quagga/daemon_name astring zebra
+       Quagga/group astring quagga
+       Quagga/pid_file astring /var/run/quagga/zebra.pid
+       Quagga/stability astring Evolving
+       Quagga/user astring quagga
+       Quagga/vty_addr astring 127.1
+       Quagga/vty_port integer 0
+
+  Note that by default the telnet 'vty' interface is disabled -
+  Quagga/vty_port is set to 0. Other daemon-specific options may be
+  available, however they are not yet honoured/used (eg ospfd/apiserver on
+  svc:/network/ospf).
+
+  You can change these properties with the 'svccfg' SMF utility, eg:
+
+       # svccfg 
+       svc:> select svc:/network/zebra
+       svc:/network/zebra> listprop Quagga/vty_port
+       Quagga/vty_port  integer  0
+       svc:/network/zebra> setprop Quagga/vty_port = 2601
+       svc:/network/zebra> listprop Quagga/vty_port
+       Quagga/vty_port  integer  2601
+       svc:/network/zebra> quit
+       # svcprop -p Quagga/vty_port network/zebra
+       2601
+
+  As SMF is dependency aware, restarting network/zebra will restart all the
+  other daemons.
+
+- These packages are not supported by Sun Microsystems, report bugs via the
+  usual Quagga channels, ie Bugzilla. Improvements/contributions of course
+  would be greatly appreciated.
+