mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Fix documentation
This commit is contained in:
8 files changed
+17
-19
No files matched your search
+2
-4
@@ -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
|
||||
|
||||
+3
-3
@@ -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.
|
||||
|
||||
+6
-6
@@ -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/*
|
||||
|
||||
Reference in new issue
Block a user