-
Notifications
You must be signed in to change notification settings - Fork 18
Environment Variables
Tami Takamiya edited this page Oct 5, 2023
·
35 revisions
This page contains the list of environment variables read by Wisdom Service. Note that these variables are also specified in
- Resources used in deployment
- Docker (Podman) Compose file
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.
- Django-specific
- Model Server
- watsonx Code Assistant (WCA)
- Attributions
- Authentication
- Postprocessing/Ansible Risk Insight (ARI)
- Production Environment/Pilot-related
- API Rate Throttle, Analytics
- Mock Model
| 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 |
| ALLOWED_CIDR_NETS | |||
| MULTI_TASK_MAX_REQUESTS | |||
| DJANGO_LOG_LEVEL | |||
| LAUNCHDARKLY_SDK_KEY |
| Name | Default | Description | Read by |
|---|---|---|---|
| ANSIBLE_AI_MODEL_MESH_API_HEALTHCHECK_PROTOCOL | https | Protocol used for health check on model server (grpc) | development.py, production.py |
| 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 |
| ANSIBLE_AI_MODEL_NAME |
| Name | Default | Description | Read by |
|---|---|---|---|
| ANSIBLE_WCA_INFERENCE_URL | |||
| ANSIBLE_WCA_FREE_API_KEY | |||
| ANSIBLE_WCA_FREE_MODEL_ID | |||
| ANSIBLE_WCA_RETRY_COUNT | 4 | ||
| WCA_SECRET_MANAGER_ACCESS_KEY | |||
| WCA_SECRET_MANAGER_SECRET_ACCESS_KEY | |||
| WCA_SECRET_MANAGER_KMS_KEY_ID | |||
| WCA_SECRET_MANAGER_PRIMARY_REGIONS |
| 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 |
| 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 |
| SOCIAL_AUTH_GITHUB_KEY | |||
| SOCIAL_AUTH_GITHUB_SECRET | |||
| SOCIAL_AUTH_OIDC_OIDC_ENDPOINT | |||
| SOCIAL_AUTH_OIDC_KEY | |||
| AUTHZ_BACKEND_TYPE | |||
| AUTHZ_SSO_CLIENT_ID | |||
| AUTHZ_SSO_CLIENT_SECRET | |||
| AUTHZ_SSO_SERVER | |||
| AUTHZ_API_SERVER |
Postprocessing / Ansible Risk Insight (ARI)
| 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 |
| ENABLE_ANSIBLE_LINT_POSTPROCESS |
| 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 |
| 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 |
| 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_MAX_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 |