mirror of
https://github.com/GNS3/gns3-server
synced 2024-11-12 19:38:57 +00:00
Fix documentation
This commit is contained in:
parent
6b9e46950c
commit
9349bdc916
@ -193,10 +193,8 @@ concurrent.
|
||||
Authentication
|
||||
-----------------
|
||||
|
||||
In this version of the API you have no authentification system. If you
|
||||
listen on your network interface instead of localhost be carefull. Due
|
||||
to the nature of the multiple supported VM it's easy for an user to
|
||||
upload and run code on your machine.
|
||||
You can use HTTP basic auth to protect the access to the API. And run
|
||||
the API over HTTPS.
|
||||
|
||||
|
||||
Notifications
|
||||
|
@ -23,11 +23,11 @@ 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.
|
||||
|
||||
|
@ -17,18 +17,18 @@ Endpoints
|
||||
GNS3 expose two type of endpoints:
|
||||
|
||||
* Controller
|
||||
* Hypervisor
|
||||
* Compute
|
||||
|
||||
Controller API Endpoints
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The controller manage all the running topologies. The controller
|
||||
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.
|
||||
|
||||
In a standard GNS3 installation you have one controller and one or many
|
||||
hypervisors.
|
||||
computes.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
@ -37,10 +37,10 @@ hypervisors.
|
||||
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.
|
||||
|
||||
.. WARNING::
|
||||
@ -50,5 +50,5 @@ the VM process.
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
api/v2/hypervisor/*
|
||||
api/v2/compute/*
|
||||
|
||||
|
@ -35,7 +35,7 @@ class IndexHandler:
|
||||
@classmethod
|
||||
@Route.get(
|
||||
r"/compute",
|
||||
description="Ressources used by GNS3 Hypervisor"
|
||||
description="Ressources used by GNS3 Compute"
|
||||
)
|
||||
def compute(request, response):
|
||||
response.template("compute.html",
|
||||
|
@ -70,7 +70,7 @@ VM_OBJECT_SCHEMA = {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"compute_id": {
|
||||
"description": "Hypervisor identifier",
|
||||
"description": "Compute identifier",
|
||||
"type": "string"
|
||||
},
|
||||
"project_id": {
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
{% block head %}
|
||||
<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) {
|
||||
document.getElementById("notifications").innerText = "Connected";
|
||||
};
|
||||
@ -16,7 +16,7 @@ socket.onmessage = function (event) {
|
||||
|
||||
{% block body %}
|
||||
<h1>
|
||||
Hypervisor status
|
||||
Compute status
|
||||
</h1>
|
||||
The purpose of this page is to help for GNS3 debug. This can be dropped
|
||||
in futur GNS3 versions.
|
||||
|
@ -16,7 +16,7 @@
|
||||
|
|
||||
<a href="/controller">Controller status</a>
|
||||
|
|
||||
<a href="/hypervisor">Hypervisor status</a>
|
||||
<a href="/compute">Compute status</a>
|
||||
</div>
|
||||
{% block body %}{% endblock %}
|
||||
</body>
|
||||
|
@ -44,7 +44,7 @@ class Documentation(object):
|
||||
"""
|
||||
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):
|
||||
if "controller." in handler_name:
|
||||
|
Loading…
Reference in New Issue
Block a user