feat: add Cloud Compute instance samples (GoogleCloudPlatform#1309)

Author: bshaffer

compute/helloworld/README.md renamed to compute/README.md

@@ -1,4 +1,4 @@
-# Google Compute Engine PHP Sample Application
+# Google Compute Engine PHP Samples
 
 ## Description
 This is a simple web-based example of calling the Google Compute Engine API

compute/helloworld/api-client/README.md renamed to compute/api-client/helloworld/README.md

@@ -1,5 +1,8 @@
 # Google Compute Engine PHP Sample Application
 
+**NOTE: This sample is outdated. It is recommended you use the [ALPHA Compute
+Client](../../cloud-client/helloworld) instead**
+
 ## Description
 This is a simple web-based example of calling the Google Compute Engine API
 in PHP.

compute/helloworld/api-client/app.php renamed to compute/api-client/helloworld/app.php

@@ -0,0 +1,110 @@
+Google Cloud Compute PHP Instances Samples
+==========================================
+
+[![Open in Cloud Shell][shell_img]][shell_link]
+
+[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
+[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=compute/cloud-client/instances
+
+This directory contains samples for calling [Google Cloud Compute][compute]
+from PHP. Specifically, they show how to manage your Compute Engine [instances][instances].
+
+[compute]: https://cloud.google.com/compute/docs/apis
+[instances]: https://cloud.google.com/compute/docs/instances/stop-start-instance
+
+## Setup
+
+### Authentication
+
+Authentication is typically done through [Application Default Credentials][adc]
+which means you do not have to change the code to authenticate as long as
+your environment has credentials. You have a few options for setting up
+authentication:
+
+1. When running locally, use the [Google Cloud SDK][google-cloud-sdk]
+
+        gcloud auth application-default login
+
+1. When running on App Engine or Compute Engine, credentials are already
+   set-up. However, you may need to configure your Compute Engine instance
+   with [additional scopes][additional_scopes].
+
+1. You can create a [Service Account key file][service_account_key_file]. This file can be used to
+   authenticate to Google Cloud Platform services from any environment. To use
+   the file, set the ``GOOGLE_APPLICATION_CREDENTIALS`` environment variable to
+   the path to the key file, for example:
+
+        export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json
+
+[adc]: https://cloud.google.com/docs/authentication#getting_credentials_for_server-centric_flow
+[additional_scopes]: https://cloud.google.com/compute/docs/authentication#using
+[service_account_key_file]: https://developers.google.com/identity/protocols/OAuth2ServiceAccount#creatinganaccount
+
+## Install Dependencies
+
+1. **Install dependencies** via [Composer](http://getcomposer.org/doc/00-intro.md).
+    Run `php composer.phar install` (if composer is installed locally) or `composer install`
+    (if composer is installed globally).
+
+1. Create a service account at the
+[Service account section in the Cloud Console](https://console.cloud.google.com/iam-admin/serviceaccounts/)
+
+1. Download the json key file of the service account.
+
+1. Set `GOOGLE_APPLICATION_CREDENTIALS` environment variable pointing to that file.
+
+## Samples
+
+To run the Compute Samples, run any of the files in `src/` on the CLI to print
+the usage instructions:
+
+```
+$ php src/list_instances.php
+
+Usage: list_instances.php $projectId $zone
+
+  @param string $projectId Your Google Cloud project ID.
+  @param string $zone The zone to create the instance in (e.g. "us-central1-a")
+```
+
+### Create an instance
+
+```
+$ php src/create_instance.php $YOUR_PROJECT_ID "us-central1-a" "my-new-instance-name"
+Created instance my-new-instance-name
+```
+
+### List instances
+
+```
+$ php src/list_instances.php $YOUR_PROJECT_ID "us-central1-a"
+Instances for YOUR_PROJECT_ID (us-central1-a)
+ - my-new-instance-name
+```
+
+### Delete an instance
+
+```
+$ php src/delete_instance.php $YOUR_PROJECT_ID "us-central1-a" "my-new-instance-name"
+Deleted instance my-new-instance-name
+```
+
+## Troubleshooting
+
+If you get the following error, set the environment variable `GCLOUD_PROJECT` to your project ID:
+
+```
+[Google\Cloud\Core\Exception\GoogleException]
+No project ID was provided, and we were unable to detect a default project ID.
+```
+
+## The client library
+
+This sample uses the [Google Cloud Compute Client Library for PHP][google-cloud-php].
+You can read the documentation for more details on API usage and use GitHub
+to [browse the source][google-cloud-php-source] and [report issues][google-cloud-php-issues].
+
+[google-cloud-php]: https://googleapis.github.io/google-cloud-php/#/docs/google-cloud/v0.152.0/compute/readme
+[google-cloud-php-source]: https://github.com/GoogleCloudPlatform/google-cloud-php
+[google-cloud-php-issues]: https://github.com/GoogleCloudPlatform/google-cloud-php/issues
+[google-cloud-sdk]: https://cloud.google.com/sdk/

compute/helloworld/api-client/composer.json renamed to compute/api-client/helloworld/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "google/cloud-compute": "^0.1.0"
+    }
+}

compute/helloworld/cloud-client/README.md renamed to compute/cloud-client/helloworld/README.md

@@ -0,0 +1,34 @@
+xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="../../../testing/bootstrap.php">
+    <testsuites>
+        <testsuite name="Google Compute Cloud Client Instances Tests">
+            <directory>testdirectory>
+        testsuite>
+    testsuites>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    logging>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">srcdirectory>
+            <exclude>
+              <directory>./vendordirectory>
+            exclude>
+        whitelist>
+    filter>
+phpunit>

compute/helloworld/cloud-client/app.php renamed to compute/cloud-client/helloworld/app.php

@@ -0,0 +1,85 @@
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/compute/cloud-client/README.md
+ */
+
+namespace Google\Cloud\Samples\Compute;
+
+use Google\Cloud\Compute\V1\InstancesClient;
+use Google\Cloud\Compute\V1\AttachedDisk;
+use Google\Cloud\Compute\V1\AttachedDiskInitializeParams;
+use Google\Cloud\Compute\V1\Instance;
+use Google\Cloud\Compute\V1\NetworkInterface;
+
+/**
+ * Creates an instance.
+ * Example:
+ * ```
+ * create_instance($projectId, $zone, $instanceName);
+ * ```
+ *
+ * @param string $projectId Your Google Cloud project ID.
+ * @param string $zone The zone to create the instance in (e.g. "us-central1-a")
+ * @param string $instanceName The unique name for this Compute instance.
+ * @param string $machineType Instance machine type
+ * @param string $sourceImage Boot disk image name or family
+ * @param string $networkName The Compute instance ID.
+ */
+function create_instance(
+    string $projectId,
+    string $zone,
+    string $instanceName,
+    string $machineType = 'n1-standard-1',
+    string $sourceImage = 'projects/debian-cloud/global/images/family/debian-10',
+    string $networkName = 'global/networks/default'
+) {
+    // Set the machine type using the specified zone
+    $machineTypeFullName = sprintf('zones/%s/machineTypes/%s', $zone, $machineType);
+
+    // Set the boot disk
+    $diskInitializeParams = (new AttachedDiskInitializeParams())
+        ->setSourceImage($sourceImage);
+    $disk = (new AttachedDisk())
+        ->setBoot(true)
+        ->setInitializeParams($diskInitializeParams);
+
+    // Set the network
+    $network = (new NetworkInterface())
+        ->setName($networkName);
+
+    // Create the Instance message
+    $instance = (new Instance())
+        ->setName($instanceName)
+        ->setDisks([$disk])
+        ->setMachineType($machineTypeFullName)
+        ->setNetworkInterfaces([$network]);
+
+    // Insert the new Compute Engine instance using the InstancesClient
+    $instancesClient = new InstancesClient();
+    $operation = $instancesClient->insert($instance, $projectId, $zone);
+
+    /** TODO: wait until operation completes */
+
+    printf('Created instance %s' . PHP_EOL, $instanceName);
+}
+
+require_once __DIR__ . '/../../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

compute/helloworld/cloud-client/composer.json renamed to compute/cloud-client/helloworld/composer.json

@@ -0,0 +1,54 @@
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/compute/cloud-client/README.md
+ */
+
+namespace Google\Cloud\Samples\Compute;
+
+use Google\Cloud\Compute\V1\InstancesClient;
+
+/**
+ * Creates an instance.
+ * Example:
+ * ```
+ * delete_instance($projectId, $zone, $instanceName);
+ * ```
+ *
+ * @param string $projectId Your Google Cloud project ID.
+ * @param string $zone The zone to delete the instance in (e.g. "us-central1-a")
+ * @param string $instanceName The unique name for the Compute instance to delete.
+ */
+function delete_instance(
+    string $projectId,
+    string $zone,
+    string $instanceName
+) {
+    // Delete the Compute Engine instance using the InstancesClient
+    $instancesClient = new InstancesClient();
+    $operation = $instancesClient->delete($instanceName, $projectId, $zone);
+
+    /** TODO: wait until operation completes */
+
+    printf('Deleted instance %s' . PHP_EOL, $instanceName);
+}
+
+require_once __DIR__ . '/../../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

compute/cloud-client/instances/README.md

@@ -0,0 +1,51 @@
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/compute/cloud-client/README.md
+ */
+
+namespace Google\Cloud\Samples\Compute;
+
+use Google\Cloud\Compute\V1\InstancesClient;
+
+/**
+ * Creates an instance.
+ * Example:
+ * ```
+ * list_instances($projectId, $zone);
+ * ```
+ *
+ * @param string $projectId Your Google Cloud project ID.
+ * @param string $zone The zone to list the instance in (e.g. "us-central1-a")
+ */
+function list_instances(string $projectId, string $zone)
+{
+    // List the new Compute Engine instance using the InstancesClient
+    $instancesClient = new InstancesClient();
+    $instancesList = $instancesClient->list_($projectId, $zone);
+
+    printf('Instances for %s (%s)' . PHP_EOL, $projectId, $zone);
+    foreach ($instancesList as $instance) {
+        printf(' - %s' . PHP_EOL, $instance->getName());
+    }
+}
+
+require_once __DIR__ . '/../../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);