Configuration

The configuration modules provide settings and configuration classes for the CLI. These modules define default values, environment variables, and configuration schemas used throughout the SDK.

Authentication Manager Configuration

Configuration settings for the authentication manager.

Copyright 2021 Kelvin Inc.

Licensed under the Kelvin Inc. Developer SDK License Agreement (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.kelvininc.com/developer-sdk-license

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class kelvin.sdk.lib.configs.auth_manager_configs.AuthManagerConfigs

Bases: object

kelvin_client_timeout_thresholds = (10.0, 30.0)

invalid_session_message: str = 'No valid session found. Please login.'

browser_auth_port: int = 38638

browser_auth_redirect_uri = 'http://localhost:38638'

browser_auth_client_id: str = 'kelvin-client'

browser_auth_timeout: int = 30

Click Configuration

Configuration for Click CLI framework customizations.

Docker Configuration

Configuration settings for Docker operations.

Copyright 2021 Kelvin Inc.

Licensed under the Kelvin Inc. Developer SDK License Agreement (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.kelvininc.com/developer-sdk-license

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class kelvin.sdk.lib.configs.docker_configs.DockerConfigs

Bases: object

docker_client_timeout: int = 120

docker_dependency: str = 'docker'

latest_docker_image_version: str = 'latest'

default_ksdk_network: str = 'ksdk'

default_ksdk_network_driver: str = 'bridge'

ksdk_base_identification_label: dict = {'source': 'ksdk'}

ksdk_app_identification_label: dict = {'name': '', 'source': 'ksdk', 'type': ''}

container_app_dir_path: str = '/opt/kelvin/app'

container_app_config_file_path: str = '/opt/kelvin/app/app.yaml'

app_unpack_temp_file: str = 'unpack_temp_file'

app_container_app_dir: str = 'app'

default_unpack_app_name: str = 'unpack'

layer_base_description: str = '[Layer: {layer_id}] [Pending..]'

layer_download_success_description: str = '[Layer: {layer_id}] - [{status}] {progress}'

progress_bar_format: str = ' [elapsed: {elapsed}] - {desc} {bar} '

Emulation Configuration

Configuration settings for application emulation and testing.

Copyright 2021 Kelvin Inc.

Licensed under the Kelvin Inc. Developer SDK License Agreement (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.kelvininc.com/developer-sdk-license

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class kelvin.sdk.lib.configs.emulation_configs.EmulationConfigs

Bases: object

emulation_system_node: str = 'emulation'

emulation_system_access_local_app_registry: str = 'Running applications'

emulation_system_native_applications_message: str = 'Emulation System native applications'

class kelvin.sdk.lib.configs.emulation_configs.StudioConfigs(host='localhost', port=8000, default_port=8000, studio_schema_file_bind='{schema_file_path}:/opt/kelvin/app/server/data/{schema_file_name}:Z', studio_input_file_bind='{input_file_path}:/opt/kelvin/app/server/data/{input_file_name}:Z')

Bases: object

Parameters:

• host (str)

• port (int)

• default_port (int)

• studio_schema_file_bind (str)

• studio_input_file_bind (str)

host: str = 'localhost'

port: int = 8000

default_port: int = 8000

studio_schema_file_bind: str = '{schema_file_path}:/opt/kelvin/app/server/data/{schema_file_name}:Z'

studio_input_file_bind: str = '{input_file_path}:/opt/kelvin/app/server/data/{input_file_name}:Z'

get_url()

Return type:

str

is_port_open()

Return type:

bool

class kelvin.sdk.lib.configs.emulation_configs.ControlManagerConfigs

Bases: object

control_manager_config_file: str = '/kelvin/app/config.yaml'

default_control_manager_config_content: str = '\nnode: emulation\nmqtt:\n  host: kelvin-mqtt-broker.app\n  port: 1883\n'

General Configuration

General SDK configuration settings and constants.

Copyright 2021 Kelvin Inc.

Licensed under the Kelvin Inc. Developer SDK License Agreement (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.kelvininc.com/developer-sdk-license

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class kelvin.sdk.lib.configs.general_configs.KSDKHelpMessages

Bases: object

verbose: str = 'Display all executed steps to the screen.'

yes: str = 'If specified, will ignore the destructive warning of the operation and proceed.'

docs: str = 'Open the kelvin-sdk documentation webpage.'

tree_title: str = '\n        Kelvin Command Overview.\n    '

tree_help: str = 'Display all available commands in a tree structure.'

current_session_login: str = 'No current session available.'

login_username: str = 'The username used to login on the platform.'

login_password: str = 'The password corresponding to the provided user.'

login_totp: str = 'The time-based one-time password (TOTP) corresponding to the provided user.'

browser: str = 'If specified ksdk opens a browser window to proceed with the authentication.'

client_id: str = 'The client ID to be used for authentication.'

client_secret: str = 'The client secret to be used for authentication.'

reset: str = 'If specified will reset all local configuration files required by this tool.'

no_store: str = 'If specified, the provided credentials will not be stored in the local keyring.'

token_full: str = 'Return the full authentication token, not just the access authentication token field.'

token_margin: str = '\n        Minimum time to expiry (in seconds) for authentication token (new authentication_token retrieved if previous authentication token expires within margin).\n        \x08\n        Set to 0 to retrieve a new authentication_token.\n    '

app_name: str = 'The name of the application'

app_version: str = 'The version of the application (eg: 1.0.1)'

app_assets_array: str = 'Comma separated list of assets (eg: beam1,beam2,beam3). No spaces between commas are allowed.'

app_asset: str = 'A single asset (eg: beam1). Option can be repeated.'

app_description: str = 'A simple description for the new app.'

app_type: str = '\n        Specify the application type. \n\n        Default: "app"\n    '

flavour: str = '\n        Specify the kelvin application flavour. \n\n        Default: "default"\n    '

kelvin_app_lang: str = '\n        The programming language of the application.\n        Applicable only to applications of type "kelvin". \n\n        Default: "python"\n    '

app_dir: str = "The path to the application's directory. Assumes the current directory if not specified."

status_source: str = "\n        The source of data to read from.\n        Retrieve from 'cache' or force a 'live' update. \n\n        Default: 'cache'.\n    "

app_images_unpack_container_dir: str = 'The directory to extract from the container.'

app_images_unpack_output_dir: str = 'The directory into which the extracted content will be placed.'

apps_download_tag_local_name: str = 'Specifies whether or not the local name should be tagged (no registry).'

app_build_args = 'docker build-args'

app_build_multiarch: str = 'Comma-separated list of architectures to build. Supported: amd64,arm64,arm32. Any other value will be passed to docker build engine as is.'

skip_schema_validation: str = 'Skip schema validation during build process.'

apps_image_upload: str = 'Docker image to upload'

apps_app_yaml: str = 'Path to application configuration file (app.yaml)'

bridge_cluster_name: str = 'The name of the cluster (or node) to deploy the bridge to.'

bridge_name: str = 'The friendly name of the bridge.'

bridge_title: str = 'The title of the bridge.'

bridge_protocol: str = 'The protocol to be used by the bridge. May be one of: [opc-ua, mqtt, modbus, roc]'

bridge_config: str = 'The configuration file (e.g. app.yaml) to be used by the bridge.'

workload_list_node_name: str = 'The node name used to filter the workloads.'

workload_list_app_name: str = 'The app name, with version, used to filter the workloads.'

workload_deploy_node_name: str = 'The node to associate to the new workload.'

workload_deploy_workload_name: str = 'The name of the workload.'

workload_deploy_workload_title: str = 'The title of the workload.'

workload_deploy_app_config: str = 'App configuration file (app.yaml).'

workload_deploy_runtime: str = 'Workload runtime configuration.'

workload_deploy_bulk_file_type: str = 'Type of the workload file.'

workload_deploy_bulk_ignore_failures: str = 'Ignore deployment failures and automatically continue.'

workload_deploy_bulk_skip_successes: str = 'Skip deployments already marked as successful.'

workload_deploy_bulk_delay: str = 'Delay to wait between updates.'

workload_deploy_bulk_variable: str = 'Extra variables for configuration template.'

workload_deploy_bulk_dry_run: str = 'Dry-run to validate inputs only.'

workload_update_workload_title: str = 'The new title of the workload.'

workload_update_app_config: str = 'The new configuration to be set on the existing workload.'

workload_logs_tail_lines: str = 'The number of lines to display.'

workload_logs_output_file: str = 'The output file to write the logs into.'

workload_logs_follow: str = 'If specified, follows the logs.'

datatype_list_all: str = 'If specified, will list all data types and its respective versions.'

datatype_create_output_dir: str = 'The directory where the new data type will be created.'

datatype_upload_input_dir: str = 'The directory to read the data types from.'

datatype_upload_names: str = 'The data type names to filter the upload operation.'

datatype_download_output_dir: str = 'The directory where the downloaded data type will be put.'

fresh: str = 'If specified will remove any cache and rebuild the application from scratch.'

show_logs: str = "Log the application's output once started."

emulation_logs_tail_lines: str = 'Tails the container logs.'

emulation_logs_follow_lines: str = 'Follows the container logs stream'

emulation_app_config: str = 'The app configuration file to be used on the emulation.'

report_app_config_file: str = 'The path fo the app configuration file to be reported.'

kelvin_server_port: str = 'Specifies the kelvin server port.'

kelvin_server_colored_logs: str = "Indicates whether all logs should be colored and 'pretty' formatted."

kelvin_server_working_dir: str = '\n    Specifies the kelvin server context directory where temporary files will be handled.\n    '

schema_file: str = 'The path to the schema file to validate the file against.'

studio_schema_file: str = "The schema file used to power the Kelvin Studio's interface."

studio_input_file: str = 'The input file to modify based on the schema file.'

studio_port: str = 'Specifies the studio server port.'

studio_no_browser: str = 'If specified, Kelvin Studio will not be automatically opened on the default browser.'

secret_create_value: str = 'The value corresponding to the secret.'

secret_list_filter: str = 'The query to filter the secrets by.'

asset_type_name: str = 'The asset type name to associate to the asset.'

asset_title: str = 'The title to associate to the asset.'

asset_entity_type_name: str = 'The Device Type to associate to the asset.'

asset_parent_name: str = 'Asset name of the parent asset'

autocomplete_message: str = 'Generate command-completion configuration for KSDK commands.\n        \x08\n\n        To configure your shell to complete KSDK commands:\n\n        \x08\n            Bash:\n\n                $ kelvin configuration autocomplete --shell bash > ~/.bashrc.ksdk\n                $ echo "source ~/.bashrc.ksdk" >> ~/.bashrc\n\n        \x08\n            ZSH:\n\n                $ kelvin configuration autocomplete --shell zsh > ~/.zshrc.ksdk\n                $ echo "source ~/.zshrc.ksdk" >> ~/.zshrc'

shell: str = 'Name of the shell to generate completion configuration, e.g. bash, zsh, fish'

mlflow_registry_uri: str = 'MLFlow registry URI.'

mlflow_model_uri: str = "The URI of the MLFlow model. Eg: 'models:/name/version'."

mlflow_app_name: str = 'App name, defaults to the model name.'

class kelvin.sdk.lib.configs.general_configs.GeneralConfigs

Bases: object

docs_url: str = 'https://docs.kelvininc.com'

default_report_file: str = 'kelvin_report.txt'

default_ksdk_configuration_dir: str = '~/.config/kelvin/'

default_ksdk_temp_dir: str = 'temp'

default_ksdk_schema_storage_dir: str = 'schemas'

default_ksdk_history_file: str = 'ksdk_history.log'

default_ksdk_configuration_file: str = 'ksdk.yaml'

default_kelvin_sdk_client_configuration_file: str = 'client.yaml'

default_app_description: str = 'Default description.'

default_app_version: str = '1.0.0'

default_build_dir: str = 'build'

default_data_dir: str = 'data'

default_datatype_dir: str = 'datatype'

default_docs_dir: str = 'docs'

default_tests_dir: str = 'tests'

default_wheels_dir: str = 'wheels'

default_python_init_file: str = '__init__.py'

default_python_main_file: str = '__main__.py'

default_python_pyproject_file: str = 'pyproject.toml'

default_python_setup_file: str = 'setup.py'

default_python_test_file: str = 'test_application.py'

default_app_config_file: str = 'app.yaml'

default_alternative_config_file: str = 'config.yaml'

default_git_keep_file: str = '.keep'

default_git_ignore_file: str = '.gitignore'

default_dockerignore_file: str = '.dockerignore'

default_requirements_file: str = 'requirements.txt'

default_dockerfile: str = 'Dockerfile'

default_mqtt_config_file: str = '/mosquitto/config/mosquitto.conf'

default_mqtt_config_content: str = 'listener 1883\nallow_anonymous true'

default_mqtt_port: int = 1883

table_title: str = '*************************** {title} ***************************'

default_datetime_visualization_format: str = '%Y-%m-%d %H:%M:%S %z'

default_datetime_and_elapsed_display: str = '{base_date}  ({now_minus_base_date})'

code_samples_url: str = 'https://github.com/kelvininc/app-samples'

class kelvin.sdk.lib.configs.general_configs.GeneralMessages

Bases: object

invalid_name: str = 'The provided name is not valid. \nErrors:\n{reason}'

no_data_yielded: str = 'No data yielded.'

no_data_available: str = 'No data available.'

are_you_sure_question: str = '\t    Are you sure? {prompt}'

provide_a_valid_response: str = "Please provide a valid response. ['yes','y','no','n']\n"

invalid_file_or_directory: str = 'Please provide a valid file type and/or directory.'

PyPI Configuration

Configuration settings for PyPI package management.

Copyright 2021 Kelvin Inc.

Licensed under the Kelvin Inc. Developer SDK License Agreement (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.kelvininc.com/developer-sdk-license

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class kelvin.sdk.lib.configs.pypi_configs.PypiConfigs

Bases: object

env_key: str = ':env:'

global_key: str = 'global'

pypi_index_url_key: str = 'index-url'

pypi_extra_index_url_key: str = 'extra-index-url'

kelvin_pypi_internal_repository: str = 'https://nexus.kelvininc.com/repository/pypi-internal/simple'

Schema Manager Configuration

Configuration settings for schema management.

Copyright 2021 Kelvin Inc.

Licensed under the Kelvin Inc. Developer SDK License Agreement (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.kelvininc.com/developer-sdk-license

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class kelvin.sdk.lib.configs.schema_manager_configs.SchemaManagerConfigs

Bases: object

general_app_schema_url: str = 'https://apps.kelvininc.com/schemas/kelvin/{version}/app/app.json'

request_timeout: int = 10