[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-devel] [PATCH] docs: network diagrams for the wiki



After informal discussion, I think this is the best (although not
ideal) way to handle these.  I have arranged for
  http://xenbits.xen.org/docs/unstable-staging/
to exist.

After this patch is pushed to xen-unstable staging, it will be
necessary to update the docs generator to run "make -C docs figs" and
install the result.  Another alternative would be for "make -C docs
html" to produce these and put them somewhere.

I intend also to produce a version for the NAT case and perhaps the
isolated guests case.

Ian.

From: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>
Subject: [PATCH] docs: network diagrams for the wiki

We provide two new diagrams
  docs/figs/network-{bridge,basic}.fig
which are converted to pngs by the Makefiles and intended for
consumption by http://wiki.xen.org/wiki/Xen_Networking.

This is perhaps not the ideal location for this source code but we
don't have a better one.

Signed-off-by: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>

---
 .gitignore                   |    1 +
 .hgignore                    |    1 +
 docs/Makefile                |    7 ++-
 docs/figs/network-basic.fig  |   73 ++++++++++++++++++++++++
 docs/figs/network-bridge.fig |  125 ++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 206 insertions(+), 1 deletions(-)

diff --git a/.gitignore b/.gitignore
index 776e4b2..022a7e8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -392,3 +392,4 @@ tools/xenstore/xenstore-watch
 
 docs/txt/misc/*.txt
 docs/txt/man/*.txt
+docs/figs/*.png
diff --git a/.hgignore b/.hgignore
index 141809e..5095722 100644
--- a/.hgignore
+++ b/.hgignore
@@ -45,6 +45,7 @@
 ^docs/interface/interface\.css$
 ^docs/interface/interface\.html$
 ^docs/interface/labels\.pl$
+^docs/figs/.*\.png
 ^docs/man1/
 ^docs/man5/
 ^docs/pdf/.*$
diff --git a/docs/Makefile b/docs/Makefile
index 007a5a9..8806990 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -25,7 +25,7 @@ DOC_TXT         := $(patsubst %.txt,txt/%.txt,$(wildcard 
misc/*.txt)) \
 all: build
 
 .PHONY: build
-build: html txt man-pages
+build: html txt man-pages figs
        @if which $(DOT) 1>/dev/null 2>/dev/null ; then              \
        $(MAKE) -C xen-api build ; else                              \
         echo "Graphviz (dot) not installed; skipping xen-api." ; fi
@@ -40,6 +40,10 @@ html: $(DOC_HTML) html/index.html
 .PHONY: txt
 txt: $(DOC_TXT)
 
+.PHONY: figs
+figs:
+       $(MAKE) -C figs
+
 .PHONY: python-dev-docs
 python-dev-docs:
        @mkdir -v -p api/tools/python
@@ -68,6 +72,7 @@ man5/%.5: man/%.pod.5 Makefile
 .PHONY: clean
 clean:
        $(MAKE) -C xen-api clean
+       $(MAKE) -C figs clean
        rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~ 
        rm -rf *.ilg *.log *.ind *.toc *.bak core
        rm -rf html txt
diff --git a/docs/figs/network-basic.fig b/docs/figs/network-basic.fig
new file mode 100644
index 0000000..b343def
--- /dev/null
+++ b/docs/figs/network-basic.fig
@@ -0,0 +1,73 @@
+#FIG 3.2  Produced by xfig version 3.2.5b
+Landscape
+Center
+Metric
+A4      
+100.00
+Single
+-2
+1200 2
+0 32 #c0c0c0
+6 4275 5160 6105 6315
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        6090 5175 4290 5175 4290 6075 6090 6075 6090 5175
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        4965 6075 5865 6075 5865 6300 4965 6300 4965 6075
+2 1 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 4
+        6090 5400 5865 5400 5865 5625 6090 5625
+-6
+6 7170 5145 9000 6300
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        7185 5160 8985 5160 8985 6060 7185 6060 7185 5160
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        8310 6060 7410 6060 7410 6285 8310 6285 8310 6060
+2 1 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 4
+        7185 5385 7410 5385 7410 5610 7185 5610
+-6
+6 900 4050 9225 4950
+4 0 0 50 -1 0 16 0.0000 4 195 1335 1170 4860 of the world\001
+4 0 0 50 -1 0 16 0.0000 4 240 1815 1080 4590 interface, to rest\001
+4 0 0 50 -1 0 16 0.0000 4 255 1890 990 4320 Physical network\001
+4 0 0 50 -1 0 16 0.0000 4 255 1485 4050 4860 guest's traffic\001
+4 0 0 50 -1 0 16 0.0000 4 195 1305 4050 4590 backend for\001
+4 0 0 50 -1 0 16 0.0000 4 195 1905 3960 4320 Virtual interface:\001
+4 0 0 50 -1 0 16 0.0000 4 195 1290 7515 4860 Xen drivers\001
+4 0 0 50 -1 0 16 0.0000 4 255 1290 7425 4590 provided by\001
+4 0 0 50 -1 0 16 0.0000 4 195 1905 7155 4320 Virtual interface:\001
+-6
+2 2 0 2 0 29 50 -1 20 0.000 0 0 7 0 0 5
+        660 5160 2460 5160 2460 6060 660 6060 660 5160
+2 2 0 2 0 29 50 -1 20 0.000 0 0 7 0 0 5
+        1785 6060 885 6060 885 6285 1785 6285 1785 6060
+2 1 0 2 0 29 50 -1 20 0.000 0 0 7 0 0 4
+        660 5385 885 5385 900 5625 675 5625
+2 1 0 2 0 29 50 -1 -1 0.000 0 0 7 0 0 3
+        675 6300 675 4950 450 4950
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 7 0 0 2
+        6075 5490 7200 5490
+2 1 0 3 4 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        675 5490 0 5490
+2 1 0 3 4 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        0 2475 0 6525
+2 2 0 1 0 32 100 -1 20 0.000 0 0 7 0 0 5
+        675 2250 9675 2250 9675 6750 675 6750 675 2250
+2 2 0 1 0 7 70 -1 20 0.000 0 0 7 0 0 5
+        6300 2925 900 2925 900 6525 6300 6525 6300 2925
+2 2 0 1 0 7 70 -1 20 0.000 0 0 7 0 0 5
+        6975 6525 9450 6525 9450 2925 6975 2925 6975 6525
+2 2 0 1 7 7 125 -1 20 0.000 0 0 -1 0 0 5
+        -225 2025 9900 2025 9900 6975 -225 6975 -225 2025
+4 0 0 50 -1 18 20 0.0000 4 240 735 1170 5490 ethN\001
+4 0 0 50 -1 18 20 0.0000 4 240 945 4500 5490 vifA.B\001
+4 0 0 50 -1 16 20 0.0000 4 315 1410 4500 5850 e.g. vif4.0\001
+4 0 0 50 -1 16 20 0.0000 4 315 1260 1125 5850 e.g. eth0\001
+4 0 0 50 -1 0 16 1.5708 4 255 1395 225 5400 physical link\001
+4 0 0 50 -1 18 20 0.0000 4 240 735 7875 5490 ethB\001
+4 0 0 50 -1 16 20 0.0000 4 315 1260 7650 5850 e.g. eth0\001
+4 0 0 50 -1 0 20 0.0000 4 300 1995 1530 3870 typically dom0\001
+4 0 0 50 -1 0 20 0.0000 4 285 3330 990 3420 Backend (driver) domain\001
+4 0 0 50 -1 0 20 0.0000 4 300 1785 7155 3420 guest domain\001
+4 0 0 50 -1 0 20 0.0000 4 300 1410 7155 3810 domU e.g.\001
+4 0 0 50 -1 16 20 0.0000 4 240 810 8550 3825 dom4\001
+4 0 0 50 -1 0 20 0.0000 4 300 1320 900 2700 Computer\001
+4 0 0 50 -1 0 16 1.5708 4 195 1350 6750 6210 virtual   link\001
diff --git a/docs/figs/network-bridge.fig b/docs/figs/network-bridge.fig
new file mode 100644
index 0000000..63c6ac4
--- /dev/null
+++ b/docs/figs/network-bridge.fig
@@ -0,0 +1,125 @@
+#FIG 3.2  Produced by xfig version 3.2.5b
+Landscape
+Center
+Metric
+A4      
+100.00
+Single
+-2
+1200 2
+0 32 #ffc3ff
+0 33 #c0c0c0
+6 -225 3825 2475 8325
+2 2 0 2 0 29 50 -1 20 0.000 0 0 7 0 0 5
+        660 6735 2460 6735 2460 7635 660 7635 660 6735
+2 2 0 2 0 29 50 -1 20 0.000 0 0 7 0 0 5
+        1785 7635 885 7635 885 7860 1785 7860 1785 7635
+2 1 0 2 0 29 50 -1 20 0.000 0 0 7 0 0 4
+        660 6960 885 6960 900 7200 675 7200
+2 1 0 2 0 29 50 -1 -1 0.000 0 0 7 0 0 3
+        675 7875 675 6525 450 6525
+2 1 0 3 4 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        675 7065 0 7065
+2 1 0 3 4 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        0 4050 0 8100
+4 0 0 50 -1 18 20 0.0000 4 240 675 1170 7065 eth0\001
+-6
+6 1936 4020 3149 5850
+2 2 0 2 0 32 50 -1 19 0.000 0 0 7 0 0 5
+        1951 5835 1951 4035 2898 4035 2898 5835 1951 5835
+2 2 0 2 0 32 50 -1 19 0.000 0 0 7 0 0 5
+        2898 4710 2898 5610 3134 5610 3134 4710 2898 4710
+2 1 0 2 0 32 50 -1 19 0.000 0 0 7 0 0 4
+        2187 5835 2187 5610 2424 5610 2424 5835
+-6
+6 4275 5160 6105 6315
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        6090 5175 4290 5175 4290 6075 6090 6075 6090 5175
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        4965 6075 5865 6075 5865 6300 4965 6300 4965 6075
+2 1 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 4
+        6090 5400 5865 5400 5865 5625 6090 5625
+-6
+6 7170 5145 9000 6300
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        7185 5160 8985 5160 8985 6060 7185 6060 7185 5160
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        8310 6060 7410 6060 7410 6285 8310 6285 8310 6060
+2 1 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 4
+        7185 5385 7410 5385 7410 5610 7185 5610
+-6
+6 4275 7815 6105 8970
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        6090 7830 4290 7830 4290 8730 6090 8730 6090 7830
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        4965 8730 5865 8730 5865 8955 4965 8955 4965 8730
+2 1 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 4
+        6090 8055 5865 8055 5865 8280 6090 8280
+-6
+6 7170 7800 9000 8955
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        7185 7815 8985 7815 8985 8715 7185 8715 7185 7815
+2 2 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 5
+        8310 8715 7410 8715 7410 8940 8310 8940 8310 8715
+2 1 0 2 0 11 50 -1 28 0.000 0 0 7 0 0 4
+        7185 8040 7410 8040 7410 8265 7185 8265
+-6
+6 6975 6750 9450 9225
+6 6975 6750 9450 9225
+2 2 0 1 0 7 70 -1 20 0.000 0 0 7 0 0 5
+        6975 9225 9450 9225 9450 6750 6975 6750 6975 9225
+4 0 0 50 -1 0 20 0.0000 4 270 705 7200 7200 guest\001
+4 0 0 50 -1 16 20 0.0000 4 240 810 8100 7200 dom7\001
+4 0 0 50 -1 16 20 0.0000 4 225 2070 7200 7650 198.51.100.32\001
+-6
+-6
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        4275 5625 3375 5625
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        4275 8325 3375 8325
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        3375 7200 2475 7200
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 -1 0 0 2
+        3375 9000 3375 5220
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 -1 0 0 3
+        2250 5850 2250 6300 3375 6300
+2 2 0 1 0 7 70 -1 20 0.000 0 0 7 0 0 5
+        6300 2925 900 2925 900 9450 6300 9450 6300 2925
+2 2 0 1 0 33 100 -1 20 0.000 0 0 7 0 0 5
+        675 2250 9675 2250 9675 9675 675 9675 675 2250
+2 2 0 1 7 7 125 -1 20 0.000 0 0 7 0 0 5
+        -225 9900 9900 9900 9900 2025 -225 2025 -225 9900
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 7 0 0 2
+        6075 5490 7200 5490
+2 2 0 1 0 7 70 -1 20 0.000 0 0 7 0 0 5
+        6975 6525 9450 6525 9450 2925 6975 2925 6975 6525
+2 1 0 3 1 29 50 -1 -1 0.000 0 0 7 0 0 2
+        6075 8145 7200 8145
+2 2 0 1 0 7 70 -1 20 0.000 0 0 7 0 0 5
+        6975 6525 9450 6525 9450 5580 6975 5580 6975 6525
+2 2 0 1 0 29 50 -1 -1 0.000 0 0 -1 0 0 5
+        1395 4230 5670 4230 5670 9180 1395 9180 1395 4230
+4 0 0 50 -1 0 16 1.5708 4 255 1395 225 5400 physical link\001
+4 0 0 50 -1 0 20 0.0000 4 300 1320 900 2700 Computer\001
+4 0 0 50 -1 0 20 0.0000 4 285 3330 990 3420 Backend (driver) domain\001
+4 0 0 50 -1 0 16 1.5708 4 195 1515 3690 7560 virtual switch\001
+4 0 0 50 -1 16 20 0.0000 4 225 1890 1440 3960 198.51.100.1\001
+4 0 0 50 -1 18 20 1.5708 4 240 1095 2250 5400 xenbr0\001
+4 0 0 50 -1 0 16 1.5708 4 255 1185 2520 5490 O/S bridge\001
+4 0 0 50 -1 0 16 1.5708 4 195 990 2790 5310 interface\001
+4 0 0 50 -1 0 20 0.0000 4 300 840 4680 4590 bridge\001
+4 0 0 50 -1 0 20 0.0000 4 225 1185 3330 4590 Software\001
+4 0 0 50 -1 0 20 0.0000 4 300 1785 7155 3420 guest domain\001
+4 0 0 50 -1 0 20 0.0000 4 300 1410 7155 3810 domU e.g.\001
+4 0 0 50 -1 16 20 0.0000 4 240 810 8550 3825 dom4\001
+4 0 0 50 -1 18 20 0.0000 4 240 825 4500 5490 vif4.0\001
+4 0 0 50 -1 18 20 0.0000 4 240 675 7875 5490 eth0\001
+4 0 0 50 -1 16 20 0.0000 4 225 2070 7200 4950 198.51.100.27\001
+4 0 0 50 -1 0 16 0.0000 4 255 1080 4500 5850 (netback)\001
+4 0 0 50 -1 0 16 0.0000 4 255 1140 7560 5850 (netfront)\001
+4 0 0 50 -1 0 16 1.5708 4 195 1350 6750 6210 virtual   link\001
+4 0 0 50 -1 0 16 0.0000 4 255 1080 4500 8505 (netback)\001
+4 0 0 50 -1 0 16 0.0000 4 255 1140 7560 8505 (netfront)\001
+4 0 0 50 -1 0 16 1.5708 4 195 1350 6750 8865 virtual   link\001
+4 0 0 50 -1 18 20 0.0000 4 240 825 4500 8190 vif7.0\001
+4 0 0 50 -1 18 20 0.0000 4 240 675 7830 8190 eth0\001
-- 
tg: (0730dd5..) t/xen/docs.wiki-figs (depends on: base)

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel


 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.