various improvements
This commit is contained in:
@ -0,0 +1,11 @@
|
||||
Package: compute-doc
|
||||
Source: compute
|
||||
Version: 0.1.0.dev1-1
|
||||
Architecture: all
|
||||
Maintainer: ge <ge@nixhacks.net>
|
||||
Installed-Size: 376
|
||||
Depends: libjs-sphinxdoc (>= 5.2)
|
||||
Section: doc
|
||||
Priority: optional
|
||||
Homepage: https://git.lulzette.ru/hstack/compute
|
||||
Description: Compute instances management library and tools (documentation)
|
||||
@ -0,0 +1,40 @@
|
||||
6845278a102bd147f30f770ed1134ce5 usr/share/doc/compute-doc/changelog.Debian.gz
|
||||
fb1a6c11d7a8fa5f238617c20b13b6a1 usr/share/doc/compute-doc/copyright
|
||||
705113edf19bbf7f9d406fccd98ebef9 usr/share/doc/compute-doc/html/_sources/index.rst.txt
|
||||
91934f7b742b8395043e25cfa73682af usr/share/doc/compute-doc/html/_sources/pyapi/exceptions.rst.txt
|
||||
de8bc1c2c00774ddee5363aef80c0775 usr/share/doc/compute-doc/html/_sources/pyapi/index.rst.txt
|
||||
2a0040e0a150de53ed929e963af635a8 usr/share/doc/compute-doc/html/_sources/pyapi/instance/guest_agent.rst.txt
|
||||
dd6324cb85dc57ef37c4f8161aa2d233 usr/share/doc/compute-doc/html/_sources/pyapi/instance/index.rst.txt
|
||||
c594567565cc48a247932409d9adcc4a usr/share/doc/compute-doc/html/_sources/pyapi/instance/instance.rst.txt
|
||||
e6a69ab447e455dba6e7b865a3d872d2 usr/share/doc/compute-doc/html/_sources/pyapi/instance/schemas.rst.txt
|
||||
ba27654c086857e64d58468b13bc31c4 usr/share/doc/compute-doc/html/_sources/pyapi/session.rst.txt
|
||||
801ccc953fc57199b06ec122e10f784c usr/share/doc/compute-doc/html/_sources/pyapi/storage/index.rst.txt
|
||||
324ae7c877f3cf7895b2a5d3af579345 usr/share/doc/compute-doc/html/_sources/pyapi/storage/pool.rst.txt
|
||||
db91c0d83c2c80e9f9323a8943eeeff4 usr/share/doc/compute-doc/html/_sources/pyapi/storage/volume.rst.txt
|
||||
572ed749dd8924c36f1afe9e8e14d4d3 usr/share/doc/compute-doc/html/_sources/pyapi/utils.rst.txt
|
||||
4fc9d553e40384beedf38e21f205d2a7 usr/share/doc/compute-doc/html/_static/alabaster.css
|
||||
23ffe661f835b08e157d492a86aae74d usr/share/doc/compute-doc/html/_static/basic.css
|
||||
dad0c9b31e59069c83018ce87594ed65 usr/share/doc/compute-doc/html/_static/custom.css
|
||||
5e103d51310d4e0c065325d795cc9def usr/share/doc/compute-doc/html/_static/documentation_options.js
|
||||
ba0c95766a77a6c598a7ca542f1db738 usr/share/doc/compute-doc/html/_static/file.png
|
||||
5b6b3233153feca50a94aa6c60873a5f usr/share/doc/compute-doc/html/_static/forkme_right_darkblue_121621.png
|
||||
36b1a4b05451c7acde7ced60b2f6bc21 usr/share/doc/compute-doc/html/_static/minus.png
|
||||
0d7849fd4d4148b7f78cab60a087633a usr/share/doc/compute-doc/html/_static/plus.png
|
||||
4f81be1c1dd97a6ec76af15b8f926189 usr/share/doc/compute-doc/html/_static/pygments.css
|
||||
fd297228a19ece7e38824d0704f3635d usr/share/doc/compute-doc/html/genindex.html
|
||||
3e038e6169c721ebacf889ea4ac5c1bf usr/share/doc/compute-doc/html/index.html
|
||||
b8e4906e5136e907ab0d7ae826720603 usr/share/doc/compute-doc/html/objects.inv
|
||||
2658558520c0c9f209dd4c69516facfd usr/share/doc/compute-doc/html/py-modindex.html
|
||||
4254a2ecc3e154f52646febebd0ef6e6 usr/share/doc/compute-doc/html/pyapi/exceptions.html
|
||||
bf4609f321d2c60399574c3e52dd6a44 usr/share/doc/compute-doc/html/pyapi/index.html
|
||||
730aab71986cb938e9aff03ba203c9a9 usr/share/doc/compute-doc/html/pyapi/instance/guest_agent.html
|
||||
fad8eba8a9cb9b1befd8e0ecdf1bbe5f usr/share/doc/compute-doc/html/pyapi/instance/index.html
|
||||
781272676f0b35c52f43b99f2ca86647 usr/share/doc/compute-doc/html/pyapi/instance/instance.html
|
||||
ede88501ec628083bb1ad1cb86cdec9f usr/share/doc/compute-doc/html/pyapi/instance/schemas.html
|
||||
4c8d372d298068aba7272d11feb2cc52 usr/share/doc/compute-doc/html/pyapi/session.html
|
||||
000f86f6184a455843017772ff2fec9d usr/share/doc/compute-doc/html/pyapi/storage/index.html
|
||||
a2b63c0194a1e55be8d7036b46851986 usr/share/doc/compute-doc/html/pyapi/storage/pool.html
|
||||
8d4e9081b213585aad36b4daadc37e26 usr/share/doc/compute-doc/html/pyapi/storage/volume.html
|
||||
307d7a44f4343b0f34ee758e4ab20d88 usr/share/doc/compute-doc/html/pyapi/utils.html
|
||||
5999199d4710213969f7fb1b50647f4a usr/share/doc/compute-doc/html/search.html
|
||||
148b182d3691ae88c629783c3623007d usr/share/doc/compute-doc/html/searchindex.js
|
||||
Binary file not shown.
@ -0,0 +1,32 @@
|
||||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Source: https://git.lulzette.ru/hstack/compute
|
||||
Upstream-Name: compute
|
||||
|
||||
Files:
|
||||
*
|
||||
Copyright:
|
||||
2023 ge <ge@nixhacks.net>
|
||||
License: GPL-3.0+
|
||||
|
||||
Files:
|
||||
debian/*
|
||||
Copyright:
|
||||
2023 ge <ge@nixhacks.net>
|
||||
License: GPL-3.0+
|
||||
|
||||
License: GPL-3.0+
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
.
|
||||
This package is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
Comment:
|
||||
On Debian systems, the complete text of the GNU General
|
||||
Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
|
||||
@ -0,0 +1,16 @@
|
||||
Compute
|
||||
=======
|
||||
|
||||
Compute instances management library.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
pyapi/index
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
@ -0,0 +1,5 @@
|
||||
``exceptions``
|
||||
==============
|
||||
|
||||
.. automodule:: compute.exceptions
|
||||
:members:
|
||||
@ -0,0 +1,49 @@
|
||||
Python API
|
||||
==========
|
||||
|
||||
The API allows you to perform actions on instances programmatically. Below is
|
||||
an example of changing parameters and launching the `myinstance` instance.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import logging
|
||||
|
||||
from compute import Session
|
||||
|
||||
logging.basicConfig(level=logging.DEBUG)
|
||||
|
||||
with Session() as session:
|
||||
instance = session.get_instance('myinstance')
|
||||
instance.set_vcpus(4)
|
||||
instance.start()
|
||||
instance.set_autostart(enabled=True)
|
||||
|
||||
|
||||
:class:`Session` context manager provides an abstraction over :class:`libvirt.virConnect`
|
||||
and returns objects of other classes of the present library.
|
||||
|
||||
Entity representation
|
||||
---------------------
|
||||
|
||||
Entities such as a compute-instance are represented as classes. These classes directly
|
||||
call libvirt methods to perform operations on the hypervisor. An example class is
|
||||
:class:`Volume`.
|
||||
|
||||
The configuration files of various libvirt objects in `compute` are described by special
|
||||
dataclasses. The dataclass stores object parameters in its properties and can return an
|
||||
XML config for libvirt using the ``to_xml()`` method. For example :class:`VolumeConfig`.
|
||||
|
||||
`Pydantic <https://docs.pydantic.dev/>`_ models are used to validate input data.
|
||||
For example :class:`VolumeSchema`.
|
||||
|
||||
Modules documentation
|
||||
---------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
session
|
||||
instance/index
|
||||
storage/index
|
||||
utils
|
||||
exceptions
|
||||
@ -0,0 +1,6 @@
|
||||
``guest_agent``
|
||||
===============
|
||||
|
||||
.. automodule:: compute.instance.guest_agent
|
||||
:members:
|
||||
:special-members: __init__
|
||||
@ -0,0 +1,10 @@
|
||||
``instance``
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Contents:
|
||||
|
||||
instance
|
||||
guest_agent
|
||||
schemas
|
||||
@ -0,0 +1,6 @@
|
||||
``instance``
|
||||
============
|
||||
|
||||
.. automodule:: compute.instance.instance
|
||||
:members:
|
||||
:special-members: __init__
|
||||
@ -0,0 +1,5 @@
|
||||
``schemas``
|
||||
===========
|
||||
|
||||
.. automodule:: compute.instance.schemas
|
||||
:members:
|
||||
@ -0,0 +1,6 @@
|
||||
``session``
|
||||
===========
|
||||
|
||||
.. automodule:: compute.session
|
||||
:members:
|
||||
:special-members: __init__
|
||||
@ -0,0 +1,9 @@
|
||||
``storage``
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Contents:
|
||||
|
||||
pool
|
||||
volume
|
||||
@ -0,0 +1,6 @@
|
||||
``pool``
|
||||
========
|
||||
|
||||
.. automodule:: compute.storage.pool
|
||||
:members:
|
||||
:special-members: __init__
|
||||
@ -0,0 +1,6 @@
|
||||
``volume``
|
||||
==========
|
||||
|
||||
.. automodule:: compute.storage.volume
|
||||
:members:
|
||||
:special-members: __init__
|
||||
@ -0,0 +1,14 @@
|
||||
``utils``
|
||||
=========
|
||||
|
||||
``utils.units``
|
||||
---------------
|
||||
|
||||
.. automodule:: compute.utils.units
|
||||
:members:
|
||||
|
||||
``utils.ids``
|
||||
-------------
|
||||
|
||||
.. automodule:: compute.utils.ids
|
||||
:members:
|
||||
@ -0,0 +1 @@
|
||||
../../../../javascript/sphinxdoc/1.0/_sphinx_javascript_frameworks_compat.js
|
||||
@ -0,0 +1,701 @@
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: Georgia, serif;
|
||||
font-size: 17px;
|
||||
background-color: #fff;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
|
||||
div.document {
|
||||
width: 940px;
|
||||
margin: 30px auto 0 auto;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 220px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
width: 220px;
|
||||
font-size: 14px;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid #B1B4B6;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #fff;
|
||||
color: #3E4349;
|
||||
padding: 0 30px 0 30px;
|
||||
}
|
||||
|
||||
div.body > .section {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
width: 940px;
|
||||
margin: 20px auto 30px auto;
|
||||
font-size: 14px;
|
||||
color: #888;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #888;
|
||||
}
|
||||
|
||||
p.caption {
|
||||
font-family: inherit;
|
||||
font-size: inherit;
|
||||
}
|
||||
|
||||
|
||||
div.relations {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #444;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a:hover {
|
||||
border-bottom: 1px solid #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 18px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.logo {
|
||||
padding: 0;
|
||||
margin: -10px 0 0 0px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper h1.logo {
|
||||
margin-top: -10px;
|
||||
text-align: center;
|
||||
margin-bottom: 5px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper h1.logo-name {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.blurb {
|
||||
margin-top: 0;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3,
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: Georgia, serif;
|
||||
color: #444;
|
||||
font-size: 24px;
|
||||
font-weight: normal;
|
||||
margin: 0 0 5px 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-size: 20px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo a,
|
||||
div.sphinxsidebar h3 a,
|
||||
div.sphinxsidebar p.logo a:hover,
|
||||
div.sphinxsidebar h3 a:hover {
|
||||
border: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #555;
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px 0;
|
||||
padding: 0;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul li.toctree-l1 > a {
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul li.toctree-l2 > a {
|
||||
font-size: 110%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #CCC;
|
||||
font-family: Georgia, serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar hr {
|
||||
border: none;
|
||||
height: 1px;
|
||||
color: #AAA;
|
||||
background: #AAA;
|
||||
|
||||
text-align: left;
|
||||
margin-left: 0;
|
||||
width: 50%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar .badge {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar .badge:hover {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* To address an issue with donation coming after search */
|
||||
div.sphinxsidebar h3.donation {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
a {
|
||||
color: #004B6B;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #6D4100;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: Georgia, serif;
|
||||
font-weight: normal;
|
||||
margin: 30px 0px 10px 0px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
|
||||
div.body h2 { font-size: 180%; }
|
||||
div.body h3 { font-size: 150%; }
|
||||
div.body h4 { font-size: 130%; }
|
||||
div.body h5 { font-size: 100%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #DDD;
|
||||
padding: 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
color: #444;
|
||||
background: #EAEAEA;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
line-height: 1.4em;
|
||||
}
|
||||
|
||||
div.admonition {
|
||||
margin: 20px 0px;
|
||||
padding: 10px 30px;
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
|
||||
background-color: #FBFBFB;
|
||||
border-bottom: 1px solid #fafafa;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title {
|
||||
font-family: Georgia, serif;
|
||||
font-weight: normal;
|
||||
font-size: 24px;
|
||||
margin: 0 0 10px 0;
|
||||
padding: 0;
|
||||
line-height: 1;
|
||||
}
|
||||
|
||||
div.admonition p.last {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.highlight {
|
||||
background-color: #fff;
|
||||
}
|
||||
|
||||
dt:target, .highlight {
|
||||
background: #FAF3E8;
|
||||
}
|
||||
|
||||
div.warning {
|
||||
background-color: #FCC;
|
||||
border: 1px solid #FAA;
|
||||
}
|
||||
|
||||
div.danger {
|
||||
background-color: #FCC;
|
||||
border: 1px solid #FAA;
|
||||
-moz-box-shadow: 2px 2px 4px #D52C2C;
|
||||
-webkit-box-shadow: 2px 2px 4px #D52C2C;
|
||||
box-shadow: 2px 2px 4px #D52C2C;
|
||||
}
|
||||
|
||||
div.error {
|
||||
background-color: #FCC;
|
||||
border: 1px solid #FAA;
|
||||
-moz-box-shadow: 2px 2px 4px #D52C2C;
|
||||
-webkit-box-shadow: 2px 2px 4px #D52C2C;
|
||||
box-shadow: 2px 2px 4px #D52C2C;
|
||||
}
|
||||
|
||||
div.caution {
|
||||
background-color: #FCC;
|
||||
border: 1px solid #FAA;
|
||||
}
|
||||
|
||||
div.attention {
|
||||
background-color: #FCC;
|
||||
border: 1px solid #FAA;
|
||||
}
|
||||
|
||||
div.important {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.tip {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.hint {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #EEE;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre, tt, code {
|
||||
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.hll {
|
||||
background-color: #FFC;
|
||||
margin: 0 -12px;
|
||||
padding: 0 12px;
|
||||
display: block;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
}
|
||||
|
||||
tt.descname, tt.descclassname, code.descname, code.descclassname {
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
tt.descname, code.descname {
|
||||
padding-right: 0.08em;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
-moz-box-shadow: 2px 2px 4px #EEE;
|
||||
-webkit-box-shadow: 2px 2px 4px #EEE;
|
||||
box-shadow: 2px 2px 4px #EEE;
|
||||
}
|
||||
|
||||
table.docutils {
|
||||
border: 1px solid #888;
|
||||
-moz-box-shadow: 2px 2px 4px #EEE;
|
||||
-webkit-box-shadow: 2px 2px 4px #EEE;
|
||||
box-shadow: 2px 2px 4px #EEE;
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
border: 1px solid #888;
|
||||
padding: 0.25em 0.7em;
|
||||
}
|
||||
|
||||
table.field-list, table.footnote {
|
||||
border: none;
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
table.footnote {
|
||||
margin: 15px 0;
|
||||
width: 100%;
|
||||
border: 1px solid #EEE;
|
||||
background: #FDFDFD;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
table.footnote + table.footnote {
|
||||
margin-top: -15px;
|
||||
border-top: none;
|
||||
}
|
||||
|
||||
table.field-list th {
|
||||
padding: 0 0.8em 0 0;
|
||||
}
|
||||
|
||||
table.field-list td {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.field-list p {
|
||||
margin-bottom: 0.8em;
|
||||
}
|
||||
|
||||
/* Cloned from
|
||||
* https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
|
||||
*/
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
table.footnote td.label {
|
||||
width: .1px;
|
||||
padding: 0.3em 0 0.3em 0.5em;
|
||||
}
|
||||
|
||||
table.footnote td {
|
||||
padding: 0.3em 0.5em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
margin: 0 0 0 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul, ol {
|
||||
/* Matches the 30px from the narrow-screen "li > ul" selector below */
|
||||
margin: 10px 0 10px 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
pre {
|
||||
background: #EEE;
|
||||
padding: 7px 30px;
|
||||
margin: 15px 0px;
|
||||
line-height: 1.3em;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
background: #ffd;
|
||||
}
|
||||
|
||||
dl pre, blockquote pre, li pre {
|
||||
margin-left: 0;
|
||||
padding-left: 30px;
|
||||
}
|
||||
|
||||
tt, code {
|
||||
background-color: #ecf0f3;
|
||||
color: #222;
|
||||
/* padding: 1px 2px; */
|
||||
}
|
||||
|
||||
tt.xref, code.xref, a tt {
|
||||
background-color: #FBFBFB;
|
||||
border-bottom: 1px solid #fff;
|
||||
}
|
||||
|
||||
a.reference {
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
/* Don't put an underline on images */
|
||||
a.image-reference, a.image-reference:hover {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
a.reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a.footnote-reference {
|
||||
text-decoration: none;
|
||||
font-size: 0.7em;
|
||||
vertical-align: top;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
a.footnote-reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a:hover tt, a:hover code {
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
|
||||
@media screen and (max-width: 870px) {
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
margin-left: 0;
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
li > ul {
|
||||
/* Matches the 30px from the "ul, ol" selector above */
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
.document {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.github {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
@media screen and (max-width: 875px) {
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
padding: 20px 30px;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: none;
|
||||
background: #fff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: block;
|
||||
float: none;
|
||||
width: 102.5%;
|
||||
margin: 50px -30px -20px -30px;
|
||||
padding: 10px 20px;
|
||||
background: #333;
|
||||
color: #FFF;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #AAA;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.body {
|
||||
min-height: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.rtd_doc_footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.document {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.github {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/* misc. */
|
||||
|
||||
.revsys-inline {
|
||||
display: none!important;
|
||||
}
|
||||
|
||||
/* Make nested-list/multi-paragraph items look better in Releases changelog
|
||||
* pages. Without this, docutils' magical list fuckery causes inconsistent
|
||||
* formatting between different release sub-lists.
|
||||
*/
|
||||
div#changelog > div.section > ul > li > p:only-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
/* Hide fugly table cell borders in ..bibliography:: directive output */
|
||||
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
|
||||
border: none;
|
||||
/* Below needed in some edge cases; if not applied, bottom shadows appear */
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
|
||||
/* relbar */
|
||||
|
||||
.related {
|
||||
line-height: 30px;
|
||||
width: 100%;
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
|
||||
.related.top {
|
||||
border-bottom: 1px solid #EEE;
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.related.bottom {
|
||||
border-top: 1px solid #EEE;
|
||||
}
|
||||
|
||||
.related ul {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
nav#rellinks {
|
||||
float: right;
|
||||
}
|
||||
|
||||
nav#rellinks li+li:before {
|
||||
content: "|";
|
||||
}
|
||||
|
||||
nav#breadcrumbs li+li:before {
|
||||
content: "\00BB";
|
||||
}
|
||||
|
||||
/* Hide certain items when printing */
|
||||
@media print {
|
||||
div.related {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,900 @@
|
||||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
div.section::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox form.search {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
float: left;
|
||||
width: 80%;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
float: left;
|
||||
width: 20%;
|
||||
border-left: none;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li p.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
table.indextable > tbody > tr > td > ul {
|
||||
padding-left: 0em;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- domain module index --------------------------------------------------- */
|
||||
|
||||
table.modindextable td {
|
||||
padding: 2px;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body {
|
||||
min-width: 360px;
|
||||
max-width: 800px;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, figure.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar,
|
||||
aside.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
clear: right;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
nav.contents,
|
||||
aside.topic,
|
||||
div.admonition, div.topic, blockquote {
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
nav.contents,
|
||||
aside.topic,
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
nav.contents > :last-child,
|
||||
aside.topic > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::after,
|
||||
nav.contents::after,
|
||||
aside.topic::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > :first-child,
|
||||
td > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > :last-child,
|
||||
td > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure, figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption, figcaption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number,
|
||||
figcaption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text,
|
||||
figcaption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
/* -- hlist styles ---------------------------------------------------------- */
|
||||
|
||||
table.hlist {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
table.hlist td {
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
/* -- object description styles --------------------------------------------- */
|
||||
|
||||
.sig {
|
||||
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
}
|
||||
|
||||
.sig-name, code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.sig-name {
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
.sig-prename, code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.sig-param.n {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* C++ specific styling */
|
||||
|
||||
.sig-inline.c-texpr,
|
||||
.sig-inline.cpp-texpr {
|
||||
font-family: unset;
|
||||
}
|
||||
|
||||
.sig.c .k, .sig.c .kt,
|
||||
.sig.cpp .k, .sig.cpp .kt {
|
||||
color: #0033B3;
|
||||
}
|
||||
|
||||
.sig.c .m,
|
||||
.sig.cpp .m {
|
||||
color: #1750EB;
|
||||
}
|
||||
|
||||
.sig.c .s, .sig.c .sc,
|
||||
.sig.cpp .s, .sig.cpp .sc {
|
||||
color: #067D17;
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:first-child > :first-child,
|
||||
:not(li) > ul > li:first-child > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:last-child > :last-child,
|
||||
:not(li) > ul > li:last-child > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
ol.simple ol p,
|
||||
ol.simple ul p,
|
||||
ul.simple ol p,
|
||||
ul.simple ul p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple > li:not(:first-child) > p,
|
||||
ul.simple > li:not(:first-child) > p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple p,
|
||||
ul.simple p {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
aside.footnote > span,
|
||||
div.citation > span {
|
||||
float: left;
|
||||
}
|
||||
aside.footnote > span:last-of-type,
|
||||
div.citation > span:last-of-type {
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
aside.footnote > p {
|
||||
margin-left: 2em;
|
||||
}
|
||||
div.citation > p {
|
||||
margin-left: 4em;
|
||||
}
|
||||
aside.footnote > p:last-of-type,
|
||||
div.citation > p:last-of-type {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
aside.footnote > p:last-of-type:after,
|
||||
div.citation > p:last-of-type:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dl > dd:last-child,
|
||||
dl > dd:last-child > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
rect.highlighted {
|
||||
fill: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0 0.5em;
|
||||
content: ":";
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
pre, div[class*="highlight-"] {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
div[class*="highlight-"] {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tbody {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tr {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos {
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td.code {
|
||||
flex: 1;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.highlight .hll {
|
||||
display: block;
|
||||
}
|
||||
|
||||
div.highlight pre,
|
||||
table.highlighttable pre {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption + div {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
margin-top: 1em;
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos,
|
||||
span.linenos,
|
||||
div.highlight span.gp { /* gp: Generic.Prompt */
|
||||
user-select: none;
|
||||
-webkit-user-select: text; /* Safari fallback only */
|
||||
-webkit-user-select: none; /* Chrome/Safari */
|
||||
-moz-user-select: none; /* Firefox */
|
||||
-ms-user-select: none; /* IE10+ */
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
span.eqno a.headerlink {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
div.math:hover a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1 @@
|
||||
/* This file intentionally left blank. */
|
||||
@ -0,0 +1 @@
|
||||
../../../../javascript/sphinxdoc/1.0/doctools.js
|
||||
@ -0,0 +1,14 @@
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '0.1.0',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
FILE_SUFFIX: '.html',
|
||||
LINK_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
SHOW_SEARCH_SUMMARY: true,
|
||||
ENABLE_SEARCH_SHORTCUTS: true,
|
||||
};
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 286 B |
Binary file not shown.
|
After Width: | Height: | Size: 7.6 KiB |
@ -0,0 +1 @@
|
||||
../../../../javascript/sphinxdoc/1.0/jquery.js
|
||||
@ -0,0 +1 @@
|
||||
../../../../javascript/sphinxdoc/1.0/language_data.js
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
@ -0,0 +1,83 @@
|
||||
pre { line-height: 125%; }
|
||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #f8f8f8; }
|
||||
.highlight .c { color: #8f5902; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
|
||||
.highlight .g { color: #000000 } /* Generic */
|
||||
.highlight .k { color: #004461; font-weight: bold } /* Keyword */
|
||||
.highlight .l { color: #000000 } /* Literal */
|
||||
.highlight .n { color: #000000 } /* Name */
|
||||
.highlight .o { color: #582800 } /* Operator */
|
||||
.highlight .x { color: #000000 } /* Other */
|
||||
.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
|
||||
.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #8f5902 } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
|
||||
.highlight .gd { color: #a40000 } /* Generic.Deleted */
|
||||
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #ef2929 } /* Generic.Error */
|
||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
||||
.highlight .go { color: #888888 } /* Generic.Output */
|
||||
.highlight .gp { color: #745334 } /* Generic.Prompt */
|
||||
.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||
.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
|
||||
.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
|
||||
.highlight .ld { color: #000000 } /* Literal.Date */
|
||||
.highlight .m { color: #990000 } /* Literal.Number */
|
||||
.highlight .s { color: #4e9a06 } /* Literal.String */
|
||||
.highlight .na { color: #c4a000 } /* Name.Attribute */
|
||||
.highlight .nb { color: #004461 } /* Name.Builtin */
|
||||
.highlight .nc { color: #000000 } /* Name.Class */
|
||||
.highlight .no { color: #000000 } /* Name.Constant */
|
||||
.highlight .nd { color: #888888 } /* Name.Decorator */
|
||||
.highlight .ni { color: #ce5c00 } /* Name.Entity */
|
||||
.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #000000 } /* Name.Function */
|
||||
.highlight .nl { color: #f57900 } /* Name.Label */
|
||||
.highlight .nn { color: #000000 } /* Name.Namespace */
|
||||
.highlight .nx { color: #000000 } /* Name.Other */
|
||||
.highlight .py { color: #000000 } /* Name.Property */
|
||||
.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #000000 } /* Name.Variable */
|
||||
.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
|
||||
.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */
|
||||
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
|
||||
.highlight .mb { color: #990000 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #990000 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #990000 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #990000 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #990000 } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
|
||||
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #000000 } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #000000 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #000000 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */
|
||||
@ -0,0 +1 @@
|
||||
../../../../javascript/sphinxdoc/1.0/searchtools.js
|
||||
@ -0,0 +1 @@
|
||||
../../../../javascript/sphinxdoc/1.0/sphinx_highlight.js
|
||||
@ -0,0 +1 @@
|
||||
../../../../javascript/sphinxdoc/1.0/underscore.js
|
||||
@ -0,0 +1,614 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="#" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#_"><strong>_</strong></a>
|
||||
| <a href="#A"><strong>A</strong></a>
|
||||
| <a href="#B"><strong>B</strong></a>
|
||||
| <a href="#C"><strong>C</strong></a>
|
||||
| <a href="#D"><strong>D</strong></a>
|
||||
| <a href="#E"><strong>E</strong></a>
|
||||
| <a href="#G"><strong>G</strong></a>
|
||||
| <a href="#I"><strong>I</strong></a>
|
||||
| <a href="#L"><strong>L</strong></a>
|
||||
| <a href="#M"><strong>M</strong></a>
|
||||
| <a href="#N"><strong>N</strong></a>
|
||||
| <a href="#P"><strong>P</strong></a>
|
||||
| <a href="#R"><strong>R</strong></a>
|
||||
| <a href="#S"><strong>S</strong></a>
|
||||
| <a href="#T"><strong>T</strong></a>
|
||||
| <a href="#U"><strong>U</strong></a>
|
||||
| <a href="#V"><strong>V</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="_">_</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.__init__">__init__() (compute.instance.guest_agent.GuestAgent method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.__init__">(compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceConfig.__init__">(compute.instance.instance.InstanceConfig method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.__init__">(compute.session.Session method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.__init__">(compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.DiskConfig.__init__">(compute.storage.volume.DiskConfig method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.Volume.__init__">(compute.storage.volume.Volume method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.VolumeConfig.__init__">(compute.storage.volume.VolumeConfig method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="A">A</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePoolUsageInfo.allocation">allocation (compute.storage.pool.StoragePoolUsageInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.arch">arch (compute.session.Capabilities attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.arch">(compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.attach_device">attach_device() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePoolUsageInfo.available">available (compute.storage.pool.StoragePoolUsageInfo attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="B">B</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.BootOptionsSchema">BootOptionsSchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="C">C</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities">Capabilities (class in compute.session)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePoolUsageInfo.capacity">capacity (compute.storage.pool.StoragePoolUsageInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.Volume.clone">clone() (compute.storage.volume.Volume method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.clone_volume">clone_volume() (compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.close">close() (compute.session.Session method)</a>
|
||||
</li>
|
||||
<li>
|
||||
compute.exceptions
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/exceptions.html#module-compute.exceptions">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
compute.instance.guest_agent
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/instance/guest_agent.html#module-compute.instance.guest_agent">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
compute.instance.instance
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/instance/instance.html#module-compute.instance.instance">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
compute.instance.schemas
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/instance/schemas.html#module-compute.instance.schemas">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
compute.session
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/session.html#module-compute.session">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
compute.storage.pool
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/storage/pool.html#module-compute.storage.pool">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
compute.storage.volume
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/storage/volume.html#module-compute.storage.volume">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li>
|
||||
compute.utils.ids
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/utils.html#module-compute.utils.ids">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
compute.utils.units
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/utils.html#module-compute.utils.units">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.ComputeError">ComputeError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.ConfigLoaderError">ConfigLoaderError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.cores">cores (compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.cpu_features">cpu_features (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.cpu_model">cpu_model (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.cpu_vendor">cpu_vendor (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.CPUEmulationMode">CPUEmulationMode (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.CPUFeaturesSchema">CPUFeaturesSchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.cpus">cpus (compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.CPUSchema">CPUSchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceInfo.cputime">cputime (compute.instance.instance.InstanceInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.CPUTopologySchema">CPUTopologySchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.create_instance">create_instance() (compute.session.Session method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.create_volume">create_volume() (compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="D">D</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/utils.html#compute.utils.units.DataUnit">DataUnit (class in compute.utils.units)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.delete">delete() (compute.instance.instance.Instance method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.Volume.delete">(compute.storage.volume.Volume method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.delete_ssh_keys">delete_ssh_keys() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.detach_device">detach_device() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.detach_disk">detach_disk() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.DiskConfig">DiskConfig (class in compute.storage.volume)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.dump_xml">dump_xml() (compute.instance.instance.Instance method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.dump_xml">(compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.Volume.dump_xml">(compute.storage.volume.Volume method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="E">E</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.emulator">emulator (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.EntityModel">EntityModel (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.EntityModel.Config">EntityModel.Config (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.execute">execute() (compute.instance.guest_agent.GuestAgent method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.exitcode">exitcode (compute.instance.guest_agent.GuestExecOutput attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.exited">exited (compute.instance.guest_agent.GuestExecOutput attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="G">G</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.get_capabilities">get_capabilities() (compute.session.Session method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.get_disks">get_disks() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.get_info">get_info() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.get_instance">get_instance() (compute.session.Session method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.get_max_memory">get_max_memory() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.get_max_vcpus">get_max_vcpus() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.get_node_info">get_node_info() (compute.session.Session method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.get_ssh_keys">get_ssh_keys() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.get_status">get_status() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.get_storage_pool">get_storage_pool() (compute.session.Session method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.get_supported_commands">get_supported_commands() (compute.instance.guest_agent.GuestAgent method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.get_usage_info">get_usage_info() (compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.get_volume">get_volume() (compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.guest_exec">guest_exec() (compute.instance.guest_agent.GuestAgent method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.guest_exec_status">guest_exec_status() (compute.instance.guest_agent.GuestAgent method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent">GuestAgent (class in compute.instance.guest_agent)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.GuestAgentCommandNotSupportedError">GuestAgentCommandNotSupportedError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.GuestAgentError">GuestAgentError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.GuestAgentTimeoutExceededError">GuestAgentTimeoutExceededError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.GuestAgentUnavailableError">GuestAgentUnavailableError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput">GuestExecOutput (class in compute.instance.guest_agent)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="I">I</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance">Instance (class in compute.instance.instance)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceConfig">InstanceConfig (class in compute.instance.instance)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.InstanceError">InstanceError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceInfo">InstanceInfo (class in compute.instance.instance)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.InstanceNotFoundError">InstanceNotFoundError</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.InstanceSchema">InstanceSchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/utils.html#compute.utils.units.InvalidDataUnitError">InvalidDataUnitError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.is_autostart">is_autostart() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.is_available">is_available() (compute.instance.guest_agent.GuestAgent method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.is_running">is_running() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="L">L</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.list_instances">list_instances() (compute.session.Session method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Session.list_storage_pools">list_storage_pools() (compute.session.Session method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.list_volumes">list_volumes() (compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="M">M</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.machine">machine (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceInfo.max_memory">max_memory (compute.instance.instance.InstanceInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.max_vcpus">max_vcpus (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceInfo.memory">memory (compute.instance.instance.InstanceInfo attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.memory">(compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.mhz">mhz (compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
<li>
|
||||
module
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/exceptions.html#module-compute.exceptions">compute.exceptions</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#module-compute.instance.guest_agent">compute.instance.guest_agent</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#module-compute.instance.instance">compute.instance.instance</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#module-compute.instance.schemas">compute.instance.schemas</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#module-compute.session">compute.session</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#module-compute.storage.pool">compute.storage.pool</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#module-compute.storage.volume">compute.storage.volume</a>
|
||||
</li>
|
||||
<li><a href="pyapi/utils.html#module-compute.utils.ids">compute.utils.ids</a>
|
||||
</li>
|
||||
<li><a href="pyapi/utils.html#module-compute.utils.units">compute.utils.units</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="N">N</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.NetworkInterfaceSchema">NetworkInterfaceSchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo">NodeInfo (class in compute.session)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.nodes">nodes (compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceInfo.nproc">nproc (compute.instance.instance.InstanceInfo attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="P">P</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.pause">pause() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.power_reset">power_reset() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="R">R</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.raise_for_commands">raise_for_commands() (compute.instance.guest_agent.GuestAgent method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/utils.html#compute.utils.ids.random_mac">random_mac() (in module compute.utils.ids)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.reboot">reboot() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool.refresh">refresh() (compute.storage.pool.StoragePool method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.reset">reset() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.Volume.resize">resize() (compute.storage.volume.Volume method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.resize_disk">resize_disk() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.resume">resume() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="S">S</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Session">Session (class in compute.session)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.SessionError">SessionError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.set_autostart">set_autostart() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.set_memory">set_memory() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.set_ssh_keys">set_ssh_keys() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.set_user_password">set_user_password() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.set_vcpus">set_vcpus() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.shutdown">shutdown() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.sockets">sockets (compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.Instance.start">start() (compute.instance.instance.Instance method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceInfo.state">state (compute.instance.instance.InstanceInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.stderr">stderr (compute.instance.guest_agent.GuestExecOutput attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.stdout">stdout (compute.instance.guest_agent.GuestExecOutput attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePool">StoragePool (class in compute.storage.pool)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.StoragePoolError">StoragePoolError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.StoragePoolNotFoundError">StoragePoolNotFoundError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/pool.html#compute.storage.pool.StoragePoolUsageInfo">StoragePoolUsageInfo (class in compute.storage.pool)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="T">T</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.NodeInfo.threads">threads (compute.session.NodeInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/utils.html#compute.utils.units.to_bytes">to_bytes() (in module compute.utils.units)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/instance/instance.html#compute.instance.instance.InstanceConfig.to_xml">to_xml() (compute.instance.instance.InstanceConfig method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.DiskConfig.to_xml">(compute.storage.volume.DiskConfig method)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.VolumeConfig.to_xml">(compute.storage.volume.VolumeConfig method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="U">U</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.usable_cpus">usable_cpus (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="V">V</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/session.html#compute.session.Capabilities.virt_type">virt_type (compute.session.Capabilities attribute)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.Volume">Volume (class in compute.storage.volume)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.VolumeCapacitySchema">VolumeCapacitySchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pyapi/storage/volume.html#compute.storage.volume.VolumeConfig">VolumeConfig (class in compute.storage.volume)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/exceptions.html#compute.exceptions.VolumeNotFoundError">VolumeNotFoundError</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.VolumeSchema">VolumeSchema (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
<li><a href="pyapi/instance/schemas.html#compute.instance.schemas.VolumeType">VolumeType (class in compute.instance.schemas)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="pyapi/index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,122 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>Compute — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Python API" href="pyapi/index.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="compute">
|
||||
<h1>Compute<a class="headerlink" href="#compute" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Compute instances management library.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="pyapi/index.html">Python API</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section id="indices-and-tables">
|
||||
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="#">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="pyapi/index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="#">Documentation overview</a><ul>
|
||||
<li>Next: <a href="pyapi/index.html" title="next chapter">Python API</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="_sources/index.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
@ -0,0 +1,165 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Python Module Index — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1>Python Module Index</h1>
|
||||
|
||||
<div class="modindex-jumpbox">
|
||||
<a href="#cap-c"><strong>c</strong></a>
|
||||
</div>
|
||||
|
||||
<table class="indextable modindextable">
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-c"><td></td><td>
|
||||
<strong>c</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-1" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<code class="xref">compute</code></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/exceptions.html#module-compute.exceptions"><code class="xref">compute.exceptions</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/instance/guest_agent.html#module-compute.instance.guest_agent"><code class="xref">compute.instance.guest_agent</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/instance/instance.html#module-compute.instance.instance"><code class="xref">compute.instance.instance</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/instance/schemas.html#module-compute.instance.schemas"><code class="xref">compute.instance.schemas</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/session.html#module-compute.session"><code class="xref">compute.session</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/storage/pool.html#module-compute.storage.pool"><code class="xref">compute.storage.pool</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/storage/volume.html#module-compute.storage.volume"><code class="xref">compute.storage.volume</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/utils.html#module-compute.utils.ids"><code class="xref">compute.utils.ids</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="pyapi/utils.html#module-compute.utils.units"><code class="xref">compute.utils.units</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="pyapi/index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,183 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>exceptions — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="prev" title="utils" href="utils.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-compute.exceptions">
|
||||
<span id="exceptions"></span><h1><code class="docutils literal notranslate"><span class="pre">exceptions</span></code><a class="headerlink" href="#module-compute.exceptions" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Exceptions.</p>
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.ComputeError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">ComputeError</span></span><a class="headerlink" href="#compute.exceptions.ComputeError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Basic exception class.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.ConfigLoaderError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">ConfigLoaderError</span></span><a class="headerlink" href="#compute.exceptions.ConfigLoaderError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Something went wrong when loading configuration.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.GuestAgentCommandNotSupportedError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">GuestAgentCommandNotSupportedError</span></span><a class="headerlink" href="#compute.exceptions.GuestAgentCommandNotSupportedError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Guest agent command is not supported or blacklisted on guest.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.GuestAgentError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">GuestAgentError</span></span><a class="headerlink" href="#compute.exceptions.GuestAgentError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Something went wring when QEMU Guest Agent call.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.GuestAgentTimeoutExceededError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">GuestAgentTimeoutExceededError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.exceptions.GuestAgentTimeoutExceededError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>QEMU timeout exceeded.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.GuestAgentUnavailableError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">GuestAgentUnavailableError</span></span><a class="headerlink" href="#compute.exceptions.GuestAgentUnavailableError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Guest agent is not connected or is unavailable.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.InstanceError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">InstanceError</span></span><a class="headerlink" href="#compute.exceptions.InstanceError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Something went wrong while interacting with the domain.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.InstanceNotFoundError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">InstanceNotFoundError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.exceptions.InstanceNotFoundError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Virtual machine or container not found on compute node.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.SessionError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">SessionError</span></span><a class="headerlink" href="#compute.exceptions.SessionError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Something went wrong while connecting to libvirtd.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.StoragePoolError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">StoragePoolError</span></span><a class="headerlink" href="#compute.exceptions.StoragePoolError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Something went wrong when operating with storage pool.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.StoragePoolNotFoundError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">StoragePoolNotFoundError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.exceptions.StoragePoolNotFoundError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Storage pool not found.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.exceptions.VolumeNotFoundError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.exceptions.</span></span><span class="sig-name descname"><span class="pre">VolumeNotFoundError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.exceptions.VolumeNotFoundError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Storage volume not found.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
<li><a href="index.html">Python API</a><ul>
|
||||
<li>Previous: <a href="utils.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">utils</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/pyapi/exceptions.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,342 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>Python API — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="session" href="session.html" />
|
||||
<link rel="prev" title="Compute" href="../index.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="python-api">
|
||||
<h1>Python API<a class="headerlink" href="#python-api" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The API allows you to perform actions on instances programmatically. Below is
|
||||
an example of changing parameters and launching the <cite>myinstance</cite> instance.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">logging</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">compute</span> <span class="kn">import</span> <span class="n">Session</span>
|
||||
|
||||
<span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
|
||||
|
||||
<span class="k">with</span> <span class="n">Session</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
|
||||
<span class="n">instance</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">get_instance</span><span class="p">(</span><span class="s1">'myinstance'</span><span class="p">)</span>
|
||||
<span class="n">instance</span><span class="o">.</span><span class="n">set_vcpus</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
|
||||
<span class="n">instance</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
|
||||
<span class="n">instance</span><span class="o">.</span><span class="n">set_autostart</span><span class="p">(</span><span class="n">enabled</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="xref py py-class docutils literal notranslate"><span class="pre">Session</span></code> context manager provides an abstraction over <code class="xref py py-class docutils literal notranslate"><span class="pre">libvirt.virConnect</span></code>
|
||||
and returns objects of other classes of the present library.</p>
|
||||
<section id="entity-representation">
|
||||
<h2>Entity representation<a class="headerlink" href="#entity-representation" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Entities such as a compute-instance are represented as classes. These classes directly
|
||||
call libvirt methods to perform operations on the hypervisor. An example class is
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">Volume</span></code>.</p>
|
||||
<p>The configuration files of various libvirt objects in <cite>compute</cite> are described by special
|
||||
dataclasses. The dataclass stores object parameters in its properties and can return an
|
||||
XML config for libvirt using the <code class="docutils literal notranslate"><span class="pre">to_xml()</span></code> method. For example <code class="xref py py-class docutils literal notranslate"><span class="pre">VolumeConfig</span></code>.</p>
|
||||
<p><a class="reference external" href="https://docs.pydantic.dev/">Pydantic</a> models are used to validate input data.
|
||||
For example <code class="xref py py-class docutils literal notranslate"><span class="pre">VolumeSchema</span></code>.</p>
|
||||
</section>
|
||||
<section id="modules-documentation">
|
||||
<h2>Modules documentation<a class="headerlink" href="#modules-documentation" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="session.html"><code class="docutils literal notranslate"><span class="pre">session</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="session.html#compute.session.Capabilities"><code class="docutils literal notranslate"><span class="pre">Capabilities</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.arch"><code class="docutils literal notranslate"><span class="pre">Capabilities.arch</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.cpu_features"><code class="docutils literal notranslate"><span class="pre">Capabilities.cpu_features</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.cpu_model"><code class="docutils literal notranslate"><span class="pre">Capabilities.cpu_model</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.cpu_vendor"><code class="docutils literal notranslate"><span class="pre">Capabilities.cpu_vendor</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.emulator"><code class="docutils literal notranslate"><span class="pre">Capabilities.emulator</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.machine"><code class="docutils literal notranslate"><span class="pre">Capabilities.machine</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.max_vcpus"><code class="docutils literal notranslate"><span class="pre">Capabilities.max_vcpus</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.usable_cpus"><code class="docutils literal notranslate"><span class="pre">Capabilities.usable_cpus</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Capabilities.virt_type"><code class="docutils literal notranslate"><span class="pre">Capabilities.virt_type</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="session.html#compute.session.NodeInfo"><code class="docutils literal notranslate"><span class="pre">NodeInfo</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.arch"><code class="docutils literal notranslate"><span class="pre">NodeInfo.arch</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.cores"><code class="docutils literal notranslate"><span class="pre">NodeInfo.cores</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.cpus"><code class="docutils literal notranslate"><span class="pre">NodeInfo.cpus</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.memory"><code class="docutils literal notranslate"><span class="pre">NodeInfo.memory</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.mhz"><code class="docutils literal notranslate"><span class="pre">NodeInfo.mhz</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.nodes"><code class="docutils literal notranslate"><span class="pre">NodeInfo.nodes</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.sockets"><code class="docutils literal notranslate"><span class="pre">NodeInfo.sockets</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.NodeInfo.threads"><code class="docutils literal notranslate"><span class="pre">NodeInfo.threads</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="session.html#compute.session.Session"><code class="docutils literal notranslate"><span class="pre">Session</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.__init__"><code class="docutils literal notranslate"><span class="pre">Session.__init__()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.close"><code class="docutils literal notranslate"><span class="pre">Session.close()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.create_instance"><code class="docutils literal notranslate"><span class="pre">Session.create_instance()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.get_capabilities"><code class="docutils literal notranslate"><span class="pre">Session.get_capabilities()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.get_instance"><code class="docutils literal notranslate"><span class="pre">Session.get_instance()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.get_node_info"><code class="docutils literal notranslate"><span class="pre">Session.get_node_info()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.get_storage_pool"><code class="docutils literal notranslate"><span class="pre">Session.get_storage_pool()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.list_instances"><code class="docutils literal notranslate"><span class="pre">Session.list_instances()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="session.html#compute.session.Session.list_storage_pools"><code class="docutils literal notranslate"><span class="pre">Session.list_storage_pools()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="instance/index.html"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="instance/instance.html"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance"><code class="docutils literal notranslate"><span class="pre">Instance</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.__init__"><code class="docutils literal notranslate"><span class="pre">Instance.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.attach_device"><code class="docutils literal notranslate"><span class="pre">Instance.attach_device()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.delete"><code class="docutils literal notranslate"><span class="pre">Instance.delete()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.delete_ssh_keys"><code class="docutils literal notranslate"><span class="pre">Instance.delete_ssh_keys()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.detach_device"><code class="docutils literal notranslate"><span class="pre">Instance.detach_device()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.detach_disk"><code class="docutils literal notranslate"><span class="pre">Instance.detach_disk()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.dump_xml"><code class="docutils literal notranslate"><span class="pre">Instance.dump_xml()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.get_disks"><code class="docutils literal notranslate"><span class="pre">Instance.get_disks()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.get_info"><code class="docutils literal notranslate"><span class="pre">Instance.get_info()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.get_max_memory"><code class="docutils literal notranslate"><span class="pre">Instance.get_max_memory()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.get_max_vcpus"><code class="docutils literal notranslate"><span class="pre">Instance.get_max_vcpus()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.get_ssh_keys"><code class="docutils literal notranslate"><span class="pre">Instance.get_ssh_keys()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.get_status"><code class="docutils literal notranslate"><span class="pre">Instance.get_status()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.is_autostart"><code class="docutils literal notranslate"><span class="pre">Instance.is_autostart()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.is_running"><code class="docutils literal notranslate"><span class="pre">Instance.is_running()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.pause"><code class="docutils literal notranslate"><span class="pre">Instance.pause()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.power_reset"><code class="docutils literal notranslate"><span class="pre">Instance.power_reset()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.reboot"><code class="docutils literal notranslate"><span class="pre">Instance.reboot()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.reset"><code class="docutils literal notranslate"><span class="pre">Instance.reset()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.resize_disk"><code class="docutils literal notranslate"><span class="pre">Instance.resize_disk()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.resume"><code class="docutils literal notranslate"><span class="pre">Instance.resume()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.set_autostart"><code class="docutils literal notranslate"><span class="pre">Instance.set_autostart()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.set_memory"><code class="docutils literal notranslate"><span class="pre">Instance.set_memory()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.set_ssh_keys"><code class="docutils literal notranslate"><span class="pre">Instance.set_ssh_keys()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.set_user_password"><code class="docutils literal notranslate"><span class="pre">Instance.set_user_password()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.set_vcpus"><code class="docutils literal notranslate"><span class="pre">Instance.set_vcpus()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.shutdown"><code class="docutils literal notranslate"><span class="pre">Instance.shutdown()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance.start"><code class="docutils literal notranslate"><span class="pre">Instance.start()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceConfig"><code class="docutils literal notranslate"><span class="pre">InstanceConfig</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceConfig.__init__"><code class="docutils literal notranslate"><span class="pre">InstanceConfig.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceConfig.to_xml"><code class="docutils literal notranslate"><span class="pre">InstanceConfig.to_xml()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceInfo"><code class="docutils literal notranslate"><span class="pre">InstanceInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceInfo.cputime"><code class="docutils literal notranslate"><span class="pre">InstanceInfo.cputime</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceInfo.max_memory"><code class="docutils literal notranslate"><span class="pre">InstanceInfo.max_memory</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceInfo.memory"><code class="docutils literal notranslate"><span class="pre">InstanceInfo.memory</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceInfo.nproc"><code class="docutils literal notranslate"><span class="pre">InstanceInfo.nproc</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/instance.html#compute.instance.instance.InstanceInfo.state"><code class="docutils literal notranslate"><span class="pre">InstanceInfo.state</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="instance/guest_agent.html"><code class="docutils literal notranslate"><span class="pre">guest_agent</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent"><code class="docutils literal notranslate"><span class="pre">GuestAgent</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.__init__"><code class="docutils literal notranslate"><span class="pre">GuestAgent.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.execute"><code class="docutils literal notranslate"><span class="pre">GuestAgent.execute()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.get_supported_commands"><code class="docutils literal notranslate"><span class="pre">GuestAgent.get_supported_commands()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.guest_exec"><code class="docutils literal notranslate"><span class="pre">GuestAgent.guest_exec()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.guest_exec_status"><code class="docutils literal notranslate"><span class="pre">GuestAgent.guest_exec_status()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.is_available"><code class="docutils literal notranslate"><span class="pre">GuestAgent.is_available()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestAgent.raise_for_commands"><code class="docutils literal notranslate"><span class="pre">GuestAgent.raise_for_commands()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput"><code class="docutils literal notranslate"><span class="pre">GuestExecOutput</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.exitcode"><code class="docutils literal notranslate"><span class="pre">GuestExecOutput.exitcode</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.exited"><code class="docutils literal notranslate"><span class="pre">GuestExecOutput.exited</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.stderr"><code class="docutils literal notranslate"><span class="pre">GuestExecOutput.stderr</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/guest_agent.html#compute.instance.guest_agent.GuestExecOutput.stdout"><code class="docutils literal notranslate"><span class="pre">GuestExecOutput.stdout</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="instance/schemas.html"><code class="docutils literal notranslate"><span class="pre">schemas</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.BootOptionsSchema"><code class="docutils literal notranslate"><span class="pre">BootOptionsSchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.CPUEmulationMode"><code class="docutils literal notranslate"><span class="pre">CPUEmulationMode</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.CPUFeaturesSchema"><code class="docutils literal notranslate"><span class="pre">CPUFeaturesSchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.CPUSchema"><code class="docutils literal notranslate"><span class="pre">CPUSchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.CPUTopologySchema"><code class="docutils literal notranslate"><span class="pre">CPUTopologySchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.EntityModel"><code class="docutils literal notranslate"><span class="pre">EntityModel</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.EntityModel.Config"><code class="docutils literal notranslate"><span class="pre">EntityModel.Config</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.InstanceSchema"><code class="docutils literal notranslate"><span class="pre">InstanceSchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.NetworkInterfaceSchema"><code class="docutils literal notranslate"><span class="pre">NetworkInterfaceSchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.VolumeCapacitySchema"><code class="docutils literal notranslate"><span class="pre">VolumeCapacitySchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.VolumeSchema"><code class="docutils literal notranslate"><span class="pre">VolumeSchema</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="instance/schemas.html#compute.instance.schemas.VolumeType"><code class="docutils literal notranslate"><span class="pre">VolumeType</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="storage/index.html"><code class="docutils literal notranslate"><span class="pre">storage</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="storage/pool.html"><code class="docutils literal notranslate"><span class="pre">pool</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool"><code class="docutils literal notranslate"><span class="pre">StoragePool</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.__init__"><code class="docutils literal notranslate"><span class="pre">StoragePool.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.clone_volume"><code class="docutils literal notranslate"><span class="pre">StoragePool.clone_volume()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.create_volume"><code class="docutils literal notranslate"><span class="pre">StoragePool.create_volume()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.dump_xml"><code class="docutils literal notranslate"><span class="pre">StoragePool.dump_xml()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.get_usage_info"><code class="docutils literal notranslate"><span class="pre">StoragePool.get_usage_info()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.get_volume"><code class="docutils literal notranslate"><span class="pre">StoragePool.get_volume()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.list_volumes"><code class="docutils literal notranslate"><span class="pre">StoragePool.list_volumes()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool.refresh"><code class="docutils literal notranslate"><span class="pre">StoragePool.refresh()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePoolUsageInfo"><code class="docutils literal notranslate"><span class="pre">StoragePoolUsageInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePoolUsageInfo.allocation"><code class="docutils literal notranslate"><span class="pre">StoragePoolUsageInfo.allocation</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePoolUsageInfo.available"><code class="docutils literal notranslate"><span class="pre">StoragePoolUsageInfo.available</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePoolUsageInfo.capacity"><code class="docutils literal notranslate"><span class="pre">StoragePoolUsageInfo.capacity</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="storage/volume.html"><code class="docutils literal notranslate"><span class="pre">volume</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="storage/volume.html#compute.storage.volume.DiskConfig"><code class="docutils literal notranslate"><span class="pre">DiskConfig</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.DiskConfig.__init__"><code class="docutils literal notranslate"><span class="pre">DiskConfig.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.DiskConfig.to_xml"><code class="docutils literal notranslate"><span class="pre">DiskConfig.to_xml()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="storage/volume.html#compute.storage.volume.Volume"><code class="docutils literal notranslate"><span class="pre">Volume</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.Volume.__init__"><code class="docutils literal notranslate"><span class="pre">Volume.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.Volume.clone"><code class="docutils literal notranslate"><span class="pre">Volume.clone()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.Volume.delete"><code class="docutils literal notranslate"><span class="pre">Volume.delete()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.Volume.dump_xml"><code class="docutils literal notranslate"><span class="pre">Volume.dump_xml()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.Volume.resize"><code class="docutils literal notranslate"><span class="pre">Volume.resize()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="storage/volume.html#compute.storage.volume.VolumeConfig"><code class="docutils literal notranslate"><span class="pre">VolumeConfig</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.VolumeConfig.__init__"><code class="docutils literal notranslate"><span class="pre">VolumeConfig.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="storage/volume.html#compute.storage.volume.VolumeConfig.to_xml"><code class="docutils literal notranslate"><span class="pre">VolumeConfig.to_xml()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="utils.html"><code class="docutils literal notranslate"><span class="pre">utils</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="utils.html#module-compute.utils.units"><code class="docutils literal notranslate"><span class="pre">utils.units</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="utils.html#compute.utils.units.DataUnit"><code class="docutils literal notranslate"><span class="pre">DataUnit</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="utils.html#compute.utils.units.InvalidDataUnitError"><code class="docutils literal notranslate"><span class="pre">InvalidDataUnitError</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="utils.html#compute.utils.units.to_bytes"><code class="docutils literal notranslate"><span class="pre">to_bytes()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="utils.html#module-compute.utils.ids"><code class="docutils literal notranslate"><span class="pre">utils.ids</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="utils.html#compute.utils.ids.random_mac"><code class="docutils literal notranslate"><span class="pre">random_mac()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="exceptions.html"><code class="docutils literal notranslate"><span class="pre">exceptions</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.ComputeError"><code class="docutils literal notranslate"><span class="pre">ComputeError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.ConfigLoaderError"><code class="docutils literal notranslate"><span class="pre">ConfigLoaderError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.GuestAgentCommandNotSupportedError"><code class="docutils literal notranslate"><span class="pre">GuestAgentCommandNotSupportedError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.GuestAgentError"><code class="docutils literal notranslate"><span class="pre">GuestAgentError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.GuestAgentTimeoutExceededError"><code class="docutils literal notranslate"><span class="pre">GuestAgentTimeoutExceededError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.GuestAgentUnavailableError"><code class="docutils literal notranslate"><span class="pre">GuestAgentUnavailableError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.InstanceError"><code class="docutils literal notranslate"><span class="pre">InstanceError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.InstanceNotFoundError"><code class="docutils literal notranslate"><span class="pre">InstanceNotFoundError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.SessionError"><code class="docutils literal notranslate"><span class="pre">SessionError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.StoragePoolError"><code class="docutils literal notranslate"><span class="pre">StoragePoolError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.StoragePoolNotFoundError"><code class="docutils literal notranslate"><span class="pre">StoragePoolNotFoundError</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#compute.exceptions.VolumeNotFoundError"><code class="docutils literal notranslate"><span class="pre">VolumeNotFoundError</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="../index.html" title="previous chapter">Compute</a></li>
|
||||
<li>Next: <a href="session.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">session</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/pyapi/index.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,266 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>guest_agent — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
|
||||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="schemas" href="schemas.html" />
|
||||
<link rel="prev" title="instance" href="instance.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-compute.instance.guest_agent">
|
||||
<span id="guest-agent"></span><h1><code class="docutils literal notranslate"><span class="pre">guest_agent</span></code><a class="headerlink" href="#module-compute.instance.guest_agent" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Interacting with the QEMU Guest Agent.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.instance.guest_agent.</span></span><span class="sig-name descname"><span class="pre">GuestAgent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virDomain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">60</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Class for interacting with QEMU guest agent.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virDomain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">60</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialise GuestAgent.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>domain</strong> – Libvirt domain object</p></li>
|
||||
<li><p><strong>timeout</strong> – QEMU timeout</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent.execute">
|
||||
<span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent.execute" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Execute QEMU guest agent command.</p>
|
||||
<p>See: <a class="reference external" href="https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html">https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>command</strong> – QEMU guest agent command as dict</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Command output</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>dict</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent.get_supported_commands">
|
||||
<span class="sig-name descname"><span class="pre">get_supported_commands</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">set</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent.get_supported_commands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return set of supported guest agent commands.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent.guest_exec">
|
||||
<span class="sig-name descname"><span class="pre">guest_exec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capture_output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#compute.instance.guest_agent.GuestExecOutput" title="compute.instance.guest_agent.GuestExecOutput"><span class="pre">GuestExecOutput</span></a></span></span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent.guest_exec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Execute qemu-exec command and return output.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>path</strong> – Path ot executable on guest.</p></li>
|
||||
<li><p><strong>arg</strong> – List of arguments to pass to executable.</p></li>
|
||||
<li><p><strong>env</strong> – List of environment variables to pass to executable.
|
||||
For example: <code class="docutils literal notranslate"><span class="pre">['LANG=C',</span> <span class="pre">'TERM=xterm']</span></code></p></li>
|
||||
<li><p><strong>stdin</strong> – Data to pass to executable STDIN.</p></li>
|
||||
<li><p><strong>capture_output</strong> – Capture command output.</p></li>
|
||||
<li><p><strong>decode_output</strong> – Use base64_decode() to decode command output.
|
||||
Affects only if <cite>capture_output</cite> is True.</p></li>
|
||||
<li><p><strong>poll</strong> – Poll command output. Uses <cite>self.timeout</cite> and
|
||||
POLL_INTERVAL constant.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Command output</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#compute.instance.guest_agent.GuestExecOutput" title="compute.instance.guest_agent.GuestExecOutput">GuestExecOutput</a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent.guest_exec_status">
|
||||
<span class="sig-name descname"><span class="pre">guest_exec_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll_interval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.3</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent.guest_exec_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Execute guest-exec-status and return output.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>pid</strong> – PID in guest.</p></li>
|
||||
<li><p><strong>poll</strong> – If True poll command status.</p></li>
|
||||
<li><p><strong>poll_interval</strong> – Time between attempts to obtain command status.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Command output</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>dict</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent.is_available">
|
||||
<span class="sig-name descname"><span class="pre">is_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent.is_available" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Execute guest-ping.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>True or False if guest agent is unreachable.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>bool</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestAgent.raise_for_commands">
|
||||
<span class="sig-name descname"><span class="pre">raise_for_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commands</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.guest_agent.GuestAgent.raise_for_commands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Raise exception if QEMU GA command is not available.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>commands</strong> – List of required commands</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>GuestAgentCommandNotSupportedError</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestExecOutput">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.instance.guest_agent.</span></span><span class="sig-name descname"><span class="pre">GuestExecOutput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exited</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exitcode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.guest_agent.GuestExecOutput" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>QEMU guest-exec command output.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestExecOutput.exitcode">
|
||||
<span class="sig-name descname"><span class="pre">exitcode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#compute.instance.guest_agent.GuestExecOutput.exitcode" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestExecOutput.exited">
|
||||
<span class="sig-name descname"><span class="pre">exited</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#compute.instance.guest_agent.GuestExecOutput.exited" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestExecOutput.stderr">
|
||||
<span class="sig-name descname"><span class="pre">stderr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#compute.instance.guest_agent.GuestExecOutput.stderr" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 3</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.guest_agent.GuestExecOutput.stdout">
|
||||
<span class="sig-name descname"><span class="pre">stdout</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#compute.instance.guest_agent.GuestExecOutput.stdout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Python API</a><ul>
|
||||
<li><a href="index.html"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a><ul>
|
||||
<li>Previous: <a href="instance.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a></li>
|
||||
<li>Next: <a href="schemas.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">schemas</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../../_sources/pyapi/instance/guest_agent.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,120 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>instance — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
|
||||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="instance" href="instance.html" />
|
||||
<link rel="prev" title="session" href="../session.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="instance">
|
||||
<h1><code class="docutils literal notranslate"><span class="pre">instance</span></code><a class="headerlink" href="#instance" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="instance.html"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="guest_agent.html"><code class="docutils literal notranslate"><span class="pre">guest_agent</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="schemas.html"><code class="docutils literal notranslate"><span class="pre">schemas</span></code></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Python API</a><ul>
|
||||
<li>Previous: <a href="../session.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">session</span></code></a></li>
|
||||
<li>Next: <a href="instance.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../../_sources/pyapi/instance/index.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,490 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>instance — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
|
||||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="guest_agent" href="guest_agent.html" />
|
||||
<link rel="prev" title="instance" href="index.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-compute.instance.instance">
|
||||
<span id="instance"></span><h1><code class="docutils literal notranslate"><span class="pre">instance</span></code><a class="headerlink" href="#module-compute.instance.instance" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Manage compute instances.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.instance.instance.</span></span><span class="sig-name descname"><span class="pre">Instance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virDomain</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.instance.Instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Manage compute instances.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virDomain</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.instance.Instance.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialise Instance.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Variables<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>domain</strong> (<em>libvirt.virDomain</em>) – domain object</p></li>
|
||||
<li><p><strong>connection</strong> (<em>libvirt.virConnect</em>) – connection object</p></li>
|
||||
<li><p><strong>name</strong> (<em>str</em>) – domain name</p></li>
|
||||
<li><p><strong>guest_agent</strong> (<a class="reference internal" href="guest_agent.html#compute.instance.guest_agent.GuestAgent" title="compute.instance.guest_agent.GuestAgent"><em>GuestAgent</em></a>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">GuestAgent</span></code> object</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><strong>domain</strong> – libvirt domain object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.attach_device">
|
||||
<span class="sig-name descname"><span class="pre">attach_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">EntityConfig</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.attach_device" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attach device to compute instance.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>device</strong> – Object with device description e.g. DiskConfig</p></li>
|
||||
<li><p><strong>live</strong> – Affect a running instance</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Undefine instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.delete_ssh_keys">
|
||||
<span class="sig-name descname"><span class="pre">delete_ssh_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssh_keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.delete_ssh_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove SSH keys from guest for specific user.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user</strong> – Username.</p></li>
|
||||
<li><p><strong>ssh_keys</strong> – List of public SSH keys.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.detach_device">
|
||||
<span class="sig-name descname"><span class="pre">detach_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">EntityConfig</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.detach_device" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Dettach device from compute instance.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>device</strong> – Object with device description e.g. DiskConfig</p></li>
|
||||
<li><p><strong>live</strong> – Affect a running instance</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.detach_disk">
|
||||
<span class="sig-name descname"><span class="pre">detach_disk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.detach_disk" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Detach disk device by target name.</p>
|
||||
<p>There is no <code class="docutils literal notranslate"><span class="pre">attach_disk()</span></code> method. Use <a class="reference internal" href="#compute.instance.instance.Instance.attach_device" title="compute.instance.instance.Instance.attach_device"><code class="xref py py-func docutils literal notranslate"><span class="pre">attach_device()</span></code></a>
|
||||
with <code class="xref py py-class docutils literal notranslate"><span class="pre">DiskConfig</span></code> as argument.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>name</strong> – Disk name e.g. ‘vda’, ‘sda’, etc. This name may
|
||||
not match the name of the disk inside the guest OS.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.dump_xml">
|
||||
<span class="sig-name descname"><span class="pre">dump_xml</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inactive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.dump_xml" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return instance XML description.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.get_disks">
|
||||
<span class="sig-name descname"><span class="pre">get_disks</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../storage/volume.html#compute.storage.volume.DiskConfig" title="compute.storage.volume.DiskConfig"><span class="pre">compute.storage.volume.DiskConfig</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.get_disks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return list of attached disks.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.get_info">
|
||||
<span class="sig-name descname"><span class="pre">get_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#compute.instance.instance.InstanceInfo" title="compute.instance.instance.InstanceInfo"><span class="pre">InstanceInfo</span></a></span></span><a class="headerlink" href="#compute.instance.instance.Instance.get_info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return instance info.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.get_max_memory">
|
||||
<span class="sig-name descname"><span class="pre">get_max_memory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.get_max_memory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Maximum memory value for domain in KiB.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.get_max_vcpus">
|
||||
<span class="sig-name descname"><span class="pre">get_max_vcpus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.get_max_vcpus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Maximum vCPUs number for domain.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.get_ssh_keys">
|
||||
<span class="sig-name descname"><span class="pre">get_ssh_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.get_ssh_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return list of SSH keys on guest for specific user.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>user</strong> – Username.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.get_status">
|
||||
<span class="sig-name descname"><span class="pre">get_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.get_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return instance state: ‘running’, ‘shutoff’, etc.</p>
|
||||
<p>Reference:
|
||||
<a class="reference external" href="https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainState">https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainState</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.is_autostart">
|
||||
<span class="sig-name descname"><span class="pre">is_autostart</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.is_autostart" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return True if instance autostart is enabled, else return False.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.is_running">
|
||||
<span class="sig-name descname"><span class="pre">is_running</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.is_running" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return True if instance is running, else return False.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.pause">
|
||||
<span class="sig-name descname"><span class="pre">pause</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.pause" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Pause instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.power_reset">
|
||||
<span class="sig-name descname"><span class="pre">power_reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.power_reset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Shutdown instance and start.</p>
|
||||
<p>By analogy with real hardware, this is a normal server shutdown,
|
||||
and then turning off from the power supply and turning it on again.</p>
|
||||
<p>This method is applicable in cases where there has been a
|
||||
configuration change in libvirt and you need to restart the
|
||||
instance to apply the new configuration.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.reboot">
|
||||
<span class="sig-name descname"><span class="pre">reboot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.reboot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Send ACPI signal to guest OS to reboot. OS may ignore this.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.reset">
|
||||
<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.reset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Reset instance.</p>
|
||||
<p>Copypaste from libvirt doc:</p>
|
||||
<p>Reset a domain immediately without any guest OS shutdown.
|
||||
Reset emulates the power reset button on a machine, where all
|
||||
hardware sees the RST line set and reinitializes internal state.</p>
|
||||
<p>Note that there is a risk of data loss caused by reset without any
|
||||
guest OS shutdown.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.resize_disk">
|
||||
<span class="sig-name descname"><span class="pre">resize_disk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../utils.html#compute.utils.units.DataUnit" title="compute.utils.units.DataUnit"><span class="pre">DataUnit</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.resize_disk" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resize attached block device.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> – Disk device name e.g. <cite>vda</cite>, <cite>sda</cite>, etc.</p></li>
|
||||
<li><p><strong>capacity</strong> – New capacity.</p></li>
|
||||
<li><p><strong>unit</strong> – Capacity unit.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.resume">
|
||||
<span class="sig-name descname"><span class="pre">resume</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.resume" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resume paused instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.set_autostart">
|
||||
<span class="sig-name descname"><span class="pre">set_autostart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.set_autostart" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set autostart flag for instance.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>enabled</strong> – Bool argument to set or unset autostart flag.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.set_memory">
|
||||
<span class="sig-name descname"><span class="pre">set_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.set_memory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set memory.</p>
|
||||
<p>If <cite>live</cite> is True and instance is not currently running set memory
|
||||
in config and will applied when instance boot.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>memory</strong> – Memory value in mebibytes</p></li>
|
||||
<li><p><strong>live</strong> – Affect a running instance</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.set_ssh_keys">
|
||||
<span class="sig-name descname"><span class="pre">set_ssh_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssh_keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.set_ssh_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add SSH keys to guest for specific user.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user</strong> – Username.</p></li>
|
||||
<li><p><strong>ssh_keys</strong> – List of public SSH keys.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.set_user_password">
|
||||
<span class="sig-name descname"><span class="pre">set_user_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encrypted</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.set_user_password" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set new user password in guest OS.</p>
|
||||
<p>This action performs by guest agent inside the guest.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user</strong> – Username.</p></li>
|
||||
<li><p><strong>password</strong> – Password.</p></li>
|
||||
<li><p><strong>encrypted</strong> – Set it to True if password is already encrypted.
|
||||
Right encryption method depends on guest OS.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.set_vcpus">
|
||||
<span class="sig-name descname"><span class="pre">set_vcpus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nvcpus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.set_vcpus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set vCPU number.</p>
|
||||
<p>If <cite>live</cite> is True and instance is not currently running vCPUs
|
||||
will set in config and will applied when instance boot.</p>
|
||||
<p>NB: Note that if this call is executed before the guest has
|
||||
finished booting, the guest may fail to process the change.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>nvcpus</strong> – Number of vCPUs</p></li>
|
||||
<li><p><strong>live</strong> – Affect a running instance</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.shutdown">
|
||||
<span class="sig-name descname"><span class="pre">shutdown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.shutdown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Shutdown instance.</p>
|
||||
<p>Shutdown methods:</p>
|
||||
<dl class="simple">
|
||||
<dt>SOFT</dt><dd><p>Use guest agent to shutdown. If guest agent is unavailable
|
||||
NORMAL method will be used.</p>
|
||||
</dd>
|
||||
<dt>NORMAL</dt><dd><p>Use method choosen by hypervisor to shutdown. Usually send ACPI
|
||||
signal to guest OS. OS may ignore ACPI e.g. if guest is hanged.</p>
|
||||
</dd>
|
||||
<dt>HARD</dt><dd><p>Shutdown instance without any guest OS shutdown. This is simular
|
||||
to unplugging machine from power. Internally send SIGTERM to
|
||||
instance process and destroy it gracefully.</p>
|
||||
</dd>
|
||||
<dt>UNSAFE</dt><dd><p>Force shutdown. Internally send SIGKILL to instance process.
|
||||
There is high data corruption risk!</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>If method is None NORMAL method will used.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>method</strong> – Method used to shutdown instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.Instance.start">
|
||||
<span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.instance.instance.Instance.start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Start defined instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceConfig">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.instance.instance.</span></span><span class="sig-name descname"><span class="pre">InstanceConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="schemas.html#compute.instance.schemas.InstanceSchema" title="compute.instance.schemas.InstanceSchema"><span class="pre">InstanceSchema</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.instance.InstanceConfig" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Compute instance XML config builder.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceConfig.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="schemas.html#compute.instance.schemas.InstanceSchema" title="compute.instance.schemas.InstanceSchema"><span class="pre">InstanceSchema</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.instance.InstanceConfig.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialise InstanceConfig.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>schema</strong> – InstanceSchema object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceConfig.to_xml">
|
||||
<span class="sig-name descname"><span class="pre">to_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.instance.instance.InstanceConfig.to_xml" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return XML config for libvirt.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.instance.instance.</span></span><span class="sig-name descname"><span class="pre">InstanceInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nproc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cputime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.instance.instance.InstanceInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Store compute instance info.</p>
|
||||
<p>Reference:
|
||||
<a class="reference external" href="https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainInfo">https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainInfo</a></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceInfo.cputime">
|
||||
<span class="sig-name descname"><span class="pre">cputime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.instance.instance.InstanceInfo.cputime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 4</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceInfo.max_memory">
|
||||
<span class="sig-name descname"><span class="pre">max_memory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.instance.instance.InstanceInfo.max_memory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceInfo.memory">
|
||||
<span class="sig-name descname"><span class="pre">memory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.instance.instance.InstanceInfo.memory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceInfo.nproc">
|
||||
<span class="sig-name descname"><span class="pre">nproc</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.instance.instance.InstanceInfo.nproc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 3</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.instance.instance.InstanceInfo.state">
|
||||
<span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.instance.instance.InstanceInfo.state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Python API</a><ul>
|
||||
<li><a href="index.html"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a><ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a></li>
|
||||
<li>Next: <a href="guest_agent.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">guest_agent</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../../_sources/pyapi/instance/instance.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,331 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>session — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="instance" href="instance/index.html" />
|
||||
<link rel="prev" title="Python API" href="index.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-compute.session">
|
||||
<span id="session"></span><h1><code class="docutils literal notranslate"><span class="pre">session</span></code><a class="headerlink" href="#module-compute.session" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Hypervisor session manager.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.session.</span></span><span class="sig-name descname"><span class="pre">Capabilities</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">virt_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">emulator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">machine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_vcpus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_vendor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_features</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usable_cpus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.session.Capabilities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Store domain capabilities info.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.arch">
|
||||
<span class="sig-name descname"><span class="pre">arch</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.session.Capabilities.arch" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.cpu_features">
|
||||
<span class="sig-name descname"><span class="pre">cpu_features</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span></em><a class="headerlink" href="#compute.session.Capabilities.cpu_features" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 7</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.cpu_model">
|
||||
<span class="sig-name descname"><span class="pre">cpu_model</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.session.Capabilities.cpu_model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 6</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.cpu_vendor">
|
||||
<span class="sig-name descname"><span class="pre">cpu_vendor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.session.Capabilities.cpu_vendor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 5</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.emulator">
|
||||
<span class="sig-name descname"><span class="pre">emulator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.session.Capabilities.emulator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.machine">
|
||||
<span class="sig-name descname"><span class="pre">machine</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.session.Capabilities.machine" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 3</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.max_vcpus">
|
||||
<span class="sig-name descname"><span class="pre">max_vcpus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.Capabilities.max_vcpus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 4</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.usable_cpus">
|
||||
<span class="sig-name descname"><span class="pre">usable_cpus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#compute.session.Capabilities.usable_cpus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 8</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.Capabilities.virt_type">
|
||||
<span class="sig-name descname"><span class="pre">virt_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.session.Capabilities.virt_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.session.</span></span><span class="sig-name descname"><span class="pre">NodeInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mhz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sockets</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cores</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threads</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.session.NodeInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Store compute node info.</p>
|
||||
<p>See <a class="reference external" href="https://libvirt.org/html/libvirt-libvirt-host.html#virNodeInfo">https://libvirt.org/html/libvirt-libvirt-host.html#virNodeInfo</a>
|
||||
NOTE: memory unit in libvirt docs is wrong! Actual unit is MiB.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.arch">
|
||||
<span class="sig-name descname"><span class="pre">arch</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#compute.session.NodeInfo.arch" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.cores">
|
||||
<span class="sig-name descname"><span class="pre">cores</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.NodeInfo.cores" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 6</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.cpus">
|
||||
<span class="sig-name descname"><span class="pre">cpus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.NodeInfo.cpus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.memory">
|
||||
<span class="sig-name descname"><span class="pre">memory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.NodeInfo.memory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.mhz">
|
||||
<span class="sig-name descname"><span class="pre">mhz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.NodeInfo.mhz" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 3</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.nodes">
|
||||
<span class="sig-name descname"><span class="pre">nodes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.NodeInfo.nodes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 4</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.sockets">
|
||||
<span class="sig-name descname"><span class="pre">sockets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.NodeInfo.sockets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 5</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.session.NodeInfo.threads">
|
||||
<span class="sig-name descname"><span class="pre">threads</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.session.NodeInfo.threads" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 7</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.session.Session">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.session.</span></span><span class="sig-name descname"><span class="pre">Session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uri</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.session.Session" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hypervisor session context manager.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Variables<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>IMAGES_POOL</strong> – images storage pool name taken from env</p></li>
|
||||
<li><p><strong>VOLUMES_POOL</strong> – volumes storage pool name taken from env</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uri</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.session.Session.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialise session with hypervisor.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Variables<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>uri</strong> (<em>str</em>) – libvirt connection URI.</p></li>
|
||||
<li><p><strong>connection</strong> (<em>libvirt.virConnect</em>) – libvirt connection object.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><strong>uri</strong> – libvirt connection URI.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.close">
|
||||
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.session.Session.close" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Close connection to libvirt daemon.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.create_instance">
|
||||
<span class="sig-name descname"><span class="pre">create_instance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance" title="compute.instance.instance.Instance"><span class="pre">Instance</span></a></span></span><a class="headerlink" href="#compute.session.Session.create_instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create and return new compute instance.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<em>str</em>) – Instance name.</p></li>
|
||||
<li><p><strong>title</strong> (<em>str</em>) – Instance title for humans.</p></li>
|
||||
<li><p><strong>description</strong> (<em>str</em>) – Some information about instance.</p></li>
|
||||
<li><p><strong>memory</strong> (<em>int</em>) – Memory in MiB.</p></li>
|
||||
<li><p><strong>max_memory</strong> (<em>int</em>) – Maximum memory in MiB.</p></li>
|
||||
<li><p><strong>vcpus</strong> (<em>int</em>) – Number of vCPUs.</p></li>
|
||||
<li><p><strong>max_vcpus</strong> (<em>int</em>) – Maximum vCPUs.</p></li>
|
||||
<li><p><strong>cpu</strong> (<em>dict</em>) – CPU configuration. See <code class="xref py py-class docutils literal notranslate"><span class="pre">CPUSchema</span></code> for info.</p></li>
|
||||
<li><p><strong>machine</strong> (<em>str</em>) – QEMU emulated machine.</p></li>
|
||||
<li><p><strong>emulator</strong> (<em>str</em>) – Path to emulator.</p></li>
|
||||
<li><p><strong>arch</strong> (<em>str</em>) – CPU architecture to virtualization.</p></li>
|
||||
<li><p><strong>boot</strong> (<em>dict</em>) – Boot settings. See <code class="xref py py-class docutils literal notranslate"><span class="pre">BootOptionsSchema</span></code>.</p></li>
|
||||
<li><p><strong>image</strong> (<em>str</em>) – Source disk image name for system disk.</p></li>
|
||||
<li><p><strong>volumes</strong> (<em>list</em><em>[</em><em>dict</em><em>]</em>) – List of storage volume configs. For more info
|
||||
see <code class="xref py py-class docutils literal notranslate"><span class="pre">VolumeSchema</span></code>.</p></li>
|
||||
<li><p><strong>network_interfaces</strong> (<em>list</em><em>[</em><em>dict</em><em>]</em>) – List of virtual network interfaces
|
||||
configs. See <code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkInterfaceSchema</span></code> for more info.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.get_capabilities">
|
||||
<span class="sig-name descname"><span class="pre">get_capabilities</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#compute.session.Capabilities" title="compute.session.Capabilities"><span class="pre">Capabilities</span></a></span></span><a class="headerlink" href="#compute.session.Session.get_capabilities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return capabilities e.g. arch, virt, emulator, etc.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.get_instance">
|
||||
<span class="sig-name descname"><span class="pre">get_instance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance" title="compute.instance.instance.Instance"><span class="pre">Instance</span></a></span></span><a class="headerlink" href="#compute.session.Session.get_instance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get compute instance by name.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.get_node_info">
|
||||
<span class="sig-name descname"><span class="pre">get_node_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#compute.session.NodeInfo" title="compute.session.NodeInfo"><span class="pre">NodeInfo</span></a></span></span><a class="headerlink" href="#compute.session.Session.get_node_info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return information about compute node.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.get_storage_pool">
|
||||
<span class="sig-name descname"><span class="pre">get_storage_pool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool" title="compute.storage.pool.StoragePool"><span class="pre">StoragePool</span></a></span></span><a class="headerlink" href="#compute.session.Session.get_storage_pool" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get storage pool by name.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.list_instances">
|
||||
<span class="sig-name descname"><span class="pre">list_instances</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="instance/instance.html#compute.instance.instance.Instance" title="compute.instance.instance.Instance"><span class="pre">compute.instance.instance.Instance</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compute.session.Session.list_instances" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all instances.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.session.Session.list_storage_pools">
|
||||
<span class="sig-name descname"><span class="pre">list_storage_pools</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="storage/pool.html#compute.storage.pool.StoragePool" title="compute.storage.pool.StoragePool"><span class="pre">compute.storage.pool.StoragePool</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compute.session.Session.list_storage_pools" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all strage pools.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
<li><a href="index.html">Python API</a><ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">Python API</a></li>
|
||||
<li>Next: <a href="instance/index.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">instance</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/pyapi/session.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,119 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>storage — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
|
||||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="pool" href="pool.html" />
|
||||
<link rel="prev" title="schemas" href="../instance/schemas.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="storage">
|
||||
<h1><code class="docutils literal notranslate"><span class="pre">storage</span></code><a class="headerlink" href="#storage" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="pool.html"><code class="docutils literal notranslate"><span class="pre">pool</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="volume.html"><code class="docutils literal notranslate"><span class="pre">volume</span></code></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Python API</a><ul>
|
||||
<li>Previous: <a href="../instance/schemas.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">schemas</span></code></a></li>
|
||||
<li>Next: <a href="pool.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">pool</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../../_sources/pyapi/storage/index.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,201 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>pool — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
|
||||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="volume" href="volume.html" />
|
||||
<link rel="prev" title="storage" href="index.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-compute.storage.pool">
|
||||
<span id="pool"></span><h1><code class="docutils literal notranslate"><span class="pre">pool</span></code><a class="headerlink" href="#module-compute.storage.pool" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Manage storage pools.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.storage.pool.</span></span><span class="sig-name descname"><span class="pre">StoragePool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virStoragePool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.storage.pool.StoragePool" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Storage pool manipulating class.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virStoragePool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.storage.pool.StoragePool.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initislise StoragePool.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.clone_volume">
|
||||
<span class="sig-name descname"><span class="pre">clone_volume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="volume.html#compute.storage.volume.Volume" title="compute.storage.volume.Volume"><span class="pre">Volume</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dst</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="volume.html#compute.storage.volume.VolumeConfig" title="compute.storage.volume.VolumeConfig"><span class="pre">VolumeConfig</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="volume.html#compute.storage.volume.Volume" title="compute.storage.volume.Volume"><span class="pre">Volume</span></a></span></span><a class="headerlink" href="#compute.storage.pool.StoragePool.clone_volume" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make storage volume copy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>src</strong> – Input volume</p></li>
|
||||
<li><p><strong>dst</strong> – Output volume config</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.create_volume">
|
||||
<span class="sig-name descname"><span class="pre">create_volume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vol_conf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="volume.html#compute.storage.volume.VolumeConfig" title="compute.storage.volume.VolumeConfig"><span class="pre">VolumeConfig</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="volume.html#compute.storage.volume.Volume" title="compute.storage.volume.Volume"><span class="pre">Volume</span></a></span></span><a class="headerlink" href="#compute.storage.pool.StoragePool.create_volume" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create storage volume and return Volume instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.dump_xml">
|
||||
<span class="sig-name descname"><span class="pre">dump_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.storage.pool.StoragePool.dump_xml" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return storage pool XML description as string.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.get_usage_info">
|
||||
<span class="sig-name descname"><span class="pre">get_usage_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#compute.storage.pool.StoragePoolUsageInfo" title="compute.storage.pool.StoragePoolUsageInfo"><span class="pre">StoragePoolUsageInfo</span></a></span></span><a class="headerlink" href="#compute.storage.pool.StoragePool.get_usage_info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return info about storage pool usage.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.get_volume">
|
||||
<span class="sig-name descname"><span class="pre">get_volume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="volume.html#compute.storage.volume.Volume" title="compute.storage.volume.Volume"><span class="pre">compute.storage.volume.Volume</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#compute.storage.pool.StoragePool.get_volume" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lookup and return Volume instance or None.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.list_volumes">
|
||||
<span class="sig-name descname"><span class="pre">list_volumes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="volume.html#compute.storage.volume.Volume" title="compute.storage.volume.Volume"><span class="pre">compute.storage.volume.Volume</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compute.storage.pool.StoragePool.list_volumes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return list of volumes in storage pool.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePool.refresh">
|
||||
<span class="sig-name descname"><span class="pre">refresh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.storage.pool.StoragePool.refresh" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Refresh storage pool.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePoolUsageInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.storage.pool.</span></span><span class="sig-name descname"><span class="pre">StoragePoolUsageInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allocation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.storage.pool.StoragePoolUsageInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Storage pool usage info.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePoolUsageInfo.allocation">
|
||||
<span class="sig-name descname"><span class="pre">allocation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.storage.pool.StoragePoolUsageInfo.allocation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePoolUsageInfo.available">
|
||||
<span class="sig-name descname"><span class="pre">available</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.storage.pool.StoragePoolUsageInfo.available" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="compute.storage.pool.StoragePoolUsageInfo.capacity">
|
||||
<span class="sig-name descname"><span class="pre">capacity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#compute.storage.pool.StoragePoolUsageInfo.capacity" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Python API</a><ul>
|
||||
<li><a href="index.html"><code class="docutils literal notranslate"><span class="pre">storage</span></code></a><ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">storage</span></code></a></li>
|
||||
<li>Next: <a href="volume.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">volume</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../../_sources/pyapi/storage/pool.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,210 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>volume — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
|
||||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="utils" href="../utils.html" />
|
||||
<link rel="prev" title="pool" href="pool.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-compute.storage.volume">
|
||||
<span id="volume"></span><h1><code class="docutils literal notranslate"><span class="pre">volume</span></code><a class="headerlink" href="#module-compute.storage.volume" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Manage storage volumes.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.DiskConfig">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.storage.volume.</span></span><span class="sig-name descname"><span class="pre">DiskConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">disk_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">pathlib.Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readonly</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.storage.volume.DiskConfig" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Disk XML config builder.</p>
|
||||
<p>Generate XML config for attaching or detaching storage volumes
|
||||
to compute instances.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.DiskConfig.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">disk_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">pathlib.Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readonly</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.storage.volume.DiskConfig.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.DiskConfig.to_xml">
|
||||
<span class="sig-name descname"><span class="pre">to_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.storage.volume.DiskConfig.to_xml" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return XML config for libvirt.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.Volume">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.storage.volume.</span></span><span class="sig-name descname"><span class="pre">Volume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virStoragePool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virStorageVol</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.storage.volume.Volume" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Storage volume manipulating class.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.Volume.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virStoragePool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">virStorageVol</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.storage.volume.Volume.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialise Volume.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>pool</strong> – libvirt virStoragePool object</p></li>
|
||||
<li><p><strong>vol</strong> – libvirt virStorageVol object</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.Volume.clone">
|
||||
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vol_conf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#compute.storage.volume.VolumeConfig" title="compute.storage.volume.VolumeConfig"><span class="pre">VolumeConfig</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.storage.volume.Volume.clone" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make a copy of volume to the same storage pool.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>VolumeInfo</strong> (<em>vol_info</em>) – New storage volume dataclass object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.Volume.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.storage.volume.Volume.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete volume from storage pool.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.Volume.dump_xml">
|
||||
<span class="sig-name descname"><span class="pre">dump_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.storage.volume.Volume.dump_xml" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return volume XML description as string.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.Volume.resize">
|
||||
<span class="sig-name descname"><span class="pre">resize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../utils.html#compute.utils.units.DataUnit" title="compute.utils.units.DataUnit"><span class="pre">DataUnit</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.storage.volume.Volume.resize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resize volume.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>int</strong> (<em>capacity</em>) – Volume new capacity.</p></li>
|
||||
<li><p><strong>DataUnit</strong> (<em>unit</em>) – Data unit. Internally converts into bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.VolumeConfig">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.storage.volume.</span></span><span class="sig-name descname"><span class="pre">VolumeConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.storage.volume.VolumeConfig" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Storage volume XML config builder.</p>
|
||||
<p>Generate XML config for creating a volume in a libvirt
|
||||
storage pool.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.VolumeConfig.__init__">
|
||||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#compute.storage.volume.VolumeConfig.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compute.storage.volume.VolumeConfig.to_xml">
|
||||
<span class="sig-name descname"><span class="pre">to_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.storage.volume.VolumeConfig.to_xml" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return XML config for libvirt.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Python API</a><ul>
|
||||
<li><a href="index.html"><code class="docutils literal notranslate"><span class="pre">storage</span></code></a><ul>
|
||||
<li>Previous: <a href="pool.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">pool</span></code></a></li>
|
||||
<li>Next: <a href="../utils.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">utils</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../../_sources/pyapi/storage/volume.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,144 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<title>utils — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="exceptions" href="exceptions.html" />
|
||||
<link rel="prev" title="volume" href="storage/volume.html" />
|
||||
|
||||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="utils">
|
||||
<h1><code class="docutils literal notranslate"><span class="pre">utils</span></code><a class="headerlink" href="#utils" title="Permalink to this heading">¶</a></h1>
|
||||
<section id="module-compute.utils.units">
|
||||
<span id="utils-units"></span><h2><code class="docutils literal notranslate"><span class="pre">utils.units</span></code><a class="headerlink" href="#module-compute.utils.units" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Tools for data units convertion.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compute.utils.units.DataUnit">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.utils.units.</span></span><span class="sig-name descname"><span class="pre">DataUnit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.utils.units.DataUnit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Data units enumerated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt class="sig sig-object py" id="compute.utils.units.InvalidDataUnitError">
|
||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compute.utils.units.</span></span><span class="sig-name descname"><span class="pre">InvalidDataUnitError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compute.utils.units.InvalidDataUnitError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Data unit is not valid.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="compute.utils.units.to_bytes">
|
||||
<span class="sig-prename descclassname"><span class="pre">compute.utils.units.</span></span><span class="sig-name descname"><span class="pre">to_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#compute.utils.units.DataUnit" title="compute.utils.units.DataUnit"><span class="pre">DataUnit</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">DataUnit.BYTES</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#compute.utils.units.to_bytes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Convert value to bytes. See <a class="reference internal" href="#compute.utils.units.DataUnit" title="compute.utils.units.DataUnit"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataUnit</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-compute.utils.ids">
|
||||
<span id="utils-ids"></span><h2><code class="docutils literal notranslate"><span class="pre">utils.ids</span></code><a class="headerlink" href="#module-compute.utils.ids" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Random identificators.</p>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="compute.utils.ids.random_mac">
|
||||
<span class="sig-prename descclassname"><span class="pre">compute.utils.ids.</span></span><span class="sig-name descname"><span class="pre">random_mac</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#compute.utils.ids.random_mac" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrun random MAC address.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
<li><a href="index.html">Python API</a><ul>
|
||||
<li>Previous: <a href="storage/volume.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">volume</span></code></a></li>
|
||||
<li>Next: <a href="exceptions.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">exceptions</span></code></a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="../_sources/pyapi/utils.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,124 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Search — Compute 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/searchtools.js"></script>
|
||||
<script src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="#" />
|
||||
<script src="searchindex.js" defer></script>
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1 id="search-documentation">Search</h1>
|
||||
|
||||
<noscript>
|
||||
<div class="admonition warning">
|
||||
<p>
|
||||
Please activate JavaScript to enable the search
|
||||
functionality.
|
||||
</p>
|
||||
</div>
|
||||
</noscript>
|
||||
|
||||
|
||||
<p>
|
||||
Searching for multiple words only shows matches that contain
|
||||
all words.
|
||||
</p>
|
||||
|
||||
|
||||
<form action="" method="get">
|
||||
<input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="search" />
|
||||
<span id="search-progress" style="padding-left: 10px"></span>
|
||||
</form>
|
||||
|
||||
|
||||
|
||||
<div id="search-results">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">Compute</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="pyapi/index.html">Python API</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2023, Compute Authors.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user