jpo-ode/sample.env at develop · CDOT-CV/jpo-ode · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
###################################
# JPO ODE Docker Environment File #
###################################
# WARNING! The contents of this file may be sensitive. Take care not to add to source control.
#
# Instructions:
#   Rename this file from `sample.env` to `.env` and Docker will automatically pick up the variables.
#
# Description:
#   This file aggregates all the variables used in docker-compose.yml for ease of use. Variables are
#   prefixed with the format DESTINATION_MESSAGETYPE_ to provide guidance. Some variables are filled
#   out with commonly used values.
###################################

####################
# General Properties

# (Required) The IP address of Docker host machine which can be found by running "ip -4 addr"
# Hint: look for "inet addr:" within "eth0" or "en0" for OSX
DOCKER_HOST_IP=

# (Required) The full path of a directory on the host machine to be shared with docker containers.
# Hint: usually the path to the `jpo-ode` directory.
DOCKER_SHARED_VOLUME=

# Docker compose restart policy: https://docs.docker.com/engine/containers/start-containers-automatically/
RESTART_POLICY="on-failure:3"

# (Required if values are not sent in REST request JSON messages)
# RSU SNMP username and password
ODE_RSU_USERNAME=
ODE_RSU_PASSWORD=

# (Required values to define what services spin up)
# Available profiles:
# - all
#   - ode_base
#       - ode
#       - adm
#       - aem
#   - ode_full
#       - ode
#       - adm
#       - aem
#       - ppm_bsm
#       - sdw_depositor
#       - sec
# All profiles from the jpo-utils repo are also allowed
# EXAMPLE: COMPOSE_PROFILES=ode_base,kafka_connect_standalone,kafka_setup
COMPOSE_PROFILES=ode_base,kafka,kafka_setup

# Values to sign TIM messages delivered to RSUs/SDX (accepted values are true or false)
# If not set, DATA_SIGNING_ENABLED_RSU will default to false
# If not set, DATA_SIGNING_ENABLED_SDW will default to true
DATA_SIGNING_ENABLED_RSU=
DATA_SIGNING_ENABLED_SDW=

# Default SNMP protocol version when not specified in the request
# Current supported values are FOURDOT1 and NTCIP1218
# If no protocol is specified the NTCIP1218 protocol will be used
DEFAULT_SNMP_PROTOCOL=

#########################
# Kafka and Confluent Cloud Properties

# While not strictly required for the ODE to operate properly. Setting this value is required to allow applications outside of the ODE's docker network to connect to Kafka.
# to connect to Kafka.
KAFKA_BOOTSTRAP_SERVERS=${DOCKER_HOST_IP}:9092

# The type of Kafka broker to connect to. If set to "CONFLUENT", the broker will be Confluent Cloud. Otherwise, it will be a local Kafka broker.
KAFKA_TYPE=
KAFKA_LINGER_MS=1

# Local Kafka broker properties - you can override these if you want, but the defaults should be fine for normal use
# The application will not boot if these environment variables are set to empty strings (e.g. KAFKA_BATCH_SIZE=)

KAFKA_COMPRESSION_TYPE="zstd"
KAFKA_BATCH_SIZE=16384
KAFKA_BUFFER_MEMORY=33554432
KAFKA_ACKS="all"
KAFKA_RETRIES=0
KAFKA_KEY_SERIALIZER="org.apache.kafka.common.serialization.StringSerializer"
KAFKA_VALUE_SERIALIZER="org.apache.kafka.common.serialization.StringSerializer"
KAFKA_PARTITIONER_CLASS="org.apache.kafka.clients.producer.internals.DefaultPartitioner"

# Confluent Cloud API access credentials (only required if KAFKA_TYPE is set to "CONFLUENT")
CONFLUENT_KEY=
CONFLUENT_SECRET=

#########################
# RocksDB Bounded Memory Config Properties
# 128 MB = 134217728
# 64 MB = 67108864
# 16 MB = 16777216
ODE_ROCKSDB_TOTAL_OFF_HEAP_MEMORY=134217728
ODE_ROCKSDB_INDEX_FILTER_BLOCK_RATIO=0.1
ODE_ROCKSDB_TOTAL_MEMTABLE_MEMORY=67108864
ODE_ROCKSDB_BLOCK_SIZE=4096
ODE_ROCKSDB_N_MEMTABLES=2
ODE_ROCKSDB_MEMTABLE_SIZE=16777216

#########################
# SDX Depositor Properties

## Required if using SDX depositor module (REST interface)
SDW_API_KEY=
SDW_DESTINATION_URL=https://sdx-service.trihydro.com/api/deposit-multi
SDW_SUBSCRIPTION_TOPIC=topic.SDWDepositorInput

## Optional overrides
SDW_EMAIL_LIST=error@email.com,test@test.com
SDW_EMAIL_FROM=error@email.com
SPRING_MAIL_HOST=
SPRING_MAIL_PORT=

#jpo-security-svcs module properties
SEC_CRYPTO_SERVICE_BASE_URI=http://${DOCKER_HOST_IP}:8091
SEC_CRYPTO_SERVICE_ENDPOINT_SIGN_PATH=/mock-signer/sign
SEC_USE_CERTIFICATES=false
ODE_SECURITY_SVCS_SIGNATURE_URI=

# These are just the file names expected to be found in the ODE directory
PPM_BSM_CONFIG_FILE=ppmBsm.properties
PPM_MAP_FILE=I_80.edges

# PPM Logging
PPM_BSM_LOG_TO_CONSOLE=true
PPM_BSM_LOG_TO_FILE=false
PPM_BSM_LOG_LEVEL=INFO

# ACM Logging
AEM_LOG_TO_CONSOLE=true
AEM_LOG_TO_FILE=false
AEM_LOG_LEVEL=INFO
ADM_LOG_TO_FILE=false
ADM_LOG_TO_CONSOLE=true
ADM_LOG_LEVEL=INFO

# ODE Monitoring
ODE_TIM_INGEST_MONITORING_ENABLED=true
# The interval is measured in seconds. 60 seconds is a sane default for local monitoring, but you may want to increase
# the interval to 3600 (1 hour) or more for production monitoring to reduce the noise in logs for healthy systems
ODE_TIM_INGEST_MONITORING_INTERVAL=60

# ODE STOMP Exporter for Demo UI
# Set this to false to save resources when running the application in a production environement. The StompStringExporter
# is exclusively used to support the Demo Console hosted at http://localhost:8080
ODE_STOMP_EXPORTER_ENABLED=true