Commit a29d2f88 authored by Stavros Sachtouris's avatar Stavros Sachtouris
Browse files

Apply uniform descriptions to all client commands

<GRNET name>/<OS name> API <actuall api> commands

e.g.
  Cyclades/Compute API server commands
or
  Pithos+/Storage API commands

Commands file names are named after the API they implement, not the command interface.
It cyclades, astakos, pithos, etc. instead of server, user, file, although the command
names they expose are "server *", "user *", "file *", etc.

Cyclades is a pretty good example: it exposes a set of commands with different prefixes
(server, network, flavor) and they all use the cyclades client.
parent 737c7deb
......@@ -36,7 +36,7 @@ from kamaki.cli.argument import FlagArgument
from kamaki.cli.commands import _command_init, errors
from kamaki.cli.command_tree import CommandTree
config_cmds = CommandTree('config', 'Configuration commands')
config_cmds = CommandTree('config', 'Kamaki configurations')
_commands = [config_cmds]
about_options = '\nAbout options:\
......
......@@ -44,9 +44,9 @@ from base64 import b64encode
from os.path import exists
server_cmds = CommandTree('server', 'Compute/Cyclades API server commands')
flavor_cmds = CommandTree('flavor', 'Compute/Cyclades API flavor commands')
network_cmds = CommandTree('network', 'Compute/Cyclades API network commands')
server_cmds = CommandTree('server', 'Cyclades/Compute API server commands')
flavor_cmds = CommandTree('flavor', 'Cyclades/Compute API flavor commands')
network_cmds = CommandTree('network', 'Cyclades/Compute API network commands')
_commands = [server_cmds, flavor_cmds, network_cmds]
......
......@@ -45,7 +45,7 @@ from kamaki.cli.utils import split_input
from kamaki.clients import ClientError
history_cmds = CommandTree('history', 'Command history')
history_cmds = CommandTree('history', 'Kamaki command history')
_commands = [history_cmds]
......
......@@ -41,7 +41,10 @@ from kamaki.cli.commands.cyclades_cli import _init_cyclades
from kamaki.cli.commands import _command_init, errors
image_cmds = CommandTree('image', 'Plankton (and Compute) Image API commands')
image_cmds = CommandTree(
'image',
'Cyclades/Plankton API image commands\n'
'image compute:\tCyclades/Compute API image commands')
_commands = [image_cmds]
......@@ -291,7 +294,7 @@ class image_setmembers(_init_image):
@command(image_cmds)
class image_compute(_init_cyclades):
"""Compute Image API commands"""
"""Cyclades/Compute API image commands"""
@command(image_cmds)
......
......@@ -38,7 +38,7 @@ from kamaki.cli.command_tree import CommandTree
from kamaki.clients import livetest
from kamaki.cli.errors import raiseCLIError
livetest_cmds = CommandTree('livetest', 'Test clients on live servers')
livetest_cmds = CommandTree('livetest', 'Client func. tests on live servers')
_commands = [livetest_cmds]
......
......@@ -58,7 +58,7 @@ from kamaki.clients.astakos import AstakosClient
kloger = getLogger('kamaki')
pithos_cmds = CommandTree('file', 'Pithos+ storage commands')
pithos_cmds = CommandTree('file', 'Pithos+/Storage API commands')
_commands = [pithos_cmds]
......
# Copyright 2012 GRNET S.A. All rights reserved.
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# 1. Redistributions of source code must retain the above
# copyright notice, this list of conditions and the following
# disclaimer.
#
# 2. Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials
# provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
from kamaki.cli.commissioning import commissioning_cli
from kamaki.clients.quotaholder import QuotaholderClient
class quotaholder(commissioning_cli):
def __init__(self):
self.client = QuotaholderClient
self.add_context = True
self.description = 'Quotaholder description'
super(self.__class__, self).__init__()
cli = quotaholder()
cli.generate_all()
_commands = [cli.ctree]
......@@ -91,7 +91,7 @@ DEFAULTS = {
'url': 'https://cyclades.okeanos.grnet.gr/plankton'
},
'user': {
'cli': 'user',
'cli': 'astakos',
'url': 'https://accounts.okeanos.grnet.gr'
}
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment