`orangeqs.juice.orchestration.zest`#

Module for handling integration with orangeqs-zest.

Module Contents#

Functions#

`write_setup_id_and_name_to_zest_config`	Write the setup ID and setup name to the configuration for zest.
`request_user_consent_for_zest`	Request user consent for orangeqs-zest telemetry, managed through juice.

Data#

`CONSENT_FILE`
`CONSENT_TEXT`
`DECLINE_TEXT`
`DETAILS_URL`
`ZEST_FOLDER`
`ZEST_CONSENT_FILE_JUICE`
`GREEN`
`RED`
`RESET`

API#

orangeqs.juice.orchestration.zest.CONSENT_FILE#: ‘/etc/orangeqs/zest/telemetry_consent_basic’

orangeqs.juice.orchestration.zest.CONSENT_TEXT#: ‘opt-in’

orangeqs.juice.orchestration.zest.DECLINE_TEXT#: ‘opt-out’

orangeqs.juice.orchestration.zest.DETAILS_URL#: ‘https://docs.orangeqs.com/juice/core/dev/concepts/telemetry.html’

orangeqs.juice.orchestration.zest.ZEST_FOLDER#: ‘/etc/orangeqs/zest’

orangeqs.juice.orchestration.zest.ZEST_CONSENT_FILE_JUICE#: ‘zest_basic_consent.toml’

orangeqs.juice.orchestration.zest.GREEN#: ‘\x1b[92m’

orangeqs.juice.orchestration.zest.RED#: ‘\x1b[91m’

orangeqs.juice.orchestration.zest.RESET#: ‘\x1b[0m’

orangeqs.juice.orchestration.zest.write_setup_id_and_name_to_zest_config(setup_id: str, setup_name: str) → None#

Write the setup ID and setup name to the configuration for zest.

If the files already exist, they will be updated if the content differs. This is used by orangeqs-zest to determine which setup is currently active. Note: This is used by zest only on the host system, not inside the services Inside the services, the setup ID and name are provided via environment variables.

Parameters#

setup_id (str): The setup ID to write.
setup_name (str): The setup name to write.

orangeqs.juice.orchestration.zest.request_user_consent_for_zest(zest_basic_consent: bool | None) → None#

Request user consent for orangeqs-zest telemetry, managed through juice.

This function checks if the user has already provided consent by checking the orchestration settings. If consent has not been provided, it prompts the user to opt in or out of telemetry collection.

It adds a file to the zest configuration directory for zest to work on the host OS. It also adds a file to the orchestration settings for zest to work inside the services.