-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
28 lines (23 loc) · 2.26 KB
/
docs.html
File metadata and controls
28 lines (23 loc) · 2.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="css/main.css" />
<title>OpenCache Project: Documentation</title>
</head>
<body>
<h1><span style="color:#942930;">Open</span><span style="color:#3F4142;">Cache</span> <span style="font-weight:300">Documentation</span></h1>
<div class='links'><a href='index.html'>overview</a> // <a href='#'>docs</a> // <a href='tutorial.html'>tutorial</a> // <a href='research.html'>research</a> // <a href='about.html'>about</a></div>
<p><span style="color:#942930;">Open</span><span style="color:#3F4142;">Cache</span> consists of a number of unique elements, each of which has its own documentation. This is hosted at the excellent <a href="http://readthedocs.org">Read the Docs</a>.</p>
<h3>Controller</h3>
<p><span style="color:#942930;">Open</span><span style="color:#3F4142;">Cache</span> operates in a controller-node architecture, where a single controller is responsible for a number of nodes. The controller is used as a focal point for command and control operations, including exposing a powerful API. Detailed documentation on the controller and external API can be found at: <a href="http://opencache-controller.rtfd.org">opencache-controller.rtfd.org</a>.</p>
<h3>Node</h3>
<p>A node directly serves content in response to a user request. It also regulararly communicates with the controller using an internal API to relay statistics and state. Node documentation can be found at: <a href="http://opencache-node.rtfd.org">opencache-node.rtfd.org</a>.</p>
<h3>Console</h3>
<p>A user can interact with an <span style="color:#942930;">Open</span><span style="color:#3F4142;">Cache</span> deployment using the console; a graphical user interface. This also provides live graphing and monitoring functionality. More details can be found at: <a href="http://opencache-console.rtfd.org">opencache-console.rtfd.org</a>.</p>
<h3>Vagrant</h3>
<p>To get started with <span style="color:#942930;">Open</span><span style="color:#3F4142;">Cache</span>, a Mininet-based virtual machine is provided. For more information, please see: <a href="http://opencache-vagrant.rtfd.org">opencache-vagrant.rtfd.org</a>.</p>
</body>
<footer>
© Matthew Broadbent 2016
</footer>
</html>