From 1ea406a4cf930616253d8fe4b99dece861265c99 Mon Sep 17 00:00:00 2001 From: Fedor Isakov Date: Tue, 14 Dec 2021 18:02:41 +0300 Subject: [PATCH] chore(samples): add custom hostname instances samples (#650) --- .../createInstanceWithCustomHostname.js | 123 ++++++++++++++++++ .../getInstanceHostname.js | 54 ++++++++ compute/test/customHostnameInstance.test.js | 77 +++++++++++ 3 files changed, 254 insertions(+) create mode 100644 compute/custom-hostname-instance/createInstanceWithCustomHostname.js create mode 100644 compute/custom-hostname-instance/getInstanceHostname.js create mode 100644 compute/test/customHostnameInstance.test.js diff --git a/compute/custom-hostname-instance/createInstanceWithCustomHostname.js b/compute/custom-hostname-instance/createInstanceWithCustomHostname.js new file mode 100644 index 0000000000..3f0f13572f --- /dev/null +++ b/compute/custom-hostname-instance/createInstanceWithCustomHostname.js @@ -0,0 +1,123 @@ +// Copyright 2021 Google LLC +// +// 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. + +/** + * Creates an instance with custom hostname. + * + * @param {string} projectId - ID of the project in which you want to create the VM instance. + * @param {string} zone - Name of the zone where you want to create the VM in, for example: us-west3-b. + * @param {string} instanceName - Name of the new VM instance. + * @param {string} hostname - Custom hostname of the new VM instance. + * Custom hostnames must conform to RFC 1035 requirements for valid hostnames. + * @param {string} machineType - Machine type for the VM instance specified in the following format: + * "zones/{zone}/machineTypes/{type_name}". For example: + * "zones/europe-west3-c/machineTypes/f1-micro" + * You can find the list of available machine types by using this gcloud command: + * $ gcloud compute machine-types list + * @param {string} sourceImage - Path of the disk image you want to use for your boot + * disk. This image can be one of the public images + * (for example, "projects/...) + * or a private image you have access to. + * You can check the list of available public images using: + * $ gcloud compute images list + * @param {string} networkName - Name of the network you want the new instance to use. + * For example: global/networks/default - if you want to use the default network. + */ +function main( + projectId, + zone, + instanceName, + hostname, + machineType = 'n1-standard-1', + sourceImage = 'projects/debian-cloud/global/images/family/debian-10', + networkName = 'global/networks/default' +) { + // [START compute_instances_create_custom_hostname] + /** + * TODO(developer): Uncomment and replace these variables before running the sample. + */ + // const projectId = 'YOUR_PROJECT_ID'; + // const zone = 'europe-central2-b' + // const instanceName = 'YOUR_INSTANCE_NAME' + // const hostname = 'host.example.com' + // const machineType = 'n1-standard-1'; + // const sourceImage = 'projects/debian-cloud/global/images/family/debian-10'; + // const networkName = 'global/networks/default'; + + const compute = require('@google-cloud/compute'); + const computeProtos = compute.protos.google.cloud.compute.v1; + + // Create a new instance with the values provided above in the specified project and zone. + async function createInstanceWithCustomHostname() { + const instancesClient = new compute.InstancesClient(); + + console.log( + `Creating the ${instanceName} instance in ${zone} with hostname ${hostname}...` + ); + + const [response] = await instancesClient.insert({ + instanceResource: { + name: instanceName, + // Custom hostnames are not resolved by the automatically created records + // provided by Compute Engine internal DNS. + // You must manually configure the DNS record for your custom hostname. + hostname, + disks: [ + { + // Describe the size and source image of the boot disk to attach to the instance. + initializeParams: { + diskSizeGb: '10', + sourceImage, + }, + autoDelete: true, + boot: true, + type: computeProtos.AttachedDisk.Type.PERSISTENT, + }, + ], + machineType: `zones/${zone}/machineTypes/${machineType}`, + networkInterfaces: [ + { + // Use the network interface provided in the networkName argument. + name: networkName, + }, + ], + }, + project: projectId, + zone, + }); + let operation = response.latestResponse; + const operationsClient = new compute.ZoneOperationsClient(); + + // Wait for the create operation to complete. + while (operation.status !== 'DONE') { + [operation] = await operationsClient.wait({ + operation: operation.name, + project: projectId, + zone: operation.zone.split('/').pop(), + }); + } + + console.log('Instance created.'); + } + + createInstanceWithCustomHostname(); + // [END compute_instances_create_custom_hostname] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); + +main(...process.argv.slice(2)); diff --git a/compute/custom-hostname-instance/getInstanceHostname.js b/compute/custom-hostname-instance/getInstanceHostname.js new file mode 100644 index 0000000000..561d8b2518 --- /dev/null +++ b/compute/custom-hostname-instance/getInstanceHostname.js @@ -0,0 +1,54 @@ +// Copyright 2021 Google LLC +// +// 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. + +/** + * Prints the hostname of the Google Cloud VM instance. + * + * @param {string} projectId - ID of the project in which you want to get the VM instance hostname. + * @param {string} zone - Name of the zone your instance belongs to, for example: us-west3-b. + * @param {string} instanceName - Name of the new VM instance. + */ +function main(projectId, zone, instanceName) { + // [START compute_instances_get_hostname] + /** + * TODO(developer): Uncomment and replace these variables before running the sample. + */ + // const projectId = 'YOUR_PROJECT_ID'; + // const zone = 'europe-central2-b' + // const instanceName = 'YOUR_INSTANCE_NAME' + + const compute = require('@google-cloud/compute'); + + async function getInstanceHostname() { + const instancesClient = new compute.InstancesClient(); + + const [instance] = await instancesClient.get({ + project: projectId, + zone, + instance: instanceName, + }); + // If a custom hostname is not set, the output for instance.hostname will be undefined + console.log(`Instance ${instanceName} has hostname: ${instance.hostname}`); + } + + getInstanceHostname(); + // [END compute_instances_get_hostname] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); + +main(...process.argv.slice(2)); diff --git a/compute/test/customHostnameInstance.test.js b/compute/test/customHostnameInstance.test.js new file mode 100644 index 0000000000..56985dc9aa --- /dev/null +++ b/compute/test/customHostnameInstance.test.js @@ -0,0 +1,77 @@ +// Copyright 2021 Google LLC +// +// 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. + +'use strict'; + +const compute = require('@google-cloud/compute'); + +const {describe, it} = require('mocha'); +const uuid = require('uuid'); +const cp = require('child_process'); +const {assert} = require('chai'); + +const instancesClient = new compute.InstancesClient(); + +const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'}); + +const getInstance = async (projectId, zone, instanceName) => { + const [instance] = await instancesClient.get({ + project: projectId, + zone, + instance: instanceName, + }); + return instance; +}; + +describe('Instance with a custom hostname samples', () => { + const instanceName = `gcloud-test-instance-${uuid.v4().split('-')[0]}`; + const zone = 'europe-central2-b'; + const custom_hostname = 'host.domain.com'; + + it('should create instance with a custom hostname and return correct hostname', async () => { + const projectId = await instancesClient.getProjectId(); + let output = execSync( + `node custom-hostname-instance/createInstanceWithCustomHostname ${projectId} ${zone} ${instanceName} ${custom_hostname}` + ); + + const instance = await getInstance(projectId, zone, instanceName); + + assert.equal(instance.hostname, custom_hostname); + assert.match(output, /Instance created./); + + output = execSync( + `node custom-hostname-instance/getInstanceHostname ${projectId} ${zone} ${instanceName}` + ); + + assert.include( + output, + `Instance ${instanceName} has hostname: ${custom_hostname}` + ); + + execSync(`node deleteInstance ${projectId} ${zone} ${instanceName}`); + }); + + it('should return undefined if hostname is not set', async () => { + const projectId = await instancesClient.getProjectId(); + + execSync(`node createInstance ${projectId} ${zone} ${instanceName}`); + const output = execSync( + `node custom-hostname-instance/getInstanceHostname ${projectId} ${zone} ${instanceName}` + ); + + assert.include(output, `Instance ${instanceName} has hostname: undefined`); + + execSync(`node deleteInstance ${projectId} ${zone} ${instanceName}`); + }); +});