Customizer API Settings¶
The settings in this section are used to configure the Customizer API Server.
Sample .env¶
# 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. Supports IPv4, IPv6
# 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 order.
# 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=/tmp/customizer
# Possible values:
# `INFO`, `DEBUG`, `WARNING`, `ERROR`
# CUSTOMIZER_LOGLEVEL=INFO
# Logfolder for Customizer logfiles
# CUSTOMIZER_LOGFOLDER=/tmp/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
# Folder for uploads
# CUSTOMIZER_UPLOAD_FOLDER=/tmp/upload
# Upload key for the Logs
# CUSTOMIZER_UPLOAD_KEY=76a058fe-9cde-4299-a684-da2d13b11a5f
# 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
# Enable the pod endpoints: list the pods of the namespace, browse, download and upload their files and read their logs - and the ConfigMaps, Secrets and workloads of the namespace: show and change them, restart workloads. Follows ws_terminal when not set.
# CUSTOMIZER_POD_ACCESS=
# Largest file that can be uploaded into a pod (in bytes).
# CUSTOMIZER_POD_UPLOAD_MAX_BYTES=2147483648
# Number of downloads and uploads from and to pods that can run at the same time.
# CUSTOMIZER_POD_TRANSFER_CONCURRENCY=4
# Folder for the copies of the pod logs that are looked at.
# CUSTOMIZER_POD_LOG_SPOOL_DIR=/tmp/podlogs
# Largest copy of a pod log (in bytes). Following the log stops when it is reached.
# CUSTOMIZER_POD_LOG_MAX_BYTES=1073741824
# A copy of a pod log that nobody read for this long (in seconds) is stopped and deleted.
# CUSTOMIZER_POD_LOG_IDLE_SECONDS=900
# Number of pod logs that can be followed at the same time.
# CUSTOMIZER_POD_LOG_MAX_SESSIONS=20
Documentation¶
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. Supports IPv4, IPv6
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 order.
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: /tmp/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_LOGFOLDER¶
Optional, default value: /tmp/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_UPLOAD_FOLDER¶
Optional, default value: /tmp/upload
Folder for uploads
CUSTOMIZER_UPLOAD_KEY¶
Optional, default value: 20b2d71a-ef4d-4306-9478-cd74c2b98f3c
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
CUSTOMIZER_POD_ACCESS¶
Optional, default value: None
Enable the pod endpoints: list the pods of the namespace, browse, download and upload their files and read their logs - and the ConfigMaps, Secrets and workloads of the namespace: show and change them, restart workloads. Follows ws_terminal when not set.
CUSTOMIZER_POD_UPLOAD_MAX_BYTES¶
Optional, default value: 2147483648
Largest file that can be uploaded into a pod (in bytes).
CUSTOMIZER_POD_TRANSFER_CONCURRENCY¶
Optional, default value: 4
Number of downloads and uploads from and to pods that can run at the same time.
CUSTOMIZER_POD_LOG_SPOOL_DIR¶
Optional, default value: /tmp/podlogs
Folder for the copies of the pod logs that are looked at.
CUSTOMIZER_POD_LOG_MAX_BYTES¶
Optional, default value: 1073741824
Largest copy of a pod log (in bytes). Following the log stops when it is reached.
CUSTOMIZER_POD_LOG_IDLE_SECONDS¶
Optional, default value: 900
A copy of a pod log that nobody read for this long (in seconds) is stopped and deleted.
CUSTOMIZER_POD_LOG_MAX_SESSIONS¶
Optional, default value: 20
Number of pod logs that can be followed at the same time.