feat: [google-cloud-batch] Add TaskGroup.enable_oslogin to give the Batch job submitter the ability to run runnables as non-root controlled by IAM (googleapis#12041)

gcf-owl-bot[bot] · web-flow · commit 5392065c6288 · 2023-11-21T10:46:17.000-05:00
- [ ] Regenerate this pull request now. BEGIN_COMMIT_OVERRIDE docs: Update documentation for the network field of AllocationPolicy feat: Add TaskGroup.enable_oslogin to give the Batch job submitter the ability to run runnables as non-root controlled by IAM END_COMMIT_OVERRIDE PiperOrigin-RevId: 584258085 Source-Link: googleapis/googleapis@0f85c39 Source-Link: https://github.com/googleapis/googleapis-gen/commit/b07e603f8671a6b281e4c3edb92ff219da25b30c Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhdGNoLy5Pd2xCb3QueWFtbCIsImgiOiJiMDdlNjAzZjg2NzFhNmIyODFlNGMzZWRiOTJmZjIxOWRhMjViMzBjIn0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/packages/google-cloud-batch/google/cloud/batch/gapic_version.py b/packages/google-cloud-batch/google/cloud/batch/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.17.4"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1/gapic_version.py b/packages/google-cloud-batch/google/cloud/batch_v1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.17.4"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1alpha/gapic_version.py b/packages/google-cloud-batch/google/cloud/batch_v1alpha/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.17.4"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1alpha/types/job.py b/packages/google-cloud-batch/google/cloud/batch_v1alpha/types/job.py
@@ -541,6 +541,11 @@ class AllocationPolicy(proto.Message):
             reserved.
         network (google.cloud.batch_v1alpha.types.AllocationPolicy.NetworkPolicy):
             The network policy.
+
+            If you define an instance template in the
+            InstancePolicyOrTemplate field, Batch will use
+            the network settings in the instance template
+            instead of this field.
         placement (google.cloud.batch_v1alpha.types.AllocationPolicy.PlacementPolicy):
             The placement policy.
     """
@@ -1120,6 +1125,19 @@ class TaskGroup(proto.Message):
             When true, Batch will configure SSH to allow
             passwordless login between VMs running the Batch
             tasks in the same TaskGroup.
+        enable_oslogin (bool):
+            Optional. When true, Batch will use the OS Login generated
+            POSIX account to exeucute the runnables instead of the
+            default root user.
+
+            | To control root or non-root privilege for runnable
+              execution, the project
+            | Admin user needs to configure IAM roles according to
+              https://cloud.google.com/compute/docs/oslogin/set-up-oslogin#configure_users.
+              Specifically, if a root execution is needed, the
+              roles/compute.osAdminLogin should be granted to the Batch
+              job submitter. Otherwise, roles/compute.osLogin should be
+              granted to the Batch job submitter.
     """
 
     class SchedulingPolicy(proto.Enum):
@@ -1191,6 +1209,10 @@ class SchedulingPolicy(proto.Enum):
         proto.BOOL,
         number=12,
     )
+    enable_oslogin: bool = proto.Field(
+        proto.BOOL,
+        number=13,
+    )
 
 
 class ServiceAccount(proto.Message):
diff --git a/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1.json b/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-batch",
-    "version": "0.17.4"
+    "version": "0.1.0"
   },
   "snippets": [
     {
diff --git a/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1alpha.json b/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1alpha.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-batch",
-    "version": "0.17.4"
+    "version": "0.1.0"
   },
   "snippets": [
     {
diff --git a/packages/google-cloud-batch/tests/unit/gapic/batch_v1alpha/test_batch_service.py b/packages/google-cloud-batch/tests/unit/gapic/batch_v1alpha/test_batch_service.py
@@ -2687,6 +2687,7 @@ def test_create_job_rest(request_type):
                 "task_count_per_node": 2022,
                 "require_hosts_file": True,
                 "permissive_ssh": True,
+                "enable_oslogin": True,
             }
         ],
         "scheduling_policy": 1,

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@`
`13`	`13`	`# See the License for the specific language governing permissions and`
`14`	`14`	`# limitations under the License.`
`15`	`15`	`#`
`16`		`-__version__ = "0.17.4" # {x-release-please-version}`
	`16`	`+__version__ = "0.0.0" # {x-release-please-version}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`],`
`9`	`9`	`"language": "PYTHON",`
`10`	`10`	`"name": "google-cloud-batch",`
`11`		`- "version": "0.17.4"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2687,6 +2687,7 @@ def test_create_job_rest(request_type):`
`2687`	`2687`	`"task_count_per_node": 2022,`
`2688`	`2688`	`"require_hosts_file": True,`
`2689`	`2689`	`"permissive_ssh": True,`
	`2690`	`+ "enable_oslogin": True,`
`2690`	`2691`	`}`
`2691`	`2692`	`],`
`2692`	`2693`	`"scheduling_policy": 1,`