1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-28 11:18:11 +00:00

Fix documentation

This commit is contained in:
Julien Duponchelle 2016-04-18 20:55:22 +02:00
parent 6b9e46950c
commit 9349bdc916
No known key found for this signature in database
GPG Key ID: CE8B29639E07F5E8
8 changed files with 17 additions and 19 deletions

View File

@ -193,10 +193,8 @@ concurrent.
Authentication Authentication
----------------- -----------------
In this version of the API you have no authentification system. If you You can use HTTP basic auth to protect the access to the API. And run
listen on your network interface instead of localhost be carefull. Due the API over HTTPS.
to the nature of the multiple supported VM it's easy for an user to
upload and run code on your machine.
Notifications Notifications

View File

@ -23,11 +23,11 @@ Controller
---------- ----------
The central server managing everything in GNS3. A GNS3 controller The central server managing everything in GNS3. A GNS3 controller
will manage multiple GNS3 hypervisor. will manage multiple GNS3 compute node.
Hypervisor Compute
---------- ----------
The process running on each server with GNS3. The GNS3 hypervisor The process running on each server with GNS3. The GNS3 compute node
is controlled by the GNS3 controller. is controlled by the GNS3 controller.

View File

@ -17,18 +17,18 @@ Endpoints
GNS3 expose two type of endpoints: GNS3 expose two type of endpoints:
* Controller * Controller
* Hypervisor * Compute
Controller API Endpoints Controller API Endpoints
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
The controller manage all the running topologies. The controller The controller manage all the running topologies. The controller
has knowledge of everything on in GNS3. If you want to create and has knowledge of everything on in GNS3. If you want to create and
manage a topology it's here. The controller will call the hypervisor API manage a topology it's here. The controller will call the compute API
when needed. when needed.
In a standard GNS3 installation you have one controller and one or many In a standard GNS3 installation you have one controller and one or many
hypervisors. computes.
.. toctree:: .. toctree::
:glob: :glob:
@ -37,10 +37,10 @@ hypervisors.
api/v2/controller/* api/v2/controller/*
Hypervisor API Endpoints Compute API Endpoints
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
The hypervisor is the GNS3 process running on a server and controlling The compute is the GNS3 process running on a server and controlling
the VM process. the VM process.
.. WARNING:: .. WARNING::
@ -50,5 +50,5 @@ the VM process.
:glob: :glob:
:maxdepth: 2 :maxdepth: 2
api/v2/hypervisor/* api/v2/compute/*

View File

@ -35,7 +35,7 @@ class IndexHandler:
@classmethod @classmethod
@Route.get( @Route.get(
r"/compute", r"/compute",
description="Ressources used by GNS3 Hypervisor" description="Ressources used by GNS3 Compute"
) )
def compute(request, response): def compute(request, response):
response.template("compute.html", response.template("compute.html",

View File

@ -70,7 +70,7 @@ VM_OBJECT_SCHEMA = {
"type": "object", "type": "object",
"properties": { "properties": {
"compute_id": { "compute_id": {
"description": "Hypervisor identifier", "description": "Compute identifier",
"type": "string" "type": "string"
}, },
"project_id": { "project_id": {

View File

@ -2,7 +2,7 @@
{% block head %} {% block head %}
<script> <script>
var socket = new WebSocket("ws://" + location.host + "/v2/hypervisor/notifications/ws"); var socket = new WebSocket("ws://" + location.host + "/v2/compute/notifications/ws");
socket.onopen = function (event) { socket.onopen = function (event) {
document.getElementById("notifications").innerText = "Connected"; document.getElementById("notifications").innerText = "Connected";
}; };
@ -16,7 +16,7 @@ socket.onmessage = function (event) {
{% block body %} {% block body %}
<h1> <h1>
Hypervisor status Compute status
</h1> </h1>
The purpose of this page is to help for GNS3 debug. This can be dropped The purpose of this page is to help for GNS3 debug. This can be dropped
in futur GNS3 versions. in futur GNS3 versions.

View File

@ -16,7 +16,7 @@
| |
<a href="/controller">Controller status</a> <a href="/controller">Controller status</a>
| |
<a href="/hypervisor">Hypervisor status</a> <a href="/compute">Compute status</a>
</div> </div>
{% block body %}{% endblock %} {% block body %}{% endblock %}
</body> </body>

View File

@ -44,7 +44,7 @@ class Documentation(object):
""" """
Build all the doc page for handlers Build all the doc page for handlers
:param doc_type: Type of doc to generate (controller, hypervisor) :param doc_type: Type of doc to generate (controller, compute)
""" """
for handler_name in sorted(self._documentation): for handler_name in sorted(self._documentation):
if "controller." in handler_name: if "controller." in handler_name: