===========
.. toctree::
-
connection
compute
:show-inheritance:
:undoc-members:
-Compute stuff. This is what we do here in GRNet. We are compute people, after all!
-
cyclades
--------
Commands
========
-Command specifications for the kamaki.cli
-
-compute_cli
------------
-
-.. automodule:: kamaki.cli.commands.compute_cli
- :members:
- :show-inheritance:
- :undoc-members:
+Command specifications for kamaki.cli
cyclades_cli
------------
:undoc-members:
-storage_cli
------------
-
-.. automodule:: kamaki.cli.commands.storage_cli
- :members:
- :show-inheritance:
- :undoc-members:
-
-
pithos_cli
----------
# documentation root, use os.path.abspath to make it absolute, like shown here.
import sys, os
-sys.path.append("gevent.monkey")
-sys.path.append("~/src/synnefo/snf-common")
-sys.path.append("snf-common")
-sys.path.append("../")
+sys.path.append("/home/saxtouri/src/synnefo/snf-common")
+sys.path.append('../')
# -- General configuration -----------------------------------------------------
In version 0.6 and on it is safe to use parallel connections with greenlets.
-It uses httplib and GRNet Synnefo snf-common packages. All pooling parameters are configures in the external snf-common package.
\ No newline at end of file
+It uses httplib and GRNet Synnefo snf-common packages. All pooling parameters are configures in the external snf-common package.
+
+.. automodule:: kamaki.clients.connection
+ :members:
+ :show-inheritance:
+ :undoc-members:
\ No newline at end of file
* setmeta update server metadata
* delmeta delete server metadata
* stats get server statistics
+* wait: Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
flavor commands
store commands
**************
-* create create a container
-* container get container info
-* upload upload a file
-* download download a file
-* delete delete a file
+* append Append local file to (existing) remote object
+* cat Print a file to console
+* copy Copy an object
+* create Create a container or a directory object
+* delete Delete a container [or an object]
+* delgroup Delete a user group on an account
+* delmeta Delete an existing metadatum of account [, container [or object]]
+* delpermissions Delete all sharing permissions
+* download Download a file
+* group Get user groups details for account
+* hashmap Get the hashmap of an object
+* info Get information for account [, container [or object]]
+* list List containers, object trees or objects in a directory
+* manifest Create a remote file with uploaded parts by manifestation
+* meta Get custom meta-content for account [, container [or object]]
+* mkdir Create a directory
+* move Copy an object
+* overwrite Overwrite part (from start to end) of a remote file
+* permissions Get object read/write permissions
+* publish Publish an object
+* purge Purge a container
+* quota Get quota for account [or container]
+* setgroup Create/update a new user group on account
+* setmeta Set a new metadatum for account [, container [or object]]
+* setpermissions Set sharing permissions
+* setquota Set new quota (in KB) for account [or container]
+* setversioning Set new versioning (auto, none) for account [or container]
+* sharers List the accounts that share objects with default account
+* truncate Truncate remote file up to a size
+* unpublish Unpublish an object
+* upload Upload a file
+* versioning Get versioning for account [or container ]
+* versions Get the version list of an object
+
Author
-------
Here, at the
-`Greek Research and Technology Network <http://grnet.gr/default.asp?pid=1&la=2>`_,
+`Greek Research and Technology Network `_,
we have been developing an IaaS cloud management software called **synnefo**
-(or **+nefo**) that is accessed and managed via an extended OpenStack Compute API v1.1. Synnefo has been deployed in many enviroments to cover multiple needs. For example, the `~okeanos <http://okeanos.grnet.gr/>`_ IaaS service, running in our datacenters, is used to offer services for the Greek Research and Academic Community.
+(or **+nefo**) that is accessed and managed via an extended OpenStack Compute API v1.1. Synnefo has been deployed in many environments to cover multiple needs. For example, the `~okeanos `_ IaaS service, running in our datacenters, is used to offer services for the Greek Research and Academic Community.
From the early start, we needed a simple command-line tool to test the OpenStack API. That's why we developed *kamaki*, which proved to be powerful and intuitive enough, to be used not only for testing purposes but also as a complete Openstack Compute API v1.1 client, able to manage our cloud from the command line.
* synnefo@lists.grnet.gr
Please be sure to have read the Documentation and check the known
-`issues <https://code.grnet.gr/project*kamaki*/issues>`_ before contacting the
+`issues `_ before contacting the
team.
-Set up
-======
+Setup
+=====
-Kamaki is easy to install from source or as a package. Some ui features are optional and can be install seperately. Kamaki behavior can be configured in the kamaki config file.
+Kamaki is easy to install from source or as a package. Some ui features are optional and can be install separately. Kamaki behavior can be configured in the kamaki config file.
Requirements
------------
Kamaki comes with preset default values to all configuration options. All vital configurion options are set to use the okeanos.grnet.gr cloud services. User information is not included and should be provided either through the kamaki config command or by editing the configuration file.
-Kamaki configuration options are vital for correct Kamaki behavior. An incorrect option may render some command groups disfunctional. There are two ways of managing configuration options: edit the config file or use the kamaki config command.
+Kamaki configuration options are vital for correct Kamaki behavior. An incorrect option may render some command groups dysfunctional. There are two ways of managing configuration options: edit the config file or use the kamaki config command.
Using multiple setups
^^^^^^^^^^^^^^^^^^^^^
In the above example, if the kamaki configuration file does not exist, it will be created with all the default values plus the *global.account* option set to *myusername@mydomain.com* value.
-The configuration file is formated so that it can be parsed by the python Config Parser module. It consists of command sections that are denoted with brackets. Every section contains variables with values. For example:
+The configuration file is formatted so that it can be parsed by the python ConfigParser module. It consists of command sections that are denoted with brackets. Every section contains variables with values. For example:
*[store]*
*url=https://okeanos.grnet.gr/pithos*
Available options
^^^^^^^^^^^^^^^^^
-The [global] group is treated by kamaki as a generic group for arbitary options, and it is used as a super-group for vital Kamaki options like account, token, or url. For example if global.account option is set and store.account option is not set, store services will use the global.account option instead. In case of conflict, the most specific options overide the global ones.
+The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a supergroup for vital Kamaki options like account, token, or url. For example if global.account option is set and store.account option is not set, store services will use the global.account option instead. In case of conflict, the most specific options override the global ones.
* global.colors <on|off>
- enable/dissable colors in command line based uis. Requires ansicolors, otherwise it is ignored
+ enable/disable colors in command line based uis. Requires ansicolors, otherwise it is ignored
* global.account <account name>
- the username or user email that is user to connect to the cloud service. It can be ommited if provided as a service-specific option
+ the username or user email that is user to connect to the cloud service. It can be omitted if provided as a service-specific option
-* global.token <user authedication token>
+* global.token <user authentication token>
* store.cli <UI command specifications for store>
a special package that is used to load storage commands to kamaki UIs. Don't touch this unless if you know what you are doing.
the url of the OOS storage or Pithos+ service. Set to Okeanos.grnet.gr Pithos+ storage service by default. Users should set a different value if they need to use a different storage service.
* store.account <account name>
- if set, it overides possible global.account option for store level commands.
+ if set, it overrides possible global.account option for store level commands.
* compute.url <OOS compute or Cyclades service url>
the url of the OOS compute or Cyclades service. Set to Okeanos.grnet.gr Cyclades IaaS service by default. Users should set a different value if they need to use a different IaaS service.
the url of the Astakos authentication service. Set to the Okeanos.grnet.gr Astakos service by default. Users should set a different value if they need to use a different service.
* astakos.cli <UI command specifications for Astakos authentication service>
- a special package that is used to load astakos-related commands to kamaki UIs. Don't touch this unless you know what you are doing.
+ a special package that is used to load astakos-related commands to kamaki UIs. Don't touch this unless you know what you are doing.
\ No newline at end of file
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.command
-from kamaki.clients.quotaholder import QuotaHolderClient
+#from kamaki.clients.quotaholder import QuotaHolderClient
from kamaki.cli import command
from kamaki.cli.commands import _command_init
super(self.__class__, self).main()
@command()
-class quotaholder_test_me(_quotaholder_init):
- """quotaholder test"""
+class quotaholder_manage(_quotaholder_init):
+ """quotaholder manage"""
- def main(self, who='you'):
+ def main(self):
super(self.__class__, self).main()
projects / kamaki / commitdiff