-The addresses collection represents IP addresses and allows IP address management. +The addresses collection represents IP addresses and allows IP address management.

-This collection is currently implemented for the Amazon EC2 cloud driver. For EC2, IP address management corresponds to Amazon's 'Elastic IP' feature. +This collection is currently implemented for Amazon EC2 and Fujitsu GCP drivers. For EC2, IP address management corresponds to Amazon's 'Elastic IP' feature.

- +

Get a list of all addresses

@@ -220,10 +220,10 @@ Date: Wed, 27 Jul 2011 13:29:00 GMT

Associate an adress with an instance

Associate an address with an instance

-To associate a given address with a running instance use call POST /api/addresses/:id/associate. The client must specify the instance_id as a parameter to this call. For Amazon EC2, the specified address will replace the currently assigned public_address of the instance. A succesful operation results in a HTTP 202 Accepted response. The example client request below specifies the required instance_id parameter using the application/x-www-form-urlencoded content-type, however client can also use multipart/form-data. +To associate a given address with a running instance use call POST /api/addresses/:id/associate. The client must specify the instance_id as a parameter to this call. For Amazon EC2, the specified address will replace the currently assigned public_address of the instance, while for the Fujitsu GCP it is added. A succesful operation results in a HTTP 202 Accepted response. The example client request below specifies the required instance_id parameter using the application/x-www-form-urlencoded content-type, however client can also use multipart/form-data.

Example request:

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/content/blob-storage.md ---------------------------------------------------------------------- diff --git a/site/content/blob-storage.md b/site/content/blob-storage.md index 3e24e4b..f515116 100644 --- a/site/content/blob-storage.md +++ b/site/content/blob-storage.md @@ -11,7 +11,7 @@ title: Blob storage

Blob Storage

-Blob storage represents a generic key ==> value data store. It is implemented by Amazon S3 or Rackspace Cloudfiles. In Deltacloud, the organisational unit of blob storage is a bucket. Individual data items - blobs are exposed as a subcollection under each bucket. +Blob storage represents a generic key ==> value data store, as implemented for example by Amazon S3 or Openstack swift. In Deltacloud, the organisational unit of blob storage is a bucket. Individual data items - blobs are exposed as a subcollection under each bucket.

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/content/firewalls.md ---------------------------------------------------------------------- diff --git a/site/content/firewalls.md b/site/content/firewalls.md index a4036c1..535518e 100644 --- a/site/content/firewalls.md +++ b/site/content/firewalls.md @@ -11,7 +11,7 @@ title: Firewalls

Firewalls

-Firewalls represent sets of rules that govern the accessibility of a running instance over the public Internet. At present, only the Amazon EC2 cloud supports this collection (Amazon EC2 'Security Groups'). A firewall has these attributes: +Firewalls represent sets of rules that govern the accessibility of a running instance over the public Internet. At present, only Amazon EC2 cloud (Amazon EC2 'Security Groups') and Fujitsu GCP support this collection. A firewall has these attributes:

@@ -22,11 +22,11 @@ Firewalls represent sets of rules that govern the accessibility of a running ins

-An instance is launched into a firewall by specifying the firewalls1 ... firewallsN parameters in the POST /api/instances operation (see the Create an instance section). +For Amazon EC2, an instance is launched into a firewall by specifying the firewalls1 ... firewallsN parameters in the POST /api/instances operation (see the Create an instance section).

-Each firewall rule has a number of attributes describing the access granted to clients that want to communicate with the instance over the Internet. Each rule cosists of +Each firewall rule has a number of attributes describing the access granted to clients that want to communicate with the instance over the Internet. Each rule consists of

firewall rule

-Each rule also specifies a direction, indicating whether it applies to ingress or egress traffic. +Each rule also specifies a direction, indicating whether it applies to ingress or egress traffic. A rule can also specify a rule_action (accept, deny), to indicate whether the firewall should accept or deny access for this traffic, and log_rule (true, false), to indicate whether an entry should be added to the log. +

@@ -281,11 +282,13 @@ Date: Wed, 27 Jul 2011 09:47:43 GMT

-The rules governing the deletion of a firewall are back-end cloud specific. At present, only the Amazon EC2 cloud supports the firewalls collection, so we describe the firewall deletion rules for EC2 here. +The rules governing the deletion of a firewall are back-end cloud specific. +

+For Fujitsu GCP, as this operation destroys the virtual system with it, all instances in the system, including the firewall need to be in the STOPPED state.

-It is permitted to delete a firewall that has rules defined within it, with two exceptions. You cannot delete a firewall if it is referenced by another firewall; for instance firewall_1 has a rule giving access to firewall_2. An attempt to delete firewall_2 will result in the error InvalidGroup.InUse, as you can see in the example below. The second exception is that you cannot delete a firewall if there are currently any running instances within that firewall (i.e. instances that specified the given firewall when they were launched). The error message in that case would be InvalidGroup.InUse: There are active instances using security group. In both cases the error messages are propagated from the back-end cloud provider to the requesting client. +For Amazon EC2, it is permitted to delete a firewall that has rules defined within it, with two exceptions. You cannot delete a firewall if it is referenced by another firewall; for instance firewall_1 has a rule giving access to firewall_2. An attempt to delete firewall_2 will result in the error InvalidGroup.InUse, as you can see in the example below. The second exception is that you cannot delete a firewall if there are currently any running instances within that firewall (i.e. instances that specified the given firewall when they were launched). The error message in that case would be InvalidGroup.InUse: There are active instances using security group. In both cases the error messages are propagated from the back-end cloud provider to the requesting client.

@@ -324,7 +327,7 @@ Content-Length: 626

Create a firewall rule

-To create a new firewall rule within a specified firewall use call POST /api/firewalls/:id/rules. A client must supply the protocol (one of udp, tcp or icmp), port_from and port_to as parameters. Of course the client must also specify the sources to which the given rule is applied. IP addresses are specified in CIDR format sequentially: ip_address1=192.168.10.10/24, ip_address2=10.1.1.1/16 ... ip_addressN=.... The IP address '0.0.0.0/0' acts as a wildcard to specify any IP address. Source firewalls are also specified sequentially, but the owner_id of the firewall prepared for authorization must also be supplied (this is an Amazon EC2 requirement): group1=name1, group1owner=1234567890, group2=name2, group2owner=0987654321, ... groupN=nameN, groupNowner=... +To create a new firewall rule within a specified firewall use call POST /api/firewalls/:id/rules. This operation of the firewalls collection is not supported by Fujitsu GCP. A client must supply the protocol (one of udp, tcp or icmp), port_from and port_to as parameters. Of course the client must also specify the sources to which the given rule is applied. IP addresses are specified in CIDR format sequentially: ip_address1=192.168.10.10/24, ip_address2=10.1.1.1/16 ... ip_addressN=.... The IP address '0.0.0.0/0' acts as a wildcard to specify any IP address. Source firewalls are also specified sequentially, but the owner_id of the firewall prepared for authorization must also be supplied (this is an Amazon EC2 requirement): group1=name1, group1owner=1234567890, group2=name2, group2owner=0987654321, ... groupN=nameN, groupNowner=...

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/content/images.md ---------------------------------------------------------------------- diff --git a/site/content/images.md b/site/content/images.md index e0f41c1..b66a1f5 100644 --- a/site/content/images.md +++ b/site/content/images.md @@ -177,14 +177,14 @@ Content-Length: 433

Create an image

-To create a new image from an existing running instance use call POST /api/images. This operation is not available to all cloud providers and for some cloud providers this operation is not possible for all instances. For example, in the Amazon EC2 cloud, you can create a custom image from EBS backed instances but not from root-store instances. +To create a new image from an existing running instance use call POST /api/images. This operation is not available to all cloud providers and for some cloud providers this operation is not possible for all instances. For example, in the Amazon EC2 cloud, you can create a custom image from EBS backed instances but not from root-store instances.

× - Note: + Note:

- RHVE-M and vSphere providers allow you to create an image only from a stopped instance, not from a running instance. + RHVE-M, vSphere and Fujitsu GCP providers allow you to create an image only from a stopped instance, not from a running instance.

@@ -248,10 +248,15 @@ Content-Length: 427

× - Note: + Note:

When you create an image from a stopped instance in vSphere cloud, this particular instance is marked as template and it is also removed from Instances.

- +

Unlike other providers, vSphere does not support assigning a name and a description to the image when you create an image from a stopped instance. The image created in vSphere ignores these attributes passed to the API during the creation.

Fujitsu GCP does not return an ID that can be used to track the state of the image + creation. Poll the list of all images until your image appears. This will contain the + proper image id that can be used in other image actions. +

Delete an image

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/content/load-balancers.md ---------------------------------------------------------------------- diff --git a/site/content/load-balancers.md b/site/content/load-balancers.md index 48d27af..fa3147e 100644 --- a/site/content/load-balancers.md +++ b/site/content/load-balancers.md @@ -15,7 +15,7 @@ Load balancers allow distribution of ingress network traffic received by a speci

-This collection is not supported by all back-end cloud providers and at present, it is implemented for the Gogrid and Amazon EC2 cloud drivers. A load balancer is launched into a specific realm. Only instances within this specific realm may be attached to the balancer. Each load balancer has +This collection is not supported by all back-end cloud providers and at present, it is implemented for the Fujitsu GCP, Gogrid and Amazon EC2 cloud drivers. A load balancer is launched into a specific realm. Only instances within this specific realm may be attached to the balancer. Each load balancer has

listener

protocol

- +

Get the details of all load balancers

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/content/rest-api.md ---------------------------------------------------------------------- diff --git a/site/content/rest-api.md b/site/content/rest-api.md index 30a85a6..bc58934 100644 --- a/site/content/rest-api.md +++ b/site/content/rest-api.md @@ -1,4 +1,4 @@ ---- +--- site_name: Deltacloud API title: REST API --- @@ -98,7 +98,7 @@ The following terms describe abstractions used in the Apache Deltacloud API. Eac

Metrics

- Metrics collection provides useful information about your cloud resources, e.g. CPU utilization or network throughput. It may be helpful for developers for better scaling and monitoring. The collection is currently supported only for Amazon EC2 cloud. It collects information from Amazon CloudWatch service. + Metrics collection provides useful information about your cloud resources, e.g. CPU utilization or network throughput. It may be helpful for developers for better scaling and monitoring. The collection is currently supported for Amazon EC2 cloud, collecting information from Amazon CloudWatch service, and Fujitsu GCP.

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/content/storage-resources.md ---------------------------------------------------------------------- diff --git a/site/content/storage-resources.md b/site/content/storage-resources.md index 796a9a5..3c8d574 100644 --- a/site/content/storage-resources.md +++ b/site/content/storage-resources.md @@ -180,9 +180,18 @@ Content-Length: 794

Create a new storage volume

-To create a new storage volume use call POST /api/storage_volumes. A client may specify a snapshot_id from which the storage volume is instantiated though this is optional. The capacity parameter, expressed in Gigabytes, is also optional and its default size is 1 GB. Finally clients may also specify the realm_id, as a storage volume can typically only be attached to instances running within the specified realm. If the realm is not specified it will set it at the first realm returned by the cloud provider. A succesful operation will return HTTP 201 Created with the details of the new storage volume. +To create a new storage volume use call POST /api/storage_volumes. A client may specify a snapshot_id from which the storage volume is instantiated though this is optional. The capacity parameter, expressed in Gigabytes, is also optional and its default size is 1 GB. Finally clients may also specify the realm_id, as a storage volume can typically only be attached to instances running within the specified realm. If the realm is not specified it will set it at the first realm returned by the cloud provider. A successful operation will return HTTP 201 Created with the details of the new storage volume.

+ × + Note: +

+ Fujitsu GCP requires the size to be a multiple of 10, so the specified capacity is rounded + up to the nearest multiple of ten, making the default size 10 GB. +

As with the other POST operations in the Deltacloud API, clients may choose to specify operation parameters as multipart/form-data or as application/x-www-form-urlencoded data.

@@ -225,12 +234,12 @@ Content-Length: 649

Delete a storage volume

-To delete the specified storage volume use call DELETE /api/storage_volumes/:id. The operation will return a HTTP 204 No Content after a succesful operation. +To delete the specified storage volume use call DELETE /api/storage_volumes/:id. The operation will return a HTTP 204 No Content after a succesful operation.

× - Note: + Note:

The operation will fail if the given storage_volume is currently attached to an instance.

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/output/addresses.html ---------------------------------------------------------------------- diff --git a/site/output/addresses.html b/site/output/addresses.html index b18d2f2..fe7ccda 100644 --- a/site/output/addresses.html +++ b/site/output/addresses.html @@ -95,11 +95,11 @@

Addresses

-The addresses collection represents IP addresses and allows IP address management. +The addresses collection represents IP addresses and allows IP address management.

@@ -147,7 +147,7 @@ The addresses collection supports these operations:

- +

Get a list of all addresses

@@ -295,10 +295,10 @@ Date: Wed, 27 Jul 2011 13:29:00 GMT

Associate an adress with an instance

Associate an address with an instance

Example request:

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/output/blob-storage.html ---------------------------------------------------------------------- diff --git a/site/output/blob-storage.html b/site/output/blob-storage.html index df409cc..a6995b2 100644 --- a/site/output/blob-storage.html +++ b/site/output/blob-storage.html @@ -95,7 +95,7 @@

Blob Storage

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/output/firewalls.html ---------------------------------------------------------------------- diff --git a/site/output/firewalls.html b/site/output/firewalls.html index 7b398f4..3b5faf1 100644 --- a/site/output/firewalls.html +++ b/site/output/firewalls.html @@ -95,7 +95,7 @@

Firewalls

@@ -109,11 +109,11 @@ Firewalls represent sets of rules that govern the accessibility of a running ins

firewall rule

@@ -362,11 +363,13 @@ Date: Wed, 27 Jul 2011 09:47:43 GMT

+For Fujitsu GCP, as this operation destroys the virtual system with it, all instances in the system, including the firewall need to be in the STOPPED state.

@@ -405,7 +408,7 @@ Content-Length: 626

Create a firewall rule

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/output/images.html ---------------------------------------------------------------------- diff --git a/site/output/images.html b/site/output/images.html index 7301c8e..144bb97 100644 --- a/site/output/images.html +++ b/site/output/images.html @@ -260,14 +260,14 @@ Content-Length: 433

Create an image

× - Note: + Note:

@@ -331,10 +331,15 @@ Content-Length: 427

× - Note: + Note:

When you create an image from a stopped instance in vSphere cloud, this particular instance is marked as template and it is also removed from Instances.

- +

Delete an image

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/output/load-balancers.html ---------------------------------------------------------------------- diff --git a/site/output/load-balancers.html b/site/output/load-balancers.html index 57d9bcf..34ccbb6 100644 --- a/site/output/load-balancers.html +++ b/site/output/load-balancers.html @@ -99,7 +99,7 @@ Load balancers allow distribution of ingress network traffic received by a speci

listener

protocol

- +

Get the details of all load balancers

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/output/rest-api.html ---------------------------------------------------------------------- diff --git a/site/output/rest-api.html b/site/output/rest-api.html index 40f9cc6..6528d52 100644 --- a/site/output/rest-api.html +++ b/site/output/rest-api.html @@ -182,7 +182,7 @@ The following terms describe abstractions used in the Apache Deltacloud API. Eac

Metrics

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/8116e6a3/site/output/storage-resources.html ---------------------------------------------------------------------- diff --git a/site/output/storage-resources.html b/site/output/storage-resources.html index 81f1bcf..20a6b21 100644 --- a/site/output/storage-resources.html +++ b/site/output/storage-resources.html @@ -258,9 +258,18 @@ Content-Length: 794

Create a new storage volume

+ × + Note: +

+ Fujitsu GCP requires the size to be a multiple of 10, so the specified capacity is rounded + up to the nearest multiple of ten, making the default size 10 GB. +

As with the other POST operations in the Deltacloud API, clients may choose to specify operation parameters as multipart/form-data or as application/x-www-form-urlencoded data.

@@ -303,12 +312,12 @@ Content-Length: 649

Delete a storage volume

× - Note: + Note:

The operation will fail if the given storage_volume is currently attached to an instance.