r4996 - in trunk/varnish-cache/doc/sphinx: . installation tutorial

[perbu at varnish-cache.org]

Author: perbu
Date: 2010-07-03 11:43:54 +0200 (Sat, 03 Jul 2010)
New Revision: 4996

Added:
   trunk/varnish-cache/doc/sphinx/installation/prerequisites.rst
   trunk/varnish-cache/doc/sphinx/tutorial/sizing_your_cache.rst
Modified:
   trunk/varnish-cache/doc/sphinx/index.rst
   trunk/varnish-cache/doc/sphinx/installation/index.rst
   trunk/varnish-cache/doc/sphinx/tutorial/index.rst
   trunk/varnish-cache/doc/sphinx/tutorial/starting_varnish.rst
Log:
prerequisites for installation, cache sizing guidelines + some general cleanup

Modified: trunk/varnish-cache/doc/sphinx/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/index.rst	2010-07-03 09:04:57 UTC (rev 4995)
+++ trunk/varnish-cache/doc/sphinx/index.rst	2010-07-03 09:43:54 UTC (rev 4996)
@@ -30,3 +30,6 @@
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+
+`$Id:$`

Modified: trunk/varnish-cache/doc/sphinx/installation/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/installation/index.rst	2010-07-03 09:04:57 UTC (rev 4995)
+++ trunk/varnish-cache/doc/sphinx/installation/index.rst	2010-07-03 09:43:54 UTC (rev 4996)
@@ -4,29 +4,16 @@
 Varnish Installation
 %%%%%%%%%%%%%%%%%%%%
 
-This manual explains how to get Varnish onto your system, where
+This document explains how to get Varnish onto your system, where
 to get help, how report bugs etc.  In other words, it is a manual
 about pretty much everything else than actually using Varnish to
 move traffic.
 
 .. toctree::
 
+	prerequisites.rst
 	install.rst
 	help.rst
 	bugs.rst
 
-.. todo::
-        [V] on this os, pull this package
-        [V] .. that ..//..
-        [V] to compile from source
-        [V] how to get help
-        [V]- mailing list
-        [V] - IRC
-        [V] - varnish-software.com
-        [V] - other listed consultants
-        reporting bugs
-        - using varnishtest to reproduce
-        - what data do we need
-        - confidentiality
-        - ...
 

Added: trunk/varnish-cache/doc/sphinx/installation/prerequisites.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/installation/prerequisites.rst	                        (rev 0)
+++ trunk/varnish-cache/doc/sphinx/installation/prerequisites.rst	2010-07-03 09:43:54 UTC (rev 4996)
@@ -0,0 +1,22 @@
+Prerequisites
+=============
+
+
+In order for you to install Varnish you must have the following:
+
+  * A fairly modern and 64 bit version of either
+    - Linux
+    - FreeBSD
+    - Solaris
+  * root access to said system
+
+
+Varnish can be installed on other UNIX systems as well, but it is not
+tested particularly well on these plattforms. Varnish is, from time to
+time, said to work on: 
+
+  * 32 bit versions of the before-mentioned systems.
+  * OS X
+  * NetBSD
+  * OpenBSD
+

Modified: trunk/varnish-cache/doc/sphinx/tutorial/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/index.rst	2010-07-03 09:04:57 UTC (rev 4995)
+++ trunk/varnish-cache/doc/sphinx/tutorial/index.rst	2010-07-03 09:43:54 UTC (rev 4996)
@@ -4,7 +4,7 @@
 Varnish Tutorial
 %%%%%%%%%%%%%%%%
 
-Varnish is a web accelerator. It is installed in frond of your web
+Varnish is a web accelerator. It is installed in front of your web
 application and it caches the reponses, making your web site run  Varnish
 is fast, flexible and easy to use.
 
@@ -18,13 +18,16 @@
 Furthermore we assume you have read the :ref:`install-index` and that
 it is installed with the default configuration.
 
+Good luck.
 
+perbu.
 
 .. toctree:: 
 
 	backend_servers.rst
         starting_varnish.rst
 	logging.rst
+        sizing_your_cache.rst
         putting_varnish_on_port_80.rst
 	vcl.rst
         statistics.rst

Added: trunk/varnish-cache/doc/sphinx/tutorial/sizing_your_cache.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/sizing_your_cache.rst	                        (rev 0)
+++ trunk/varnish-cache/doc/sphinx/tutorial/sizing_your_cache.rst	2010-07-03 09:43:54 UTC (rev 4996)
@@ -0,0 +1,16 @@
+
+Sizing your cache
+-----------------
+
+Picking how much memory you should give Varnish can be a tricky
+task. A few things to consider:
+ * How big is your *hot* data set. For a portal or news site that
+   would be the size of the front page with all the stuff on it, and
+   the size of all the pages and objects linked from the first page. 
+ * How expensive is it to generate an object? Sometimes it makes sense
+   to only cache images a little while or not to cache them at all if
+   they are cheap to serve from the backend and you have a limited
+   amount of memory.
+ * Watch the n_lru_nuked counter with varnishstat or some other
+   tool. If you have a lot of LRU activity then you should consider
+   increasing the size of the cache.

Modified: trunk/varnish-cache/doc/sphinx/tutorial/starting_varnish.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/starting_varnish.rst	2010-07-03 09:04:57 UTC (rev 4995)
+++ trunk/varnish-cache/doc/sphinx/tutorial/starting_varnish.rst	2010-07-03 09:43:54 UTC (rev 4996)
@@ -4,7 +4,7 @@
 ----------------
 
 I assume varnishd is in your path. You might want to run ``pkill
-varnishd`` to make sure Varnish isn't running. Become root and type:
+varnishd`` to make sure varnishd isn't running. Become root and type:
 
 ``# varnishd -f /usr/local/etc/varnish/default.vcl -s malloc,1G -T 127.0.0.1:2000 -a 0.0.0.0:8080``
 
@@ -18,7 +18,7 @@
  storing its content. I used the type *malloc*, which just uses memory
  for storage. There are other backends as well, described in 
  :ref:tutorial-storage. 1G specifies how much memory should be allocated 
- - one gigabyte.
+ - one gigabyte. 
 
 ``-T 127.0.0.1:2000``
  Varnish has a buildt in text-based administration