Shepard-Setups

Shepard setups from the Shepard User Community for use by anyone.

If you add a setup please make sure to add documentation inside the folder containing your setup so fellow Shepard users know how to run jobs on the setup and any other useful information!

Table of contents

• Shepard-Setups
  • Getting Started Using These Setups
    • Instantiating a Flock and Deploying Code to it
    • Hello World Example
  • Joining the Shepard Dev Team
    • How to Join the Team
    • General Team rules

Getting Started Using These Setups

Instantiating a Flock and Deploying Code to it

Deploying your code to Shepard and instantiating a new flock or reconfiguring an existing flock is all accomplished with one command: shepard deploy.

You can either use Shepard deploy with a deployment folder hosted publicly in the Shepard-Setups repository or use one hosted on your local machine.

The Shepard CLI will detect this for you automatically when you go to run Shepard deploy. If your argument to path_to_deployment_folder is an absolute filepath then Shepard CLI will look locally on your machine for a deployment folder. If path_to_deployment_folder is a string then Shepard CLI will check Shepard-Setups for a folder with the same name and use that as your deployment folder.

A properly formatted Shepard deployment folder is a directory containing two sub-directories; one named "code" and another named "infrastructure".

Hello World Example

#install shepard
pip3 install shepard

#deploy our testing infrastructure and code
shepard deploy --cloudformation_stack_name testing --path_to_deployment_folder testing-setup

#this job will fail
shepard batch_via_api --json_payload '{"an_example_variable_name":"an_example_variable_value"}'

#this job will succeed
shepard batch_via_api --json_payload '{"test1":"test1","test2":"test2","test3":"test3","test4":"0"}'

#after the jobs complete you can tear down the infrastructure with the following command
shepard destroy --cloudformation_stack_name testing

Joining the Shepard Dev Team

How to Join the Team

Send an email to the Shepard Dev Team at [email protected]. Ask that you be added to the Google user group and the github repos which are, for reference, this repo and the Shepard Setups repo.

General Team rules

1. Be nice to each other!
2. Have fun!