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

Env variables #173

Closed
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: 4 additions & 0 deletions content/docs/Getting started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ date: 2019-02-22
description: >
Guides for system admins deploying OpenCue components and installing dependencies
---

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this PR includes changes from one of your other branches. I'm guessing that you may have created the env_variables branch not from master, but from another work branch?

You should clean up your branch to make sure it only includes changes relevant to this PR. You might want to create a new, clean branch from master and cherry-pick the relevant commits from env_variables to the new branch.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes @bcipriano, actually I had an open PR from master at the time I created this PR, thus this issue arise.
I'll cherry pick the changes to a new branch and make a new PR accordingly.

The guides in this section provide detailed instructions for installing OpenCue in a production environment. If you'd like to quickly try out OpenCue to evaluate the project for your needs, see the [Quick starts](https://www.opencue.io/docs/quick-starts/).

OpenCue relies on a lot of components and project-specific terminology. If you're new to OpenCue, you might find it useful to learn how some of the components work together. For more information, see the [OpenCue overview](https://www.opencue.io/docs/concepts/opencue-overview/) and [Glossary](https://www.opencue.io/docs/concepts/glossary/).
70 changes: 70 additions & 0 deletions content/docs/Reference/env-variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: "Environment Variables"
linkTitle: "Environment Variables"
date: 2019-03-30
weight: 4
description: >
Reference for common environment variables
---

This page list some of the most common environment variables used in OpenCUE.

## Outline

Environment variables related to pyOutline.

##### OL_BASE_SESSION_PATH


##### OL_LAYER_SESSION_PATH


##### OL_LAYER_RANGE


##### OL_VERSION


##### OL_OS


##### OL_TAG_OVERRIDE


##### OL_CONFIG

## CueBOT

Environment variables related to CueBOT.

##### CUEBOT_HOSTS


##### CUEBOT_GRPC_CUE_PORT


##### CUEBOT_GRPC_RQD_SERVER_PORT


## Others


##### CUEGUI_DEFAULT_INI_PATH


##### OPENCUE_CONF


##### CUESUBMIT_CONFIG_FILE


##### CUE_FRAME_LOG_DIR


##### CUE_FS_ROOT


##### CUE_PYTHON_BIN


##### CUE_PYTHONPATH
38 changes: 38 additions & 0 deletions content/docs/Reference/tokens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Tokens"
linkTitle: "Tokens"
date: 2019-03-30
weight: 5
description: >
Various tokens that can be used in the commands you send to Cue
---

Tokens can be used in the commands when submitting outline jobs, either inthe graphical Cuesubmit client, or via the PyOutline API.

Following are the commonly used tokens:


##### #ZFRAME#
To be added.

##### #IFRAME#
The number of the current frame.

##### #FRAME_START#
The number of the final frame in the current chunk.

##### #FRAME_END#
The number of the final frame in the current chunk.

##### #FRAME_CHUNK#
The value of the current chunk.

##### #LAYER#
The name of the current layer.

##### #JOB#
The name of the current job.

##### #FRAMESPEC#
The value of the current frame spec. A frame spec consists