From 75375adf62cb0db4b39bf4aa446ed8c302ae7bf4 Mon Sep 17 00:00:00 2001 From: Xinwei Xiong <3293172751@qq.com> Date: Sat, 18 Nov 2023 12:36:30 +0800 Subject: [PATCH] feat: deployment and design of management backend and monitoring (#1432) Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> --- deployments/templates/env_template.yaml | 4 ++-- docs/contrib/environment.md | 4 ++-- docs/contrib/prometheus-grafana.md | 4 ++-- scripts/install/environment.sh | 2 +- scripts/install/install-protobuf.sh | 2 ++ 5 files changed, 9 insertions(+), 7 deletions(-) diff --git a/deployments/templates/env_template.yaml b/deployments/templates/env_template.yaml index 398fbb820..954b2cf65 100644 --- a/deployments/templates/env_template.yaml +++ b/deployments/templates/env_template.yaml @@ -225,7 +225,7 @@ PROMETHEUS_PORT=${PROMETHEUS_PORT} GRAFANA_ADDRESS=${GRAFANA_NETWORK_ADDRESS} # Port on which Grafana service is running. -# Default: GRAFANA_PORT=3000 +# Default: GRAFANA_PORT=13000 GRAFANA_PORT=${GRAFANA_PORT} # ====================================== @@ -303,7 +303,7 @@ NODE_EXPORTER_PORT=${NODE_EXPORTER_PORT} PROMETHEUS_PORT=${PROMETHEUS_PORT} # Port for the grafana. -# Default: GRAFANA_PORT=3000 +# Default: GRAFANA_PORT=13000 GRAFANA_PORT=${GRAFANA_PORT} # Port for the admin front. diff --git a/docs/contrib/environment.md b/docs/contrib/environment.md index 20939f213..221efdf03 100644 --- a/docs/contrib/environment.md +++ b/docs/contrib/environment.md @@ -150,7 +150,7 @@ For convenience, configuration through modifying environment variables is recomm + **Description**: API address. + **Note**: If the server has an external IP, it will be automatically obtained. For internal networks, set this variable to the IP serving internally. - ``` + ```bash export API_URL="http://ip:10002" ``` @@ -412,7 +412,7 @@ Configuration for Grafana, including its port and address. | Parameter | Example Value | Description | | --------------- | -------------------------- | --------------------- | -| GRAFANA_PORT | "3000" | Port used by Grafana. | +| GRAFANA_PORT | "13000" | Port used by Grafana. | | GRAFANA_ADDRESS | "${DOCKER_BRIDGE_GATEWAY}" | Address for Grafana. | ### 2.16. RPC Port Configuration Variables diff --git a/docs/contrib/prometheus-grafana.md b/docs/contrib/prometheus-grafana.md index 349c1b884..a59847f71 100644 --- a/docs/contrib/prometheus-grafana.md +++ b/docs/contrib/prometheus-grafana.md @@ -39,7 +39,7 @@ OpenIM offers various flexible deployment options to suit different environments and requirements. Here is a simplified and optimized description of these deployment options: 1. Source Code Deployment: - + **Regular Source Code Deployment**: Deployment using the `nohup` method. This is a basic deployment method suitable for development and testing environments. For details, refer to the [Regular Source Code Deployment Guide](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment). + + **Regular Source Code Deployment**: Deployment using the `nohup` method. This is a basic deployment method suitable for development and testing environments. For details, refer to the [Regular Source Code Deployment Guide](https://docs.openim.io/). + **Production-Level Deployment**: Deployment using the `system` method, more suitable for production environments. This method provides higher stability and reliability. For details, refer to the [Production-Level Deployment Guide](https://docs.openim.io/guides/gettingStarted/install-openim-linux-system). 2. Cluster Deployment: + **Kubernetes Deployment**: Provides two deployment methods, including deployment through Helm and sealos. This is suitable for environments that require high availability and scalability. Specific methods can be found in the [Kubernetes Deployment Guide](https://docs.openim.io/guides/gettingStarted/k8s-deployment). @@ -74,7 +74,7 @@ docker compose up -d To configure Prometheus data sources in Grafana, follow these steps: -1. **Log in to Grafana**: First, open your web browser and access the Grafana URL. If you haven't changed the port, the address is typically [http://localhost:3000](http://localhost:3000/). +1. **Log in to Grafana**: First, open your web browser and access the Grafana URL. If you haven't changed the port, the address is typically [http://localhost:13000](http://localhost:13000/). 2. **Log in with default credentials**: Grafana's default username and password are both `admin`. You will be prompted to change the password on your first login. diff --git a/scripts/install/environment.sh b/scripts/install/environment.sh index ed8c18276..777f88e18 100755 --- a/scripts/install/environment.sh +++ b/scripts/install/environment.sh @@ -289,7 +289,7 @@ readonly ALERTMANAGER_EMAIL_SUBJECT=${ALERTMANAGER_EMAIL_SUBJECT:-"{EMAIL_SUBJEC readonly ALERTMANAGER_SEND_RESOLVED=${ALERTMANAGER_SEND_RESOLVED:-"{SEND_RESOLVED:-'true'}"} ###################### Grafana 配置信息 ###################### -def "GRAFANA_PORT" "3000" # Grafana的端口 +def "GRAFANA_PORT" "13000" # Grafana的端口 def "GRAFANA_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # Grafana的地址 ###################### RPC Port Configuration Variables ###################### diff --git a/scripts/install/install-protobuf.sh b/scripts/install/install-protobuf.sh index c75dc7e25..33ceaeb0d 100755 --- a/scripts/install/install-protobuf.sh +++ b/scripts/install/install-protobuf.sh @@ -22,6 +22,8 @@ # It can be downloaded from the following link: # https://github.com/OpenIMSDK/Open-IM-Protoc/releases/tag/v1.0.0 # +# About the tool: +# https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc-tools.md # Download link (Windows): https://github.com/OpenIMSDK/Open-IM-Protoc/releases/download/v1.0.0/windows.zip # Download link (Linux): https://github.com/OpenIMSDK/Open-IM-Protoc/releases/download/v1.0.0/linux.zip #