Envvar Naming Scope

The scope of an environment variable can be derived from its name. Therefore it is important to follow the correct naming scheme to enable easy and proper identification. This is important when either:

• a new local envvar is introduced.
• a new global envvar is added to an existing local envvar.

• A variable that is only used in a particular service is a local envvar.
• A variable that is used in more than one service is a global envvar.
• Mandatory when used in a service, a global envvar must have a local counterpart.
• Variables that do not belong to any service are by definition global.

A local envvar always starts with the the service name like POSTPROCESSING_LOG_FILE.

A global envvar always starts with OCIS_ like OCIS_LOG_FILE.

Note that this envvar is the global representation of the local example from above.

To get a list of global envvars used in all services, see the Global Environment Variables table in the ocis admin documentation.

All environment variable types that are used in a service follow the same deprecation rules independent of their scope.

When multiple envvars are defined for one purpose like a global and local one, use ; (semicolon) to properly separate the envvars in go code. Though it is possible to separate with , (comma) according go rules, the current implementation of the docs generation process only recognizes semicolons as separator.