[one-users] Documentation

[Daniel Molina]

Dear Hutson,

On 19 November 2011 06:59, Hutson Betts <hut101 at tamu.edu> wrote:
> Potential Documentation Issues:
>
> There are a few documentation issues which can be found here
> (http://opennebula.org/documentation:rel3.0:occiug)
>
> On the Storage example there are two definitions for the Storage entity,
> and, for which, one is blank:
>
> $ occi-storage --url http://localhost:4567 --username oneadmin
> --password opennebula create image.xml
> <STORAGE href='http://0.0.0.0:4567/storage/3'>
>
> </STORAGE>
>
> <STORAGE href='http://localhost:4567/storage/0'>
>    <ID>3</ID>
>    <NAME>Ubuntu Desktop</NAME>
>    <TYPE>OS</TYPE>
>    <DESCRIPTION>Ubuntu 10.04 desktop for students.</DESCRIPTION>
>    <PUBLIC>NO</PUBLIC>
>    <PERSISTENT>NO</PERSISTENT>
>    <SIZE>41943040</SIZE>
> </STORAGE>

I have already fixed this error in the documentation

>
> On the Compute example there is an "id" attribute which I don't believe
> should be there:
>
> <DISK id='0'>
>    <STORAGE href='http://0.0.0.0:4567/storage/3' name='Ubuntu
> Desktop'/>
>    <TYPE>DISK</TYPE>
>    <TARGET>hda</TARGET>
>  </DISK>
>

That attribute is needed in order to specify the disk you want to
save. This operation can be performed using the PUT method. I will
update the documentation with examples of this operation.

> On the "Using the Cloud" page, each Storage Entity is name attribute.
> However, on the OCCI API page for the OpenNebula 3.0 documentation, each
> Storage Entity is only given a href attribute. Which documentation is
> correct?

I have updated the documentation to show the correct option (href and name)

>
> On the "OpenNebula OCCI User Guide 3.0" I see the following example in
> which the STATE value is in all caps:
>
> $ occi-compute --url http://localhost:4567 --username oneadmin
> --password opennebula create vm.xml
> <COMPUTE href='http://0.0.0.0:4567/compute/0'>
>  <ID>0</ID>
>  <CPU>1</CPU>
>  <MEMORY>1024</MEMORY>
>  <NAME>MyCompute</NAME>
>  <INSTANCE_TYPE>small</INSTANCE_TYPE>
>  <STATE>PENDING</STATE>
>  <DISK id='0'>
>    <STORAGE href='http://0.0.0.0:4567/storage/3' name='Ubuntu
> Desktop'/>
>    <TYPE>DISK</TYPE>
>    <TARGET>hda</TARGET>
>  </DISK>
>  <NIC>
>    <NETWORK href='http://0.0.0.0:4567/network/0'
> name='MyServiceNetwork'/>
>    <IP>192.168.1.12</IP>
>    <MAC>02:00:c0:a8:01:0c</MAC>
>  </NIC>
>  <CONTEXT>
>    <DATA>DATA1</DATA>
>    <HOSTNAME>MAINHOST</HOSTNAME>
>    <TARGET>hdb</TARGET>
>  </CONTEXT>
> </COMPUTE>
>
> However, on the "OpenNebula OCCI Specification 3.0" page, the values for
> the state of a Compute Resource are show in lower caps. Which is it?
>

You must use the upcase option (documentation updated).

Thanks for your feedback. If you have any comments do not hesitate to
let us know.

Kind regards.

> --
> Hutson Betts
> Computer Science and Engineering
> Texas A&M University
>
>
>
> _______________________________________________
> Users mailing list
> Users at lists.opennebula.org
> http://lists.opennebula.org/listinfo.cgi/users-opennebula.org
>
>



-- 
Daniel Molina
Project Engineer
OpenNebula - The Open Source Toolkit for Data Center Virtualization
www.OpenNebula.org | dmolina at opennebula.org | @OpenNebula