v2.3.3

Author: acn-ericlaw

CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+---
+## Version 2.3.3, 5/1/2022
+
+### Added
+
+N/A
+
+### Removed
+
+N/A
+
+### Changed
+
+Updated README and application.yml files
+
 ---
 ## Version 2.3.0, 1/8/2022
 

README.md

@@ -218,6 +218,27 @@ This will restore the metadata information for pip.
 pip install --ignore-installed git+https://github.com/Accenture/mercury-python.git
 ```
 
+## Application configuration file
+
+The default application config file is located in resources/application.yml.
+
+To use your own config file, please specify "config_file=your_config_file_path" when creating the platform instance.
+Please use application.yml as a template and update the parameters.
+e.g.
+```
+platform = Platform(config_file='/tmp/config/application.yml')
+```
+
+## language connector's shared secret key
+
+language.pack.key should point to an environment variable containing a secret key for connection to
+a language connector. If the environment variable does not exist, the system will get the secret key
+from the temporary local file system at /tmp/config/lang-api-key.txt
+
+If /tmp/config/lang-api-key.txt does not exist, the system will create a random secret key automatically.
+If the language connector and the python application are running in the same container, they will find each other
+without any configuration.
+
 ## Distributed tracing
 
 Microservices are likely to be deployed in a multi-tier environment. 

mercury/resources/application.yml

@@ -3,7 +3,11 @@
 # the websocket endpoint for a language connector sidecar
 network.connector: 'ws://127.0.0.1:8090/ws/lang'
 
-# the environment variable name for the API key to connect to a language connector
+#
+# language.pack.key should point to an environment variable containing a secret key for connection to
+# a language connector. If the environment variable does not exist, the system will get the secret key
+# from the temporary local file system at /tmp/config/lang-api-key.txt
+#
 language:
   pack:
     key: 'LANGUAGE_PACK_KEY'

setup.py

@@ -4,7 +4,7 @@
 from setuptools import setup
 
 setup(name='mercury',
-      version='2.3.0',
+      version='2.3.3',
       description='Python Language pack for Mercury',
       author='Eric Law',
       author_email='eric.law@accenture.com',