YellowDog Documentation

Welcome to YellowDog’s customer documentation page. Here you’ll find links to useful information about your YellowDog products.

Contents

This page includes the following sections:

• Release Notes
• YellowDog Platform and Portal
• YellowDog Index
• YellowDog for CGI

Release Notes

• YellowDog product release notes These monthly release notes summarise all the new features and bugfixes provided by YellowDog.

YellowDog Platform and Portal

YellowDog Platform

YellowDog strongly recommends reading the Implementation Guide before referring to the API information, in order to understand the context and workflow.

• Implementation Guide (PDF) Explains how to use the YellowDog API to provision compute and run applications in the cloud. You will also need to refer to the relevant API document.
• YellowDog Scheduler Service (PDF) A conceptual and architectural introduction to the scheduler service.
• API documents Detailed API information for Java and Python.

YellowDog Portal

• Portal Help (WebHelp) Explains how to set up, use and troubleshoot provisioning and applications via the YellowDog Portal.
• Portal User Guide (PDF) As above, but in PDF format.

YellowDog Index

• YellowDog Index Help (WebHelp) Explains how to use the YellowDog Index to find the best source of compute for your requirements.
• Guide to the YellowDog Index (PDF) As above, but in PDF format.

YellowDog for CGI

• Guide to the YellowDog User Interface (PDF) A short guide to using YellowDog for CGI from the web interface.
• Exporting from Modo (PDF) A detailed technical guide to using the YellowDog Modo plugin from the command line.
• Using YellowDog with Deadline (PDF) A simple guide to using Deadline Monitor to create and control additional YellowDog rendering instances. (This document replaces the previous Deadline Plugin Quick Start Guide)
• YellowDog for CGI API Detailed API information for YellowDog for CGI. Access to this API requires a login.
• API Guide (PDF) A guide to using the CGI API to perform common tasks.