Tangle
Check-in [3075a0b6d3]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:New metadata files
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:3075a0b6d3ad8acb17171b5c257fe0267573775d
User & Date: alaric 2012-07-13 12:35:30
Context
2012-07-13
15:08
Fixed METADATA.rdf check-in: 3a77f2d466 user: alaric tags: trunk
12:35
New metadata files check-in: 3075a0b6d3 user: alaric tags: trunk
2012-04-11
13:36
Renamed README.txt to README.wiki, but failed to actually change it to wiki syntax yet. check-in: de4fc2582b user: alaric tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Added DOWNLOAD.wiki.



























>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
<h1>Releases</h1>

  *  [http://www.kitten-technologies.co.uk/project/tangle/tarball/tangle-0.1.tar.gz?uuid=0.1|0.1]
  *  [http://www.kitten-technologies.co.uk/project/tangle/tarball/tangle-0.2.tar.gz?uuid=0.2|0.2]
  *  [http://www.kitten-technologies.co.uk/project/tangle/tarball/tangle-0.3.tar.gz?uuid=0.3|0.3]
  *  [http://www.kitten-technologies.co.uk/project/tangle/tarball/tangle-0.5.tar.gz?uuid=0.5|0.5]

<h1>Source Control</h1>

You can obtain the latest sources, all history, and a local copy of
the ticket database using [http://www.fossil-scm.org/|Fossil], like so:

fossil clone http://www.kitten-technologies.co.uk/project/tangle tangle.fossil

Added METADATA.rdf.













































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns="http://usefulinc.com/ns/doap#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns:admin="http://webns.net/mvcb/"
         rdf:about="http://www.kitten-technologies.co.uk/project/tangle">
 <name>Tangle</name>
 <description>Tangle is a tool for documenting networks.</description>
 <homepage rdf:resource="http://www.kitten-technologies.co.uk/project/tangle" />
 <download-page rdf:resource="http://www.kitten-technologies.co.uk/project/tangle/doc/trunk/DOWNLOAD.wiki" />
 <bug-database rdf:resource="http://www.kitten-technologies.co.uk/project/tangle/reportlist" />
 <license rdf:resource="http://usefulinc.com/doap/licenses/bsd" />
 <maintainer>
  <foaf:Person>
     <foaf:name>Alaric Snell-Pym</foaf:name>
     <foaf:homepage rdf:resource="http://www.snell-pym.org.uk/alaric/"/>
     <foaf:mbox_sha1sum>8b3ce83384145fe1187db8ef60c007efd7fae461</foaf:mbox_sha1sum>
  </foaf:Person>
 </maintainer>
 <repository>
   <Repository>
     <browse rdf:resource='http://www.kitten-technologies.co.uk/project/tangle/dir?ci=tip' />
     <location rdf:resource='http://www.kitten-technologies.co.uk/project/tangle' />
   </Repository>
 </repository>
</Project>

Changes to README.wiki.

26
27
28
29
30
31
32




33
34
35
36
37
38
39
document listing all the components of your network. Every device will
list every cable that connects to it (specifying the logical circuit(s), IPv4 addresses and so on), and clicking on a cable will lead to a list of all devices and circuits on that cable; clicking on a circuit will lead to a list of all devices and IPv4 subnets on the circuit; and clicking on an IPv4 address or subnet will go to a list of all the IPv4 addresses on that subnet, and so on.

It also outputs several "dot" files for GraphViz. The default makefile produces three diagrams: one for physical network cabling, one for logical network connectivity (showing what devices are on which circuits), and one showing management cabling (power, serial, and KVM).

It is written in Python, and consists of two layers: a network parser library which reads the network description file, checks it for errors (duplicate IP addresses, etc), and produces an in-memory cross-referenced object graph; and then a set of scripts that use that library to generate the HTML and "dot" output formats. You can write your own scripts that do other things with the data (such as generating reverse DNS zonefiles).





# Using it

A simple (all too simple) driver shell script is supplied, called
`document-network.sh`, that runs parts of Tangle to make a veritable
soup of network documentation.

Try it out on the supplied examples. From this directory, run:







>
>
>
>







26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
document listing all the components of your network. Every device will
list every cable that connects to it (specifying the logical circuit(s), IPv4 addresses and so on), and clicking on a cable will lead to a list of all devices and circuits on that cable; clicking on a circuit will lead to a list of all devices and IPv4 subnets on the circuit; and clicking on an IPv4 address or subnet will go to a list of all the IPv4 addresses on that subnet, and so on.

It also outputs several "dot" files for GraphViz. The default makefile produces three diagrams: one for physical network cabling, one for logical network connectivity (showing what devices are on which circuits), and one showing management cabling (power, serial, and KVM).

It is written in Python, and consists of two layers: a network parser library which reads the network description file, checks it for errors (duplicate IP addresses, etc), and produces an in-memory cross-referenced object graph; and then a set of scripts that use that library to generate the HTML and "dot" output formats. You can write your own scripts that do other things with the data (such as generating reverse DNS zonefiles).

# Getting it

Pick up the [/tarball/Tangle-0.5.tar.gz?uuid=0.5|latest release (0.5)] or the [/tarball/Tangle-TRUNK.tar.gz?uuid=tip|unstable development version]

# Using it

A simple (all too simple) driver shell script is supplied, called
`document-network.sh`, that runs parts of Tangle to make a veritable
soup of network documentation.

Try it out on the supplied examples. From this directory, run: