Skip to content

Commit a0eb8ce

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs:Add instructions on how to configure cross-project pubsub publisher
--- docs: document default disk type: pd-standard for non boot disk, pd-balanced for boot disk --- docs: Update list of volume.mount_options field --- docs: Update GCS description of volume.mount_options field --- docs: Update links in the description of volume.mount_options field PiperOrigin-RevId: 646637874
1 parent 76b2166 commit a0eb8ce

2 files changed

Lines changed: 29 additions & 15 deletions

File tree

‎google/cloud/batch/v1alpha/job.proto‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -292,11 +292,19 @@ message JobNotification {
292292
TASK_STATE_CHANGED = 2;
293293
}
294294

295-
// The Pub/Sub topic where notifications like the job state changes
296-
// will be published. The topic must exist in the same project as
297-
// the job and billings will be charged to this project.
298-
// If not specified, no Pub/Sub messages will be sent.
299-
// Topic format: `projects/{project}/topics/{topic}`.
295+
// The Pub/Sub topic where notifications for the job, like state
296+
// changes, will be published. If undefined, no Pub/Sub notifications
297+
// are sent for this job.
298+
//
299+
// Specify the topic using the following format:
300+
// `projects/{project}/topics/{topic}`.
301+
// Notably, if you want to specify a Pub/Sub topic that is in a
302+
// different project than the job, your administrator must grant your
303+
// project's Batch service agent permission to publish to that topic.
304+
//
305+
// For more information about configuring Pub/Sub notifications for
306+
// a job, see
307+
// https://cloud.google.com/batch/docs/enable-notifications.
300308
string pubsub_topic = 1;
301309

302310
// The attribute requirements of messages to be sent to this Pub/Sub topic.
@@ -363,7 +371,9 @@ message AllocationPolicy {
363371
// Disk type as shown in `gcloud compute disk-types list`.
364372
// For example, local SSD uses type "local-ssd".
365373
// Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd"
366-
// or "pd-standard".
374+
// or "pd-standard". If not specified, "pd-standard" will be used as the
375+
// default type for non-boot disks, "pd-balanced" will be used as the
376+
// default type for boot disks.
367377
string type = 1;
368378

369379
// Disk size in GB.

‎google/cloud/batch/v1alpha/volume.proto‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,19 @@ message Volume {
5050
// The mount path for the volume, e.g. /mnt/disks/share.
5151
string mount_path = 4;
5252

53-
// For Google Cloud Storage (GCS), mount options are the options supported by
54-
// the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse).
55-
// For existing persistent disks, mount options provided by the
56-
// mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except
57-
// writing are supported. This is due to restrictions of multi-writer mode
58-
// (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms).
59-
// For other attached disks and Network File System (NFS), mount options are
60-
// these supported by the mount command
61-
// (https://man7.org/linux/man-pages/man8/mount.8.html).
53+
// Mount options vary based on the type of storage volume:
54+
//
55+
// * For a Cloud Storage bucket, all the mount options provided
56+
// by
57+
// the [`gcsfuse` tool](https://cloud.google.com/storage/docs/gcsfuse-cli)
58+
// are supported.
59+
// * For an existing persistent disk, all mount options provided by the
60+
// [`mount` command](https://man7.org/linux/man-pages/man8/mount.8.html)
61+
// except writing are supported. This is due to restrictions of
62+
// [multi-writer
63+
// mode](https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms).
64+
// * For any other disk or a Network File System (NFS), all the
65+
// mount options provided by the `mount` command are supported.
6266
repeated string mount_options = 5;
6367
}
6468

0 commit comments

Comments
 (0)