README

==================
Tag Query Language
==================
== by examples ==
# list accounts
> list a

# list hypervisor
> list hv

# list vm
> list vm

# list vm of hypervisor toto
> list hv=toto&vm

# list vm chiche of hypervisor toto
> list hv=toto&vm=chiche

#list vm with 2 cpu
> list vm&cpu=2

#list vm with 2 cpu and mem > 10g
> list vm&cpu=2&mem>10g

#list hypervistor with 2cpu and vm with 2cpu
> list hv&cpu=2&vm&cpu=2

#list hypervistor at least 2cpu and show tags pop and alloc
> list hv&cpu>=2$pop$alloc

== Basics ==
- TQL build a list of objects from left to right
- Every tag can add or remove objects
- Separators create link between tag
- Operators apply only on one tag

== separators of tags ==
& and between tags
$ show a tag

== operators on tags ==
= strict equality
!= not strict equlity
: globing matching
!:not globing matching
~ regex matching
!~ not regex matching
> superior strict
>= superior
< inferior
<= inferior strict

== number facility ==
10k = 1000
10ki = 1024
1m = 1000 ^ 2
1mi = 1024 ^ 2
1g = 1000 ^ 3
1gi = 1024 ^ 3

== well known tags ==
a: account name
hv: hypervisor name
vm: virtual machine name
id: a.hv.vm
h: hostname
role: (hypersivor/host/cli/vm)
hvtype: hypervistor type (xen/kvm)
libvirtver: Libvirt version
status: online/offline
vmstatus: Running/Paused/Stoped
pop: Point of Presence
cpu: cpu count
mem: memory size
usedmem: memory used
freemem: memory free
arch: (x86/x64)
uname: uname of host
uptime: uptime of hostname
load: load average
hvm: hardware virtualisation enabled
alloc: host is allowed to be selected to a migration
nvm: vm count on an hypervisor
version: account version
sto: total available storage
freesto: free storage
usedsto: used storage


===========
New release
===========
Update version in debian/control
Update version in debian/changelog
Update version in setup.py
Update version in cccli/__init__.py