Environment Variables with Special Scopes

Introduction

Some environment variables have a special, extended or global scope. Variables with special scope are related to a deployment method only. Variables with an extended scope do not directly configure services but functions underneath. Variables with a global scope can configure more than one service.

Examples:

  • The global environment variable OCIS_LOG_LEVEL is available in multiple services.

  • The extended environment variable OCIS_CONFIG_DIR can be used with ocis init.

  • The special environment variable OCIS_RUN_SERVICES defines services to start when the container is started.

Special Environment Variables

The following environment variables are only available when using a developer version for Infinite Scale. For additional information read the Start Infinite Scale documentation. Read the Environment Variable Types documentation for important details.

  • 8.2.0

Environment variables to define services when starting the container
Name Description

OCIS_RUN_SERVICES

A comma-separated list of service names. Will start only the listed services.

OCIS_EXCLUDE_RUN_SERVICES

A comma-separated list of service names. Will start all default services except of the ones listed. Has no effect when OCIS_RUN_SERVICES is set.

OCIS_ADD_RUN_SERVICES

A comma-separated list of service names. Will add the listed services to the default configuration. Has no effect when OCIS_RUN_SERVICES is set. Note that one can add services not started by the default list and exclude services from the default list by using both envvars at the same time.

OCIS_RUNTIME_PORT

The port where the runtime will start. Defaults to 9250. Only necessary when multiple runtimes are started in parallel. Each runtime must have its own port exclusively.

OCIS_RUNTIME_HOST

The hostname the runtime will listen to. Defaults to localhost.

Note to get the current list of services started by default, you need to run ocis server without restriction which services to start and run afterwards ocis list.

Extended Environment Variables

Note, see the Registry documentation for details on the Micro Registry and their available settings.

The extended variables are defined in the following way. Read the Environment Variable Types documentation for important details. Column IV shows with which release the environment variable has been introduced.

  • 8.2.0

404: Not Found

Global Environment Variables

Note that the descriptions of these environment variables may differ depending on the service context.

The global variables are defined in the following way. Read the Environment Variable Types documentation for important details. Column IV shows with which release the environment variable has been introduced.

  • 8.2.0

404: Not Found