From 91d8f1d605bac542e0c7ab38c31fe82dc2c5ba44 Mon Sep 17 00:00:00 2001 From: Xinwei Xiong <3293172751@qq.com> Date: Thu, 4 Jan 2024 12:15:11 +0800 Subject: [PATCH] Update env-template.yaml --- deployments/templates/env-template.yaml | 96 ++++++++++++------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/deployments/templates/env-template.yaml b/deployments/templates/env-template.yaml index 5e7e60081..1772af644 100644 --- a/deployments/templates/env-template.yaml +++ b/deployments/templates/env-template.yaml @@ -11,14 +11,14 @@ # Data storage directory for persistent data. # Example: DATA_DIR=/path/to/data -DATA_DIR=/data/workspaces/open-im-server +DATA_DIR=${DATA_DIR} # Docker image registry. Uncomment the preferred one. # Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk # IMAGE_REGISTRY="ghcr.io/openimsdk" # IMAGE_REGISTRY="openim" # IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk" -IMAGE_REGISTRY=ghcr.io/openimsdk +IMAGE_REGISTRY=${IMAGE_REGISTRY} # ====================================== # ========= Network Configuration ====== @@ -26,24 +26,24 @@ IMAGE_REGISTRY=ghcr.io/openimsdk # Subnet for the Docker network. # Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16 -DOCKER_BRIDGE_SUBNET=172.28.0.0/16 +DOCKER_BRIDGE_SUBNET=${DOCKER_BRIDGE_SUBNET} # Set and specify the IP addresses of some containers. Generally speaking, # you do not need to modify these configurations to facilitate debugging -DOCKER_BRIDGE_GATEWAY=172.28.0.1 -MONGO_NETWORK_ADDRESS=172.28.0.2 -REDIS_NETWORK_ADDRESS=172.28.0.3 -KAFKA_NETWORK_ADDRESS=172.28.0.4 -ZOOKEEPER_NETWORK_ADDRESS=172.28.0.5 -MINIO_NETWORK_ADDRESS=172.28.0.6 -OPENIM_WEB_NETWORK_ADDRESS=172.28.0.7 -OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.8 -OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.9 -PROMETHEUS_NETWORK_ADDRESS=172.28.0.10 -GRAFANA_NETWORK_ADDRESS=172.28.0.11 -NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12 -OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13 -ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14 +DOCKER_BRIDGE_GATEWAY=${DOCKER_BRIDGE_GATEWAY} +MONGO_NETWORK_ADDRESS=${MONGO_NETWORK_ADDRESS} +REDIS_NETWORK_ADDRESS=${REDIS_NETWORK_ADDRESS} +KAFKA_NETWORK_ADDRESS=${KAFKA_NETWORK_ADDRESS} +ZOOKEEPER_NETWORK_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS} +MINIO_NETWORK_ADDRESS=${MINIO_NETWORK_ADDRESS} +OPENIM_WEB_NETWORK_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS} +OPENIM_SERVER_NETWORK_ADDRESS=${OPENIM_SERVER_NETWORK_ADDRESS} +OPENIM_CHAT_NETWORK_ADDRESS=${OPENIM_CHAT_NETWORK_ADDRESS} +PROMETHEUS_NETWORK_ADDRESS=${PROMETHEUS_NETWORK_ADDRESS} +GRAFANA_NETWORK_ADDRESS=${GRAFANA_NETWORK_ADDRESS} +NODE_EXPORTER_NETWORK_ADDRESS=${NODE_EXPORTER_NETWORK_ADDRESS} +OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=${OPENIM_ADMIN_FRONT_NETWORK_ADDRESS} +ALERT_MANAGER_NETWORK_ADDRESS=${ALERT_MANAGER_NETWORK_ADDRESS} # ============================================================================== # Configuration Update Instructions @@ -77,77 +77,77 @@ ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14 # ============================================================================== # Local IP address of the service. Modify if necessary. # Example: OPENIM_IP=172.28.0.1， -OPENIM_IP=14.155.87.4 +OPENIM_IP=${OPENIM_IP} # ----- ZooKeeper Configuration ----- # Port for ZooKeeper service. # Default: ZOOKEEPER_PORT=12181 -ZOOKEEPER_PORT=12181 +ZOOKEEPER_PORT=${ZOOKEEPER_PORT} # Port on which MongoDB service is running. # Default: MONGO_PORT=37017 -# MONGO_PORT=37017 +# MONGO_PORT=${MONGO_PORT} # Username to authenticate with the MongoDB service. # Default: MONGO_USERNAME=root -# MONGO_USERNAME=root +# MONGO_USERNAME=${MONGO_USERNAME} # Password to authenticate with the MongoDB service. # Default: MONGO_PASSWORD=openIM123 -MONGO_PASSWORD=openIM123 +MONGO_PASSWORD=${MONGO_PASSWORD} # Name of the database in MongoDB to be used. # Default: MONGO_DATABASE=openIM_v3 -MONGO_DATABASE=openIM_v3 +MONGO_DATABASE=${MONGO_DATABASE} # ----- Redis Configuration ----- # Port on which Redis in-memory data structure store is running. # Default: REDIS_PORT=16379 -REDIS_PORT=16379 +REDIS_PORT=${REDIS_PORT} # Password to authenticate with the Redis service. # Default: REDIS_PASSWORD=openIM123 -REDIS_PASSWORD=openIM123 +REDIS_PASSWORD=${REDIS_PASSWORD} # Kakfa username to authenticate with the Kafka service. -# KAFKA_USERNAME='' +# KAFKA_USERNAME=${KAFKA_USERNAME} # Port on which Kafka distributed streaming platform is running. # Default: KAFKA_PORT=19092 -KAFKA_PORT=19094 +KAFKA_PORT=${KAFKA_PORT} # Topic in Kafka for storing the latest messages in Redis. # Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis -KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis +KAFKA_LATESTMSG_REDIS_TOPIC=${KAFKA_LATESTMSG_REDIS_TOPIC} # MINIO_PORT # ---------- # MINIO_PORT sets the port for the MinIO object storage service. -# Upon changing this port, the MinIO endpoint URLs in the file must be updated +# Upon changing this port, the MinIO endpoint URLs in the `config/config.yaml` file must be updated # to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' # under the MinIO configuration. # # Default: MINIO_PORT=10005 -MINIO_PORT=10005 +MINIO_PORT=${MINIO_PORT} # Access key to authenticate with the MinIO service. # Default: MINIO_ACCESS_KEY=root -# MINIO_ACCESS_KEY=root +# MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY} # Secret key corresponding to the access key for MinIO authentication. # Default: MINIO_SECRET_KEY=openIM123 -MINIO_SECRET_KEY=openIM123 +MINIO_SECRET_KEY=${MINIO_SECRET_KEY} # ----- Prometheus Configuration ----- # Port on which Prometheus service is running. # Default: PROMETHEUS_PORT=19090 -PROMETHEUS_PORT=19090 +PROMETHEUS_PORT=${PROMETHEUS_PORT} # ----- Grafana Configuration ----- # Port on which Grafana service is running. # Default: GRAFANA_PORT=13000 -GRAFANA_PORT=13000 +GRAFANA_PORT=${GRAFANA_PORT} # ====================================== # ============ OpenIM Web =============== @@ -155,18 +155,18 @@ GRAFANA_PORT=13000 # Path to the OpenIM web distribution. # Default: OPENIM_WEB_DIST_PATH=/app/dist -OPENIM_WEB_DIST_PATH=/app/dist +OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH} # Port on which OpenIM web service is running. # Default: OPENIM_WEB_PORT=11001 -OPENIM_WEB_PORT=11001 +OPENIM_WEB_PORT=${OPENIM_WEB_PORT} # ====================================== # ========= OpenIM Server ============== # ====================================== # Port for the OpenIM WebSockets. # Default: OPENIM_WS_PORT=10001 -OPENIM_WS_PORT=10001 +OPENIM_WS_PORT=${OPENIM_WS_PORT} # API_OPENIM_PORT # --------------- @@ -175,7 +175,7 @@ OPENIM_WS_PORT=10001 # to ensure the API service is accessible at the new port. # # Default: API_OPENIM_PORT=10002 -API_OPENIM_PORT=10002 +API_OPENIM_PORT=${API_OPENIM_PORT} # ====================================== # ========== OpenIM Chat =============== @@ -183,21 +183,21 @@ API_OPENIM_PORT=10002 # Branch name for OpenIM chat. # Default: CHAT_IMAGE_VERSION=main -CHAT_IMAGE_VERSION=main +CHAT_IMAGE_VERSION=${CHAT_IMAGE_VERSION} # Port for the OpenIM chat API. # Default: OPENIM_CHAT_API_PORT=10008 # !!! TODO: Do not change the chat port https://github.com/openimsdk/chat/issues/365 -OPENIM_CHAT_API_PORT=10008 +OPENIM_CHAT_API_PORT=${OPENIM_CHAT_API_PORT} # Port for the OpenIM admin API. # Default: OPENIM_ADMIN_API_PORT=10009 # !!! TODO: Do not change the chat port https://github.com/openimsdk/chat/issues/365 -OPENIM_ADMIN_API_PORT=10009 +OPENIM_ADMIN_API_PORT=${OPENIM_ADMIN_API_PORT} # Directory path for storing data files or related information for OpenIM chat. # Default: OPENIM_CHAT_DATA_DIR=./openim-chat/main -OPENIM_CHAT_DATA_DIR=./openim-chat/main +OPENIM_CHAT_DATA_DIR=${OPENIM_CHAT_DATA_DIR} # ====================================== # ========== OpenIM Admin ============== @@ -205,24 +205,24 @@ OPENIM_CHAT_DATA_DIR=./openim-chat/main # Branch name for OpenIM server. # Default: SERVER_IMAGE_VERSION=main -SERVER_IMAGE_VERSION=main +SERVER_IMAGE_VERSION=${SERVER_IMAGE_VERSION} # Port for the node exporter. # Default: NODE_EXPORTER_PORT=19100 -NODE_EXPORTER_PORT=19100 +NODE_EXPORTER_PORT=${NODE_EXPORTER_PORT} # Port for the prometheus. # Default: PROMETHEUS_PORT=19090 -PROMETHEUS_PORT=19090 +PROMETHEUS_PORT=${PROMETHEUS_PORT} # Port for the grafana. # Default: GRAFANA_PORT=13000 -GRAFANA_PORT=13000 +GRAFANA_PORT=${GRAFANA_PORT} # Port for the admin front. # Default: OPENIM_ADMIN_FRONT_PORT=11002 -OPENIM_ADMIN_FRONT_PORT=11002 +OPENIM_ADMIN_FRONT_PORT=${OPENIM_ADMIN_FRONT_PORT} # Port for the alertmanager. # Default: ALERT_MANAGER_PORT=19093 -ALERT_MANAGER_PORT=19093 +ALERT_MANAGER_PORT=${ALERT_MANAGER_PORT}