| commit | f1c55045d4c967185c08f4e73899de882cc10d74 | [log] [tgz] |
|---|---|---|
| author | BroganD1993 <darrenbrogan@hotmail.com> | Thu May 15 19:34:19 2014 +0100 |
| committer | BroganD1993 <darrenbrogan@hotmail.com> | Thu May 15 19:34:19 2014 +0100 |
| tree | cf2905297d9756dad3f313c426d1d815d9d0fabd | |
| parent | e5b5bf21dd171c1eaea655bce735ab5c9e994407 [diff] |
Update project URL
This project aims to provide a new compute API interface for Apache Cloudstack that is compatible with Google Compute Engine GCE. GCE is Google's Infrastructure-as-a-Service (IaaS) compute service that competes with Amazon Web Services EC2. In short, this is a mapping of the GCE API reference and the CloudStack API
The GCE APIs for Cloudstack is supplied as a layer over the current Cloudstack API. The given application will take in a GCE based API request, pass it over to the Cloudstack API, get the required data and return it in a suitable format.
It is written in Python, using Flask to expose a GCE compliant REST API. Requests, Pycrypto, Pyopenssl and Flask-sqlachemy are dependencies. A custom version of pyoauth2 is included in the source.
In this first early release, the following GCE categories are implemented:
Caveat: There exists some semantic differences between the two APIs, for example between the concept of zones and regions, projects and domains. This project does a best effort attempt at creating a usable GCE interface to a CloudStack cloud but it may not fit every CloudStack deployment.
##Installation
#Developers
Clone the repository
git clone https://github.com/NOPping/gstack.git
Install the package
python ./setup.py install
This will install a gstack and a gstack-configure binary in your path.
Before running gstack you must configure it. To do so run
gstack-configure
And enter your configuration information as prompted.
Install gcutil
gstack comes with a self-signed certificate for the local endpoint gstack/data/server.crt, copy the certificate to the gcutil certificates file gcutil/lib/httplib2/httplib2/cacerts.txt
At this stage your CloudStack apikey and secretkey need to be entered in the gcutil auth_helper.py file at gcutil/lib/google_compute_engine/gcutil/auth_helper.py
This is far from ideal and we opened a feature request with google to pass the client_id and client_secret as options to gcutil, hopefully future release of gcutil will allow us to do so.
Start gstack:
gstack
Create a cached parameters file for gcutil:
--auth_local_webserver --auth_host_port=9999 --dump_request_response --authorization_uri_base=https://localhost:5000/oauth2 --ssh_user=root --fetch_discovery --auth_host_name=127.0.0.1 --api_host=https://localhost:5000/
gcutil will issues requests to the local Flask application, get an OAuth token and then issue requests to your CloudStack endpoint
#Users
You can grab the package from Pypi
pip install gstack
Then follow the same instructions as the Developers.
##Usage
You can start issuing standard gcutil commands. For illustration purposes we use Exoscale
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie listzones +--------+-------------+--------+-------------+-------------------------+-----------------+------------+-------------+----------------------+ | name | description | status | deprecation | next-maintenance-window | instances-usage | cpus-usage | disks-usage | disks-total-gb-usage | +--------+-------------+--------+-------------+-------------------------+-----------------+------------+-------------+----------------------+ | CH-GV2 | CH-GV2 | UP | | None scheduled | | | | | +--------+-------------+--------+-------------+-------------------------+-----------------+------------+-------------+----------------------+
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie listmachinetypes Items in zone/CH-GV2: +-------------+--------------------------+--------+------+-----------+----------------------+---------+----------------------+-------------+ | name | description | zone | cpus | memory-mb | scratch-disk-size-gb | max-pds | max-total-pd-size-gb | deprecation | +-------------+--------------------------+--------+------+-----------+----------------------+---------+----------------------+-------------+ | Micro | Micro 512mb 1cpu | CH-GV2 | 1 | 512 | | | | | | Tiny | Tiny 1024mb 1cpu | CH-GV2 | 1 | 1024 | | | | | | Small | Small 2048mb 2cpu | CH-GV2 | 2 | 2048 | | | | | | Medium | Medium 4096mb 2cpu | CH-GV2 | 2 | 4096 | | | | | | Large | Large 8192mb 4cpu | CH-GV2 | 4 | 8182 | | | | | | Extra-large | Extra-large 16384mb 4cpu | CH-GV2 | 4 | 16384 | | | | | | Huge | Huge 32184mb 8cpu | CH-GV2 | 8 | 32184 | | | | | +-------------+--------------------------+--------+------+-----------+----------------------+---------+----------------------+-------------+
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie listimages +---------------------------------+------------------------------------------+--------+-------------+--------+ | name | description | kernel | deprecation | status | +---------------------------------+------------------------------------------+--------+-------------+--------+ | CentOS 5.5(64-bit) no GUI (KVM) | CentOS 5.5(64-bit) no GUI (KVM) | | | Ready | | Linux CentOS 6.4 64-bit | Linux CentOS 6.4 64-bit 10GB Disk | | | Ready | | Linux CentOS 6.4 64-bit | Linux CentOS 6.4 64-bit 50GB Disk | | | Ready | | Linux CentOS 6.4 64-bit | Linux CentOS 6.4 64-bit 100GB Disk | | | Ready | | Linux CentOS 6.4 64-bit | Linux CentOS 6.4 64-bit 200GB Disk | | | Ready | | Linux CentOS 6.4 64-bit | Linux CentOS 6.4 64-bit 400GB Disk | | | Ready | | Linux Ubuntu 12.04 LTS 64-bit | Linux Ubuntu 12.04 LTS 64-bit 10GB Disk | | | Ready | | Linux Ubuntu 12.04 LTS 64-bit | Linux Ubuntu 12.04 LTS 64-bit 50GB Disk | | | Ready | | Linux Ubuntu 12.04 LTS 64-bit | Linux Ubuntu 12.04 LTS 64-bit 100GB Disk | | | Ready | | Linux Ubuntu 12.04 LTS 64-bit | Linux Ubuntu 12.04 LTS 64-bit 200GB Disk | | | Ready | | Linux Ubuntu 12.04 LTS 64-bit | Linux Ubuntu 12.04 LTS 64-bit 400GB Disk | | | Ready | | Linux Ubuntu 13.04 64-bit | Linux Ubuntu 13.04 64-bit 10 GB Disk | | | Ready | | Linux Ubuntu 13.04 64-bit | Linux Ubuntu 13.04 64-bit 50 GB Disk | | | Ready | | Linux Ubuntu 13.04 64-bit | Linux Ubuntu 13.04 64-bit 100 GB Disk | | | Ready | | Linux Ubuntu 13.04 64-bit | Linux Ubuntu 13.04 64-bit 200 GB Disk | | | Ready | | Linux Ubuntu 13.04 64-bit | Linux Ubuntu 13.04 64-bit 400 GB Disk | | | Ready | | Windows Server 2008 R2 SP1 | 50 | | | Ready | | Windows Server 2008 R2 SP1 | Windows Server 2008 R2 SP1 100GB Disk | | | Ready | | Windows Server 2008 R2 SP1 | Windows Server 2008 R2 SP1 200GB Disk | | | Ready | | Windows Server 2008 R2 SP1 | Windows Server 2008 R2 SP1 400GB Disk | | | Ready | | Windows Server 2012 | Windows Server 2012 Disk 50GB | | | Ready | | Windows Server 2012 | Windows Server 2012 Disk 200GB | | | Ready | | Windows Server 2012 | Windows Server 2012 Disk 100GB | | | Ready | | Windows Server 2012 | Windows Server 2012 Disk 400GB | | | Ready | +---------------------------------+------------------------------------------+--------+-------------+--------+
To create a securitygroup, use the firewall commands:
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie addfirewall ssh --allowed=tcp:22
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie getfirewall ssh +---------------+-----------+ | property | value | +---------------+-----------+ | name | ssh | | description | | | creation-time | | | network | | | source-ips | 0.0.0.0/0 | | source-tags | | | target-tags | | | allowed | tcp: 22 | +---------------+-----------+
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie deletefirewall ssh Delete firewall ssh? [y/n] y
To start an instance note that you need to pass your account name as project. Also note that persistent disks are not supported yet.
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie addinstance foobar Selecting the only available zone: CH-GV2 1: Extra-large Extra-large 16384mb 4cpu 2: Huge Huge 32184mb 8cpu 3: Large Large 8192mb 4cpu 4: Medium Medium 4096mb 2cpu 5: Micro Micro 512mb 1cpu 6: Small Small 2048mb 2cpu 7: Tiny Tiny 1024mb 1cpu 5 The boot disk is unspecified. I can create a new persistent boot disk and use it (preferred), or use a scratch disk (not recommended). Do you want to use a persistent boot disk? [y/n] n 1: CentOS 5.5(64-bit) no GUI (KVM) 2: Linux CentOS 6.4 64-bit 3: Linux CentOS 6.4 64-bit 4: Linux CentOS 6.4 64-bit 5: Linux CentOS 6.4 64-bit 6: Linux CentOS 6.4 64-bit 7: Linux Ubuntu 12.04 LTS 64-bit 8: Linux Ubuntu 12.04 LTS 64-bit 9: Linux Ubuntu 12.04 LTS 64-bit 10: Linux Ubuntu 12.04 LTS 64-bit 11: Linux Ubuntu 12.04 LTS 64-bit 12: Linux Ubuntu 13.04 64-bit 13: Linux Ubuntu 13.04 64-bit 14: Linux Ubuntu 13.04 64-bit 15: Linux Ubuntu 13.04 64-bit 16: Linux Ubuntu 13.04 64-bit 17: Windows Server 2008 R2 SP1 18: Windows Server 2008 R2 SP1 19: Windows Server 2008 R2 SP1 20: Windows Server 2008 R2 SP1 21: Windows Server 2012 22: Windows Server 2012 23: Windows Server 2012 24: Windows Server 2012 5 INFO: Waiting for insert of instance . Sleeping for 3s. INFO: Waiting for insert of instance . Sleeping for 3s. INFO: Waiting for insert of instance . Sleeping for 3s. INFO: Waiting for insert of instance . Sleeping for 3s. INFO: Waiting for insert of instance . Sleeping for 3s. Table of resources: +--------+--------------+-------------------------+--------+---------+---------------+---------------+-------+--------+---------+----------------+ | name | machine-type | image | kernel | network | network-ip | external-ip | disks | zone | status | status-message | +--------+--------------+-------------------------+--------+---------+---------------+---------------+-------+--------+---------+----------------+ | foobar | Micro | Linux CentOS 6.4 64-bit | | default | 185.19.28.146 | 185.19.28.146 | | CH-GV2 | RUNNING | | +--------+--------------+-------------------------+--------+---------+---------------+---------------+-------+--------+---------+----------------+ Table of operations: +--------------------------------------+--------+--------+--------+----------------+--------+--------------------------+----------------+-------+---------------+---------+ | name | region | zone | status | status-message | target | insert-time | operation-type | error | error-message | warning | +--------------------------------------+--------+--------+--------+----------------+--------+--------------------------+----------------+-------+---------------+---------+ | 1274e34e-62a8-4655-b3ea-f406f3bdaa67 | | CH-GV2 | DONE | | foobar | 2013-10-13T21:41:27+0200 | insert | | | | +--------------------------------------+--------+--------+--------+----------------+--------+--------------------------+----------------+-------+---------------+---------+
You can of course list and delete instances
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie listinstances Items in zone/CH-GV2: +--------+--------------+-------------------------+--------+---------+---------------+---------------+-------+--------+---------+----------------+ | name | machine-type | image | kernel | network | network-ip | external-ip | disks | zone | status | status-message | +--------+--------------+-------------------------+--------+---------+---------------+---------------+-------+--------+---------+----------------+ | foobar | Micro | Linux CentOS 6.4 64-bit | | default | 185.19.28.146 | 185.19.28.146 | | CH-GV2 | RUNNING | | +--------+--------------+-------------------------+--------+---------+---------------+---------------+-------+--------+---------+----------------+
$ ./gcutil --cached_flags_file=~/.gcutil_params --project=ian@ianduffy.ie deleteinstance foobar Delete instance foobar? [y/n] y WARNING: Consider passing '--zone=CH-GV2' to avoid the unnecessary zone lookup which requires extra API calls. INFO: Waiting for delete of instance . Sleeping for 3s. INFO: Waiting for delete of instance . Sleeping for 3s. INFO: Waiting for delete of instance . Sleeping for 3s. +--------------------------------------+--------+--------+--------+----------------+-------------------------+--------------------------+----------------+-------+---------------+---------+ | name | region | zone | status | status-message | target | insert-time | operation-type | error | error-message | warning | +--------------------------------------+--------+--------+--------+----------------+-------------------------+--------------------------+----------------+-------+---------------+---------+ | 05be1cbb-99be-4656-b74c-87bcafc659ae | | CH-GV2 | DONE | | CH-GV2/instances/foobar | 2013-10-13T21:42:57+0200 | delete | | | | +--------------------------------------+--------+--------+--------+----------------+-------------------------+--------------------------+----------------+-------+---------------+---------+
##Trouble shooting
If you encounter authentication/authorization issues, clean up your gcutil authentication information rm -rf ~/.gcutil_auth, make sure that you set your client_id and client_secret in gcutil/lib/google_compute_engine/gcutil/auth_helper.py
##Apache CloudStack
For more information about CloudStack check the official website
Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. “Apache”, “CloudStack”, “Apache CloudStack”, and the Apache feather logos are registered trademarks or trademarks of The Apache Software Foundation. g