Customizer API Settings

The settings in this section are used to configure the Customizer API Server.

`CUSTOMIZER_TITLE`

Optional, default value: Customizer API

Name of the API Service

`CUSTOMIZER_DESCRIPTION`

Optional, default value: API provided by [pyxecm](https://github.com/opentext/pyxecm). The documentation for the payload syntax can be found [here](https://opentext.github.io/pyxecm/payload-syntax/).

Descriptive text on the SwaggerUI page.

`CUSTOMIZER_API_KEY`

Optional, default value: None

Optional API KEY that can be specified that has access to the Customizer API, bypassing the OTDS authentication.

`CUSTOMIZER_BIND_ADDRESS`

Optional, default value: 0.0.0.0

Interface to bind the Customizer API.

`CUSTOMIZER_BIND_PORT`

Optional, default value: 8000

Port to bind the Customizer API to

`CUSTOMIZER_WORKERS`

Optional, default value: 1

Number of workers to use for the API background tasks

`CUSTOMIZER_ROOT_PATH`

Optional, default value: ``

Root path for the Customizer API

`CUSTOMIZER_OPENAPI_URL`

Optional, default value: /api/openapi.json

OpenAPI URL

`CUSTOMIZER_RELOAD`

Optional, default value: False

Enable or disable the autoreload feature

`CUSTOMIZER_CONCURRENT_PAYLOADS`

Optional, default value: 3

Maximum number of concurrent payloads that are executed at the same time.

`CUSTOMIZER_IMPORT_PAYLOAD`

Optional, default value: False

`CUSTOMIZER_PAYLOAD`

Optional, default value: /payload/payload.yml.gz.b64

Path to a single payload file to be loaded.

`CUSTOMIZER_PAYLOAD_DIR`

Optional, default value: /payload-external/

Path to a directory of payload files. All files in this directory will be loaded in alphabetical order and dependencies will be added automatically on the previous object. So all payload in this folder will be processed sequentially in alphabetical oder.

`CUSTOMIZER_PAYLOAD_DIR_OPTIONAL`

Optional, default value: /payload-optional/

Path of payload files to be loaded. No additional logic for dependencies will be applied, they need to be managed within the payloadSettings section of each payload. See -> payloadOptions in the Payload Syntax documentation.

`CUSTOMIZER_TEMP_DIR`

Optional, default value: /var/folders/yk/vkrlb78s2_3cjt4g0kxmm0f80000gn/T/customizer

location of the temp folder. Used for temporary files during the payload execution

`CUSTOMIZER_LOGLEVEL`

Optional, default value: INFO

Possible values

INFO, DEBUG, WARNING, ERROR

`CUSTOMIZER_LOG_PAYLOAD_PROCESSING`

Optional, default value: False

Print the customizer payload processing log messages to stdout

`CUSTOMIZER_LOGFOLDER`

Optional, default value: /var/folders/yk/vkrlb78s2_3cjt4g0kxmm0f80000gn/T/customizer

Logfolder for Customizer logfiles

`CUSTOMIZER_LOGFILE`

Optional, default value: customizer.log

Logfile for Customizer API. This logfile also contains the execution of every payload.

`CUSTOMIZER_NAMESPACE`

Optional, default value: default

Namespace to use for otxecm resource lookups

`CUSTOMIZER_MAINTENANCE_PAGE`

Optional, default value: True

Start the Maintenance Page server.

`CUSTOMIZER_MAINTENANCE_MODE`

Optional, default value: False

Automatically enable and disable the maintenance mode during payload deployments.

`CUSTOMIZER_TRUSTED_ORIGINS`

Optional, default value: ['http://localhost', 'http://localhost:5173', 'http://localhost:8080', 'https://manager.develop.terrarium.cloud', 'https://manager.terrarium.cloud']

`OTDS_PROTOCOL`

Optional, default value: http

`OTDS_HOSTNAME`

Optional, default value: otds

`OTDS_SERVICE_PORT_OTDS`

Optional, default value: 80

`OTDS_URL`

Optional, default value: None

`CUSTOMIZER_METRICS`

Optional, default value: True

Enable or disable the /metrics endpoint for Prometheus

`CUSTOMIZER_VICTORIALOGS_HOST`

Optional, default value: ``

Hostname of the VictoriaLogs Server

`CUSTOMIZER_VICTORIALOGS_PORT`

Optional, default value: 9428

Port of the VictoriaLogs Server

`CUSTOMIZER_CSAI`

Optional, default value: False

Enable the CSAI integration

`CUSTOMIZER_CSAI_PREFIX`

Optional, default value: csai

Prefix for the CSAI

`CUSTOMIZER_CSAI_STUDIO_INTEGRATION`

Optional, default value: False

Enable the CSAI Studio Integration

`CUSTOMIZER_UPLOAD_FOLDER`

Optional, default value: /var/folders/yk/vkrlb78s2_3cjt4g0kxmm0f80000gn/T/upload

Folder for uploads

`CUSTOMIZER_UPLOAD_KEY`

Optional, default value: 3fce54ee-79e7-40f5-b189-0e2df150b564

Upload key for the Logs

`CUSTOMIZER_UPLOAD_URL`

Optional, default value: http://customizer:8000/api/v1/otcs/logs/upload

Upload URL for the Logs

`CUSTOMIZER_WS_TERMINAL`

Optional, default value: False

Enable the Websocket Terminal endpoint

Sample environment variables

# Name of the API Service
# CUSTOMIZER_TITLE=Customizer API

# Descriptive text on the SwaggerUI page.
# CUSTOMIZER_DESCRIPTION=API provided by [pyxecm](https://github.com/opentext/pyxecm). The documentation for the payload syntax can be found [here](https://opentext.github.io/pyxecm/payload-syntax/).

# Optional API KEY that can be specified that has access to the Customizer API, bypassing the OTDS authentication.
# CUSTOMIZER_API_KEY=

# Interface to bind the Customizer API.
# CUSTOMIZER_BIND_ADDRESS=0.0.0.0

# Port to bind the Customizer API to
# CUSTOMIZER_BIND_PORT=8000

# Number of workers to use for the API background tasks
# CUSTOMIZER_WORKERS=1

# Root path for the Customizer API
# CUSTOMIZER_ROOT_PATH=

# OpenAPI URL
# CUSTOMIZER_OPENAPI_URL=/api/openapi.json

# Enable or disable the autoreload feature
# CUSTOMIZER_RELOAD=False

# Maximum number of concurrent payloads that are executed at the same time.
# CUSTOMIZER_CONCURRENT_PAYLOADS=3

# CUSTOMIZER_IMPORT_PAYLOAD=False

# Path to a single payload file to be loaded.
# CUSTOMIZER_PAYLOAD=/payload/payload.yml.gz.b64

# Path to a directory of payload files. All files in this directory will be loaded in alphabetical order and dependencies will be added automatically on the previous object. So all payload in this folder will be processed sequentially in alphabetical oder.
# CUSTOMIZER_PAYLOAD_DIR=/payload-external/

# Path of payload files to be loaded. No additional logic for dependencies will be applied, they need to be managed within the payloadSettings section of each payload. See -> payloadOptions in the Payload Syntax documentation.
# CUSTOMIZER_PAYLOAD_DIR_OPTIONAL=/payload-optional/

# location of the temp folder. Used for temporary files during the payload execution
# CUSTOMIZER_TEMP_DIR=/var/folders/yk/vkrlb78s2_3cjt4g0kxmm0f80000gn/T/customizer

# Possible values:
#   `INFO`, `DEBUG`, `WARNING`, `ERROR`
# CUSTOMIZER_LOGLEVEL=INFO

# Print the customizer payload processing log messages to stdout
# CUSTOMIZER_LOG_PAYLOAD_PROCESSING=False

# Logfolder for Customizer logfiles
# CUSTOMIZER_LOGFOLDER=/var/folders/yk/vkrlb78s2_3cjt4g0kxmm0f80000gn/T/customizer

# Logfile for Customizer API. This logfile also contains the execution of every payload.
# CUSTOMIZER_LOGFILE=customizer.log

# Namespace to use for otxecm resource lookups
# CUSTOMIZER_NAMESPACE=default

# Start the Maintenance Page server.
# CUSTOMIZER_MAINTENANCE_PAGE=True

# Automatically enable and disable the maintenance mode during payload deployments.
# CUSTOMIZER_MAINTENANCE_MODE=False

# CUSTOMIZER_TRUSTED_ORIGINS=['http://localhost', 'http://localhost:5173', 'http://localhost:8080', 'https://manager.develop.terrarium.cloud', 'https://manager.terrarium.cloud']

# OTDS_PROTOCOL=http

# OTDS_HOSTNAME=otds

# OTDS_SERVICE_PORT_OTDS=80

# OTDS_URL=

# Enable or disable the /metrics endpoint for Prometheus
# CUSTOMIZER_METRICS=True

# Hostname of the VictoriaLogs Server
# CUSTOMIZER_VICTORIALOGS_HOST=

# Port of the VictoriaLogs Server
# CUSTOMIZER_VICTORIALOGS_PORT=9428

# Enable the CSAI integration
# CUSTOMIZER_CSAI=False

# Prefix for the CSAI
# CUSTOMIZER_CSAI_PREFIX=csai

# Enable the CSAI Studio Integration
# CUSTOMIZER_CSAI_STUDIO_INTEGRATION=False

# Folder for uploads
# CUSTOMIZER_UPLOAD_FOLDER=/var/folders/yk/vkrlb78s2_3cjt4g0kxmm0f80000gn/T/upload

# Upload key for the Logs
# CUSTOMIZER_UPLOAD_KEY=f8aa09bd-3e28-497f-808e-793503ab7688

# Upload URL for the Logs
# CUSTOMIZER_UPLOAD_URL=http://customizer:8000/api/v1/otcs/logs/upload

# Enable the Websocket Terminal endpoint
# CUSTOMIZER_WS_TERMINAL=False