Skip to content

Commit 2df21d1

Browse files
TetyanaYahodskaTetyanaYahodska
authored
feat(compute): add compute consume reservation samples (#9596)
* Implemented consume reservation samples, created tests * Fixed code * Fixed code * Fixed indentation * Fixed comments * Fixed code following recommendations * Fixed return value * deleted empty line after tag * Fixed tests * Fixed tests * Fixed test * Fixed zone * Fixed zone * Cleanup reservations * Fixed lint issue * Fixed test * Changed zone for HyperdisksIT * Cleanup resources * Changed zone for HyperdisksIT * Added cleanup methods * Deleted cleanup methods * Deleted cleanup methods
1 parent 282ec81 commit 2df21d1

16 files changed

+608
-152
lines changed

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

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
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_consume_any_matching_reservation]
20+
import static com.google.cloud.compute.v1.ReservationAffinity.ConsumeReservationType.ANY_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 ConsumeAnyMatchingReservation {
37+
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+
// Zone where the VM instance will be created.
44+
String zone = "us-central1-a";
45+
// Name of the VM instance you want to query.
46+
String instanceName = "YOUR_INSTANCE_NAME";
47+
// machineType: machine type of the VM being created.
48+
// * For a list of machine types, see https://cloud.google.com/compute/docs/machine-types
49+
String machineTypeName = "n1-standard-4";
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+
// Minimum CPU platform of the instances.
58+
String minCpuPlatform = "Intel Skylake";
59+
60+
createInstanceAsync(projectId, zone, instanceName, machineTypeName, sourceImage,
61+
diskSizeGb, networkName, minCpuPlatform);
62+
}
63+
64+
// Create a virtual machine targeted with the reserveAffinity field.
65+
// In this consumption model, existing and new VMs automatically consume a reservation
66+
// if their properties match the VM properties specified in the reservation.
67+
public static Instance createInstanceAsync(String projectId, String zone,
68+
String instanceName, String machineTypeName, String sourceImage,
69+
long diskSizeGb, String networkName, String minCpuPlatform)
70+
throws IOException, InterruptedException, ExecutionException, TimeoutException {
71+
String machineType = String.format("zones/%s/machineTypes/%s", zone, machineTypeName);
72+
// Initialize client that will be used to send requests. This client only needs to be created
73+
// once, and can be reused for multiple requests.
74+
try (InstancesClient instancesClient = InstancesClient.create()) {
75+
AttachedDisk disk =
76+
AttachedDisk.newBuilder()
77+
.setBoot(true)
78+
.setAutoDelete(true)
79+
.setType(AttachedDisk.Type.PERSISTENT.toString())
80+
.setDeviceName("disk-1")
81+
.setInitializeParams(
82+
AttachedDiskInitializeParams.newBuilder()
83+
.setSourceImage(sourceImage)
84+
.setDiskSizeGb(diskSizeGb)
85+
.build())
86+
.build();
87+
88+
NetworkInterface networkInterface = NetworkInterface.newBuilder()
89+
.setName(networkName)
90+
.build();
91+
92+
ReservationAffinity reservationAffinity =
93+
ReservationAffinity.newBuilder()
94+
.setConsumeReservationType(ANY_RESERVATION.toString())
95+
.build();
96+
97+
Instance instanceResource =
98+
Instance.newBuilder()
99+
.setName(instanceName)
100+
.setMachineType(machineType)
101+
.addDisks(disk)
102+
.addNetworkInterfaces(networkInterface)
103+
.setMinCpuPlatform(minCpuPlatform)
104+
.setReservationAffinity(reservationAffinity)
105+
.build();
106+
107+
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
108+
.setProject(projectId)
109+
.setZone(zone)
110+
.setInstanceResource(instanceResource)
111+
.build();
112+
113+
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
114+
insertInstanceRequest);
115+
116+
Operation response = operation.get(3, TimeUnit.MINUTES);
117+
118+
if (response.hasError()) {
119+
return null;
120+
}
121+
return instancesClient.get(projectId, zone, instanceName);
122+
}
123+
}
124+
}
125+
// [END compute_consume_any_matching_reservation]

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

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
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_consume_single_project_reservation]
20+
import static com.google.cloud.compute.v1.ReservationAffinity.ConsumeReservationType.SPECIFIC_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 ConsumeSingleProjectReservation {
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 where the reservation is located.
43+
String zone = "us-central1-a";
44+
// Name of the reservation you want to query.
45+
String reservationName = "YOUR_RESERVATION_NAME";
46+
// Name of the VM instance you want to query.
47+
String instanceName = "YOUR_INSTANCE_NAME";
48+
// machineType: machine type of the VM being created.
49+
// * For a list of machine types, see https://cloud.google.com/compute/docs/machine-types
50+
String machineTypeName = "n1-standard-4";
51+
// sourceImage: path to the operating system image to mount.
52+
// * For details about images you can mount, see https://cloud.google.com/compute/docs/images
53+
String sourceImage = "projects/debian-cloud/global/images/family/debian-11";
54+
// diskSizeGb: storage size of the boot disk to attach to the instance.
55+
long diskSizeGb = 10L;
56+
// networkName: network interface to associate with the instance.
57+
String networkName = "default";
58+
// Minimum CPU platform of the instances.
59+
String minCpuPlatform = "Intel Skylake";
60+
61+
createInstanceAsync(projectId, zone, instanceName, reservationName, machineTypeName,
62+
sourceImage, diskSizeGb, networkName, minCpuPlatform);
63+
}
64+
65+
// Create a virtual machine targeted with the reserveAffinity field.
66+
// Ensure that the VM's properties match the reservation's VM properties.
67+
public static Instance createInstanceAsync(String projectId, String zone, String instanceName,
68+
String reservationName, String machineTypeName, String sourceImage, long diskSizeGb,
69+
String networkName, String minCpuPlatform)
70+
throws IOException, InterruptedException, ExecutionException, TimeoutException {
71+
String machineType = String.format("zones/%s/machineTypes/%s", zone, machineTypeName);
72+
// Initialize client that will be used to send requests. This client only needs to be created
73+
// once, and can be reused for multiple requests.
74+
try (InstancesClient instancesClient = InstancesClient.create()) {
75+
AttachedDisk disk =
76+
AttachedDisk.newBuilder()
77+
.setBoot(true)
78+
.setAutoDelete(true)
79+
.setType(AttachedDisk.Type.PERSISTENT.toString())
80+
.setDeviceName("disk-1")
81+
.setInitializeParams(
82+
AttachedDiskInitializeParams.newBuilder()
83+
.setSourceImage(sourceImage)
84+
.setDiskSizeGb(diskSizeGb)
85+
.build())
86+
.build();
87+
88+
NetworkInterface networkInterface = NetworkInterface.newBuilder()
89+
.setName(networkName)
90+
.build();
91+
92+
ReservationAffinity reservationAffinity =
93+
ReservationAffinity.newBuilder()
94+
.setConsumeReservationType(SPECIFIC_RESERVATION.toString())
95+
.setKey("compute.googleapis.com/reservation-name")
96+
// Set specific reservation
97+
.addValues(reservationName)
98+
.build();
99+
100+
Instance instanceResource =
101+
Instance.newBuilder()
102+
.setName(instanceName)
103+
.setMachineType(machineType)
104+
.addDisks(disk)
105+
.addNetworkInterfaces(networkInterface)
106+
.setMinCpuPlatform(minCpuPlatform)
107+
.setReservationAffinity(reservationAffinity)
108+
.build();
109+
110+
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
111+
.setProject(projectId)
112+
.setZone(zone)
113+
.setInstanceResource(instanceResource)
114+
.build();
115+
116+
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
117+
insertInstanceRequest);
118+
Operation response = operation.get(3, TimeUnit.MINUTES);
119+
120+
if (response.hasError()) {
121+
return null;
122+
}
123+
return instancesClient.get(projectId, zone, instanceName);
124+
}
125+
}
126+
}
127+
// [END compute_consume_single_project_reservation]

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

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
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_consume_specific_shared_reservation]
20+
import static com.google.cloud.compute.v1.ReservationAffinity.ConsumeReservationType.SPECIFIC_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 ConsumeSpecificSharedReservation {
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 the reservation is located.
43+
String zone = "us-central1-a";
44+
// Name of the reservation you want to query.
45+
String reservationName = "YOUR_RESERVATION_NAME";
46+
// Name of the VM instance you want to query.
47+
String instanceName = "YOUR_INSTANCE_NAME";
48+
// machineType: machine type of the VM being created.
49+
// * For a list of machine types, see https://cloud.google.com/compute/docs/machine-types
50+
String machineTypeName = "n1-standard-4";
51+
// sourceImage: path to the operating system image to mount.
52+
// * For details about images you can mount, see https://cloud.google.com/compute/docs/images
53+
String sourceImage = "projects/debian-cloud/global/images/family/debian-11";
54+
// diskSizeGb: storage size of the boot disk to attach to the instance.
55+
long diskSizeGb = 10L;
56+
// networkName: network interface to associate with the instance.
57+
String networkName = "default";
58+
// Minimum CPU platform of the instances.
59+
String minCpuPlatform = "Intel Skylake";
60+
61+
createInstanceAsync(projectId, zone, instanceName, reservationName, machineTypeName,
62+
sourceImage, diskSizeGb, networkName, minCpuPlatform);
63+
}
64+
65+
// Create a virtual machine targeted with the reserveAffinity field.
66+
// Ensure that the VM's properties match the reservation's VM properties.
67+
public static Instance createInstanceAsync(String projectId, String zone, String instanceName,
68+
String reservationName, String machineTypeName, String sourceImage, long diskSizeGb,
69+
String networkName, String minCpuPlatform)
70+
throws IOException, InterruptedException, ExecutionException, TimeoutException {
71+
String machineType = String.format("zones/%s/machineTypes/%s", zone, machineTypeName);
72+
// To consume this reservation from any consumer projects that this reservation is shared with,
73+
// you must also specify the owner project of the reservation - the path to the reservation.
74+
String reservationPath =
75+
String.format("projects/%s/reservations/%s", projectId, reservationName);
76+
// Initialize client that will be used to send requests. This client only needs to be created
77+
// once, and can be reused for multiple requests.
78+
try (InstancesClient instancesClient = InstancesClient.create()) {
79+
AttachedDisk disk =
80+
AttachedDisk.newBuilder()
81+
.setBoot(true)
82+
.setAutoDelete(true)
83+
.setType(AttachedDisk.Type.PERSISTENT.toString())
84+
.setDeviceName("disk-1")
85+
.setInitializeParams(
86+
AttachedDiskInitializeParams.newBuilder()
87+
.setSourceImage(sourceImage)
88+
.setDiskSizeGb(diskSizeGb)
89+
.build())
90+
.build();
91+
92+
NetworkInterface networkInterface = NetworkInterface.newBuilder()
93+
.setName(networkName)
94+
.build();
95+
96+
ReservationAffinity reservationAffinity =
97+
ReservationAffinity.newBuilder()
98+
.setConsumeReservationType(SPECIFIC_RESERVATION.toString())
99+
.setKey("compute.googleapis.com/reservation-name")
100+
// Set specific reservation
101+
.addValues(reservationPath)
102+
.build();
103+
104+
Instance instanceResource =
105+
Instance.newBuilder()
106+
.setName(instanceName)
107+
.setMachineType(machineType)
108+
.addDisks(disk)
109+
.addNetworkInterfaces(networkInterface)
110+
.setMinCpuPlatform(minCpuPlatform)
111+
.setReservationAffinity(reservationAffinity)
112+
.build();
113+
114+
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
115+
.setProject(projectId)
116+
.setZone(zone)
117+
.setInstanceResource(instanceResource)
118+
.build();
119+
120+
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
121+
insertInstanceRequest);
122+
Operation response = operation.get(3, TimeUnit.MINUTES);
123+
124+
if (response.hasError()) {
125+
return null;
126+
}
127+
return instancesClient.get(projectId, zone, instanceName);
128+
}
129+
}
130+
}
131+
// [END compute_consume_specific_shared_reservation]

0 commit comments

Comments
 (0)