OKA Parameter Reference

Here are all the parameters that can be configured to customize the OKA. They can be specified in the ${OKA_INSTALL_DIR}/conf/oka.conf file:

OKA server

  • SECRET_KEY: "yourawesomeksecretkey" A secret key. This is used to provide cryptographic signing, and should be set to a unique, unpredictable value.

  • ALLOWED_HOSTS: "localhost,127.0.0.1" A list of the host/domain names that this OKA site can serve.

  • CSRF_TRUSTED_ORIGINS: "http://instance.my.domain,https://instance.my.domain" A list of the host/domain names that will be trusted when serving OKA through a proxy. See Django documentation for more info.

Databases

Elasticsearch

  • ELASTICSEARCH_HOSTS [INIT]: "127.0.0.1:8080" Elasticsearch URL

PostgreSQL

  • DB_NAME: "ok_db" Name of the PostgreSQL database for OKA.

  • DB_USER: "oka" PostgreSQL username for OKA.

  • DB_PASSWORD: "okapwd" PostgreSQL password for the OKA user.

  • DB_HOST: "localhost" Host of PostgreSQL database.

  • DB_PORT: 5432 Port PostgreSQL is listening on.

Input data

  • DEFAULT_FILE_PATH [INIT]: "" [OPTIONAL] Absolute path to a job scheduler accounting file to load.

  • DEFAULT_FILE_NRJ_PATH [INIT]: "" [OPTIONAL] Absolute path to a directory containing power compute_all_.*.txt files. These files must follow this format:

    • node: node name

    • watts: node power consumption in kilowatts

    • temp_inlet: temperature for the inlet in Celsius

    • temp_CPU1: temperature for the CPU1 in Celsius

    • temp_CPU2: temperature for the CPU2 in Celsius

  • DEFAULT_NODES_PATH [INIT]: "" [OPTIONAL] Absolute path to a directory or a file containing nodes statistics from a job scheduler (Memory and CPU allocations). You must use one file per datetime named according to the following format: .*_YYYY-MM-DD_HH:MM:SS.txt.

  • DEFAULT_PARTITIONS_PATH [INIT]: "" [OPTIONAL] Absolute path to a directory or a file containing partitions statistics from a job scheduler (Nodes and CPUs details of each partition). You must use one file per datetime named according to the following format: .*_YYYY-MM-DD_HH:MM:SS.txt.

SMTP Email server

  • EMAIL_HOST: "SMTP HOST" The host used to send emails (to create a new user for example).

  • EMAIL_PORT: "SMTP PORT" SMTP port to use.

  • DEFAULT_FROM_EMAIL: "FROM EMAIL" Default email address to use for various automated correspondence from the OKA manager.

  • EMAIL_HOST_USER: "SENDER EMAIL" Username to use for the SMTP server defined in EMAIL_HOST. If empty, OKA won’t attempt authentication.

  • EMAIL_HOST_PASSWORD: "PASSWORD" Password to use for the SMTP server defined in EMAIL_HOST. This setting is used in conjunction with EMAIL_HOST_USER when authenticating to the SMTP server. If either of these settings is empty, OKA won’t attempt authentication.

  • EMAIL_USE_TLS: True Whether to use a TLS (secure) connection when talking to the SMTP server.

  • EMAIL_USE_SSL: False Whether to use an implicit TLS (secure) connection when talking to the SMTP server.

Licensing

  • LICENSE_FILE: "/path/to/license/license.lic" Absolute path to license file. By default it will be "${OKA_INSTALL_DIR}/license/license.lic"

Caching

  • MAIN_CACHE: [OPTIONAL] Backend and location of the main cache. Default is set on DatabaseCache. See the Cache section for more details.

  • CACHE_DURATION: 10800 Cache duration in seconds.

Debugging

  • DEBUG: True | False A boolean that turns on/off debug mode.

Logging

  • LOGGING_ROTATE: True | False A boolean that turns on/off logrotate settings.

  • LOGGING_INTERVAL_TYPE: "D" A string value used to specify the type of interval.

    • "S": Seconds

    • "M": Minutes

    • "H": Hours

    • "D": Days

    • "W0-W6": Weekday example: 0=Monday

    • "midnight": Roll over at midnight.

  • LOGGING_INTERVAL: 1 An integer to specify the value of the interval. How many times should the interval type occur prior to log rotation.

  • LOGGING_BACKUP_COUNT: 30 An integer value used to determine the maximum number of log files to keep.

See Logs for more information.

Rest Api

  • ACCESS_TOKEN_LIFETIME: 1 An integer value used to determine how many days the access token lifetime will be valid.

  • REFRESH_TOKEN_LIFETIME: 30 An integer value used to determine how many days the refresh token lifetime will be valid.

SESSION

  • SESSION_TIMEOUT: 3600 An integer value used to specify how long before a user is automatically logged out of OKA.

Authentication Method

  • AUTHENTICATION_METHOD: The authentication method to use for user authentication.

    • OKA: Default method used for authentication within the system.

    • LDAP: Allow authentication via an LDAP server (see LDAP).

    • HTTP: Use HTTP-based authentication (see HTTP Authentication).

LDAP

  • LDAP_SERVER_URI: A string value specifying the URI of the LDAP server. Example: ldap://0.0.0.0:1389.

  • LDAP_BIND_DN: A string value representing the distinguished name (DN) for binding to the LDAP directory. Example: "cn=admin,dc=example,dc=com".

  • LDAP_BIND_PASSWORD: A string value used as the password to authenticate the LDAP bind DN. Example: "adminpassword".

  • LDAP_SEARCH_BASE: A string value specifying the base DN for user searches in the LDAP directory. This should correspond to the organizational unit where user accounts are stored. Example: "ou=People,dc=example,dc=com".

  • LDAP_USERNAME_FIELD: mail A string value representing the LDAP attribute field used for username lookups. By default, mail is a common choice. Example: "mail" or "uid".

Tasks

  • CELERY_BROKER_URL: "amqp://localhost" A string value used to specify the URL of the broker that will be used by Celery.

Static variables

The following variables are used during installation/update, and cannot be updated.

  • INSTALL_PATH: Absolute path to OKA’s installation directory

  • OKA_USER: User running the OKA processes

Other variables

  • BLOCK_ADMIN_PANEL: False A boolean used to block admin panel access.

  • BLOCK_CUSTOM_DATAENHANCER: False A boolean used to block the use of “custom” Data Enhancer.

  • BLOCK_CATEGORY_BUTTONS: False A boolean used to block the switch performance / cost / energy buttons.

  • BLOCK_FORGOT_PASSWORD: False A boolean used to block the forgot password button.

  • BLOCK_CRON_SCHEDULED_TASK: True A boolean used to block scheduled task from running automatically by default in cron mode when they are created.

  • ALLOWED_JS_INGESTION_TYPE: "*" Comma separated values used to specify the available ingestion types options provided to the user while creating a cluster.

    • "LOCAL": Local job scheduler command execution

    • "FILE": Local reading of file(s)

    • "FORWARDED_PWD": Command execution remotely forwarded through SSH, login with a password

    • "FORWARDED_KEYFILE": Command execution remotely forwarded through SSH, login with an ssh key file

    • "*": Select any of the previous type when creating a cluster.

[INIT] (1,2,3,4,5)

Those parameters are used ONLY ONCE during the initialization of the system. If you wish to update them please refer to the related Administrator panels.