Skip to content

Commit 8a8a6d9

Browse files
Joanna Gryczgryczj
Joanna Grycz
authored and
gryczj
committed
feat: compute_consume_specific_shared_reservation
1 parent 0e00257 commit 8a8a6d9

13 files changed

+221
-68
lines changed

‎compute/reservations/createInstanceToConsumeAnyReservation.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async function main(instanceName) {
2222
const computeLib = require('@google-cloud/compute');
2323
const compute = computeLib.protos.google.cloud.compute.v1;
2424

25-
// Instantiate a reservationsClient
25+
// Instantiate an instancesClient
2626
const instancesClient = new computeLib.InstancesClient();
2727
// Instantiate a zoneOperationsClient
2828
const zoneOperationsClient = new computeLib.ZoneOperationsClient();

‎compute/reservations/createInstanceToConsumeSharedReservation.js

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
'use strict';
18+
19+
async function main(instancesClient, zoneOperationsClient) {
20+
// [START compute_consume_specific_shared_reservation]
21+
// Import the Compute library
22+
const computeLib = require('@google-cloud/compute');
23+
const compute = computeLib.protos.google.cloud.compute.v1;
24+
25+
/**
26+
* TODO(developer): Uncomment reservationsClient and zoneOperationsClient before running the sample.
27+
*/
28+
// Instantiate an instancesClient
29+
// instancesClient = new computeLib.InstancesClient();
30+
// Instantiate a zoneOperationsClient
31+
// zoneOperationsClient = new computeLib.ZoneOperationsClient();
32+
33+
/**
34+
* TODO(developer): Update these variables before running the sample.
35+
*/
36+
// The ID of the project where instance will be consumed and created.
37+
const baseProjectId = 'base-project-id';
38+
// The ID of the project where reservation is created.
39+
const projectId = 'project-d';
40+
// The name of the instance to create.
41+
const instanceName = 'instance-01';
42+
// The name of the reservation to consume.
43+
// Ensure that the specificReservationRequired field in reservation properties is set to true.
44+
const reservationName = 'reservation-1';
45+
// Machine type to use for VM.
46+
const machineType = 'n1-standard-1';
47+
// The zone in which to create instance.
48+
const zone = 'us-central1-a';
49+
50+
// Create instance to consume shared reservation
51+
async function callCreateInstanceToConsumeSharedReservation() {
52+
// Describe the size and source image of the boot disk to attach to the instance.
53+
// Ensure that the VM's properties match the reservation's VM properties,
54+
// including the zone, machine type (machine family, vCPUs, and memory),
55+
// minimum CPU platform, GPU amount and type, and local SSD interface and size
56+
const disk = new compute.Disk({
57+
boot: true,
58+
autoDelete: true,
59+
type: 'PERSISTENT',
60+
initializeParams: {
61+
diskSizeGb: '10',
62+
sourceImage: 'projects/debian-cloud/global/images/family/debian-12',
63+
},
64+
});
65+
66+
// Define networkInterface
67+
const networkInterface = new compute.NetworkInterface({
68+
name: 'global/networks/default',
69+
});
70+
71+
// Define reservationAffinity
72+
const reservationAffinity = new compute.ReservationAffinity({
73+
consumeReservationType: 'SPECIFIC_RESERVATION',
74+
key: 'compute.googleapis.com/reservation-name',
75+
values: [`projects/${projectId}/reservations/${reservationName}`],
76+
});
77+
78+
// Create an instance
79+
const instance = new compute.Instance({
80+
name: instanceName,
81+
machineType: `zones/${zone}/machineTypes/${machineType}`,
82+
disks: [disk],
83+
networkInterfaces: [networkInterface],
84+
reservationAffinity,
85+
});
86+
87+
const [response] = await instancesClient.insert({
88+
project: baseProjectId,
89+
instanceResource: instance,
90+
zone,
91+
});
92+
93+
let operation = response.latestResponse;
94+
95+
// Wait for the create instance operation to complete.
96+
while (operation.status !== 'DONE') {
97+
[operation] = await zoneOperationsClient.wait({
98+
operation: operation.name,
99+
project: baseProjectId,
100+
zone: operation.zone.split('/').pop(),
101+
});
102+
}
103+
104+
console.log(`Instance ${instanceName} created from shared reservation.`);
105+
return response;
106+
}
107+
108+
return await callCreateInstanceToConsumeSharedReservation();
109+
// [END compute_consume_specific_shared_reservation]
110+
}
111+
112+
module.exports = main;
113+
114+
// TODO(developer): Uncomment below lines before running the sample.
115+
// main(...process.argv.slice(2)).catch(err => {
116+
// console.error(err);
117+
// process.exitCode = 1;
118+
// });

‎compute/reservations/createInstanceToConsumeSingleProjectReservation.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async function main(instanceName, reservationName) {
2222
const computeLib = require('@google-cloud/compute');
2323
const compute = computeLib.protos.google.cloud.compute.v1;
2424

25-
// Instantiate a reservationsClient
25+
// Instantiate an instancesClient
2626
const instancesClient = new computeLib.InstancesClient();
2727
// Instantiate a zoneOperationsClient
2828
const zoneOperationsClient = new computeLib.ZoneOperationsClient();

‎compute/reservations/createInstanceToNotConsumeReservation.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async function main(instanceName) {
2222
const computeLib = require('@google-cloud/compute');
2323
const compute = computeLib.protos.google.cloud.compute.v1;
2424

25-
// Instantiate a reservationsClient
25+
// Instantiate an instancesClient
2626
const instancesClient = new computeLib.InstancesClient();
2727
// Instantiate a zoneOperationsClient
2828
const zoneOperationsClient = new computeLib.ZoneOperationsClient();

‎compute/test/consumeReservations.test.js

+4-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
const path = require('path');
2020
const assert = require('node:assert/strict');
21-
const {before, describe, it} = require('mocha');
21+
const {before, after, describe, it} = require('mocha');
2222
const cp = require('child_process');
2323
const {ReservationsClient} = require('@google-cloud/compute').v1;
2424
const {
@@ -40,6 +40,9 @@ describe('Consume reservations', async () => {
4040

4141
before(async () => {
4242
projectId = await reservationsClient.getProjectId();
43+
});
44+
45+
after(async () => {
4346
// Cleanup resources
4447
const instances = await getStaleVMInstances(instancePrefix);
4548
await Promise.all(

‎compute/test/createComputeHyperdisk.test.js

+2-14
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@
1818

1919
const path = require('path');
2020
const assert = require('node:assert/strict');
21-
const {before, after, describe, it} = require('mocha');
21+
const {after, describe, it} = require('mocha');
2222
const cp = require('child_process');
23-
const {DisksClient} = require('@google-cloud/compute').v1;
2423
const {getStaleDisks, deleteDisk} = require('./util');
2524

2625
const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
@@ -30,24 +29,13 @@ describe('Create compute hyperdisk', async () => {
3029
const prefix = 'hyperdisk-name-941ad2d';
3130
const diskName = `${prefix}${Math.floor(Math.random() * 1000 + 1)}`;
3231
const zone = 'europe-central2-b';
33-
const disksClient = new DisksClient();
34-
let projectId;
3532

36-
before(async () => {
37-
projectId = await disksClient.getProjectId();
33+
after(async () => {
3834
// Cleanup resources
3935
const disks = await getStaleDisks(prefix);
4036
await Promise.all(disks.map(disk => deleteDisk(disk.zone, disk.diskName)));
4137
});
4238

43-
after(async () => {
44-
await disksClient.delete({
45-
project: projectId,
46-
disk: diskName,
47-
zone,
48-
});
49-
});
50-
5139
it('should create a new hyperdisk', () => {
5240
const response = execSync(
5341
`node ./disks/createComputeHyperdisk.js ${diskName} ${zone}`,

‎compute/test/createComputeHyperdiskFromPool.test.js

+2-8
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
const path = require('path');
2020
const assert = require('node:assert/strict');
21-
const {after, before, describe, it} = require('mocha');
21+
const {after, describe, it} = require('mocha');
2222
const cp = require('child_process');
2323
const {
2424
getStaleDisks,
@@ -37,7 +37,7 @@ describe('Create compute hyperdisk from pool', async () => {
3737
const storagePoolName = `${poolPrefix}${Math.floor(Math.random() * 1000 + 1)}5f`;
3838
const zone = 'us-central1-a';
3939

40-
before(async () => {
40+
after(async () => {
4141
// Cleanup resources
4242
const disks = await getStaleDisks(diskPrefix);
4343
await Promise.all(disks.map(disk => deleteDisk(disk.zone, disk.diskName)));
@@ -49,12 +49,6 @@ describe('Create compute hyperdisk from pool', async () => {
4949
);
5050
});
5151

52-
after(async () => {
53-
// Cleanup resources
54-
await deleteDisk(zone, diskName);
55-
await deleteStoragePool(zone, storagePoolName);
56-
});
57-
5852
it('should create a new storage pool', async () => {
5953
const response = execSync(
6054
`node ./disks/createComputeHyperdiskPool.js ${storagePoolName} ${zone}`,

‎compute/test/createInstanceTemplates.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
const compute = require('@google-cloud/compute');
1818

19-
const {describe, it} = require('mocha');
19+
const {after, describe, it} = require('mocha');
2020
const cp = require('child_process');
2121
const {assert} = require('chai');
2222

‎compute/test/createInstanceToConsumeSharedReservation.test.js

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
'use strict';
18+
19+
const {beforeEach, afterEach, describe, it} = require('mocha');
20+
const assert = require('node:assert/strict');
21+
const sinon = require('sinon');
22+
const createInstanceToConsumeSharedReservation = require('../reservations/createInstanceToConsumeSharedReservation.js');
23+
24+
describe('Create instance to consume shared reservation', async () => {
25+
const instanceName = 'instance-1';
26+
let instancesClientMock;
27+
let zoneOperationsClientMock;
28+
29+
beforeEach(() => {
30+
instancesClientMock = {
31+
insert: sinon.stub().resolves([
32+
{
33+
name: instanceName,
34+
latestResponse: {
35+
status: 'DONE',
36+
name: 'operation-1234567890',
37+
zone: {
38+
value: 'us-central1-a',
39+
},
40+
},
41+
},
42+
]),
43+
};
44+
zoneOperationsClientMock = {
45+
wait: sinon.stub().resolves([
46+
{
47+
latestResponse: {
48+
status: 'DONE',
49+
},
50+
},
51+
]),
52+
};
53+
});
54+
55+
afterEach(() => {
56+
sinon.restore();
57+
});
58+
59+
it('should create instance', async () => {
60+
const response = await createInstanceToConsumeSharedReservation(
61+
instancesClientMock,
62+
zoneOperationsClientMock
63+
);
64+
65+
assert(response.name.includes(instanceName));
66+
});
67+
});

‎compute/test/createReservationFromVM.test.js

+10-19
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ describe('Compute reservation from VM', async () => {
4343

4444
before(async () => {
4545
projectId = await reservationsClient.getProjectId();
46+
// Create VM
47+
execSync(
48+
`node ./createInstance.js ${projectId} ${zone} ${vmName} ${machineType}`,
49+
{
50+
cwd,
51+
}
52+
);
53+
});
54+
55+
after(async () => {
4656
// Cleanup resources
4757
const instances = await getStaleVMInstances(instancePrefix);
4858
await Promise.all(
@@ -56,25 +66,6 @@ describe('Compute reservation from VM', async () => {
5666
deleteReservation(reservation.zone, reservation.reservationName)
5767
)
5868
);
59-
// Create VM
60-
execSync(
61-
`node ./createInstance.js ${projectId} ${zone} ${vmName} ${machineType}`,
62-
{
63-
cwd,
64-
}
65-
);
66-
});
67-
68-
after(() => {
69-
// Delete reservation
70-
execSync(`node ./reservations/deleteReservation.js ${reservationName}`, {
71-
cwd,
72-
});
73-
74-
// Delete VM
75-
execSync(`node ./deleteInstance.js ${projectId} ${zone} ${vmName}`, {
76-
cwd,
77-
});
7869
});
7970

8071
it('should create a new reservation from vm', () => {

‎compute/test/createReservationGlobalInstanceTemplate.test.js

+8-12
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,6 @@ describe('Create compute reservation using global instance template', async () =
3636

3737
before(async () => {
3838
projectId = await reservationsClient.getProjectId();
39-
// Cleanup resources
40-
const reservations = await getStaleReservations(reservationPrefix);
41-
await Promise.all(
42-
reservations.map(reservation =>
43-
deleteReservation(reservation.zone, reservation.reservationName)
44-
)
45-
);
4639
// Create template
4740
execSync(
4841
`node ./create-instance-templates/createTemplate.js ${projectId} ${instanceTemplateName}`,
@@ -52,11 +45,14 @@ describe('Create compute reservation using global instance template', async () =
5245
);
5346
});
5447

55-
after(() => {
56-
// Delete reservation
57-
execSync(`node ./reservations/deleteReservation.js ${reservationName}`, {
58-
cwd,
59-
});
48+
after(async () => {
49+
// Cleanup resources
50+
const reservations = await getStaleReservations(reservationPrefix);
51+
await Promise.all(
52+
reservations.map(reservation =>
53+
deleteReservation(reservation.zone, reservation.reservationName)
54+
)
55+
);
6056
// Delete template
6157
execSync(
6258
`node ./create-instance-templates/deleteInstanceTemplate.js ${projectId} ${instanceTemplateName}`,

0 commit comments

Comments
 (0)