Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add alpha support for Google Compute Engine #970

Merged
merged 61 commits into from
Apr 29, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
90894b3
Add gcloud-java-compute module
mziccard Feb 22, 2016
a566ef4
Add Compute Engine immutable resources
mziccard Feb 22, 2016
c9f028e
Add DeprecationStatus to disk and machine type, other fixes
mziccard Feb 22, 2016
35fc77d
Migrate IDs from Long to BigInteger
mziccard Feb 23, 2016
d34490f
Add deprecation status to zone and region
mziccard Feb 24, 2016
785c3fe
Add test for missing fields, fix NPE, minor docs and lint fixes
mziccard Feb 24, 2016
feec3f1
Add matchesUrl method to identity objects. Add tests
mziccard Feb 24, 2016
9bd877a
Refactor Compute immutable resources' identities and classes
mziccard Feb 29, 2016
bf2a408
Remove tab indentation from compute's pom.xml
mziccard Feb 29, 2016
41f7ab7
Replace com.google.api.client.util.DateTime with Joda formatter
mziccard Mar 1, 2016
7fc133e
Add service methods for immutable Compute resources
mziccard Mar 1, 2016
566c581
Add RemoteComputeHelper and integration tests
mziccard Mar 1, 2016
c9add80
Refactor compute service
mziccard Mar 4, 2016
e1712e9
Add support for Compute's operations
mziccard Mar 8, 2016
091d7a8
Fix Compute operations issues
mziccard Mar 10, 2016
29f2bad
Rename maxResults to pageSize, add tests for pagination
mziccard Mar 13, 2016
8fad79d
Refactor compute operations
mziccard Mar 15, 2016
ba4fcf0
Remove final from immutable resource classes
mziccard Mar 15, 2016
de30a25
Operations: better javadoc for delete, stricter parsing of identities
mziccard Mar 16, 2016
3565376
Add support for Compute's addresses
mziccard Mar 16, 2016
f3c30f1
Provide better javadoc to address related classes
mziccard Mar 17, 2016
2d691aa
Refactor identity classes
mziccard Mar 21, 2016
6e1a3f9
Refactor Address and AddressInfo classes
mziccard Mar 21, 2016
e56cb4b
Remove unused imports
mziccard Mar 21, 2016
6f9ff34
Refactor Compute service class
mziccard Mar 21, 2016
514e3fe
Better javadoc for RemoteComputeHelper.baseResourceName
mziccard Mar 21, 2016
9cf9309
Make AddressInfo.builder return Builder instead of BuilderImpl
mziccard Mar 21, 2016
1d5f171
Use TO_PB_FUNCTION when possible in ComputeImplTest
mziccard Mar 22, 2016
44fedd6
Remove repeated casts in identities'equals method
mziccard Mar 22, 2016
f36d92c
Replace 'an unique' with 'the unique' everywhere
mziccard Mar 22, 2016
4c8f888
Add SnapshotInfo, related classes and tests
mziccard Mar 22, 2016
65fdd48
Add SnapshotInfo and related classes to SerializationTest, minor fixes
mziccard Mar 23, 2016
36ddd14
Add functional methods for snapshots and Snapshot class
mziccard Mar 23, 2016
f66ea60
Fix minor issues with functional snapshot methods and tests
mziccard Mar 24, 2016
de2a6b4
Add missing final, fix codacy issues
mziccard Mar 25, 2016
2d8d0ec
Better javadoc for aggregated list methods
mziccard Mar 25, 2016
5d2c682
Add ImageInfo and related non-functional classes
mziccard Mar 31, 2016
cd08330
Add functional methods for images and Image class
mziccard Apr 2, 2016
e7866b2
Add DiskInfo, disk configurations and test classes
mziccard Apr 7, 2016
f085a41
Add functional methods for disks and Disk class (#870)
mziccard Apr 11, 2016
5bb3e9d
Move Compute's spi package to compute.spi (#901)
mziccard Apr 12, 2016
382ab77
Add RemoteComputeHelperTest (#900)
mziccard Apr 12, 2016
6e2c262
Compute Operation: remove creationTimestamp field and fix isDone() (#…
mziccard Apr 13, 2016
a4f9f2d
Fix compute homepage URL (#927)
mziccard Apr 15, 2016
282f1fc
Add SubnetworkInfo, NetworkId, SubnetworkId and test classes (#895)
mziccard Apr 19, 2016
e15ed45
Add NetworkInfo, configuration classes and tests (#941)
mziccard Apr 19, 2016
ec9c0f1
Add functional methods for networks and subnetworks (#944)
mziccard Apr 20, 2016
19227df
Chain cause in ComputeException.translateAndThrow, add tests (#948)
mziccard Apr 20, 2016
4fb78d8
Add NetworkInterface, AccessConfig classes and related tests (#947)
mziccard Apr 22, 2016
428fdbd
Add AttachedDisk class, related configurations and tests (#917)
mziccard Apr 25, 2016
20032e7
Add InstanceInfo, related classes and tests (#955)
mziccard Apr 26, 2016
cdf660c
Rename type name getters (#957)
mziccard Apr 26, 2016
9d1d455
Add functional methods for instances, Instance class and tests (#959)
mziccard Apr 27, 2016
b8989f3
Add travis_wait directive before verify script (#965)
mziccard Apr 27, 2016
4888e12
Rename id to generatedId for Compute resources (#966)
mziccard Apr 27, 2016
77821f5
Compute: rename get/delete methods to getXxx/deleteXxx (#968)
mziccard Apr 28, 2016
d77974a
Add Compute examples and snippets. Add them to READMEs. (#967)
mziccard Apr 29, 2016
dd0b186
Rename package com.google.gcloud to com.google.cloud
mziccard Apr 29, 2016
17c6eba
Use BaseSerializationTest in compute's serialization test
mziccard Apr 29, 2016
ae0a6d2
Use FieldSelector interface and Helper in compute
mziccard Apr 29, 2016
f0ae430
Update Compute equals methods to support mocking
mziccard Apr 29, 2016
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ before_install:
- cp target/travis/settings.xml ~/.m2/settings.xml
install: mvn install -DskipTests=true -Dgpg.skip=true
script:
- utilities/verify.sh
- travis_wait 30 utilities/verify.sh
after_success:
- utilities/after_success.sh
env:
Expand Down
79 changes: 79 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Java idiomatic client for [Google Cloud Platform][cloud-platform] services.
This client supports the following Google Cloud Platform services:

- [Google Cloud BigQuery] (#google-cloud-bigquery-alpha) (Alpha)
- [Google Cloud Compute] (#google-cloud-compute-alpha) (Alpha)
- [Google Cloud Datastore] (#google-cloud-datastore)
- [Google Cloud DNS] (#google-cloud-dns-alpha) (Alpha)
- [Google Cloud Resource Manager] (#google-cloud-resource-manager-alpha) (Alpha)
Expand Down Expand Up @@ -50,6 +51,8 @@ Example Applications

- [`BigQueryExample`](./gcloud-java-examples/src/main/java/com/google/cloud/examples/bigquery/BigQueryExample.java) - A simple command line interface providing some of Cloud BigQuery's functionality
- Read more about using this application on the [`BigQueryExample` docs page](http://googlecloudplatform.github.io/gcloud-java/apidocs/?com/google/cloud/examples/bigquery/BigQueryExample.html).
- [`ComputeExample`](./gcloud-java-examples/src/main/java/com/google/cloud/examples/compute/ComputeExample.java) - A simple command line interface providing some of Cloud Compute's functionality
- Read more about using this application on the [`gcloud-java-examples` docs page](http://googlecloudplatform.github.io/gcloud-java/apidocs/?com/google/cloud/examples/compute/ComputeExample.html).
- [`Bookshelf`](https://github.com/GoogleCloudPlatform/getting-started-java/tree/master/bookshelf) - An App Engine app that manages a virtual bookshelf.
- This app uses `gcloud-java` to interface with Cloud Datastore and Cloud Storage. It also uses Cloud SQL, another Google Cloud Platform service.
- [`DatastoreExample`](./gcloud-java-examples/src/main/java/com/google/cloud/examples/datastore/DatastoreExample.java) - A simple command line interface for Cloud Datastore
Expand Down Expand Up @@ -173,6 +176,78 @@ if (loadJob.status().error() != null) {
}
```

Google Cloud Compute (Alpha)
----------------------

- [API Documentation][compute-api]
- [Official Documentation][cloud-compute-docs]

#### Preview

Here are two code snippets showing simple usage examples from within Compute/App Engine. Note that
you must [supply credentials](#authentication) and a project ID if running this snippet elsewhere.

The first snippet shows how to create a snapshot from an existing disk. Complete source code can be
found at
[CreateSnapshot.java](./gcloud-java-examples/src/main/java/com/google/cloud/examples/compute/snippets/CreateSnapshot.java).

```java
import com.google.cloud.compute.Compute;
import com.google.cloud.compute.ComputeOptions;
import com.google.cloud.compute.Disk;
import com.google.cloud.compute.DiskId;
import com.google.cloud.compute.Operation;
import com.google.cloud.compute.Snapshot;

Compute compute = ComputeOptions.defaultInstance().service();
DiskId diskId = DiskId.of("us-central1-a", "disk-name");
Disk disk = compute.getDisk(diskId, Compute.DiskOption.fields());
if (disk != null) {
String snapshotName = "disk-name-snapshot";
Operation operation = disk.createSnapshot(snapshotName);
while (!operation.isDone()) {
Thread.sleep(1000L);
}
if (operation.errors() == null) {
// use snapshot
Snapshot snapshot = compute.getSnapshot("disk-name-snapshot");
}
}
```
The second snippet shows how to create a virtual machine instance. Complete source code can be found
at
[CreateInstance.java](./gcloud-java-examples/src/main/java/com/google/cloud/examples/compute/snippets/CreateInstance.java).
```java
import com.google.cloud.compute.AttachedDisk;
import com.google.cloud.compute.Compute;
import com.google.cloud.compute.ComputeOptions;
import com.google.cloud.compute.ImageId;
import com.google.cloud.compute.Instance;
import com.google.cloud.compute.InstanceId;
import com.google.cloud.compute.InstanceInfo;
import com.google.cloud.compute.MachineTypeId;
import com.google.cloud.compute.NetworkId;
import com.google.cloud.compute.NetworkInterface;
import com.google.cloud.compute.Operation;

Compute compute = ComputeOptions.defaultInstance().service();
ImageId imageId = ImageId.of("debian-cloud", "debian-8-jessie-v20160329");
NetworkId networkId = NetworkId.of("default");
AttachedDisk attachedDisk = AttachedDisk.of(AttachedDisk.CreateDiskConfiguration.of(imageId));
NetworkInterface networkInterface = NetworkInterface.of(networkId);
InstanceId instanceId = InstanceId.of("us-central1-a", "instance-name");
MachineTypeId machineTypeId = MachineTypeId.of("us-central1-a", "n1-standard-1");
Operation operation =
compute.create(InstanceInfo.of(instanceId, machineTypeId, attachedDisk, networkInterface));
while (!operation.isDone()) {
Thread.sleep(1000L);
}
if (operation.errors() == null) {
// use instance
Instance instance = compute.getInstance(instanceId);
}
```

Google Cloud Datastore
----------------------

Expand Down Expand Up @@ -455,3 +530,7 @@ Apache 2.0 - See [LICENSE] for more information.
[cloud-bigquery]: https://cloud.google.com/bigquery/
[cloud-bigquery-docs]: https://cloud.google.com/bigquery/docs/overview
[bigquery-api]: http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/cloud/bigquery/package-summary.html

[cloud-compute]: https://cloud.google.com/compute/
[cloud-compute-docs]: https://cloud.google.com/compute/docs/overview
[compute-api]: http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/cloud/compute/package-summary.html
267 changes: 267 additions & 0 deletions gcloud-java-compute/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,267 @@
Google Cloud Java Client for Compute (Alpha)
====================================

Java idiomatic client for [Google Cloud Compute](https://cloud.google.com/compute).

[![Build Status](https://travis-ci.org/GoogleCloudPlatform/gcloud-java.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/gcloud-java)
[![Coverage Status](https://coveralls.io/repos/GoogleCloudPlatform/gcloud-java/badge.svg?branch=master)](https://coveralls.io/r/GoogleCloudPlatform/gcloud-java?branch=master)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/gcloud-java-compute.svg)]( https://img.shields.io/maven-central/v/com.google.cloud/gcloud-java-compute.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/gcloud-java)
[![Dependency Status](https://www.versioneye.com/user/projects/56bd8ee72a29ed002d2b0969/badge.svg?style=flat)](https://www.versioneye.com/user/projects/56bd8ee72a29ed002d2b0969)

- [Homepage](https://googlecloudplatform.github.io/gcloud-java/)
- [API Documentation](http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/cloud/compute/package-summary.html)

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.

Quickstart
----------
If you are using Maven, add this to your pom.xml file
```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>gcloud-java-compute</artifactId>
<version>0.2.0</version>
</dependency>
```
If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:gcloud-java-compute:0.2.0'
```
If you are using SBT, add this to your dependencies
```Scala
libraryDependencies += "com.google.cloud" % "gcloud-java-compute" % "0.2.0"
```

Example Application
-------------------

[`ComputeExample`](../gcloud-java-examples/src/main/java/com/google/cloud/examples/compute/ComputeExample.java)
is a simple command line interface that provides some of Google Cloud Compute Engine's
functionality. Read more about using the application on the
[`ComputeExample` docs page](http://googlecloudplatform.github.io/gcloud-java/apidocs/?com/google/cloud/examples/compute/ComputeExample.html).

Authentication
--------------

See the [Authentication](https://github.com/GoogleCloudPlatform/gcloud-java#authentication) section in the base directory's README.

About Google Cloud Compute
--------------------------

[Google Cloud Compute][cloud-compute] delivers virtual machines running in Google's innovative data
centers and worldwide fiber network. Compute Engine's tooling and workflow support enable scaling
from single instances to global, load-balanced cloud computing. Compute Engine's VMs boot quickly,
come with persistent disk storage, deliver consistent performance and are available in many
configurations.

Be sure to activate the Google Cloud Compute API on the Developer's Console to use Compute from
your project.

See the ``gcloud-java`` API [compute documentation][compute-api] to learn how to interact
with Google Cloud Compute using this Client Library.

Getting Started
---------------

#### Prerequisites
For this tutorial, you will need a [Google Developers Console](https://console.developers.google.com/)
project with the Compute Engine API enabled. You will need to [enable billing](https://support.google.com/cloud/answer/6158867?hl=en)
to use Google Cloud DNS. [Follow these instructions](https://cloud.google.com/docs/authentication#preparation)
to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands
in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

#### Installation and setup
You'll need to obtain the `gcloud-java-compute` library. See the [Quickstart](#quickstart) section
to add `gcloud-java-compute` as a dependency in your code.

#### Creating an authorized service object
To make authenticated requests to Google Cloud Compute Engine, you must create a service object with
credentials. You can then make API calls by calling methods on the Compute service object. The
simplest way to authenticate is to use [Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials).
These credentials are automatically inferred from your environment, so you only need the following
code to create your service object:

```java
import com.google.cloud.compute.Compute;
import com.google.cloud.compute.ComputeOptions;

Compute compute = ComputeOptions.defaultInstance().service();
```

For other authentication options, see the [Authentication](https://github.com/GoogleCloudPlatform/gcloud-java#authentication)
page.

#### Creating a region IP address
An external region IP address can be associated to a Google Compute Engine instance to communicate
with instances in different regions or to communicate with the instance from ouside of Compute
Engine. In this code snippet, we will create a new external region address.

Add the following imports at the top of your file:

```java
import com.google.cloud.compute.AddressInfo;
import com.google.cloud.compute.Operation;
import com.google.cloud.compute.RegionAddressId;
```

Then add the following code to create an address. Most Compute Engine calls return an `Operation`
object that can be used to wait for operation completion and to check whether operation failed or
succeeded:

```java
RegionAddressId addressId = RegionAddressId.of("us-central1", "test-address");
Operation operation = compute.create(AddressInfo.of(addressId));
while (!operation.isDone()) {
Thread.sleep(1000L);
}
operation = operation.reload();
if (operation.errors() == null) {
System.out.println("Address " + addressId + " was successfully created");
} else {
// inspect operation.errors()
throw new RuntimeException("Address creation failed");
}
```

#### Creating a persistent disk
A persistent disk can be used as primary storage for your virtual machine instances. Persistent
disks can be created empty, from a disk image or from a disk snapshot. Compute Engine offers
[publicly-available images](https://cloud.google.com/compute/docs/operating-systems/) of certain
operating systems that you can use. In this code snippet, we will create a new persistent disk from
a publicly-available image.

Add the following imports at the top of your file:

```java
import com.google.cloud.compute.DiskInfo;
import com.google.cloud.compute.DiskId;
import com.google.cloud.compute.ImageDiskConfiguration;
import com.google.cloud.compute.ImageId;
```

Then add the following code to create a disk and wait for disk creation to terminate.

```java
ImageId imageId = ImageId.of("debian-cloud", "debian-8-jessie-v20160329");
DiskId diskId = DiskId.of("us-central1-a", "test-disk");
ImageDiskConfiguration diskConfiguration = ImageDiskConfiguration.of(imageId);
DiskInfo disk = DiskInfo.of(diskId, diskConfiguration);
Operation operation = compute.create(disk);
while (!operation.isDone()) {
Thread.sleep(1000L);
}
operation = operation.reload();
if (operation.errors() == null) {
System.out.println("Disk " + diskId + " was successfully created");
} else {
// inspect operation.errors()
throw new RuntimeException("Disk creation failed");
}
```

#### Creating a virtual machine instance
An Google Compute Engine instance is a virtual machine (VM) hosted on Google's infrastructure. An
instance can be created given it's identity, a machine type, one boot disk and a network interface.
In this code snippet, we will create a virtual machine instance in the default network using as a
boot disk the disk we have just created and assigning to it the just created IP address.

Add the following imports at the top of your file:

```java
import com.google.cloud.compute.AttachedDisk;
import com.google.cloud.compute.AttachedDisk.PersistentDiskConfiguration;
import com.google.cloud.compute.InstanceId;
import com.google.cloud.compute.InstanceInfo;
import com.google.cloud.compute.MachineTypeId;
import com.google.cloud.compute.NetworkConfiguration;
import com.google.cloud.compute.NetworkConfiguration.AccessConfig;
import com.google.cloud.compute.NetworkId;
import com.google.cloud.compute.NetworkInterface;
```

Then add the following code to create an instance and wait for instance creation to terminate.

```java
Address externalIp = compute.getAddress(addressId);
InstanceId instanceId = InstanceId.of("us-central1-a", "test-instance");
NetworkId networkId = NetworkId.of("default");
PersistentDiskConfiguration attachConfiguration =
PersistentDiskConfiguration.builder(diskId).boot(true).build();
AttachedDisk attachedDisk = AttachedDisk.of("dev0", attachConfiguration);
NetworkInterface networkInterface = NetworkInterface.builder(networkId)
.accessConfigurations(AccessConfig.of(externalIp.address()))
.build();
MachineTypeId machineTypeId = MachineTypeId.of("us-central1-a", "n1-standard-1");
InstanceInfo instance =
InstanceInfo.of(instanceId, machineTypeId, attachedDisk, networkInterface);
Operation operation = compute.create(instance);
while (!operation.isDone()) {
Thread.sleep(1000L);
}
operation = operation.reload();
if (operation.errors() == null) {
System.out.println("Instance " + instanceId + " was successfully created");
} else {
// inspect operation.errors()
throw new RuntimeException("Instance creation failed");
}
```

#### Complete source code

In
[CreateAddressDiskAndInstance.java](../gcloud-java-examples/src/main/java/com/google/cloud/examples/compute/snippets/CreateAddressDiskAndInstance.java)
we put together all the code shown above into one program. The program assumes that you are
running on Compute Engine or from your own desktop. To run the example on App Engine, simply move
the code from the main method to your application's servlet class and change the print statements to
display on your webpage.

Troubleshooting
---------------

To get help, follow the `gcloud-java` links in the `gcloud-*`[shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).

Java Versions
-------------

Java 7 or above is required for using this client.

Testing
-------

This library has tools to help make tests for code using Cloud Compute.

See [TESTING] to read more about testing.

Versioning
----------

This library follows [Semantic Versioning](http://semver.org/).

It is currently in major version zero (``0.y.z``), which means that anything
may change at any time and the public API should not be considered
stable.

Contributing
------------

Contributions to this library are always welcome and highly encouraged.

See [CONTRIBUTING] for more information on how to get started.

License
-------

Apache 2.0 - See [LICENSE] for more information.


[CONTRIBUTING]:https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/CONTRIBUTING.md
[LICENSE]: https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/LICENSE
[TESTING]: https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/TESTING.md#testing-code-that-uses-compute
[cloud-platform]: https://cloud.google.com/

[cloud-compute]: https://cloud.google.com/compute/
[compute-api]: http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/cloud/compute/package-summary.html
Loading