Skip to content

Commit 3ff39e7

Browse files
TetyanaYahodskaTetyanaYahodska
authored
feat(compute): add compute instance/instance template not consume reservation samples. (#9564)
* Added compute_instance_not_consume_reservation sample and test. * Added timeout * Fixed test * Fixed test * Created ConsumeReservationIT cals, fixed ReservationIT * Fixed ReservationIT * changed zone * changed zone * Added compute_template_not_consume_reservation sample, fixed tests * Added timeout * Fixed Instance creation * Fixed Instance creation * Disabled Instance creation * Fixed code * Fixed comments * Added comments and code * Fixed code following recommendations
1 parent 5f65217 commit 3ff39e7

File tree

4 files changed

+334
-1
lines changed

4 files changed

+334
-1
lines changed

‎compute/cloud-client/src/main/java/compute/reservation/CreateInstanceWithoutConsumingReservation.java‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
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+
* http://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+
package compute.reservation;
18+
19+
// [START compute_instance_not_consume_reservation]
20+
import static com.google.cloud.compute.v1.ReservationAffinity.ConsumeReservationType.NO_RESERVATION;
21+
22+
import com.google.api.gax.longrunning.OperationFuture;
23+
import com.google.cloud.compute.v1.AttachedDisk;
24+
import com.google.cloud.compute.v1.AttachedDiskInitializeParams;
25+
import com.google.cloud.compute.v1.InsertInstanceRequest;
26+
import com.google.cloud.compute.v1.Instance;
27+
import com.google.cloud.compute.v1.InstancesClient;
28+
import com.google.cloud.compute.v1.NetworkInterface;
29+
import com.google.cloud.compute.v1.Operation;
30+
import com.google.cloud.compute.v1.ReservationAffinity;
31+
import java.io.IOException;
32+
import java.util.concurrent.ExecutionException;
33+
import java.util.concurrent.TimeUnit;
34+
import java.util.concurrent.TimeoutException;
35+
36+
public class CreateInstanceWithoutConsumingReservation {
37+
public static void main(String[] args)
38+
throws IOException, ExecutionException, InterruptedException, TimeoutException {
39+
// TODO(developer): Replace these variables before running the sample.
40+
// Project ID or project number of the Cloud project you want to use.
41+
String projectId = "YOUR_PROJECT_ID";
42+
// Name of the zone you want to use.
43+
String zone = "us-central1-a";
44+
// Name of the VM instance you want to query.
45+
String instanceName = "YOUR_INSTANCE_NAME";
46+
// machineType: machine type of the VM being created.
47+
// * This value uses the format zones/{zone}/machineTypes/{type_name}.
48+
// * For a list of machine types, see https://cloud.google.com/compute/docs/machine-types
49+
String machineTypeName = "n1-standard-1";
50+
// sourceImage: path to the operating system image to mount.
51+
// * For details about images you can mount, see https://cloud.google.com/compute/docs/images
52+
String sourceImage = "projects/debian-cloud/global/images/family/debian-11";
53+
// diskSizeGb: storage size of the boot disk to attach to the instance.
54+
long diskSizeGb = 10L;
55+
// networkName: network interface to associate with the instance.
56+
String networkName = "default";
57+
58+
createInstanceWithoutConsumingReservationAsync(projectId, zone, instanceName,
59+
machineTypeName, sourceImage, diskSizeGb, networkName);
60+
}
61+
62+
// Create a virtual machine that explicitly doesn't consume reservations
63+
public static Instance createInstanceWithoutConsumingReservationAsync(
64+
String project, String zone, String instanceName,
65+
String machineTypeName, String sourceImage, long diskSizeGb, String networkName)
66+
throws IOException, InterruptedException, ExecutionException, TimeoutException {
67+
String machineType = String.format("zones/%s/machineTypes/%s", zone, machineTypeName);
68+
69+
// Initialize client that will be used to send requests. This client only needs to be created
70+
// once, and can be reused for multiple requests.
71+
try (InstancesClient instancesClient = InstancesClient.create()) {
72+
AttachedDisk disk =
73+
AttachedDisk.newBuilder()
74+
.setBoot(true)
75+
.setAutoDelete(true)
76+
.setType(AttachedDisk.Type.PERSISTENT.toString())
77+
.setDeviceName("disk-1")
78+
.setInitializeParams(
79+
AttachedDiskInitializeParams.newBuilder()
80+
.setSourceImage(sourceImage)
81+
.setDiskSizeGb(diskSizeGb)
82+
.build())
83+
.build();
84+
85+
NetworkInterface networkInterface = NetworkInterface.newBuilder()
86+
.setName(networkName)
87+
.build();
88+
89+
ReservationAffinity reservationAffinity =
90+
ReservationAffinity.newBuilder()
91+
.setConsumeReservationType(NO_RESERVATION.toString())
92+
.build();
93+
94+
Instance instanceResource =
95+
Instance.newBuilder()
96+
.setName(instanceName)
97+
.setMachineType(machineType)
98+
.addDisks(disk)
99+
.addNetworkInterfaces(networkInterface)
100+
.setReservationAffinity(reservationAffinity)
101+
.build();
102+
103+
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
104+
.setProject(project)
105+
.setZone(zone)
106+
.setInstanceResource(instanceResource)
107+
.build();
108+
109+
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
110+
insertInstanceRequest);
111+
112+
// Wait for the operation to complete.
113+
Operation response = operation.get(3, TimeUnit.MINUTES);
114+
115+
if (response.hasError()) {
116+
return null;
117+
}
118+
return instancesClient.get(project, zone, instanceName);
119+
}
120+
}
121+
}
122+
// [END compute_instance_not_consume_reservation]

‎compute/cloud-client/src/main/java/compute/reservation/CreateReservation.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
package compute.reservation;
1818

19+
// [START compute_reservation_create]
1920
import com.google.cloud.compute.v1.AcceleratorConfig;
2021
import com.google.cloud.compute.v1.AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk;
2122
import com.google.cloud.compute.v1.AllocationSpecificSKUAllocationReservedInstanceProperties;
@@ -28,7 +29,6 @@
2829
import java.util.concurrent.TimeUnit;
2930
import java.util.concurrent.TimeoutException;
3031

31-
// [START compute_reservation_create]
3232
public class CreateReservation {
3333

3434
public static void main(String[] args)

‎compute/cloud-client/src/main/java/compute/reservation/CreateTemplateWithoutConsumingReservation.java‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
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+
* http://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+
package compute.reservation;
18+
19+
// [START compute_template_not_consume_reservation]
20+
import static com.google.cloud.compute.v1.ReservationAffinity.ConsumeReservationType.NO_RESERVATION;
21+
22+
import com.google.cloud.compute.v1.AccessConfig;
23+
import com.google.cloud.compute.v1.AttachedDisk;
24+
import com.google.cloud.compute.v1.AttachedDiskInitializeParams;
25+
import com.google.cloud.compute.v1.InsertInstanceTemplateRequest;
26+
import com.google.cloud.compute.v1.InstanceProperties;
27+
import com.google.cloud.compute.v1.InstanceTemplate;
28+
import com.google.cloud.compute.v1.InstanceTemplatesClient;
29+
import com.google.cloud.compute.v1.NetworkInterface;
30+
import com.google.cloud.compute.v1.Operation;
31+
import com.google.cloud.compute.v1.ReservationAffinity;
32+
import java.io.IOException;
33+
import java.util.concurrent.ExecutionException;
34+
import java.util.concurrent.TimeUnit;
35+
import java.util.concurrent.TimeoutException;
36+
37+
public class CreateTemplateWithoutConsumingReservation {
38+
public static void main(String[] args)
39+
throws IOException, ExecutionException, InterruptedException, TimeoutException {
40+
// TODO(developer): Replace these variables before running the sample.
41+
// Project ID or project number of the Cloud project you want to use.
42+
String projectId = "YOUR_PROJECT_ID";
43+
// Name of the template you want to query.
44+
String templateName = "YOUR_INSTANCE_TEMPLATE_NAME";
45+
String machineType = "e2-standard-4";
46+
String sourceImage = "projects/debian-cloud/global/images/family/debian-11";
47+
48+
createTemplateWithoutConsumingReservationAsync(
49+
projectId, templateName, machineType, sourceImage);
50+
}
51+
52+
53+
// Create a template that explicitly doesn't consume any reservations.
54+
public static InstanceTemplate createTemplateWithoutConsumingReservationAsync(
55+
String projectId, String templateName, String machineType, String sourceImage)
56+
throws IOException, ExecutionException, InterruptedException, TimeoutException {
57+
// Initialize client that will be used to send requests. This client only needs to be created
58+
// once, and can be reused for multiple requests.
59+
try (InstanceTemplatesClient instanceTemplatesClient = InstanceTemplatesClient.create()) {
60+
AttachedDisk attachedDisk = AttachedDisk.newBuilder()
61+
.setInitializeParams(AttachedDiskInitializeParams.newBuilder()
62+
.setSourceImage(sourceImage)
63+
.setDiskType("pd-balanced")
64+
.setDiskSizeGb(250)
65+
.build())
66+
.setAutoDelete(true)
67+
.setBoot(true)
68+
.build();
69+
70+
NetworkInterface networkInterface = NetworkInterface.newBuilder()
71+
.setName("global/networks/default")
72+
.addAccessConfigs(AccessConfig.newBuilder()
73+
.setName("External NAT")
74+
.setType(AccessConfig.Type.ONE_TO_ONE_NAT.toString())
75+
.setNetworkTier(AccessConfig.NetworkTier.PREMIUM.toString())
76+
.build())
77+
.build();
78+
79+
ReservationAffinity reservationAffinity =
80+
ReservationAffinity.newBuilder()
81+
.setConsumeReservationType(NO_RESERVATION.toString())
82+
.build();
83+
84+
InstanceProperties instanceProperties = InstanceProperties.newBuilder()
85+
.addDisks(attachedDisk)
86+
.setMachineType(machineType)
87+
.setReservationAffinity(reservationAffinity)
88+
.addNetworkInterfaces(networkInterface)
89+
.build();
90+
91+
InsertInstanceTemplateRequest insertInstanceTemplateRequest = InsertInstanceTemplateRequest
92+
.newBuilder()
93+
.setProject(projectId)
94+
.setInstanceTemplateResource(InstanceTemplate.newBuilder()
95+
.setName(templateName)
96+
.setProperties(instanceProperties)
97+
.build())
98+
.build();
99+
100+
Operation response = instanceTemplatesClient.insertAsync(insertInstanceTemplateRequest)
101+
.get(3, TimeUnit.MINUTES);
102+
103+
if (response.hasError()) {
104+
return null;
105+
}
106+
return instanceTemplatesClient.get(projectId, templateName);
107+
}
108+
}
109+
}
110+
// [END compute_template_not_consume_reservation]

‎compute/cloud-client/src/test/java/compute/reservation/ConsumeReservationIT.java‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
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+
* http://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+
package compute.reservation;
18+
19+
import static com.google.cloud.compute.v1.ReservationAffinity.ConsumeReservationType.NO_RESERVATION;
20+
import static com.google.common.truth.Truth.assertWithMessage;
21+
22+
import com.google.cloud.compute.v1.Instance;
23+
import com.google.cloud.compute.v1.InstanceTemplate;
24+
import compute.DeleteInstance;
25+
import compute.DeleteInstanceTemplate;
26+
import java.io.IOException;
27+
import java.util.UUID;
28+
import java.util.concurrent.ExecutionException;
29+
import java.util.concurrent.TimeUnit;
30+
import java.util.concurrent.TimeoutException;
31+
import org.junit.jupiter.api.AfterAll;
32+
import org.junit.jupiter.api.Assertions;
33+
import org.junit.jupiter.api.BeforeAll;
34+
import org.junit.jupiter.api.Test;
35+
import org.junit.jupiter.api.Timeout;
36+
import org.junit.runner.RunWith;
37+
import org.junit.runners.JUnit4;
38+
39+
@RunWith(JUnit4.class)
40+
@Timeout(value = 3, unit = TimeUnit.MINUTES)
41+
public class ConsumeReservationIT {
42+
43+
private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
44+
private static final String ZONE = "us-central1-a";
45+
private static final String INSTANCE_NOT_CONSUME_RESERVATION_NAME =
46+
"test-instance-not-consume-" + UUID.randomUUID().toString().substring(0, 8);
47+
private static final String TEMPLATE_NOT_CONSUME_RESERVATION_NAME =
48+
"test-template-not-consume-" + UUID.randomUUID().toString().substring(0, 8);
49+
private static final String MACHINE_TYPE_NAME = "n1-standard-1";
50+
private static final String SOURCE_IMAGE = "projects/debian-cloud/global/images/family/debian-11";
51+
private static final String NETWORK_NAME = "default";
52+
private static final long DISK_SIZE_GD = 10L;
53+
54+
// Check if the required environment variables are set.
55+
public static void requireEnvVar(String envVarName) {
56+
assertWithMessage(String.format("Missing environment variable '%s' ", envVarName))
57+
.that(System.getenv(envVarName)).isNotEmpty();
58+
}
59+
60+
@BeforeAll
61+
public static void setUp()
62+
throws IOException, ExecutionException, InterruptedException, TimeoutException {
63+
requireEnvVar("GOOGLE_APPLICATION_CREDENTIALS");
64+
requireEnvVar("GOOGLE_CLOUD_PROJECT");
65+
}
66+
67+
@AfterAll
68+
public static void cleanup()
69+
throws IOException, ExecutionException, InterruptedException, TimeoutException {
70+
// Delete the instance created for testing.
71+
DeleteInstance.deleteInstance(PROJECT_ID, ZONE, INSTANCE_NOT_CONSUME_RESERVATION_NAME);
72+
DeleteInstanceTemplate.deleteInstanceTemplate(
73+
PROJECT_ID, TEMPLATE_NOT_CONSUME_RESERVATION_NAME);
74+
}
75+
76+
@Test
77+
public void testCreateInstanceNotConsumeReservation()
78+
throws IOException, ExecutionException, InterruptedException, TimeoutException {
79+
Instance instance = CreateInstanceWithoutConsumingReservation
80+
.createInstanceWithoutConsumingReservationAsync(
81+
PROJECT_ID, ZONE, INSTANCE_NOT_CONSUME_RESERVATION_NAME, MACHINE_TYPE_NAME,
82+
SOURCE_IMAGE, DISK_SIZE_GD, NETWORK_NAME);
83+
84+
Assertions.assertNotNull(instance);
85+
Assertions.assertEquals(NO_RESERVATION.toString(),
86+
instance.getReservationAffinity().getConsumeReservationType());
87+
}
88+
89+
@Test
90+
public void testCreateTemplateNotConsumeReservation()
91+
throws IOException, ExecutionException, InterruptedException, TimeoutException {
92+
InstanceTemplate template =
93+
CreateTemplateWithoutConsumingReservation.createTemplateWithoutConsumingReservationAsync(
94+
PROJECT_ID, TEMPLATE_NOT_CONSUME_RESERVATION_NAME,
95+
MACHINE_TYPE_NAME, SOURCE_IMAGE);
96+
97+
Assertions.assertNotNull(template);
98+
Assertions.assertEquals(NO_RESERVATION.toString(),
99+
template.getPropertiesOrBuilder().getReservationAffinity().getConsumeReservationType());
100+
}
101+
}

0 commit comments

Comments
 (0)