[doc] link to the resource description

parent 0bb6bba3
Pipeline #88312 passed with stages
in 1 minute and 55 seconds
......@@ -40,7 +40,7 @@ class Distem:
Returns:
{dict} The virtual network description
see {file:files/resources_desc.md#Virtual_Networks Resource Description - VNetworks}
see :desc:`resources description<>`
"""
return self.delete_json(
......@@ -57,7 +57,7 @@ class Distem:
Returns:
{dict} The virtual network description
see {file:files/resources_desc.md#Virtual_Networks Resource Description - VNetworks}
see :desc:`resources description<>`
"""
return self.get_json("/vnetworks/%s" % (str(vnetname)))
......@@ -72,7 +72,7 @@ class Distem:
Returns:
{dict} The virtual node description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
return self.get_json("/vnodes/%s" % (str(vnodename)))
......@@ -83,7 +83,7 @@ class Distem:
Args:
name(str): The name of the virtual node which should be unique
desc(dict): Hash structured as described in
{file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}.
:desc:`resources description<>`
ssh_key(dict): SSH key pair to be copied on the virtual node (also
adding the public key to .ssh/authorized_keys). Note that every SSH
keys located on the physical node which hosts this virtual node are
......@@ -105,7 +105,7 @@ class Distem:
Returns:
{dict} The virtual node description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
if desc is None:
......@@ -136,7 +136,7 @@ class Distem:
Returns:
{dict} The virtual node description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
desc = {
......@@ -163,7 +163,7 @@ class Distem:
Returns:
{dict} The virtual node description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
desc = {"desc": {"status": "DOWN"}, "type": "stop", "async": False}
......@@ -182,7 +182,7 @@ class Distem:
Returns:
{dict} The virtual node description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
return self.put_json("/vnodes/%s" % (vnodename), data={"type": "remove"})
......@@ -200,7 +200,7 @@ class Distem:
Returns:
{dict} The virtual node description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
return self.put_json(
......@@ -220,7 +220,7 @@ class Distem:
Returns:
{dict} The virtual node description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
return self.put_json(
......@@ -253,7 +253,7 @@ class Distem:
Returns:
[Array] Array of virtual nodes description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
return self.get_json("/vnodes")
......@@ -266,7 +266,7 @@ class Distem:
Args:
names(Array) The names of the virtual nodes which should be unique
desc(dict) Hash structured as described in
{file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}.
:desc:`resources description<>`
ssh_key(dict) SSH key pair to be copied on the virtual node
(also adding the public key to .ssh/authorized_keys).
Note that every SSH keys located on the physical node
......@@ -279,7 +279,7 @@ class Distem:
Returns:
[Array] The virtual nodes description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
if desc is None:
......@@ -300,7 +300,7 @@ class Distem:
Returns:
[Array] Array of virtual nodes description
(see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes})
(see :desc:`resources description<>`
"""
if names is None:
names = []
......@@ -328,7 +328,7 @@ class Distem:
Returns:
{dict} The virtual nodes description
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
desc = {"status": "RUNNING"}
......@@ -370,7 +370,7 @@ class Distem:
Returns:
[Array] The virtual node descriptions
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
if names is None:
......@@ -393,7 +393,7 @@ class Distem:
Returns:
[Array] The virtual node descriptions
see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
see :desc:`resources description<>`
"""
if names is None:
......@@ -443,11 +443,11 @@ class Distem:
Args:
vnodename(str) The name of the virtual node
desc(dict) Hash structured as described in
{file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}.
:desc:`resources description<>`
Returns:
{dict} The virtual Filesystem description
see {file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}
see :desc:`resources description<>`
"""
return self.post_json(
......@@ -463,11 +463,11 @@ class Distem:
Args:
vnodename(str) The name of the virtual node
desc(dict) Hash structured as described in
{file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}.
:desc:`resources description<>`
Returns:
{dict} The virtual Filesystem description
see {file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}
see :desc:`resources description<>`
"""
return self.put_json("/vnodes/%s/filesystem/" % (str(vnodename)), data=desc)
......@@ -484,7 +484,7 @@ class Distem:
Returns:
{dict} The virtual network interface description
see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
see :desc:`resources description<>`
"""
return self.get_json("/vnodes/%s/ifaces/%s" % (str(vnodename), str(vifacename)))
......@@ -500,11 +500,11 @@ class Distem:
name(str) The name of the virtual network interface
to be created (have to be unique on that virtual node)
desc(dict) Hash structured as described in
{file:files/resources_desc.md#Network_interface Resource Description - VIface}.
:desc:`resources description<>`
Returns:
{dict} The virtual network interface description
see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
see :desc:`resources description<>`
"""
return self.post_json(
......@@ -523,7 +523,7 @@ class Distem:
Returns:
{dict} The virtual network interface description
see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
see :desc:`resources description<>`
"""
return self.delete_json(
......@@ -543,11 +543,11 @@ class Distem:
vnodename(str): The name of the virtual node
vifacename(str): The name of the virtual network interface
desc(dict): Hash structured as described in
{file:files/resources_desc.md#Network_interface Resource Description - VIface}.
:desc:`resources description<>`
Returns:
{dict} The virtual network interface description
see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
see :desc:`resources description<>`
"""
if desc is None:
......@@ -573,7 +573,7 @@ class Distem:
Returns:
{dict} The virtual CPU description
see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
see :desc:`resources description<>`
"""
desc = {"corenb": corenb, "val": val, "unit": unit}
......@@ -593,7 +593,7 @@ class Distem:
Returns:
{dict} The virtual CPU description
see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
see :desc:`resources description<>`
"""
desc = {"val": val, "unit": unit}
......@@ -610,7 +610,7 @@ class Distem:
Returns:
{dict} The virtual CPU description
see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
see :desc:`resources description<>`
"""
return self.delete_json("/vnodes/%s/cpu" % (vnodename), data={})
......@@ -623,7 +623,7 @@ class Distem:
Returns:
{dict} The virtual CPU description
see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
see :desc:`resources description<>`
"""
return self.get_json("/vnodes/%s/cpu" % (vnodename))
......@@ -640,11 +640,11 @@ class Distem:
vnodename(str) The name of the virtual node
vifacename(str) The name of the virtual network interface
desc(dict) Hash structured as described in
{file:files/resources_desc.md#Virtual_Traffic Resource Description - VTraffic}.
:desc:`resources description<>`
Returns:
{dict} The virtual traffic description
see {file:files/resources_desc.md#Traffic Resource Description - VTraffic}
see :desc:`resources description<>`
"""
if desc is None:
......@@ -666,7 +666,7 @@ class Distem:
Returns:
{dict} The virtual traffic description
see {file:files/resources_desc.md#Traffic Resource Description - VTraffic}
see :desc:`resources description<>`
"""
return self.get_json("/vnodes/%s/ifaces/%s/input" % (vnodename, vifacename))
......@@ -683,11 +683,11 @@ class Distem:
vnodename(str) The name of the virtual node
vifacename(str) The name of the virtual network interface
desc(dict) Hash structured as described in
{file:files/resources_desc.md#Virtual_Traffic Resource Description - VTraffic}.
:desc:`resources description<>`
Returns:
{dict} The virtual traffic description
see {file:files/resources_desc.md#Traffic Resource Description - VTraffic}
see :desc:`resources description<>`
"""
if desc is None:
......@@ -709,7 +709,7 @@ class Distem:
Returns:
{dict} The virtual traffic description
see {file:files/resources_desc.md#Traffic Resource Description - VTraffic})
see :desc:`resources description<>`
"""
return self.get_json("/vnodes/%s/ifaces/%s/output" % (vnodename, vifacename))
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment