Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 3.53 KB

README.md

File metadata and controls

95 lines (58 loc) · 3.53 KB

PowerShell Solution Template

This directory contains simple, skeleton components for submitting and running Tasks using PowerShell scripts or commands on Windows instances. A simple example script is provided as a starting point, and this can be extended as required.

Prerequisites

Please ensure you've installed the YellowDog Python Examples scripts and that you've set up your YellowDog account. At a minimum, you'll need an Application Key and Secret, and a Compute Template ID.

The nodes in the Provisioned Worker Pool(s) must be configured to support the powershell Task Type.

Usage

All yd- commands described below should be run from within this (powershell) directory.

Configuration

The config-template.toml file in this directory contains a template for the required configuration data to run the commands below.

First, copy config-template.toml to a new file config.toml in the same directory. Then, edit the following three properties in the config.toml file:

  1. key: Insert the Key of the YellowDog Application you wish to use
  2. secret: Insert the Secret of the YellowDog Application you wish to use
  3. templateId: The ID of the Compute Template to use for provisioning Worker Pools. (The ID has a form like ydid:crt:D9C548:fa40a830-dff3-44e1-a330-8331a4a68d4a and can be obtained from the Compute Template's page in the YellowDog Portal.)

The Compute Template must use a suitable Windows virtual machine image, with the YellowDog Agent installed.

All other properties can be left at their default values.

Provisioning Worker Pools

yd-provision

The yd-provision command will provision a Worker Pool using the Compute Template specified by templateId in the config.toml file.

You can also adjust the number of instances in the Worker Pool by changing the configuration's variables, e.g.:

yd-provision -v instances=10 -v max_instances=20

Submitting Work Requirements

yd-submit

The yd-submit command will submit a single Task for execution by one of the Workers in the Worker Pool.

When a Task is complete its console output can be inspected in the Object Store in file taskoutput.txt.

Multiple (identical) Tasks can be submitted by altering the taskCount, e.g.:

yd-submit -C 100

To run PowerShell commands directly (as if typed at a PowerShell command line) instead of via an uploaded script, omit the executable property and use the following form in the arguments property in the workRequirement section:

arguments = ["-Command", "echo 'Hello World!'"]

Downloading Results

yd-download

The yd-download command will download the results of your Work Requirements to your local filesystem, in a directory named using the namespace property.

Cancelling Work Requirements

yd-cancel

This will cancel any Work Requirements that are still running. (Add the --abort option to abort any currently running Tasks, otherwise they'll run to completion.)

Shutting Down Worker Pools

yd-shutdown

The yd-shutdown command will shut down your Worker Pool(s). Note that Worker Pools will automatically shut down after being idle for the period of time specified in the config.toml file.

Deleting YellowDog Objects

yd-delete

The yd-delete command cleans up all of your objects in the YellowDog Object Store, using the namespace and tag for matching.