Synnefo » ./kamaki

Kamaki commands follow this scheme::

    [kamaki] <object> <action> [identifiers] [non-positional arguments]

In this context, objects are not services, but virtual objects like a server, a

file or an image. The action concerns objects of the specified type. Some

actions (e.g. "delete" or "info") need to operate on an existing object. The

identifiers strictly identify this object and they can have the form of an id 

(e.g., `server delete <SERVER_ID>`) or a foreign key (e.g., 

`port create <NETWORK_ID> <DEVICE_ID>`)

The examples bellow showcase some commands. The kamaki-shell (check

user (Identity/Astakos)

    info          Get info for (current) session user

    uuid2name     Get user name(s) from uuid(s)

    authenticate  Authenticate a user and get all authentication information

    list          List (cached) session users

    add           Authenticate user by token and add to kamaki session (cache)

    name2uuid     Get user uuid(s) from name(s)

    select        Select user from the (cached) list as current session user

    delete        Delete user (token) from the (cached) list of session users

In the following, cloud URL and TOKEN were set in a previous step (see

    [user]: info

    name:  My Real Name

    id:  ab1cde23-45fg-6h7i-8j9k-10l1m11no2pq

    [user]: exit

    [kamaki]:

project (Astakos)

-----------------

.. code-block:: text

    info          Get details for a project

    unsuspend     Resume a suspended project (special privileges needed)

    suspend       Suspend a project (special privileges needed)

    list          List all projects

    create        Apply for a new project

    modify        Modify a project

    terminate     Terminate a project (special privileges needed)

    application   Application management commands

    membership    Project membership management commands

    reinstate     Reinstate a terminated project (special privileges needed)

quota (Account/Astakos)

-----------------------

.. code-block:: text

    list          Get user quotas

    info          Get quota for a service (cyclades, pithos, astakos)

resource (Astakos)

------------------

.. code-block:: text

    list          List user resources

    cpu:  4

    id:  43

    ram:  2048

image (Image/Plankton)

----------------------

    info          Get image metadata

    list          List images accessible by user

    register      (Re)Register an image file to an Image service

    modify        Add / update metadata and properties for an image

    unregister    Unregister an image (does not delete the image file)

     disk_format:  diskdump

     id:  926ab1c5-2d85-49d4-aebe-0fce712789b9

     size:  11917066240

     status:  available

     disk_format:  diskdump

     id:  78262ee7-949e-4d70-af3a-85360c3de57a

     size:  11697913856

     status:  available

     disk_format:  diskdump

     id:  5ed5a29b-292c-4fe0-b32c-2e2b65628635

     size:  2578100224

     status:  available

     disk_format:  diskdump

     id:  1f8454f0-8e3e-4b6c-ab8e-5236b728dffe

     size:  795107328

     status:  available

    * Get details for image with id 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe *

    [image]: info 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe

     name: Debian_Wheezy_Base

     container_format:  bare

     disk_format:  diskdump

     id:  1f8454f0-8e3e-4b6c-ab8e-5236b728dffe

     size:  795107328

     status:  available

     owner:  s0m3-u53r-1d (user@example.com)

        DESCRIPTION:  Debian Wheezy Base (Stable)

        GUI:  No GUI

        KERNEL:  2.6.32

        OS:  debian

        OSFAMILY:  linux

        ROOT_PARTITION:  1

        SORTORDER:  1

        USERS:  root

imagecompute (Compute/Cyclades)

-------------------------------

.. code-block:: text

    info      Get detailed information on an image

    list      List images

    modify    Modify image properties (metadata)

    delete    Delete an image (WARNING: image file is also removed)

    info      Detailed information on a Virtual Machine

    modify    Modify attributes of a virtual server

    create    Create a server (aka Virtual Machine)

    list      List virtual servers accessible by user

    reboot    Reboot a virtual server

    start     Start an existing virtual server

    shutdown  Shutdown an active virtual server

    delete    Delete a virtual server

    wait      Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]

    usage: create --name NAME --flavor-id FLAVOR_ID --image-id IMAGE_ID

    [server]: create --name='My Small Debian Server' --flavor-id=1 --image-id=b2dffe52-64a4-48c3-8a4c-8214cc3165cf

.. Note:: In kamaki shell, / is used to access commands from top-level

ip (Network/Cyclades)

    info      Get details on a floating IP

    create    Reserve an IP on a network

    list      List reserved floating IPs

    delete    Unreserve an IP (also delete the port, if attached)

port (Network/Cyclades)

-----------------------

.. code-block:: text

    info      Get details about a port

    list      List all ports

    create    Create a new port (== connect server to network)

    modify    Modify the attributes of a port

    delete    Delete a port (== disconnect server from network)

    wait      Wait for port to finish [ACTIVE, DOWN, BUILD, ERROR]

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    * Enter port context *

    [kamaki]: port

    * Reserve an IP and see servers and networks*

    [port]: /ip create

    [port]: /server list

    [port]: /network list

    101  My Network 1

    102  My Network 2

    [port]: port create --device-id=43 --network-id=101 --ip-address=123.456.78.9 --wait

    Creating new port 7 between server 43 and network 101

    Port 7 still in BUILD mode |||||||||||||||||    | 80%

    Port 7 is now in ACTIVE mode

    info        Get details about a network

    disconnect  Disconnect a network from a device

    modify      Modify network attributes

    create      Create a new network

    list        List networks

    connect     Connect a network with a device (server or router)

    delete      Delete a network

    usage: connect <network id> <device id> [-s] [-h] [-i] [--config CONFIG]

    [network]: connect 11687 1409 --wait

    Creating port between network 1409 and server 11687

    New port: 8

      attachments:

                8

    [network]: /server info 11687 --nics 

    nic-11687-1

    nic-11687-0

container (Storage/Pithos+)

---------------------------

    info      Get information about a container

    modify    Modify the properties of a container

    create    Create a new container

    list      List all containers, or their contents

    empty     Empty a container

    delete    Delete a container

group (Storage/Pithos+)

-----------------------

    create    Create a group of users

    list      List all groups and group members

    delete    Delete a user group

sharer (Storage/Pithos+)

------------------------

    info      Details on a Pithos+ sharer account (default: current account)

    list      List accounts who share file objects with current user

    info      Get information/details about a file

    truncate  Truncate remote file up to size

    mkdir     Create a directory

    create    Create an empty file

    move      Move objects, even between different accounts or containers

    list      List all objects in a container or a directory object

    upload    Upload a file

    cat       Fetch remote file contents

    modify    Modify the attributes of a file or directory object

    append    Append local file to (existing) remote object

    download  Download a remove file or directory object to local file system

    copy      Copy objects, even between different accounts or containers

    overwrite Overwrite part of a remote file

    delete    Delete a file or directory object

    [file]: /container create mycont1

    [file]: /container create mycont2

    [file]: /container list

    [file]: upload /mycont1/rndm_local.file

    [file]: list /mycont1

    [file]: mkdir /mycont2/mydir

    [file]: move /mycont1/rndm_local.file /mycont2/mydir/rndm_local.file

    [file]: list /mycont1

    [file]: list /mycont2

    [file]: copy /mycont2/mydir/rndm_local.file /mycont1/rndm_remote.file

    [file]: list /mycont1

    [file]: download /mycont1/rndm_remote.file

    Downloading: |||||||||||||||||   | 72%

* by the deployment team which operates `GRNET ~okeanos` service

* as the main `Pithos+` client in Linux and other Unix-like environments, as

    well as in windows and osx by users with a preference for command line

* by third-party `Synnefo` deployers for testing and debugging their setup

* as an API library for other components in the Synnefo universe ((`burnin`,

    `image-creator`) or external applications