aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoachim Tingvold <joachim@tingvold.com>2015-03-21 15:34:11 +0100
committerJoachim Tingvold <joachim@tingvold.com>2015-03-21 15:34:11 +0100
commit86a273d80bed84a09ccdac81db3775a23ad23cdb (patch)
tree4355436c5e2a25c0c38ef465f66e3f3eca64567d
parentc1ac860a1b8eac5b421310a79b59433ab92c7578 (diff)
Markdown.
-rw-r--r--tools/README.md54
1 files changed, 31 insertions, 23 deletions
diff --git a/tools/README.md b/tools/README.md
index 869367a..5a3be09 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -28,7 +28,6 @@ The following three hosts/servers are normally used:
the first TG-servers, and may end up hosting the switch-config and NMS.
* The server to use as Primary DNS and DHCP server
* The server to use as Secondary DNS and SMTP.
-Add the three hosts to /etc/hosts, DNS is not available yet...
2: Perform bootstrapping
------------------------------------------------------------------
@@ -57,31 +56,39 @@ supposed to be pulled from switches.txt ...
The rest of the information needed should be pulled from techwiki.g.o The
format of the file is: one net per line, lines starting with # are skipped,
format of each net-line is:
-176.110.124.0 24 noc
-\# <network adress> <prefixlen> <network-name>
+
+ # <network adress> <prefixlen> <network-name>
+ 176.110.124.0 24 noc
Run 'tools/make-base-requires.sh'. This script will log in on the Primary and
Secondary boxes, install dependencies and the BIND/DHCP packages, create all
needed directories, create the initial configuration files.
-A short listing of the tasks of scripts called by make-base-requires:
-tools/install-dependencies.sh Installs needed base software to boot, primary and secondary
-tools/make-named.pl Basic BIND setup (creates named.conf et.al)
-tools/make-first-zones.pl Creates static zone-files (tgname, infra, ipv6zone)
-tools/make-reverse4-files.pl Creates reverse-zones for IPv4
-tools/make-dhcpd.pl Sets up the base setup for DHCP
-NOTE: these scripts are run by tools/make-base-requires.sh, you should not need to
-run these individually
+A short listing of the tasks of scripts called by make-base-requires (NOTE: these
+scripts are run by tools/make-base-requires.sh, you should not need to run these individually):
+ * tools/install-dependencies.sh
+ ** Installs needed base software to boot, primary and secondary
+ * tools/make-named.pl
+ ** Basic BIND setup (creates named.conf et.al)
+ * tools/make-first-zones.pl
+ ** Creates static zone-files (tgname, infra, ipv6zone)
+ * tools/make-reverse4-files.pl
+ ** Creates reverse-zones for IPv4
+ * tools/make-dhcpd.pl
+ ** Sets up the base setup for DHCP
3++: Update during the party using update-baseservice.sh from bootstrap
------------------------------------------------------------------
After 'tools/make-base-requires.sh' has been run, further updating should be
managed by the following three files:
-tools/update-baseservice.sh Used to add/update bind and DHCP configuration
-tools/apply-baseupdate.sh Used to reload bind and restart DHCP
-tools/update-tools.sh Used to push changes to the tgmanage toolchain
+* tools/update-baseservice.sh
+** Used to add/update bind and DHCP configuration
+* tools/apply-baseupdate.sh
+** Used to reload bind and restart DHCP
+* tools/update-tools.sh
+** Used to push changes to the tgmanage toolchain
This means, after the base setup is completed, updating and managing the
configuration is done by updating netlist.txt and running tools/update-baseservice.sh
@@ -108,9 +115,12 @@ Usage on this tool is documented in the "header" of the script...
The update prosess is handled by a bunch of "sub-tools", these should typically
not need to be run individually:
-tools/make-bind-include.pl Run via update-baseservice, adds new net's to DNS include
-tools/make-dhcpd-include.pl Run via update-baseservice, adds new net's to DHCP include
-tools/make-missing-conf.pl Run via update-baseservice, adds missing net-conf to BIND/DHCP
+* tools/make-bind-include.pl
+** Run via update-baseservice, adds new net's to DNS include
+* tools/make-dhcpd-include.pl
+** Run via update-baseservice, adds new net's to DHCP include
+* tools/make-missing-conf.pl
+** Run via update-baseservice, adds missing net-conf to BIND/DHCP
7: Generation of linknet dns content
@@ -132,10 +142,8 @@ Other stuff....
------------------------------------------------------------------
Files that are not used? Need to revisit these files...
->tools/make-switch-placements.pl
-
-Updates positions for switches in NMS map (png)
-
-> tools/make-switches.pl
-> tools/fetch-portlist.sh
+* tools/make-switch-placements.pl
+** Updates positions for switches in NMS map (png)?
+* tools/make-switches.pl
+* tools/fetch-portlist.sh