HOWTO11 How to use the rOCCI Client

Main

Roadmap and Innovation

Technology

For Users

For Resource Providers

Media

The rOCCI Client

The OCCI gem includes a client you can use directly from shell with the following auth methods: x509 (with --password, --user-cred and --ca-path), basic (with --username and --password), digest (with --username and --password), none. If you won't set a password using --password, the client will ask for it later on.

Find out more about available options and defaults use

occi --help

Create a proxy with VOMS extension

$ voms-proxy-init --voms fedcloud.egi.eu --rfc --dont_verify_ac
Enter GRID pass phrase for this identity:
Contacting voms1.egee.cesnet.cz:15002 [/DC=org/DC=terena/DC=tcs/C=CZ/O=CESNET/CN=voms1.egee.cesnet.cz] "fedcloud.egi.eu"...
Remote VOMS server contacted succesfully.


Created proxy in /tmp/x509up_u504.

Your proxy is valid until Sat Jun 14 01:09:06 CEST 2014

List the compute resources available in a site

$ occi --endpoint https://prisma-cloud.ba.infn.it:8787/ --action list --resource os_tpl --auth x509 --user-cred /tmp/x509up_u504 --voms
http://schemas.openstack.org/template/os#72ada03a-5694-4a79-8e7e-069516a31a59
http://schemas.openstack.org/template/os#d5b97735-747f-4f08-ab0b-1f84fe417714
http://schemas.openstack.org/template/os#ec4bb03e-d6df-4964-a490-ae0ef57536e7
http://schemas.openstack.org/template/os#d07a5f26-5f2e-453f-98f2-d0a8784ae980
http://schemas.openstack.org/template/os#f92e0a8b-1f34-424b-8682-1ba93799072d
http://schemas.openstack.org/template/os#39f2bed2-5a4f-419e-b4fb-33832e47d5af
http://schemas.openstack.org/template/os#f835d4a5-cb08-4350-b60e-3fdd0dc703a4
http://schemas.openstack.org/template/os#c0a2f9e0-081a-419c-b9a5-8cb03b1decb5
http://schemas.openstack.org/template/os#02f8cd09-7c79-4b3a-923a-51cd16496a6f
http://schemas.openstack.org/template/os#5364f77a-e1cb-4a6c-862e-96dc79c4ef67
http://schemas.openstack.org/template/os#7cfba655-f692-406f-a659-79b0224290cc
http://schemas.openstack.org/template/os#ff718bea-602b-4f13-91d2-58d134c45476
http://schemas.openstack.org/template/os#7664db29-e51f-4ab8-b4e7-3adfccee3150

Get the description of a compute resource

$ occi --endpoint https://prisma-cloud.ba.infn.it:8787/ --action describe --resource os_tpl#72ada03a-5694-4a79-8e7e-069516a31a59 --auth x509 --user-cred /tmp/x509up_u504 --voms
########################################################################################################################################################################################################
[[ http://schemas.openstack.org/template/os#72ada03a-5694-4a79-8e7e-069516a31a59 ]]
title:        Image: Ubuntu-14.04-amd64
term:         72ada03a-5694-4a79-8e7e-069516a31a59
location:     /72ada03a-5694-4a79-8e7e-069516a31a59/
########################################################################################################################################################################################################

Describe specific resources use

occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource /compute/<OCCI_ID> --auth x509
occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource /storage/<OCCI_ID> --auth x509
occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource /network/<OCCI_ID> --auth x509

Get the list of available resource templates

$ occi --endpoint https://prisma-cloud.ba.infn.it:8787/ --action list --resource resource_tpl --auth x509 --user-cred /tmp/x509up_u504 --voms
http://schemas.openstack.org/template/resource#1cpu-1gb-10dsk
http://schemas.openstack.org/template/resource#m1-xlarge
http://schemas.openstack.org/template/resource#2cpu-4gb-20dsk
http://schemas.openstack.org/template/resource#2cpu-4gb-50dsk
http://schemas.openstack.org/template/resource#16cpu-32gb-40dsk
http://schemas.openstack.org/template/resource#8cpu-8gb-30dsk
http://schemas.openstack.org/template/resource#16cpu-32gb-10dsk
http://schemas.openstack.org/template/resource#m1-large
http://schemas.openstack.org/template/resource#16cpu-32gb-20dsk
http://schemas.openstack.org/template/resource#1cpu-1gb-20dsk
http://schemas.openstack.org/template/resource#1cpu-4gb-10dsk
http://schemas.openstack.org/template/resource#8cpu-16gb-20dsk
http://schemas.openstack.org/template/resource#16cpu-32gb-60dsk
http://schemas.openstack.org/template/resource#8cpu-32gb-20dsk
http://schemas.openstack.org/template/resource#4cpu-8gb-20dsk
http://schemas.openstack.org/template/resource#m1-tiny
http://schemas.openstack.org/template/resource#16cpu-16gb-10dsk
http://schemas.openstack.org/template/resource#8cpu-8gb-20dsk
http://schemas.openstack.org/template/resource#medium
http://schemas.openstack.org/template/resource#16cpu-32gb-80dsk
http://schemas.openstack.org/template/resource#1cpu-2gb-50-dsk
http://schemas.openstack.org/template/resource#8cpu-8gb-50dsk
http://schemas.openstack.org/template/resource#extra_large
http://schemas.openstack.org/template/resource#m1-small
http://schemas.openstack.org/template/resource#8cpu-16gb-10dsk
http://schemas.openstack.org/template/resource#small
http://schemas.openstack.org/template/resource#4cpu-8gb-50dsk
http://schemas.openstack.org/template/resource#large
http://schemas.openstack.org/template/resource#4cpu-8gb-40dsk
http://schemas.openstack.org/template/resource#1cpu-512mb-25dsk
http://schemas.openstack.org/template/resource#4cpu-8gb-10dsk
http://schemas.openstack.org/template/resource#2cpu-2gb-10dsk
http://schemas.openstack.org/template/resource#8cpu-16gb-40dsk
http://schemas.openstack.org/template/resource#8cpu-8gb-10dsk
http://schemas.openstack.org/template/resource#m1-medium

Describe a specific OS template or Resource template use

occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource os_tpl#debian6 --auth x509
occi --endpoint https://<ENDPOINT>:<PORT>/ --action describe --resource resource_tpl#small --auth x509

Create a compute resource with mixins use

occi --endpoint https://<ENDPOINT>:<PORT>/ --action create --resource compute --mixin os_tpl#debian6 --mixin resource_tpl#small --attribute occi.core.title="My rOCCI VM" --auth x509

Delete a compute resource use

occi --endpoint https://<ENDPOINT>:<PORT>/ --action delete --resource /compute/<OCCI_ID> --auth x509

References

For more information, please, visit the rOCCI client GitHub repository