Skip to content

Commit 37c3db1

Browse files
gcf-owl-bot[bot]alexander-fenster
gcf-owl-bot[bot]
and
alexander-fenster
authored
docs: Refine GPU drivers installation proto description (#3433)
* feat: Enable install_gpu_drivers flag in v1 proto docs: Refine GPU drivers installation proto description docs: Refine comments for deprecated proto fields docs: Update the API comments about the device_name PiperOrigin-RevId: 481212993 Source-Link: googleapis/googleapis@b037bb3 Source-Link: googleapis/googleapis-gen@60e247b Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhdGNoLy5Pd2xCb3QueWFtbCIsImgiOiI2MGUyNDdiZDEwODJlNzA2YzQyYzExNTQ1MzIxNGI5ZmIwMzU0ODY0In0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: Refine GPU drivers installation proto description docs: Refine comments for deprecated proto fields docs: Update the API comments about the device_name PiperOrigin-RevId: 481282173 Source-Link: googleapis/googleapis@e981f84 Source-Link: googleapis/googleapis-gen@f550f5e Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhdGNoLy5Pd2xCb3QueWFtbCIsImgiOiJmNTUwZjVlNDVkN2I5ZDVjZjkyYmU5NmRiMmRlNWNjMmE4MDg4YzM5In0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Alexander Fenster <[email protected]>
1 parent 6059d1a commit 37c3db1

5 files changed

Lines changed: 424 additions & 16 deletions

File tree

‎packages/google-cloud-batch/protos/google/cloud/batch/v1/job.proto‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,9 @@ message AllocationPolicy {
274274
}
275275

276276
// Device name that the guest operating system will see.
277-
// If not specified, this is default to the disk name.
277+
// It is used by Runnable.volumes field to mount disks. So please specify
278+
// the device_name if you want Batch to help mount the disk, and it should
279+
// match the device_name field in volumes.
278280
string device_name = 3;
279281
}
280282

@@ -287,6 +289,7 @@ message AllocationPolicy {
287289
// The number of accelerators of this type.
288290
int64 count = 2;
289291

292+
// Deprecated: please use instances[0].install_gpu_drivers instead.
290293
bool install_gpu_drivers = 3 [deprecated = true];
291294
}
292295

@@ -325,6 +328,12 @@ message AllocationPolicy {
325328
// c++ keyword conflict.
326329
string instance_template = 2;
327330
}
331+
332+
// Set this field true if users want Batch to help fetch drivers from a
333+
// third party location and install them for GPUs specified in
334+
// policy.accelerators or instance_template on their behalf. Default is
335+
// false.
336+
bool install_gpu_drivers = 3;
328337
}
329338

330339
// A network interface.
@@ -378,6 +387,9 @@ message AllocationPolicy {
378387
// Only instances[0] is supported now.
379388
repeated InstancePolicyOrTemplate instances = 8;
380389

390+
// Service account that VMs will run as.
391+
ServiceAccount service_account = 9;
392+
381393
// Labels applied to all VM instances and other resources
382394
// created by AllocationPolicy.
383395
// Labels could be user provided or system generated.
@@ -443,3 +455,12 @@ message TaskGroup {
443455
// VMs running the Batch tasks in the same TaskGroup.
444456
bool permissive_ssh = 12;
445457
}
458+
459+
// Carries information about a Google Cloud service account.
460+
message ServiceAccount {
461+
// Email address of the service account. If not specified, the default
462+
// Compute Engine service account for the project will be used. If instance
463+
// template is being used, the service account has to be specified in the
464+
// instance template and it has to match the email field here.
465+
string email = 1;
466+
}

‎packages/google-cloud-batch/protos/google/cloud/batch/v1alpha/job.proto‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ message Job {
9292
// Output only. Job status. It is read only for users.
9393
JobStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
9494

95-
// Job notification.
95+
// Deprecated: please use notifications instead.
9696
JobNotification notification = 10 [deprecated = true];
9797

9898
// Output only. When the Job was created.
@@ -329,7 +329,9 @@ message AllocationPolicy {
329329
}
330330

331331
// Device name that the guest operating system will see.
332-
// If not specified, this is default to the disk name.
332+
// It is used by Runnable.volumes field to mount disks. So please specify
333+
// the device_name if you want Batch to help mount the disk, and it should
334+
// match the device_name field in volumes.
333335
string device_name = 3;
334336
}
335337

@@ -342,12 +344,14 @@ message AllocationPolicy {
342344
// The number of accelerators of this type.
343345
int64 count = 2;
344346

347+
// Deprecated: please use instances[0].install_gpu_drivers instead.
345348
bool install_gpu_drivers = 3 [deprecated = true];
346349
}
347350

348351
// InstancePolicy describes an instance type and resources attached to each VM
349352
// created by this InstancePolicy.
350353
message InstancePolicy {
354+
// Deprecated: please use machine_type instead.
351355
repeated string allowed_machine_types = 1 [deprecated = true];
352356

353357
// The Compute Engine machine type.
@@ -383,6 +387,10 @@ message AllocationPolicy {
383387
string instance_template = 2;
384388
}
385389

390+
// Set this field true if users want Batch to help fetch drivers from a
391+
// third party location and install them for GPUs specified in
392+
// policy.accelerators or instance_template on their behalf. Default is
393+
// false.
386394
bool install_gpu_drivers = 3;
387395
}
388396

@@ -433,29 +441,23 @@ message AllocationPolicy {
433441
// Location where compute resources should be allocated for the Job.
434442
LocationPolicy location = 1;
435443

436-
// Create only instances allowed by this policy.
444+
// Deprecated: please use instances[0].policy instead.
437445
InstancePolicy instance = 2 [deprecated = true];
438446

439447
// Describe instances that can be created by this AllocationPolicy.
440448
// Only instances[0] is supported now.
441449
repeated InstancePolicyOrTemplate instances = 8;
442450

443-
// Instance templates that are used to VMs.
444-
// If specified, only instance_templates[0] is used.
451+
// Deprecated: please use instances[0].template instead.
445452
repeated string instance_templates = 3 [deprecated = true];
446453

447-
// Create only instances in the listed provisiong models.
448-
// Default to allow all.
449-
//
450-
// Currently only the first model of the provisioning_models list will be
451-
// considered; specifying additional models (e.g., 2nd, 3rd, etc.) is a no-op.
454+
// Deprecated: please use instances[i].policy.provisioning_model instead.
452455
repeated ProvisioningModel provisioning_models = 4 [deprecated = true];
453456

454-
// Email of the service account that VMs will run as.
457+
// Deprecated: please use service_account instead.
455458
string service_account_email = 5 [deprecated = true];
456459

457460
// Service account that VMs will run as.
458-
// Not yet implemented.
459461
ServiceAccount service_account = 9;
460462

461463
// Labels applied to all VM instances and other resources
@@ -551,10 +553,12 @@ message TaskGroup {
551553
// Carries information about a Google Cloud service account.
552554
message ServiceAccount {
553555
// Email address of the service account. If not specified, the default
554-
// Compute Engine service account for the project will be used.
556+
// Compute Engine service account for the project will be used. If instance
557+
// template is being used, the service account has to be specified in the
558+
// instance template and it has to match the email field here.
555559
string email = 1;
556560

557561
// List of scopes to be enabled for this service account on the VM, in
558562
// addition to the cloud-platform API scope that will be added by default.
559-
repeated string scopes = 2;
563+
repeated string scopes = 2 [deprecated = true];
560564
}

‎packages/google-cloud-batch/protos/protos.d.ts‎

Lines changed: 109 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)