Skip to content

Environment Variables

Tami Takamiya edited this page Mar 24, 2023 · 35 revisions

About this page

This page contains the list of environment variables read by Wisdom Service. Note that these variables are also specified in

When you add/modify/delete any environment variables read by Wisdom Service, please consider to spend ten minutes to update this page so that the information remains updated.

Contents

Django-specific

Name Default Description Read by
ANSIBLE_AI_CACHE_URI redis://redis:6379 (development), None (production) Location of Django cache (Redis). development.py, production.py
ANSIBLE_AI_DATABASE_HOST None Location of Django DB host (Postgres) base.py
ANSIBLE_AI_DATABASE_NAME None Name of Django DB base.py
ANSIBLE_AI_DATABASE_PASSWORD None Password of Django DB base.py
ANSIBLE_AI_DATABASE_PORT 5432 Port of Django DB base.py
ANSIBLE_AI_DATABASE_USER None User name of Django DB base.py
DJANGO_SETTINGS_MODULE main.settings.development Django settings module wsgi.py, asgi.py, manage.py
SECRET_KEY None A secret used for Django base.py, development.py, production.py

Model Server

Name Default Description Read by
ANSIBLE_AI_MODEL_MESH_API_TIMEOUT None (=no timeout) Inference API timeout in secs base.py
ANSIBLE_AI_MODEL_MESH_API_TYPE http Protocol used for AI Model backend ("http", "grpc", or "mock" [=mock server backend]) development.py, production.py
ANSIBLE_AI_MODEL_MESH_HOST (This URL) (development), None (production) Location of Model server development.py, production.py
ANSIBLE_AI_MODEL_MESH_INFERENCE_PORT 443 (development), None (production) Port number of Model server development.py production.py

Attributions

Name Default Description Read by
ANSIBLE_AI_SEARCH_HOST '' (empty string) Elasticsearch hostname used for Attributions API base.py
ANSIBLE_AI_SEARCH_PORT 443 Elasticsearch port number used for Attributions API base.py
ANSIBLE_AI_SEARCH_KEY None Search key for Attributions API base.py
ANSIBLE_AI_SEARCH_SECRET None Search secret for Attributions API base.py
ANSIBLE_AI_SEARCH_REGION None Search region for Attributions API base.py
ANSIBLE_AI_SEARCH_INDEX attribution Search index for Attributions API base.py
ANSIBLE_AI_SEARCH_MODEL all-MiniLM-L6-v2 Search model for Attributions API base.py
ANSIBLE_AI_SEARCH_DIMENSION 384 Search dimension for Attributions API base.py
ANSIBLE_AI_SEARCH_METHOD 'name:hnsw,space_type:innerproduct,engine:nmslib Search methods for Attributions API base.py

Authentication

Name Default Description Read by
SOCIAL_AUTH_GITHUB_TEAM_ID 7188893 GitHub team ID for authentication base.py
SOCIAL_AUTH_GITHUB_TEAM_KEY None GitHub team Key for authentication base.py
SOCIAL_AUTH_GITHUB_TEAM_SECRET None GitHub team secret for authentication base.py
Name Default Description Read by
ARI_KB_PATH /etc/ari/kb/ Default KB (?) path for ARI base.py
ARI_RULE_FOR_OUTPUT_RESULT W007 ARI rule for output result base.py
ARI_RULES [ P001, P002, P003, P004, W001, W003, W004, W005, W006, W007, W008, W009, W010, W012, W013] Rules to be used with ARI base.py
ENABLE_ARI_POSTPROCESS False Enables ARI base.py

Production Environment/Pilot-related

Name Default Description Read by
ANSIBLE_WISDOM_DOMAIN None Domain for allowed hosts production.py
PILOT_CONTACT #ansible-wisdom-pilot on Internal Red Hat Slack Contact point on Wisdom Pilot base.py
PILOT_DOCS_URL (This URL) Document location for Wisdom Pilot base.py
SIGNUP_URL (This URL) Sign-up page for Wisdom Pilot base.py

API Rate Throttle, Analytics

Name Default Description Read by
COMPLETION_USER_RATE_THROTTLE 10/minute User rate throttle for the completion API base.py
SEGMENT_WRITE_KEY None Write key for sending analytic data to Segment.com base.py

Mock Model

Name Default Description Read by
MOCK_MODEL_RESPONSE_BODY '{"predictions":[" ansible.builtin.apt:\n name: nginx\nupdate_cache: true\n state: present\n"]}' Response body returned by the mock model base.py
MOCK_MODEL_RESPONSE_LATENCY_MSEC 3000 Latency used by the mock client base.py
MOCK_MODEL_RESPONSE_LATENCY_USE_JITTER False Whether jitter is used in latency by the mock client base.py
Clone this wiki locally