Merge branch 'main' into renovate/all

Author: subfuzion

.github/blunderbuss.yml

@@ -50,6 +50,10 @@ assign_issues_by:
   - 'api: documentai'
   to:
   - GoogleCloudPlatform/document-ai-samples-contributors
+- labels:
+  - "api: routeoptimization"
+  to:
+  - GoogleCloudPlatform/geo-routeoptimization
 
 assign_prs_by:
 - labels:
@@ -89,3 +93,7 @@ assign_prs_by:
     - 'api: documentai'
   to:
     - GoogleCloudPlatform/document-ai-samples-contributors
+- labels:
+  - "api: routeoptimization"
+  to:
+  - GoogleCloudPlatform/geo-routeoptimization

.github/workflows/functions-slack.yaml

@@ -41,22 +41,22 @@ jobs:
     timeout-minutes: 120
     steps:
     - uses: actions/[email protected]
-        with:
-          ref: ${{github.event.pull_request.head.sha}}
+      with:
+        ref: ${{github.event.pull_request.head.sha}}
     - uses: 'google-github-actions/[email protected]'
-        with:
-          workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
-          service_account: '[email protected]'
-          create_credentials_file: 'true'
-          access_token_lifetime: 600s
+      with:
+        workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
+        service_account: '[email protected]'
+        create_credentials_file: 'true'
+        access_token_lifetime: 600s
     - id: secrets
         uses: 'google-github-actions/get-secretmanager-secrets@v2'
         with:
           secrets: |-
             slack_secret:nodejs-docs-samples-tests/nodejs-docs-samples-slack-secret
             kg_api_key:nodejs-docs-samples-tests/nodejs-docs-samples-kg-api-key
     - uses: actions/[email protected]
-        with:
+      with:
           node-version: 16
     - name: Get npm cache directory
         id: npm-cache-dir
@@ -70,23 +70,23 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-
     - name: set env vars for scheduled run
-        if: github.event.action == 'schedule'
-        run: |
+      if: github.event.action == 'schedule'
+      run: |
           echo "MOCHA_REPORTER_SUITENAME=functions-slack" >> $GITHUB_ENV
           echo "MOCHA_REPORTER_OUTPUT=${{github.run_id}}_sponge_log.xml" >> $GITHUB_ENV
           echo "MOCHA_REPORTER=xunit" >> $GITHUB_ENV
     - name: Run Tests
-        run: make test dir=functions/slack
-        env:
+      run: make test dir=functions/slack
+      env:
           GOOGLE_SAMPLES_PROJECT: "long-door-651"
           SLACK_SECRET: ${{ steps.secrets.outputs.slack_secret }}
           KG_API_KEY: ${{ steps.secrets.outputs.kg_api_key }}
     - name: upload test results for FlakyBot workflow
-        if: github.event.action == 'schedule' && always()
-        uses: actions/upload-artifact@v3
-        env:
+      if: github.event.action == 'schedule' && always()
+      uses: actions/upload-artifact@v3
+      env:
           MOCHA_REPORTER_OUTPUT: "${{github.run_id}}_sponge_log.xml"
-        with:
+      with:
           name: test-results
           path: functions/slack/${{ env.MOCHA_REPORTER_OUTPUT }}
           retention-days: 1

CODEOWNERS

@@ -69,3 +69,4 @@ security-center @GoogleCloudPlatform/gcp-security-command-center @GoogleCloudPla
 retail @GoogleCloudPlatform/cloud-retail-team @GoogleCloudPlatform/nodejs-samples-reviewers @GoogleCloudPlatform/cloud-samples-reviewers
 media @GoogleCloudPlatform/cloud-media-team @GoogleCloudPlatform/nodejs-samples-reviewers @GoogleCloudPlatform/cloud-samples-reviewers
 healthcare @GoogleCloudPlatform/healthcare-life-sciences @GoogleCloudPlatform/nodejs-samples-reviewers @GoogleCloudPlatform/cloud-samples-reviewers
+routeoptimization @GoogleCloudPlatform/geo-routeoptimization @GoogleCloudPlatform/nodejs-samples-reviewers @GoogleCloudPlatform/cloud-samples-reviewers

batch/create/create_batch_notifications.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -55,14 +55,6 @@ async function main() {
   group.taskCount = 3;
   group.taskSpec = task;
 
-  const job = new batch.Job();
-  job.name = JOB_NAME;
-  job.taskGroups = [group];
-  job.labels = {env: 'testing', type: 'script'};
-  // We use Cloud Logging as it's an option available out of the box
-  job.logsPolicy = new batch.LogsPolicy();
-  job.logsPolicy.destination = batch.LogsPolicy.Destination.CLOUD_LOGGING;
-
   // Create batch notification when job state changed
   const notification1 = new batch.JobNotification();
   notification1.pubsubTopic = `projects/${PROJECT_ID}/topics/${TOPIC_ID}`;
@@ -78,6 +70,7 @@ async function main() {
     newTaskState: 'FAILED',
   };
 
+  const job = new batch.Job();
   job.name = JOB_NAME;
   job.taskGroups = [group];
   job.notifications = [notification1, notification2];
@@ -101,13 +94,11 @@ async function main() {
     console.log(JSON.stringify(response));
   }
 
-  callCreateBatchNotifications();
+  await callCreateBatchNotifications();
   // [END batch_notifications]
 }
 
-process.on('unhandledRejection', err => {
+main().catch(err => {
   console.error(err.message);
   process.exitCode = 1;
 });
-
-main();

batch/create/create_batch_using_service_account.js

@@ -0,0 +1,108 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+// [START batch_create_custom_service_account]
+// Imports the Batch library
+const batchLib = require('@google-cloud/batch');
+const batch = batchLib.protos.google.cloud.batch.v1;
+// Instantiates a client
+const batchClient = new batchLib.v1.BatchServiceClient();
+
+async function main() {
+  /**
+   * TODO(developer): Update these variables before running the sample.
+   */
+  // Project ID or project number of the Google Cloud project you want to use.
+  const projectId = await batchClient.getProjectId();
+  // Name of the region you want to use to run the job. Regions that are
+  // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
+  const region = 'europe-central2';
+  // The name of the job that will be created.
+  // It needs to be unique for each project and region pair.
+  const jobName = 'batch-service-account-job';
+  /**
+   * TODO(developer): Uncomment and update serviceAccountEmail if you do not want to use default Compute Engine service account.
+   */
+  // The email address of your service account.
+  // const serviceAccountEmail = 'email';
+  let serviceAccountEmail;
+
+  // Define what will be done as part of the job.
+  const runnable = new batch.Runnable({
+    script: new batch.Runnable.Script({
+      commands: ['-c', 'echo Hello world! This is task ${BATCH_TASK_INDEX}.'],
+    }),
+  });
+
+  const task = new batch.TaskSpec({
+    runnables: [runnable],
+    maxRetryCount: 2,
+    maxRunDuration: {seconds: 3600},
+  });
+
+  // Tasks are grouped inside a job using TaskGroups.
+  const group = new batch.TaskGroup({
+    taskCount: 3,
+    taskSpec: task,
+  });
+
+  const serviceAccount = new batch.ServiceAccount();
+
+  if (serviceAccountEmail) {
+    serviceAccount.email = serviceAccountEmail;
+  }
+
+  const allocationPolicy = new batch.AllocationPolicy({
+    // If the serviceAccount field is not specified, the value is set to the default Compute Engine service account.
+    serviceAccount,
+  });
+
+  const job = new batch.Job({
+    name: jobName,
+    taskGroups: [group],
+    labels: {env: 'testing', type: 'script'},
+    allocationPolicy,
+    // We use Cloud Logging as it's an option available out of the box
+    logsPolicy: new batch.LogsPolicy({
+      destination: batch.LogsPolicy.Destination.CLOUD_LOGGING,
+    }),
+  });
+
+  // The job's parent is the project and region in which the job will run
+  const parent = `projects/${projectId}/locations/${region}`;
+
+  async function callCreateBatchServiceAccountJob() {
+    // Construct request
+    const request = {
+      parent,
+      jobId: jobName,
+      job,
+    };
+
+    // Run request
+    const [response] = await batchClient.createJob(request);
+    console.log(JSON.stringify(response));
+  }
+  await callCreateBatchServiceAccountJob();
+  // [END batch_create_custom_service_account]
+}
+
+main().catch(err => {
+  console.error(err);
+  process.exitCode = 1;
+});

batch/create/create_gpu_job.js

@@ -0,0 +1,123 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+async function main() {
+  // [START batch_create_gpu_job]
+  // Imports the Batch library
+  const batchLib = require('@google-cloud/batch');
+  const batch = batchLib.protos.google.cloud.batch.v1;
+
+  // Instantiates a client
+  const batchClient = new batchLib.v1.BatchServiceClient();
+
+  /**
+   * TODO(developer): Update these variables before running the sample.
+   */
+  const projectId = await batchClient.getProjectId();
+  // Name of the region you want to use to run the job. Regions that are
+  // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
+  const region = 'europe-central2';
+  // The name of the job that will be created.
+  // It needs to be unique for each project and region pair.
+  const jobName = 'batch-gpu-job';
+  // The GPU type. You can view a list of the available GPU types
+  // by using the `gcloud compute accelerator-types list` command.
+  const gpuType = 'nvidia-l4';
+  // The number of GPUs of the specified type.
+  const gpuCount = 1;
+  // Optional. When set to true, Batch fetches the drivers required for the GPU type
+  // that you specify in the policy field from a third-party location,
+  // and Batch installs them on your behalf. If you set this field to false (default),
+  // you need to install GPU drivers manually to use any GPUs for this job.
+  const installGpuDrivers = false;
+  // Accelerator-optimized machine types are available to Batch jobs. See the list
+  // of available types on: https://cloud.google.com/compute/docs/accelerator-optimized-machines
+  const machineType = 'g2-standard-4';
+
+  // Define what will be done as part of the job.
+  const runnable = new batch.Runnable({
+    script: new batch.Runnable.Script({
+      commands: ['-c', 'echo Hello world! This is task ${BATCH_TASK_INDEX}.'],
+    }),
+  });
+
+  const task = new batch.TaskSpec({
+    runnables: [runnable],
+    maxRetryCount: 2,
+    maxRunDuration: {seconds: 3600},
+  });
+
+  // Tasks are grouped inside a job using TaskGroups.
+  const group = new batch.TaskGroup({
+    taskCount: 3,
+    taskSpec: task,
+  });
+
+  // Policies are used to define on what kind of virtual machines the tasks will run on.
+  // In this case, we tell the system to use "g2-standard-4" machine type.
+  // Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
+  const instancePolicy = new batch.AllocationPolicy.InstancePolicy({
+    machineType,
+    // Accelerator describes Compute Engine accelerators to be attached to the VM
+    accelerators: [
+      new batch.AllocationPolicy.Accelerator({
+        type: gpuType,
+        count: gpuCount,
+        installGpuDrivers,
+      }),
+    ],
+  });
+
+  const allocationPolicy = new batch.AllocationPolicy.InstancePolicyOrTemplate({
+    instances: [{installGpuDrivers, policy: instancePolicy}],
+  });
+
+  const job = new batch.Job({
+    name: jobName,
+    taskGroups: [group],
+    labels: {env: 'testing', type: 'script'},
+    allocationPolicy,
+    // We use Cloud Logging as it's an option available out of the box
+    logsPolicy: new batch.LogsPolicy({
+      destination: batch.LogsPolicy.Destination.CLOUD_LOGGING,
+    }),
+  });
+  // The job's parent is the project and region in which the job will run
+  const parent = `projects/${projectId}/locations/${region}`;
+
+  async function callCreateBatchGPUJob() {
+    // Construct request
+    const request = {
+      parent,
+      jobId: jobName,
+      job,
+    };
+
+    // Run request
+    const [response] = await batchClient.createJob(request);
+    console.log(JSON.stringify(response));
+  }
+
+  await callCreateBatchGPUJob();
+  // [END batch_create_gpu_job]
+}
+
+main().catch(err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});