Add a reference for some of the most common environment variables

[sharifsalah]

Add a reference for some of the most common environment variables, such as:

Outline

OL_BASE_SESSION_PATH
OL_LAYER_SESSION_PATH
OL_LAYER_RANGE
OL_VERSION
OL_OS
OL_TAG_OVERRIDE
OL_CONFIG

CueBot

CUEBOT_HOSTS
CUEBOT_GRPC_CUE_PORT
CUEBOT_GRPC_RQD_SERVER_PORT

Other

CUEGUI_DEFAULT_INI_PATH # CueGUI/Constants.py
OPENCUE_CONF (PyCue)
CUESUBMIT_CONFIG_FILE
CUE_FRAME_LOG_DIR
CUE_FS_ROOT
CUE_PYTHON_BIN
CUE_PYTHONPATH

# Path where all of the Cue Python libraries and their dependencies are installed.
# The recommended workflow is for this to be a virtual environment, like:
#  CUE_PYTHONPATH = '<path to virtualenv>/lib/python2.7/site-packages'

We should also try to document the locations of the various config files:

• PyCue: pycue/opencue/default.yaml
• CueGUI: cuegui/cuegui/config/*.(yaml|ini)
• CueSubmit: $CUESUBMIT_CONFIG_FILE
• PyOutline: pyoutline/etc/config.cfg
• RQD: /etc/opencue/rqd.conf
• cueadmin: N/A

These are just some examples as there are many others, but it would be good to publish something basic and add to it over time.

Please add any suggestions for useful variables or config files to this issue.

[bcipriano]

We should also document the various tokens that can be used in the commands you send to Cue.

We can pull the list from the spot in the code where those tokens are replaced: https://github.com/AcademySoftwareFoundation/OpenCue/blob/master/cuebot/src/main/java/com/imageworks/spcue/dispatcher/DispatchSupportService.java#L390

AcademySoftwareFoundation/OpenCue#597 just added a few new ones.

[apoorvkhare07]

@sharifsalah I would like to work on this issue if it's available ?

[sharifsalah]

@apoorvkhare07 sure, thanks for volunteering! I'll assign you the issue.

[apoorvkhare07]

@sharifsalah Thank you. As per my understanding I need to add the environment related variables to docker.yaml for all except CueBOT and to Dockerfile for CueBOT. right ?
Also should I provide them with default values for now ?

[sharifsalah]

@apoorvkhare07 I'm not sure quite what you mean. Docker is optional for all components of OpenCue. Users might use Docker to install the project but others might not use it. It will depend on the setup.

So this issue isn't strictly related to managing OpenCue in a container environment. We want to document a reference of what all the environment variables and tokens do.

For example, to document the tokens, we might use a list similar to the following:

Tokens

(explain what a token is)

You can use the following tokens when submitting outline jobs, either in
the graphical Cuesubmit client, or via the PyOutline API:

• #ZFRAME#: (I can't remember what this token does right now)
• #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

[apoorvkhare07]

Ok, Got the point.
So where in the documentation do I need to add these references ?

[apoorvkhare07]

https://www.opencue.io/docs/reference/ here we don't a page for CueBOT and tokens as well.

[sharifsalah]

Yes, I think adding a new page under https://www.opencue.io/docs/reference/ would be good.

To clarify, when you say a page for CueBot and tokens: this issue is for environment variables for all of OpenCue, not just CueBot and tokens. See the original description for more details. Eventually this page will include a reference for all the variables in the description as well as others we might not have identified yet.

Don't feel you have to document all of these. For example, a basic page that describes the tokens (as I explained in my previous comment), would be very welcome and useful. We can create additional pull requests later on.

We strongly recommend you send smaller pull requests as this could be quite a large page eventually.