Per the Twelve-Factor App methodology,
configuration is stored in environment variables.
This is the standard practice for Docker-containerized applications deployed to orchestrators
such as Azure Kubernetes Service (AKS) and Azure Container Apps (ACA).
This reference implementation uses the following environment variables.
All of these begin with the prefix CAIG_.
| Name | Description | Where Used |
|---|---|---|
| CAIG_AZURE_OPENAI_COMPLETIONS_DEP | The name of your Azure OpenAI completions deployment. | WEB RUNTIME |
| CAIG_AZURE_OPENAI_EMBEDDINGS_DEP | The name of your Azure OpenAI embeddings deployment. | WEB RUNTIME |
| CAIG_AZURE_OPENAI_KEY | The Key of your Azure OpenAI account. | WEB RUNTIME |
| CAIG_AZURE_OPENAI_URL | The URL of your Azure OpenAI account. | WEB RUNTIME |
| CAIG_CONFIG_CONTAINER | The Cosmos DB container for configuration JSON values. | RUNTIME |
| CAIG_CONVERSATIONS_CONTAINER | The Cosmos DB container where the chat conversations and history are persisted. | WEB RUNTIME |
| CAIG_COSMOSDB_NOSQL_ACCT | The Name of your Cosmos DB NoSQL account. | RUNTIME |
| CAIG_COSMOSDB_NOSQL_AUTH_MECHANISM | The Cosmos DB NoSQL authentication mechanism; key or rbac. | RUNTIME |
| CAIG_COSMOSDB_NOSQL_KEY | The key of your Cosmos DB NoSQL account. | RUNTIME |
| CAIG_COSMOSDB_NOSQL_RG | The Resource Group of your Cosmos DB NoSQL account. | DEV ENV |
| CAIG_COSMOSDB_NOSQL_URI | The URI of your Cosmos DB NoSQL account. | RUNTIME |
| CAIG_FEEDBACK_CONTAINER | The Cosmos DB container where user feedback is persisted. | WEB RUNTIME |
| CAIG_GRAPH_DUMP_OUTFILE | The file to write to if CAIG_GRAPH_DUMP_UPON_BUILD is true. | GRAPH RUNTIME |
| CAIG_GRAPH_DUMP_UPON_BUILD | Boolean true/false to dump the Java/Jena model to CAIG_GRAPH_DUMP_OUTFILE. | GRAPH RUNTIME |
| CAIG_GRAPH_NAMESPACE | The custom namespace for the RED graph. | GRAPH RUNTIME |
| CAIG_GRAPH_SERVICE_NAME | Logical app name. | DEV ENV |
| CAIG_GRAPH_SERVICE_PORT | 8002 | WEB RUNTIME |
| CAIG_GRAPH_SERVICE_URL | http://127.0.0.1 or determined by ACA. | WEB RUNTIME |
| CAIG_GRAPH_SOURCE_CONTAINER | The graph Cosmos DB container name, if CAIG_GRAPH_SOURCE_TYPE is 'cosmos_nosql'. | GRAPH RUNTIME |
| CAIG_GRAPH_SOURCE_DB | The graph Cosmos DB database name, if CAIG_GRAPH_SOURCE_TYPE is 'cosmos_nosql'. | GRAPH RUNTIME |
| CAIG_GRAPH_SOURCE_OWL_FILENAME | The input RDF OWL ontology file. | GRAPH RUNTIME |
| CAIG_GRAPH_SOURCE_RDF_FILENAME | The RDF input file, if CAIG_GRAPH_SOURCE_TYPE is 'rdf_file'. | GRAPH RUNTIME |
| CAIG_GRAPH_SOURCE_TYPE | The RDF graph data source type, either 'cosmos_nosql', or 'json_docs_file' or 'rdf_file'. | GRAPH RUNTIME |
| CAIG_HOME | Root directory of the CosmosAIGraph GitHub repository on your system. | DEV ENV |
| CAIG_LOG_LEVEL | A standard python or java logging level name. | RUNTIME |
| CAIG_WEBSVC_AUTH_HEADER | Name of the custom HTTP authentication header; defaults to 'x-caig-auth'. | RUNTIME |
| CAIG_WEBSVC_AUTH_VALUE | your-secret-value | RUNTIME |
| CAIG_WEB_APP_NAME | Logical name. | DEV ENV |
| CAIG_WEB_APP_PORT | 8000 | WEB RUNTIME |
| CAIG_WEB_APP_URL | http://127.0.0.1 or determined by ACA. | WEB RUNTIME |
The repo contains generated PowerShell script impl/set-caig-env-vars-sample.ps1 which sets all of these CAIG_ environment values. You may find it useful to edit and execute this script rather than set them manually on your system
The python-dotenv library is used
in each subapplication of this implementation.
It allows you to define environment variables in a file named .env
and thus can make it easier to use this project during local development.
Please see the dotenv_example files in each subapplication for examples.
It is important for you to have a .gitignore entry for the .env file so that application secrets don't get leaked into your source control system.
The Java codebase in this repo implements similar logic to the python-dotenv described above.
See file example-override.properties in the impl/graph_app/ directory.