CINXE.COM
OpenCue overview | OpenCue
<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="Hugo 0.63.2" /> <META NAME="ROBOTS" CONTENT="INDEX, FOLLOW"> <meta name="description" content="An introduction to OpenCue " /> <link rel="shortcut icon" href="/favicons/favicon.ico" > <link rel="apple-touch-icon" href="/favicons/apple-touch-icon-180x180.png" sizes="180x180"> <link rel="icon" type="image/png" href="/favicons/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="/favicons/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/favicons/android-36x36.png" sizes="36x36"> <link rel="icon" type="image/png" href="/favicons/android-48x48.png" sizes="48x48"> <link rel="icon" type="image/png" href="/favicons/android-72x72.png" sizes="72x72"> <link rel="icon" type="image/png" href="/favicons/android-96x96.png" sizes="96x96"> <link rel="icon" type="image/png" href="/favicons/android-144x144.png" sizes="144x144"> <link rel="icon" type="image/png" href="/favicons/android-192x192.png" sizes="192x192"> <title>OpenCue overview | OpenCue</title><meta property="og:title" content="OpenCue overview" /> <meta property="og:description" content="An introduction to OpenCue " /> <meta property="og:type" content="article" /> <meta property="og:url" content="https://www.opencue.io/docs/concepts/opencue-overview/" /> <meta property="article:published_time" content="2019-02-22T00:00:00+00:00" /> <meta property="article:modified_time" content="2019-11-07T08:23:32+00:00" /><meta property="og:site_name" content="OpenCue" /> <meta itemprop="name" content="OpenCue overview"> <meta itemprop="description" content="An introduction to OpenCue "> <meta itemprop="datePublished" content="2019-02-22T00:00:00+00:00" /> <meta itemprop="dateModified" content="2019-11-07T08:23:32+00:00" /> <meta itemprop="wordCount" content="312"> <meta itemprop="keywords" content="" /><meta name="twitter:card" content="summary"/> <meta name="twitter:title" content="OpenCue overview"/> <meta name="twitter:description" content="An introduction to OpenCue "/> <script type="application/javascript"> var doNotTrack = false; if (!doNotTrack) { window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; ga('create', 'UA-82811140-32', 'auto'); ga('send', 'pageview'); } </script> <script async src='https://www.google-analytics.com/analytics.js'></script> <link rel="preload" href="/scss/main.min.9fbae600351894799fb23f12c2dbbb3d5f0449a5d1b1c6d3eb293f7c356831bb.css" as="style"> <link href="/scss/main.min.9fbae600351894799fb23f12c2dbbb3d5f0449a5d1b1c6d3eb293f7c356831bb.css" rel="stylesheet" integrity=""> <script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script> <title>OpenCue overview | OpenCue</title> </head> <body class="td-page"> <header> <nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar"> <a class="navbar-brand" href="/"> <span class="navbar-logo"><svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 314.43 315.92"><title>Artboard 1</title><path d="M158.24 50.66A108.16 108.16.0 10266.39 158.81 108.15 108.15.0 00158.24 50.66zm90.45 143-17.77-4.76a78.44 78.44.0 01-10.32 17.83l13 13L219.16 234.2l-13-13A78.5 78.5.0 01188.3 231.5l4.76 17.76-19.76 5.3-4.76-17.79a77.22 77.22.0 01-20.6.0l-4.77 17.79-19.76-5.3 4.76-17.76a78.44 78.44.0 01-17.83-10.32l-13 13L82.85 219.73l13-13a78.81 78.81.0 01-10.32-17.83l-17.76 4.76-5.3-19.76 17.79-4.77a77.22 77.22.0 010-20.6l-17.79-4.76L67.79 124l17.76 4.76a78.59 78.59.0 0110.32-17.83l-13-13L97.32 83.43l13 13a78.44 78.44.0 0117.83-10.32l-4.76-17.77 19.76-5.29 4.77 17.79a76.13 76.13.0 0120.6.0l4.76-17.79 19.76 5.29L188.3 86.13a78.5 78.5.0 0117.84 10.32l13-13L233.62 97.9l-13 13a78.22 78.22.0 0110.32 17.83L248.69 124 254 143.75l-17.79 4.76a76.13 76.13.0 010 20.6L254 173.88z"/><path d="M276.59 174.5a119 119 0 110-31.37h30a148.72 148.72.0 100 31.37z"/></svg> </span><span class="font-weight-bold">OpenCue</span> </a> <div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar"> <ul class="navbar-nav mt-2 mt-lg-0"> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="/docs/concepts/opencue-overview"><span>What is OpenCue?</span></a> </li> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="/docs/"><span>Documentation</span></a> </li> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="/blog/"><span>Blog</span></a> </li> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="/contributing/"><span>Contributing</span></a> </li> </ul> </div> <div class="navbar-nav d-none d-lg-block"> <input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off"> </div> </nav> </header> <div class="container-fluid td-outer"> <div class="td-main"> <div class="row flex-xl-nowrap"> <div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none"> <div id="td-sidebar-menu" class="td-sidebar__inner"> <form class="td-sidebar__search d-flex align-items-center"> <input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off"> <button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation"> </button> </form> <nav class="collapse td-sidebar-nav pt-2 pl-4" id="td-section-nav"> <ul class="td-sidebar-nav__section pr-md-3"> <li class="td-sidebar-nav__section-title"> <a href="/docs/" class="align-left pl-0 pr-2 td-sidebar-link td-sidebar-link__section">Documentation</a> </li> <ul> <li class="collapse show" id="docs"> <ul class="td-sidebar-nav__section pr-md-3"> <li class="td-sidebar-nav__section-title"> <a href="/docs/quick-starts/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Quick starts</a> </li> <ul> <li class="collapse " id="docsquick-starts"> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsquick-startsquick-start-linux" href="/docs/quick-starts/quick-start-linux/">Quick start for Linux</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsquick-startsquick-start-mac" href="/docs/quick-starts/quick-start-mac/">Quick start for macOS</a> </li> </ul> </ul> <ul class="td-sidebar-nav__section pr-md-3"> <li class="td-sidebar-nav__section-title"> <a href="/docs/concepts/" class="align-left pl-0 pr-2 active td-sidebar-link td-sidebar-link__section">Concepts</a> </li> <ul> <li class="collapse show" id="docsconcepts"> <a class="td-sidebar-link td-sidebar-link__page active" id="m-docsconceptsopencue-overview" href="/docs/concepts/opencue-overview/">OpenCue overview</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsconceptsglossary" href="/docs/concepts/glossary/">Glossary</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsconceptsversioning" href="/docs/concepts/versioning/">Versioning</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsconceptsspi-case-study" href="/docs/concepts/spi-case-study/">OpenCue Sony Pictures Imageworks case study</a> </li> </ul> </ul> <ul class="td-sidebar-nav__section pr-md-3"> <li class="td-sidebar-nav__section-title"> <a href="/docs/getting-started/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Getting started</a> </li> <ul> <li class="collapse " id="docsgetting-started"> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-startedsetting-up-the-database" href="/docs/getting-started/setting-up-the-database/">Setting up the database</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-starteddeploying-cuebot" href="/docs/getting-started/deploying-cuebot/">Deploying Cuebot</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-starteddeploying-rqd" href="/docs/getting-started/deploying-rqd/">Deploying RQD</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-startedchecking-out-the-source-code" href="/docs/getting-started/checking-out-the-source-code/">Checking out the source code</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-startedinstalling-pycue-and-pyoutline" href="/docs/getting-started/installing-pycue-and-pyoutline/">Installing PyCue and PyOutline</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-startedinstalling-cuegui" href="/docs/getting-started/installing-cuegui/">Installing CueGUI</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-startedinstalling-cuesubmit" href="/docs/getting-started/installing-cuesubmit/">Installing CueSubmit</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsgetting-startedinstalling-cueadmin" href="/docs/getting-started/installing-cueadmin/">Installing CueAdmin</a> </li> </ul> </ul> <ul class="td-sidebar-nav__section pr-md-3"> <li class="td-sidebar-nav__section-title"> <a href="/docs/user-guides/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">User guides</a> </li> <ul> <li class="collapse " id="docsuser-guides"> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsuser-guidesadding-removing-limits" href="/docs/user-guides/adding-removing-limits/">Adding or removing limits</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsuser-guidessubmitting-jobs" href="/docs/user-guides/submitting-jobs/">Submitting jobs</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsuser-guidesmonitoring-your-jobs" href="/docs/user-guides/monitoring-your-jobs/">Monitoring your jobs</a> </li> </ul> </ul> <ul class="td-sidebar-nav__section pr-md-3"> <li class="td-sidebar-nav__section-title"> <a href="/docs/other-guides/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Other guides</a> </li> <ul> <li class="collapse " id="docsother-guides"> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsother-guidesconfiguring-opencue" href="/docs/other-guides/configuring-opencue/">Configuring OpenCue</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsother-guidesconfiguring-limits" href="/docs/other-guides/configuring-limits/">Configuring limits</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsother-guidescustomizing-rqd" href="/docs/other-guides/customizing-rqd/">Customizing RQD rendering hosts</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsother-guidesapplying-database-migrations" href="/docs/other-guides/applying-database-migrations/">Applying database migrations</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsother-guidestroubleshooting-deployment" href="/docs/other-guides/troubleshooting-deployment/">Troubleshooting deployment</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsother-guidestroubleshooting-rendering" href="/docs/other-guides/troubleshooting-rendering/">Troubleshooting rendering</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsother-guidesmonitoring-with-prometheus-loki-and-grafana" href="/docs/other-guides/monitoring-with-prometheus-loki-and-grafana/">Monitoring with Prometheus, Loki, and Grafana</a> </li> </ul> </ul> <ul class="td-sidebar-nav__section pr-md-3"> <li class="td-sidebar-nav__section-title"> <a href="/docs/reference/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Reference</a> </li> <ul> <li class="collapse " id="docsreference"> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsreferencecuegui-app" href="/docs/reference/cuegui-app/">CueGUI app</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsreferencecommandscueadmin" href="/docs/reference/commands/cueadmin/">cueadmin command</a> <a class="td-sidebar-link td-sidebar-link__page " id="m-docsreferencecommandspycuerun" href="/docs/reference/commands/pycuerun/">pycuerun command</a> </li> </ul> </ul> </li> </ul> </ul> </nav> </div> </div> <div class="d-none d-xl-block col-xl-2 td-toc d-print-none"> <div class="td-page-meta ml-2 pb-1 pt-2 mb-0"> <a href="https://github.com/AcademySoftwareFoundation/opencue.io/edit/master/content/docs/Concepts/opencue-overview.md" target="_blank"><i class="fa fa-edit fa-fw"></i> Edit this page</a> <a href="https://github.com/AcademySoftwareFoundation/opencue.io/issues/new?title=OpenCue%20overview" target="_blank"><i class="fab fa-github fa-fw"></i> Create documentation issue</a> <a href="https://github.com/AcademySoftwareFoundation/OpenCue/issues/new/choose" target="_blank"><i class="fas fa-tasks fa-fw"></i> Create project issue</a> </div> <nav id="TableOfContents"> <ul> <li><a href="#what-is-opencue">What is OpenCue?</a></li> <li><a href="#why-use-opencue">Why use OpenCue?</a></li> <li><a href="#opencue-architecture">OpenCue architecture</a></li> <li><a href="#whats-next">What’s next?</a></li> </ul> </nav> </div> <main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main"> <nav aria-label="breadcrumb" class="d-none d-md-block d-print-none"> <ol class="breadcrumb spb-1"> <li class="breadcrumb-item" > <a href="https://www.opencue.io/docs/">Documentation</a> </li> <li class="breadcrumb-item" > <a href="https://www.opencue.io/docs/concepts/">Concepts</a> </li> <li class="breadcrumb-item active" aria-current="page"> <a href="https://www.opencue.io/docs/concepts/opencue-overview/">OpenCue overview</a> </li> </ol> </nav > <div class="td-content"> <h1>OpenCue overview</h1> <div class="lead">An introduction to OpenCue</div> <h2 id="what-is-opencue">What is OpenCue?</h2> <p>OpenCue is an open source render management system. You can use OpenCue in visual effects and animation production to break down complex jobs into individual tasks. You can submit jobs to a configurable dispatch queue that allocates the necessary computational resources.</p> <h2 id="why-use-opencue">Why use OpenCue?</h2> <p>OpenCue provides features to manage rendering jobs at scale:</p> <ul> <li>Sony Pictures Imageworks <a href="/docs/concepts/spi-case-study/">in-house render manager</a> used on hundreds of films.</li> <li>Highly-scalable architecture supporting numerous concurrent machines.</li> <li>Tagging systems allow you to allocate specific jobs to specific machine types.</li> <li>Jobs are processed on a central render farm and don’t rely on the artist’s workstation.</li> <li>Native multithreading that supports Katana, RenderMan, and Arnold.</li> <li>Support for multi facility, on-premise, cloud, and hybrid deployments.</li> <li>You can split a host into a large number of procs, each with their own reserved core and memory requirements.</li> <li>Integrated automated booking.</li> <li>No limit on the number of procs a job can have.</li> </ul> <h2 id="opencue-architecture">OpenCue architecture</h2> <p>OpenCue includes components that run on both an artist’s workstation, as well as central server clusters. The following list provides a brief summary of the main components:</p> <ul> <li> <p>Cuebot - a utility that runs in the background on a workstation and performs a variety of important OpenCue management tasks. Cuebot can also run in a server cluster for high availability.</p> </li> <li> <p>CueGUI - a graphical user interface that artists run to monitor and manage jobs.</p> </li> <li> <p>CueSubmit - a graphical user interface for configuring and launching rendering jobs to an OpenCue deployment. Artists typically run CueSubmit as a plug-in for their 3D software on their workstation.</p> </li> <li> <p>RQD - a software daemon that runs on all rendering hosts, which are doing work for an OpenCue deployment.</p> </li> </ul> <p>Figure 1 illustrates how the various components interact in a large-scale deployment of OpenCue.</p> <p><img src="/docs/images/opencue_architecture.svg" alt="Overview of OpenCue architecture and components"></p> <h2 id="whats-next">What’s next?</h2> <p>For information on installing OpenCue components and dependencies, see <a href="/docs/getting-started">Getting started</a>.</p> <p>To learn common terminology used in OpenCue, see the <a href="/docs/concepts/glossary">Glossary</a>.</p> <style> .feedback--answer { display: inline-block; } .feedback--answer-no { margin-left: 1em; } .feedback--response { display: none; margin-top: 1em; } .feedback--response__visible { display: block; } </style> <h2 class="feedback--title">Feedback</h2> <p class="feedback--question">Was this page helpful?</p> <button class="feedback--answer feedback--answer-yes">Yes</button> <button class="feedback--answer feedback--answer-no">No</button> <p class="feedback--response feedback--response-yes"> Glad to hear it! Please <a href="https://github.com/AcademySoftwareFoundation/opencue.io/issues/new">tell us how we can improve</a>. </p> <p class="feedback--response feedback--response-no"> Sorry to hear that. Please <a href="https://github.com/AcademySoftwareFoundation/opencue.io/issues/new">tell us how we can improve</a>. </p> <script> const yesButton = document.querySelector('.feedback--answer-yes'); const noButton = document.querySelector('.feedback--answer-no'); const yesResponse = document.querySelector('.feedback--response-yes'); const noResponse = document.querySelector('.feedback--response-no'); const disableButtons = () => { yesButton.disabled = true; noButton.disabled = true; }; const sendFeedback = (value) => { if (typeof ga !== 'function') return; const args = { command: 'send', hitType: 'event', category: 'Helpful', action: 'click', label: window.location.pathname, value: value }; ga(args.command, args.hitType, args.category, args.action, args.label, args.value); }; yesButton.addEventListener('click', () => { yesResponse.classList.add('feedback--response__visible'); disableButtons(); sendFeedback(1); }); noButton.addEventListener('click', () => { noResponse.classList.add('feedback--response__visible'); disableButtons(); sendFeedback(0); }); </script> <br /> <div class="text-muted mt-5 pt-3 border-top">Last modified Thursday, November 7, 2019: <a href="https://github.com/AcademySoftwareFoundation/opencue.io/commit/7b8ef280e2e553d714523cbe71088b37fb16f346">OpenCue Sony Pictures Imageworks case study (#111) (7b8ef28)</a> </div> </div> </main> </div> </div> <footer> <div class="bg-dark py-3 row d-print-none"> <div class="container-fluid mx-sm-5"> <div class="text-center order-sm-2"> <a href="https://www.aswf.io"><img src="/images/aswf_aqua.png" alt="Academy Software Foundation logo"></a><br> <small class="text-white">Documentation Distributed under CC BY 4.0</small><br> <small class="text-white">LF Projects, LLC uses various trademarks. For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see <a href="https://www.lfprojects.org">https://www.lfprojects.org</a>.</small><br> <small class="ml-1 text-white"> <a href="https://lfprojects.org/policies/trademark-policy/">Trademark Policy</a> | <a href="https://lfprojects.org/policies/privacy-policy/">Privacy Policy</a> | <a href="https://lfprojects.org/policies/antitrust-policy/">Antitrust Policy</a> | <a href="https://lfprojects.org/policies/code-of-conduct/">Code of Conduct</a> | <a href="https://lfprojects.org/policies/terms-of-use/">Terms of Use</a></small> </div> </div> </div> <div class="bg-dark py-4 row d-print-none"> <div class="container-fluid mx-sm-5"> <div class="row"> <div class="col-6 col-sm-4 text-xs-center order-sm-2"> <ul class="list-inline mb-0"> <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list"> <a class="text-white" target="_blank" href="https://lists.aswf.io/g/opencue-user"> <i class="fa fa-envelope"></i> </a> </li> </ul> </div> <div class="col-6 col-sm-4 text-right text-xs-center order-sm-3"> <ul class="list-inline mb-0"> <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="GitHub"> <a class="text-white" target="_blank" href="https://github.com/AcademySoftwareFoundation/OpenCue"> <i class="fab fa-github"></i> </a> </li> </ul> </div> <div class="col-12 col-sm-4 text-center py-2 order-sm-2"> <small class="text-white">© 2024 Copyright Contributors to the OpenCue Project </small><br> <a href="https://www.netlify.com"> <img src="https://www.netlify.com/img/global/badges/netlify-light.svg"/> </a> </div> </div> </div> </div> </footer> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script> <script src="/js/main.min.065b82a14ada44d18527fb3cefdae13e2c33fa51d8cd3532d8f2f8ea633f8ae6.js" integrity="sha256-BluCoUraRNGFJ/s879rhPiwz+lHYzTUy2PL46mM/iuY=" crossorigin="anonymous"></script> </body> </html>