Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Batch labels job #3789

Merged
merged 3 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions batch/create/create_batch_labels_allocation.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,7 @@ async function main() {
// [END batch_labels_allocation]
}

process.on('unhandledRejection', err => {
main().catch(err => {
console.error(err.message);
process.exitCode = 1;
});

main();
113 changes: 113 additions & 0 deletions batch/create/create_batch_labels_job.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
/*
* 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_labels_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-labels-job';
// Name of the label1 to be applied for your Job.
const labelName1 = 'job_label_name_1';
// Value for the label1 to be applied for your Job.
const labelValue1 = 'job_label_value1';
// Name of the label2 to be applied for your Job.
const labelName2 = 'job_label_name_2';
// Value for the label2 to be applied for your Job.
const labelValue2 = 'job_label_value2';

// Define what will be done as part of the job.
const runnable = new batch.Runnable({
container: new batch.Runnable.Container({
imageUri: 'gcr.io/google-containers/busybox',
entrypoint: '/bin/sh',
commands: ['-c', 'echo Hello world! This is task ${BATCH_TASK_INDEX}.'],
}),
});

// Specify what resources are requested by each task.
const computeResource = new batch.ComputeResource({
// In milliseconds per cpu-second. This means the task requires 50% of a single CPUs.
cpuMilli: 500,
// In MiB.
memoryMib: 16,
});

const task = new batch.TaskSpec({
runnables: [runnable],
computeResource,
maxRetryCount: 2,
maxRunDuration: {seconds: 3600},
});

// Tasks are grouped inside a job using TaskGroups.
const group = new batch.TaskGroup({
taskCount: 3,
taskSpec: task,
});

const job = new batch.Job({
name: jobName,
taskGroups: [group],
// We use Cloud Logging as it's an option available out of the box
logsPolicy: new batch.LogsPolicy({
destination: batch.LogsPolicy.Destination.CLOUD_LOGGING,
}),
});

// Labels and their value to be applied to the job and its resources.
job.labels[labelName1] = labelValue1;
job.labels[labelName2] = labelValue2;

// The job's parent is the project and region in which the job will run
const parent = `projects/${projectId}/locations/${region}`;

async function callCreateBatchLabelsJob() {
// Construct request
const request = {
parent,
jobId: jobName,
job,
};

// Run request
const [response] = await batchClient.createJob(request);
console.log(JSON.stringify(response));
}

callCreateBatchLabelsJob();
// [END batch_labels_job]
}

main().catch(err => {
console.error(err.message);
process.exitCode = 1;
});
2 changes: 1 addition & 1 deletion batch/test/create_batch_labels_allocation.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ describe('Create batch labels allocation', async () => {

it('should create a new job with allocation policy labels', async () => {
const expectedAllocationLabels = {
'batch-job-id': 'batch-labels-allocation-job',
'batch-job-id': jobName,
vm_label_name_1: 'vmLabelValue1',
vm_label_name_2: 'vmLabelValue2',
};
Expand Down
56 changes: 56 additions & 0 deletions batch/test/create_batch_labels_job.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* 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';

const path = require('path');
const assert = require('assert');
const {describe, it} = require('mocha');
const cp = require('child_process');
const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
const cwd = path.join(__dirname, '..');
const {BatchServiceClient} = require('@google-cloud/batch').v1;
const {deleteJob} = require('./batchClient_operations');
const batchClient = new BatchServiceClient();

describe('Create batch labels for job', async () => {
const jobName = 'batch-labels-job';
const region = 'europe-central2';
let projectId;

before(async () => {
projectId = await batchClient.getProjectId();
});

after(async () => {
await deleteJob(batchClient, projectId, region, jobName);
});

it('should create a new job with labels', async () => {
const expectedJobLabels = {
job_label_name_1: 'job_label_value1',
job_label_name_2: 'job_label_value2',
};

const response = JSON.parse(
execSync('node ./create/create_batch_labels_job.js', {
cwd,
})
);

assert.deepEqual(response.labels, expectedJobLabels);
});
});