Jump to: navigation, search

Difference between revisions of "Occi"

m (Update network creation script)
 
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
+
'''https://github.com/tmetsch/occi-os appears to be the latest location for this content.'''
* '''Launchpad Entry''': [[NovaSpec]]:bexar-open-cloud-compute-interface
+
 
 +
* '''Launchpad Entry''': NovaSpec:bexar-open-cloud-compute-interface
 
* '''Created''': 11/10/2010
 
* '''Created''': 11/10/2010
 
* '''Updated''': 17/04/2012
 
* '''Updated''': 17/04/2012
* '''Contributors''': [https://blueprints.launchpad.net/~tmetsch Thijs Metsch (tmetsch)], [https://launchpad.net/~andy-edmonds Andy Edmonds (dizz)]
+
* '''Contributors''': [https://blueprints.launchpad.net/~tmetsch Thijs Metsch (tmetsch)], [https://launchpad.net/~andy-edmonds Andy Edmonds (dizz)], [https://launchpad.net/~u-marcin Marcin Spoczynski (sandlbn)]
  
<<[[TableOfContents]]()>>
+
__TOC__
  
== Summary ==
+
= Summary =
 
This will implement the Open Cloud Computing Interface (OCCI) within nova/api. OCCI is one of the first standards in Cloud Computing. The specification of OCCI can be found here: http://www.occi-wg.org
 
This will implement the Open Cloud Computing Interface (OCCI) within nova/api. OCCI is one of the first standards in Cloud Computing. The specification of OCCI can be found here: http://www.occi-wg.org
  
Line 18: Line 19:
  
 
== How to use the OCCI interface ==
 
== How to use the OCCI interface ==
 +
 
This guide will explain what you can do with the current OCCI implementation for [[OpenStack]].
 
This guide will explain what you can do with the current OCCI implementation for [[OpenStack]].
  
 
If you are evaluating or playing with the implementation, it is best followed sequentially.
 
If you are evaluating or playing with the implementation, it is best followed sequentially.
  
=== First up, prerequisites: ===
+
== Running [[OpenStack]] with OCCI ==
==== Get a running instance of [[OpenStack]] ====
 
Lots of ways to do this:
 
 
 
* Install with apt-get
 
* Install with [http://puppetlabs.com/ puppet]
 
* Install with [http://www.opscode.com/chef/ chef]
 
* Install with [https://github.com/dellcloudedge/crowbar/ crowbar]
 
* Install with [http://devstack.org/ devstack]
 
* Use the prebuilt devstack VM image (see: "Pre-prepared OCCI Devstack VM")
 
 
 
More details can be [http://wiki.openstack.org/GetOpenStack found in this wiki]
 
 
 
The easiest for experimentation and evaluation is [http://www.devstack.org devstack].
 
  
==== Running [[OpenStack]] with OCCI ====
 
 
Below will show you how to create an [http://www.openstack.org OpenStack] environment that is [http://www.occi-wg.org OCCI] compliant.
 
Below will show you how to create an [http://www.openstack.org OpenStack] environment that is [http://www.occi-wg.org OCCI] compliant.
  
===== Creating a devstack Environment =====
+
=== Creating a devstack Environment ===
 
 
'''Note''': Creating such an environment is only for development, evaluation purposes.
 
 
 
===== Create a VM =====
 
 
 
Pre-requisite: an installed hypervisor. The VM can be created on any desktop hypervisor (e.g. VMware Workstation, VMware Fusion, Parallels Desktop, [[VirtualBox]])
 
 
 
- Create a VM with [http://www.ubuntu.com/download/server/download Ubuntu Server 11.10] with 1 core and 1024MB of RAM. Disk space is at your discretion but 6GB should be enough. [http://www.youtube.com/watch?v=OW1a1ptQwcs See the following video] if you need further instructions.
 
- The hypervisor driver automatically selected will be `qemu` so don't expect your test [[OpenStack]]-managed VMs to be insanely fast!
 
- `sudo apt-get install git`
 
 
 
===== Install devstack & OCCI =====
 
  
 
With your freshly created VM, install OCCI dependencies and [devstack](http://www.devstack.org) on it.
 
With your freshly created VM, install OCCI dependencies and [devstack](http://www.devstack.org) on it.
Line 60: Line 36:
 
1. Install pyssf
 
1. Install pyssf
  
     `pip install pyssf`
+
     pip install pyssf
  
 
2. Install devstack
 
2. Install devstack
  
     `git clone git://github.com/openstack-dev/devstack.git`
+
     git clone git://github.com/openstack-dev/devstack.git
  
3. Configure devstack. Here we have to change the `NOVA_REPO` location (done with the `sed` command).
+
3. Install OCCI
  
    `cd devstack`
+
* Visit the [https://github.com/tmetsch/occi-os OCCI-OS github repository] and [https://github.com/tmetsch/occi-os/blob/master/README.md follow the installation instructions]. The installation process is a matter of installing another python package.
 +
* Note: you should not manually set the `nova.conf` file configuration yourself, rather use the method outlined in step 4.
  
    `sed -i 's/NOVA_REPO=https\:\/\/github.com\/openstack\/nova.git/NOVA_REPO=https\:\/\/github.com\/dizz\/nova.git/' stackrc`
+
4. Set the contents of `local.conf` (you may have to create the file) to:
  
     `sed -i 's/NOVA_BRANCH=master/NOVA_BRANCH=bp\/bexar-open-cloud-compute-interface/' stackrc`
+
<pre><nowiki>
 
+
     [[post-config|$NOVA_CONF]]
4. Set the contents of `localrc` (you may have to create the file) to:
+
[DEFAULT]
 
+
api_rate_limit = False
    `EXTRA_OPTS=(--allow_resize_to_same_host=True)`
+
allow_resize_to_same_host=True
 
+
libvirt_inject_password=True
    `ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-sch,n-novnc,n-xvnc,n-cauth,horizon,mysql,rabbit,n-vol,openstackx`
+
enabled_apis=ec2,occiapi,osapi_compute,metadata
 
+
</nowiki></pre>
    `OFFLINE=False`
 
  
 
4. Run devstack
 
4. Run devstack
  
   `./stack.sh`
+
   ./stack.sh
  
 
The first run will be longer than successive runs if this is the first time executing the `stack.sh` command.
 
The first run will be longer than successive runs if this is the first time executing the `stack.sh` command.
Line 92: Line 68:
 
The OCCI API will be available at http://$HOST_IP:8787/
 
The OCCI API will be available at http://$HOST_IP:8787/
  
===== Pre-prepared OCCI Devstack VM =====
+
== Using OCCI with OpenStack ==
A pre-prepared devstack instance with the OCCI API [http://dl.dropbox.com/u/165239/OCCI-OS-Devstack.ova can be downloaded here (OVA)]. It was generated with [[VirtualBox]] and the disk image format is VMDK.
 
 
 
* Username: `occi`
 
* Password: `occi`
 
 
 
All devstack administrative passwords are set to `admin`.
 
 
 
==== Create some Custom Flavors ====
 
Do this if you want to experiment with scaling up a VM on devstack.
 
 
 
1. In devstack ensure that this is in `localrc`:
 
 
 
<pre><nowiki>{
 
      EXTRA_FLAGS=(--allow_resize_to_same_host=True)
 
</nowiki></pre>
 
}
 
2. Create custom flavors:
 
 
 
<pre><nowiki>{
 
      nova-manage flavor create --name=itsy --cpu=1 --memory=128 --flavor=98 --root_gb=1 --ephemeral_gb=1
 
      nova-manage flavor create --name=bitsy --cpu=1 --memory=256 --flavor=99 --root_gb=1 --ephemeral_gb=1
 
</nowiki></pre>
 
}
 
* **Note**: your VM must have **at least** 1GB of RAM*
 
 
 
==== Get Authentication Credentials from Keystone ====
 
 
 
<pre><nowiki>{
 
    curl -d '{"auth": {"tenantName": "$YOUR_TENANT_NAME", "passwordCredentials":{"username": "$YOUR_USER_NAME", "password": "$YOUR_PASSWORD"</nowiki></pre>
 
' -H "Content-type: application/json" http://$KEYSTONE_SERVICE_IP:35357/v2.0/tokens
 
    export KID=<<Token from Keystone>>
 
</nowiki></pre>
 
}   
 
==== Get the Tenant ID from [[OpenStack]] ====
 
  
Get it from the dashboard
+
=== Get Authentication Credentials from Keystone ===
Get it from the command line
 
  
<pre><nowiki>{
+
<pre><nowiki>
    export TEN_ID=<tenant ID>
+
$ export KID=`curl -i -s -H "Content-Type: application/json" -d '{"auth":{"identity":{"methods":["password"],"password":{"user":{"name":"admin","domain":{"id":"default"},"password":"mypass"}}},"scope":{"project":{"name":"demo","domain":{"id":"default"}}}}}' http://localhost:5000/v3/auth/tokens | grep "X-Subject-Token" | awk '{print $2}'`
 
</nowiki></pre>
 
</nowiki></pre>
}
 
==== Get a valid Tenant User ====
 
 
<pre><nowiki>{
 
    export OS_USER=<open stack user name>
 
</nowiki></pre>
 
}
 
This requirement will go by having an OCCI-specific authentication middleware
 
  
 
=== OCCI-ness ===
 
=== OCCI-ness ===
Line 149: Line 82:
 
==== See What Can be Provisioned ====
 
==== See What Can be Provisioned ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -X GET localhost:8787/-/
+
     curl -v -H 'X-Auth-Token: '$KID -X GET localhost:8787/-/
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Create a VM ====
 
==== Create a VM ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/compute/ -H 'Category: compute; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"' -H 'Category: cirros-0.3.0-x86_64-uec; scheme="http://schemas.openstack.org/template/os#"; class="mixin"'
+
     curl -v -X POST localhost:8787/compute/ -H 'Category: compute; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"' -H 'Category: cirros-0.3.0-x86_64-uec; scheme="http://schemas.openstack.org/template/os#"; class="mixin"'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
* **Note**: you can supply the admin password and/or public ssh key pairs in this request*
+
'''Note''': you can supply the admin password and/or public ssh key pairs in this request*
  
 
For ease of this OCCI exercise, place the VM id into a shell variable e.g.
 
For ease of this OCCI exercise, place the VM id into a shell variable e.g.
  
<pre><nowiki>{
+
<pre><nowiki>
 
     export VM=d54b4344-16be-486a-9871-2c566ef2263d
 
     export VM=d54b4344-16be-486a-9871-2c566ef2263d
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Get a Listing of VMs ====
 
==== Get a Listing of VMs ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X GET localhost:8787/compute/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
+
     curl -v -X GET localhost:8787/compute/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID  
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Get an Individual VM's Details ====
 
==== Get an Individual VM's Details ====
  
<pre><nowiki>{   
+
<pre><nowiki>
     curl -v -X GET localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
+
     curl -v -X GET localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Execute a Stop Action Upon a VM ====
 
==== Execute a Stop Action Upon a VM ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST "localhost:8787/compute/$VM?action=stop" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: stop; scheme="http://schemas.ogf.org/occi/infrastructure/compute/action#"; class="action"'
+
     curl -v -X POST "localhost:8787/compute/$VM?action=stop" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: stop; scheme="http://schemas.ogf.org/occi/infrastructure/compute/action#"; class="action"'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Execute a Start Action Upon a VM ====
 
==== Execute a Start Action Upon a VM ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/compute/$VM?action=start -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: start; scheme="http://schemas.ogf.org/occi/infrastructure/compute/action#"; class="action"'
+
     curl -v -X POST localhost:8787/compute/$VM?action=start -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: start; scheme="http://schemas.ogf.org/occi/infrastructure/compute/action#"; class="action"'
 
</nowiki></pre>
 
</nowiki></pre>
}   
 
_Note: this will probably result in an error state. Currently looking into the issue._
 
  
 
==== Create Some a Block Storage Volume ====
 
==== Create Some a Block Storage Volume ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/storage/ -H 'Category: storage; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'X-OCCI-Attribute: occi.storage.size = 1.0'
+
     curl -v -X POST localhost:8787/storage/ -H 'Category: storage; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-OCCI-Attribute: occi.storage.size = 1.0'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
For ease of this OCCI exercise, place the volume id into a shell variable e.g.
 
For ease of this OCCI exercise, place the volume id into a shell variable e.g.
  
<pre><nowiki>{
+
<pre><nowiki>
 
     export VOL=1
 
     export VOL=1
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Show the Volume Details: ====
 
==== Show the Volume Details: ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X GET localhost:8787/storage/$VOL -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
+
     curl -v -X GET localhost:8787/storage/$VOL -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Link and Associate that Volume to the New Instance ====
 
==== Link and Associate that Volume to the New Instance ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/storage/link/ -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: storagelink; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'X-OCCI-Attribute: occi.core.source="http://localhost:8787/compute/'$VM'"' -H 'X-OCCI-Attribute: occi.core.target="http://localhost:8787/storage/'$VOL'"' -H 'X-OCCI-Attribute: occi.storagelink.deviceid="/dev/vdc"' -H 'Content-Type: text/occi'
+
     curl -v -X POST localhost:8787/storage/link/ -H 'X-Auth-Token: '$KID -H 'Category: storagelink; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'X-OCCI-Attribute: occi.core.source="http://localhost:8787/compute/'$VM'"' -H 'X-OCCI-Attribute: occi.core.target="http://localhost:8787/storage/'$VOL'"' -H 'X-OCCI-Attribute: occi.storagelink.deviceid="/dev/vdc"' -H 'Content-Type: text/occi'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
For ease of this OCCI exercise, place the volume id into a shell variable e.g.
 
For ease of this OCCI exercise, place the volume id into a shell variable e.g.
  
<pre><nowiki>{
+
<pre><nowiki>
 
     export VOL_LINK=aa49b313-9714-4cb3-92e3-13ab484235b
 
     export VOL_LINK=aa49b313-9714-4cb3-92e3-13ab484235b
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Inspect the Storage Link ====
 
==== Inspect the Storage Link ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X GET localhost:8787/storage/link/$VOL_LINK -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
+
     curl -v -X GET localhost:8787/storage/link/$VOL_LINK -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Unlink and disassociate that volume with the new instance ====
 
==== Unlink and disassociate that volume with the new instance ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X DELETE localhost:8787/storage/link/$VOL_LINK -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Content-Type: text/occi'
+
     curl -v -X DELETE localhost:8787/storage/link/$VOL_LINK -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Delete Storage Volume ====
 
==== Delete Storage Volume ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X DELETE localhost:8787/storage/$VOL -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Content-Type: text/occi'
+
     curl -v -X DELETE localhost:8787/storage/$VOL -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Scale Up a VM ====
 
==== Scale Up a VM ====
 
Let's bump the current instance from itsy (128 RAM, 1 Core) to a bitsy flavour (256 RAM, 1 Core).
 
Let's bump the current instance from itsy (128 RAM, 1 Core) to a bitsy flavour (256 RAM, 1 Core).
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: bitsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"'
+
     curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: bitsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
_Notes:_  
 
_Notes:_  
  
 
* This is a partial update with respect to OCCI.
 
* This is a partial update with respect to OCCI.
  
==== Confirm the Scaled Up VM ====
 
This is [[OpenStack]] specific. Users must confirm that the scaled up VM is what they want and that their previous configuration is as expected.
 
 
<pre><nowiki>{
 
    curl -v -X POST "localhost:8787/compute/$VM?action=confirm_resize" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: confirm_resize; scheme="http://schemas.openstack.org/instance/action#"; class="action"'
 
</nowiki></pre>
 
}
 
 
==== Scale Down a VM ====
 
==== Scale Down a VM ====
 
Let's reduce the current instance from bitsy (256 RAM, 1 Core) to a itsy flavour (128 RAM, 1 Core).
 
Let's reduce the current instance from bitsy (256 RAM, 1 Core) to a itsy flavour (128 RAM, 1 Core).
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"'
+
     curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
_Notes:_  
 
_Notes:_  
  
 
* This is a partial update with respect to OCCI.
 
* This is a partial update with respect to OCCI.
  
==== Confirm the Scaled Down VM ====
+
==== Delete a VM ====
This is [[OpenStack]] specific. Users must confirm that the scaled up VM is what they want and that their previous configuration is as expected.
 
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST "localhost:8787/compute/$VM?action=confirm_resize" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: confirm_resize; scheme="http://schemas.openstack.org/instance/action#"; class="action"'
+
     curl -v -X DELETE localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID
 
</nowiki></pre>
 
</nowiki></pre>
}
 
==== Delete a VM ====
 
  
<pre><nowiki>{
 
    curl -v -X DELETE localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
 
</nowiki></pre>
 
}
 
 
==== Update a VM: Change the OS ====
 
==== Update a VM: Change the OS ====
 
As an example, let's use SmartOS as the new OS
 
As an example, let's use SmartOS as the new OS
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: SmartOS; scheme="http://schemas.openstack.org/template/os#"; class="mixin"'
+
     curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: SmartOS; scheme="http://schemas.openstack.org/template/os#"; class="mixin"'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
_Notes:_  
 
_Notes:_  
  
Line 297: Line 214:
 
==== Create a Security Group ====
 
==== Create a Security Group ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Content-Type: text/occi' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"; rel="http://schemas.ogf.org/occi/infrastructure/security#group"; location="/mygroups/"' -X POST localhost:8787/-/
+
     curl -v -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"; rel="http://schemas.ogf.org/occi/infrastructure/security#group"; location="/mygroups/"' -X POST localhost:8787/-/
 
</nowiki></pre>
 
</nowiki></pre>
}   
 
- Follows the [[OpenStack]] model. Groups of rules are associated with a compute resource.
 
  
- A security group is associated with a compute. This is done by the addition or removal of a mixin to/from a compute instance
+
* Follows the [[OpenStack]] model. Groups of rules are associated with a compute resource.
 +
* A security group is associated with a compute. This is done by the addition or removal of a mixin to/from a compute instance
 +
* Security rules can be added and removed to a security group (mixin). This is done by (dis)associating the rule with the group (mixin). Rules can be created and deleted.
 +
 
 +
==== List Security Groups ====
  
- Security rules can be added and removed to a security group (mixin). This is done by (dis)associating the rule with the group (mixin). Rules can be created and deleted.
+
<pre><nowiki>
 +
    curl -v -H 'X-Auth-Token: '$KID -H 'Content-type: text/occi' -H 'Accept: text/plain' -H 'Category: group; scheme="http://schemas.ogf.org/occi/infrastructure/security#"; class="mixin"' -X GET localhost:8787/-/
 +
</nowiki></pre>
 +
 
 +
''''Note'''': this will only return the specified category in the request and not the related categories. This will be fixed in pyssf in the next release.
  
 
==== Create a Security Rule ====
 
==== Create a Security Rule ====
 
To do so specify the rule parameters (as a Kind) and the group the rule (as a mixin) is to belong to. This associates the rule with the respective group. Let's add a rule for inbound SSH traffic to a security rule group. This group can then be supplied when provisioning VMs. The group can also be applied an already provisioned VM.
 
To do so specify the rule parameters (as a Kind) and the group the rule (as a mixin) is to belong to. This associates the rule with the respective group. Let's add a rule for inbound SSH traffic to a security rule group. This group can then be supplied when provisioning VMs. The group can also be applied an already provisioned VM.
  
<pre><nowiki>{   
+
<pre><nowiki>  
     curl -v -X POST localhost:8787/network/security/rule/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"' -H 'Category: rule; scheme="http://schemas.openstack.org/occi/infrastructure/network/security#"; class="kind"' -H 'X-OCCI-Attribute: occi.network.security.protocol = "TCP"' -H 'X-OCCI-Attribute: occi.network.security.to = 22' -H 'X-OCCI-Attribute: occi.network.security.from = 22' -H 'X-OCCI-Attribute: occi.network.security.range = "0.0.0.0/24"'
+
     curl -v -X POST localhost:8787/network/security/rule/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"' -H 'Category: rule; scheme="http://schemas.openstack.org/occi/infrastructure/network/security#"; class="kind"' -H 'X-OCCI-Attribute: occi.network.security.protocol = "TCP"' -H 'X-OCCI-Attribute: occi.network.security.to = 22' -H 'X-OCCI-Attribute: occi.network.security.from = 22' -H 'X-OCCI-Attribute: occi.network.security.range = "0.0.0.0/24"'
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
For ease of this OCCI exercise, place the volume id into a shell variable e.g.
 
For ease of this OCCI exercise, place the volume id into a shell variable e.g.
  
<pre><nowiki>{
+
<pre><nowiki>
 
     export RULE=1233323
 
     export RULE=1233323
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== List the Associated Rules/Compute Resources to a Group ====
 
==== List the Associated Rules/Compute Resources to a Group ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X GET localhost:8787/mygroups/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
+
     curl -v -X GET localhost:8787/mygroups/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Get Security Rule's Details ====
 
==== Get Security Rule's Details ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -X GET http://localhost:8787/network/security/rule/$RULE
+
     curl -v -H 'X-Auth-Token: '$KID -X GET http://localhost:8787/network/security/rule/$RULE
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Delete a Security Rule ====
 
==== Delete a Security Rule ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -X DELETE http://localhost:8787/network/security/rule/$RULE
+
     curl -v -H 'X-Auth-Token: '$KID -X DELETE http://localhost:8787/network/security/rule/$RULE
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Delete a Security Group ====
 
==== Delete a Security Group ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Content-Type: text/occi' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"' -X DELETE localhost:8787/-/
+
     curl -v -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"' -X DELETE localhost:8787/-/
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Create a Secured VM with a Security Group ====
 
==== Create a Secured VM with a Security Group ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST localhost:8787/compute/ -H 'Category: compute; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"' -H 'Category: cirros-0.3.0-x86_64-uec; scheme="http://schemas.openstack.org/template/os#"; class="mixin"' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"'
+
     curl -v -X POST localhost:8787/compute/ -H 'Category: compute; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"' -H 'Category: cirros-0.3.0-x86_64-uec; scheme="http://schemas.openstack.org/template/os#"; class="mixin"' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"'
 +
</nowiki></pre>
 +
 
 +
==== Locate External Network ====
 +
 
 +
<pre><nowiki>
 +
  curl -v -X GET  localhost:8787/network/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID
 
</nowiki></pre>
 
</nowiki></pre>
}   
 
==== List Floating IP Pools ====
 
Request the Query Interface. Optionally filter on pool mixin.
 
  
<pre><nowiki>{
+
You should get a list of the networks, you can query each network to check which one is external. Look at the X-OCCI-Attribute: occi.network.label="internal" attribute
    curl -v -X GET localhost:8787/-/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
+
 
 +
<pre><nowiki>
 +
  export EXTERNAL_NET_URL="http://localhost:8787/network/fe9df68f-a2a4-4496-a5f9-2ce496d78dd0"
 
</nowiki></pre>
 
</nowiki></pre>
}
+
 
 
==== Allocate Floating IP to VM ====
 
==== Allocate Floating IP to VM ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST "localhost:8787/compute/$VM?action=alloc_float_ip" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: alloc_float_ip; scheme="http://schemas.openstack.org/instance/action#"; class="action"' -H 'X-OCCI-Attribute: org.openstack.network.floating.pool="nova"'
+
     curl -v -X POST -H 'X-Auth-token: '$KID localhost:8787/network/interface/ -H 'Category: networkinterface; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'x-occi-attribute: occi.core.source="http://localhost:8787/compute/'$VM'"' -H 'x-occi-attribute: occi.core.target="'$EXTERNAL_NET_URL'"' -H 'Content-Type: text/occi'
 +
</nowiki></pre>
 +
 
 +
<pre><nowiki>
 +
    export NETWORK_LINK=...
 
</nowiki></pre>
 
</nowiki></pre>
}
 
==== View Allocated Floating IP ====
 
GET the VM and inspect the `org.openstack.network.floating.ip` attribute
 
  
 
==== Deallocate Floating IP to VM ====
 
==== Deallocate Floating IP to VM ====
  
<pre><nowiki>{
+
<pre><nowiki>
     curl -v -X POST "localhost:8787/compute/$VM?action=dealloc_float_ip" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: dealloc_float_ip; scheme="http://schemas.openstack.org/instance/action#"; class="action"'
+
     curl -v -X DELETE -H 'X-Auth-token: '$KID localhost:8787/'$NETWORK_LINK
 
</nowiki></pre>
 
</nowiki></pre>
}
 
===== Current Issue =====
 
OS allows multiple floating IPs per server. Current OCCI implementation only allows one IP per compute resource. Multiple IP support will be implemented and can be done by links, once pyssf supports arbitrary values in the Link category.
 
  
 
==== Change VM Administrative (root) Password ====
 
==== Change VM Administrative (root) Password ====
Line 380: Line 306:
 
Issue the following action:
 
Issue the following action:
  
<pre><nowiki>{
+
<pre><nowiki>
curl -v -X POST "localhost:8787/compute/$VM?action=chg_pwd" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: chg_pwd; scheme="http://schemas.openstack.org/instance/action#"; class="action"' -H 'X-OCCI-Attribute: org.openstack.credentials.admin_pwd="new_pass"'
+
curl -v -X POST "localhost:8787/compute/$VM?action=chg_pwd" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: chg_pwd; scheme="http://schemas.openstack.org/instance/action#"; class="action"' -H 'X-OCCI-Attribute: org.openstack.credentials.admin_pwd="new_pass"'
 
</nowiki></pre>
 
</nowiki></pre>
}
 
  
 
==== Create a Image from an Active VM ====
 
==== Create a Image from an Active VM ====
  
<pre><nowiki>{
+
<pre><nowiki>
curl -v -X POST "localhost:8787/compute/$VM?action=create_image" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: create_image; scheme=" http://schemas.openstack.org/instance/action#; class="action"' -H 'X-OCCI-Attribute: org.openstack.snapshot.image_name="awesome_ware"'
+
curl -v -X POST "localhost:8787/compute/$VM?action=create_image" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: create_image; scheme=" http://schemas.openstack.org/instance/action#; class="action"' -H 'X-OCCI-Attribute: org.openstack.snapshot.image_name="awesome_ware"'
</nowiki></pre>
 
}
 
 
 
=== Work in Progress ===
 
 
 
Integration of Quantum
 
==== Create a Network ====
 
 
 
<pre><nowiki>{
 
    curl -v -X POST localhost:8787/network/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: network; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'occi.network.label="www"'
 
</nowiki></pre>
 
}
 
For ease of this OCCI exercise, place the volume id into a shell variable e.g.
 
 
 
<pre><nowiki>{
 
    export NET=aa49b313-9714-4cb3-92e3-13ab484235b
 
</nowiki></pre>
 
}
 
==== Get Network Details ====
 
 
 
<pre><nowiki>{
 
    curl -v -X GET localhost:8787/network/$NET_ID -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
 
</nowiki></pre>
 
}
 
==== Attach a VM to the Network ====
 
 
 
<pre><nowiki>{
 
    curl -v -X POST localhost:8787/networklink/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER -H 'Category: networkinterface; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'X-OCCI-Attribute: occi.core.source="http://localhost:8787/compute/'$VM'"' -H 'X-OCCI-Attribute: occi.core.target="http://localhost:8787/network/'$NET'"'
 
 
</nowiki></pre>
 
</nowiki></pre>
}
 
==== Delete Network ====
 
 
<pre><nowiki>{
 
    curl -v -X DELETE localhost:8787/network/$NET_ID -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-Auth-Tenant-Id: '$TEN_ID -H 'X-Auth-User: '$OS_USER
 
</nowiki></pre>
 
}
 
=== TODOs ===
 
 
* Write an OCCI registry backend that reads from the OS Nova DB
 
* Integrate CDMI volume management like in rOCCI
 
* Import/Export OVF functionality
 
* Support meta-data and file injection
 

Latest revision as of 10:40, 29 April 2015

https://github.com/tmetsch/occi-os appears to be the latest location for this content.

Summary

This will implement the Open Cloud Computing Interface (OCCI) within nova/api. OCCI is one of the first standards in Cloud Computing. The specification of OCCI can be found here: http://www.occi-wg.org

A demonstration of the implementation is also available.

Implementation details

The OCCI interface is integrated using an WSGI application - it can coexist to the current APIs but offers a rich, flexible interoperable way to interact with OpenStack through a standardized interface.

This implements an OpenStack service that runs out of nova-api. It is implemented using both the OpenStack service and WSGI frameworks. On start it will serve its functionality over HTTP on port 8787 as described in the OCCI specifications. It is compliant as per the set of OCCI specifications (GFD.183, GFD.184 and GFD.185) and implements all mandatory features. It also leverages the OCCI core model to expose OpenStack-specific features in an OCCI fashion. There is further detail on its core and OpenStack specific usage at http://wiki.openstack.org/occi. The implementation is co-funded by Intel Labs Europe Cloud Services Lab and FI-ware.

How to use the OCCI interface

This guide will explain what you can do with the current OCCI implementation for OpenStack.

If you are evaluating or playing with the implementation, it is best followed sequentially.

Running OpenStack with OCCI

Below will show you how to create an OpenStack environment that is OCCI compliant.

Creating a devstack Environment

With your freshly created VM, install OCCI dependencies and [devstack](http://www.devstack.org) on it.

A pre-requisite to this is the python dev tools: `sudo apt-get install python-pip python-dev build-essential`

1. Install pyssf

   pip install pyssf

2. Install devstack

   git clone git://github.com/openstack-dev/devstack.git

3. Install OCCI

4. Set the contents of `local.conf` (you may have to create the file) to:

    [[post-config|$NOVA_CONF]]
	[DEFAULT]
	api_rate_limit = False
	allow_resize_to_same_host=True
	libvirt_inject_password=True
	enabled_apis=ec2,occiapi,osapi_compute,metadata

4. Run devstack

  ./stack.sh

The first run will be longer than successive runs if this is the first time executing the `stack.sh` command.

For more configuration options of devstack please see the devstack.

The OCCI API will be available at http://$HOST_IP:8787/

Using OCCI with OpenStack

Get Authentication Credentials from Keystone

$ export KID=`curl -i -s -H "Content-Type: application/json" -d '{"auth":{"identity":{"methods":["password"],"password":{"user":{"name":"admin","domain":{"id":"default"},"password":"mypass"}}},"scope":{"project":{"name":"demo","domain":{"id":"default"}}}}}' http://localhost:5000/v3/auth/tokens | grep "X-Subject-Token" | awk '{print $2}'`

OCCI-ness

The examples below use the OCCI header format for terseness, however the recommended format is the OCCI text body format (Content-Type: text/plain).

See What Can be Provisioned

    curl -v -H 'X-Auth-Token: '$KID -X GET localhost:8787/-/

Create a VM

    curl -v -X POST localhost:8787/compute/ -H 'Category: compute; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"' -H 'Category: cirros-0.3.0-x86_64-uec; scheme="http://schemas.openstack.org/template/os#"; class="mixin"'

Note: you can supply the admin password and/or public ssh key pairs in this request*

For ease of this OCCI exercise, place the VM id into a shell variable e.g.

    export VM=d54b4344-16be-486a-9871-2c566ef2263d

Get a Listing of VMs

    curl -v -X GET localhost:8787/compute/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID 

Get an Individual VM's Details

    curl -v -X GET localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID

Execute a Stop Action Upon a VM

    curl -v -X POST "localhost:8787/compute/$VM?action=stop" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: stop; scheme="http://schemas.ogf.org/occi/infrastructure/compute/action#"; class="action"'

Execute a Start Action Upon a VM

    curl -v -X POST localhost:8787/compute/$VM?action=start -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: start; scheme="http://schemas.ogf.org/occi/infrastructure/compute/action#"; class="action"'

Create Some a Block Storage Volume

    curl -v -X POST localhost:8787/storage/ -H 'Category: storage; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'X-OCCI-Attribute: occi.storage.size = 1.0'

For ease of this OCCI exercise, place the volume id into a shell variable e.g.

    export VOL=1

Show the Volume Details:

    curl -v -X GET localhost:8787/storage/$VOL -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID

Link and Associate that Volume to the New Instance

    curl -v -X POST localhost:8787/storage/link/ -H 'X-Auth-Token: '$KID -H 'Category: storagelink; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'X-OCCI-Attribute: occi.core.source="http://localhost:8787/compute/'$VM'"' -H 'X-OCCI-Attribute: occi.core.target="http://localhost:8787/storage/'$VOL'"' -H 'X-OCCI-Attribute: occi.storagelink.deviceid="/dev/vdc"' -H 'Content-Type: text/occi'

For ease of this OCCI exercise, place the volume id into a shell variable e.g.

    export VOL_LINK=aa49b313-9714-4cb3-92e3-13ab484235b

Inspect the Storage Link

    curl -v -X GET localhost:8787/storage/link/$VOL_LINK -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID

Unlink and disassociate that volume with the new instance

    curl -v -X DELETE localhost:8787/storage/link/$VOL_LINK -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi'

Delete Storage Volume

    curl -v -X DELETE localhost:8787/storage/$VOL -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi'

Scale Up a VM

Let's bump the current instance from itsy (128 RAM, 1 Core) to a bitsy flavour (256 RAM, 1 Core).

    curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: bitsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"'

_Notes:_

  • This is a partial update with respect to OCCI.

Scale Down a VM

Let's reduce the current instance from bitsy (256 RAM, 1 Core) to a itsy flavour (128 RAM, 1 Core).

    curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"'

_Notes:_

  • This is a partial update with respect to OCCI.

Delete a VM

    curl -v -X DELETE localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID

Update a VM: Change the OS

As an example, let's use SmartOS as the new OS

    curl -v -X POST localhost:8787/compute/$VM -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: SmartOS; scheme="http://schemas.openstack.org/template/os#"; class="mixin"'

_Notes:_

  • this is in effect a partial update.
  • this destroys any data directly related to the VM. It does not destroy connected volumes

Create a Security Group

    curl -v -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"; rel="http://schemas.ogf.org/occi/infrastructure/security#group"; location="/mygroups/"' -X POST localhost:8787/-/
  • Follows the OpenStack model. Groups of rules are associated with a compute resource.
  • A security group is associated with a compute. This is done by the addition or removal of a mixin to/from a compute instance
  • Security rules can be added and removed to a security group (mixin). This is done by (dis)associating the rule with the group (mixin). Rules can be created and deleted.

List Security Groups

    curl -v -H 'X-Auth-Token: '$KID -H 'Content-type: text/occi' -H 'Accept: text/plain' -H 'Category: group; scheme="http://schemas.ogf.org/occi/infrastructure/security#"; class="mixin"' -X GET localhost:8787/-/ 

'Note': this will only return the specified category in the request and not the related categories. This will be fixed in pyssf in the next release.

Create a Security Rule

To do so specify the rule parameters (as a Kind) and the group the rule (as a mixin) is to belong to. This associates the rule with the respective group. Let's add a rule for inbound SSH traffic to a security rule group. This group can then be supplied when provisioning VMs. The group can also be applied an already provisioned VM.

 
    curl -v -X POST localhost:8787/network/security/rule/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"' -H 'Category: rule; scheme="http://schemas.openstack.org/occi/infrastructure/network/security#"; class="kind"' -H 'X-OCCI-Attribute: occi.network.security.protocol = "TCP"' -H 'X-OCCI-Attribute: occi.network.security.to = 22' -H 'X-OCCI-Attribute: occi.network.security.from = 22' -H 'X-OCCI-Attribute: occi.network.security.range = "0.0.0.0/24"'

For ease of this OCCI exercise, place the volume id into a shell variable e.g.

    export RULE=1233323

List the Associated Rules/Compute Resources to a Group

    curl -v -X GET localhost:8787/mygroups/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID

Get Security Rule's Details

    curl -v -H 'X-Auth-Token: '$KID -X GET http://localhost:8787/network/security/rule/$RULE

Delete a Security Rule

    curl -v -H 'X-Auth-Token: '$KID -X DELETE http://localhost:8787/network/security/rule/$RULE

Delete a Security Group

    curl -v -H 'X-Auth-Token: '$KID -H 'Content-Type: text/occi' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"' -X DELETE localhost:8787/-/

Create a Secured VM with a Security Group

    curl -v -X POST localhost:8787/compute/ -H 'Category: compute; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: itsy; scheme="http://schemas.openstack.org/template/resource#"; class="mixin"' -H 'Category: cirros-0.3.0-x86_64-uec; scheme="http://schemas.openstack.org/template/os#"; class="mixin"' -H 'Category: my_grp; scheme="http://www.mystuff.org/sec#"; class="mixin"'

Locate External Network

   curl -v -X GET  localhost:8787/network/ -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID

You should get a list of the networks, you can query each network to check which one is external. Look at the X-OCCI-Attribute: occi.network.label="internal" attribute

   export EXTERNAL_NET_URL="http://localhost:8787/network/fe9df68f-a2a4-4496-a5f9-2ce496d78dd0"

Allocate Floating IP to VM

    curl -v -X POST -H 'X-Auth-token: '$KID localhost:8787/network/interface/ -H 'Category: networkinterface; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"' -H 'x-occi-attribute: occi.core.source="http://localhost:8787/compute/'$VM'"' -H 'x-occi-attribute: occi.core.target="'$EXTERNAL_NET_URL'"' -H 'Content-Type: text/occi'
    export NETWORK_LINK=...

Deallocate Floating IP to VM

    curl -v -X DELETE -H 'X-Auth-token: '$KID localhost:8787/'$NETWORK_LINK

Change VM Administrative (root) Password

Note to use this functionality the `libvirt_inject_password` parameter must be set to `True` in `/etc/nova/nova.conf`

Issue the following action:

curl -v -X POST "localhost:8787/compute/$VM?action=chg_pwd" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID -H 'Category: chg_pwd; scheme="http://schemas.openstack.org/instance/action#"; class="action"' -H 'X-OCCI-Attribute: org.openstack.credentials.admin_pwd="new_pass"'

Create a Image from an Active VM

curl -v -X POST "localhost:8787/compute/$VM?action=create_image" -H 'Content-Type: text/occi' -H 'X-Auth-Token: '$KID  -H 'Category: create_image; scheme=" http://schemas.openstack.org/instance/action#; class="action"' -H 'X-OCCI-Attribute: org.openstack.snapshot.image_name="awesome_ware"'