docs: Batch CentOS images and HPC CentOS images are EOS

Google APIs · copybara-github · commit 906736032699 · 2024-08-13T10:09:36.000-07:00
docs: Clarify required fields for Runnable.Container
docs: Clarify required oneof fields for Runnable.Script
docs: Clarify TaskSpec requires one or more runnables

PiperOrigin-RevId: 662559250
diff --git a/google/cloud/batch/v1/job.proto b/google/cloud/batch/v1/job.proto
@@ -293,9 +293,7 @@ message AllocationPolicy {
       // The following image values are supported for a boot disk:
       //
       // * `batch-debian`: use Batch Debian images.
-      // * `batch-centos`: use Batch CentOS images.
       // * `batch-cos`: use Batch Container-Optimized images.
-      // * `batch-hpc-centos`: use Batch HPC CentOS images.
       // * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.
       string image = 4;
 
diff --git a/google/cloud/batch/v1/task.proto b/google/cloud/batch/v1/task.proto
@@ -157,32 +157,36 @@ message TaskStatus {
 message Runnable {
   // Container runnable.
   message Container {
-    // The URI to pull the container image from.
+    // Required. The URI to pull the container image from.
     string image_uri = 1;
 
-    // Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
-    // (either in the container image or with the entrypoint field below) then
-    // commands are appended as arguments to the ENTRYPOINT.
+    // Required for some container images. Overrides the `CMD` specified in the
+    // container. If there is an `ENTRYPOINT` (either in the container image or
+    // with the `entrypoint` field below) then these commands are appended as
+    // arguments to the `ENTRYPOINT`.
     repeated string commands = 2;
 
-    // Overrides the `ENTRYPOINT` specified in the container.
+    // Required for some container images. Overrides the `ENTRYPOINT` specified
+    // in the container.
     string entrypoint = 3;
 
     // Volumes to mount (bind mount) from the host machine files or directories
-    // into the container, formatted to match docker run's --volume option,
-    // e.g. /foo:/bar, or /foo:/bar:ro
+    // into the container, formatted to match `--volume` option for the
+    // `docker run` command&mdash;for example, `/foo:/bar` or `/foo:/bar:ro`.
     //
     // If the `TaskSpec.Volumes` field is specified but this field is not, Batch
     // will mount each volume from the host machine to the container with the
     // same mount path by default. In this case, the default mount option for
-    // containers will be read-only (ro) for existing persistent disks and
-    // read-write (rw) for other volume types, regardless of the original mount
-    // options specified in `TaskSpec.Volumes`. If you need different mount
-    // settings, you can explicitly configure them in this field.
+    // containers will be read-only (`ro`) for existing persistent disks and
+    // read-write (`rw`) for other volume types, regardless of the original
+    // mount options specified in `TaskSpec.Volumes`. If you need different
+    // mount settings, you can explicitly configure them in this field.
     repeated string volumes = 7;
 
-    // Arbitrary additional options to include in the "docker run" command when
-    // running this container, e.g. "--network host".
+    // Required for some container images. Arbitrary additional options to
+    // include in the `docker run` command when running this container&mdash;for
+    // example, `--network host`. For the `--volume` option, use the `volumes`
+    // field for the container.
     string options = 8;
 
     // If set to true, external network access to and from container will be
@@ -248,37 +252,41 @@ message Runnable {
 
   // Script runnable.
   message Script {
+    // Required. The source code for this script runnable.
     oneof command {
-      // Script file path on the host VM.
+      // The path to a script file that is accessible from the host VM(s).
       //
-      // To specify an interpreter, please add a `#!<interpreter>`(also known as
-      // [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
-      // first line of the file.(For example, to execute the script using bash,
-      // `#!/bin/bash` should be the first line of the file. To execute the
-      // script using`Python3`, `#!/usr/bin/env python3` should be the first
-      // line of the file.) Otherwise, the file will by default be executed by
-      // `/bin/sh`.
+      // Unless the script file supports the default `#!/bin/sh` shell
+      // interpreter, you must specify an interpreter by including a
+      // [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the
+      // first line of the file. For example, to execute the script using bash,
+      // include `#!/bin/bash` as the first line of the file. Alternatively,
+      // to execute the script using Python3, include `#!/usr/bin/env python3`
+      // as the first line of the file.
       string path = 1;
 
-      // Shell script text.
+      // The text for a script.
       //
-      // To specify an interpreter, please add a `#!<interpreter>\n` at the
-      // beginning of the text.(For example, to execute the script using bash,
-      // `#!/bin/bash\n` should be added. To execute the script using`Python3`,
-      // `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
-      // by default be executed by `/bin/sh`.
+      // Unless the script text supports the default `#!/bin/sh` shell
+      // interpreter, you must specify an interpreter by including a
+      // [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the
+      // beginning of the text. For example, to execute the script using bash,
+      // include `#!/bin/bash\n` at the beginning of the text. Alternatively,
+      // to execute the script using Python3, include `#!/usr/bin/env python3\n`
+      // at the beginning of the text.
       string text = 2;
     }
   }
 
-  // Barrier runnable blocks until all tasks in a taskgroup reach it.
+  // A barrier runnable automatically blocks the execution of subsequent
+  // runnables until all the tasks in the task group reach the barrier.
   message Barrier {
     // Barriers are identified by their index in runnable list.
     // Names are not required, but if present should be an identifier.
     string name = 1;
   }
 
-  // The script or container to run.
+  // Required. The script, container, or barrier for this runnable to execute.
   oneof executable {
     // Container runnable.
     Container container = 1;
@@ -328,10 +336,12 @@ message Runnable {
 
 // Spec of a task
 message TaskSpec {
-  // The sequence of scripts or containers to run for this Task. Each Task using
-  // this TaskSpec executes its list of runnables in order. The Task succeeds if
-  // all of its runnables either exit with a zero status or any that exit with a
-  // non-zero status have the ignore_exit_status flag.
+  // Required. The sequence of one or more runnables (executable scripts,
+  // executable containers, and/or barriers) for each task in this task group to
+  // run. Each task runs this list of runnables in order. For a task to succeed,
+  // all of its script and container runnables each must either exit with a zero
+  // status or enable the `ignore_exit_status` subfield and exit with any
+  // status.
   //
   // Background runnables are killed automatically (if they have not already
   // exited) a short time after all foreground runnables have completed. Even
