Skip to content

Commit e7ca134

Browse files
authored
timeseries: Updated README.md and added CHANGELOG file (open-edge-platform#948)
This PR simplifies the README.md by removing detailed architecture content and adds a new CHANGELOG file documenting release 2025.2 changes. Additionally, fixed the pre-merge workflow issues. Signed-off-by: B, Vinod K <vinod.k.b@intel.com>
1 parent a6f682f commit e7ca134

File tree

4 files changed

+87
-40
lines changed

4 files changed

+87
-40
lines changed

.github/workflows/industrial-edge-insights-time-series-pull-request.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,20 +59,17 @@ jobs:
5959
make down
6060
# Generate random values for sensitive environment variables
6161
INFLUXDB_USERNAME=$(cat /dev/urandom | tr -dc 'a-zA-Z' | head -c 8)
62-
INFLUXDB_PASSWORD=$(openssl rand -hex 6)
62+
base=$(tr -dc 'a-zA-Z' </dev/urandom | head -c9)
63+
digit=$(tr -dc '0-9' </dev/urandom | head -c1)
64+
pos=$((RANDOM % 10))
65+
INFLUXDB_PASSWORD=${base:0:$pos}${digit}${base:$pos}
6366
VISUALIZER_GRAFANA_USER=$(cat /dev/urandom | tr -dc 'a-zA-Z' | head -c 8)
64-
VISUALIZER_GRAFANA_PASSWORD=$(openssl rand -hex 6)
65-
MR_PSQL_PASSWORD=$(openssl rand -hex 10)
66-
MR_MINIO_ACCESS_KEY=$(openssl rand -hex 10)
67-
MR_MINIO_SECRET_KEY=$(openssl rand -hex 10)
67+
VISUALIZER_GRAFANA_PASSWORD=${base:0:$pos}${digit}${base:$pos}
6868
6969
sed -i "s/INFLUXDB_USERNAME=.*/INFLUXDB_USERNAME=${INFLUXDB_USERNAME}/g" .env
7070
sed -i "s/INFLUXDB_PASSWORD=.*/INFLUXDB_PASSWORD=${INFLUXDB_PASSWORD}/g" .env
7171
sed -i "s/VISUALIZER_GRAFANA_USER=.*/VISUALIZER_GRAFANA_USER=${VISUALIZER_GRAFANA_USER}/g" .env
7272
sed -i "s/VISUALIZER_GRAFANA_PASSWORD=.*/VISUALIZER_GRAFANA_PASSWORD=${VISUALIZER_GRAFANA_PASSWORD}/g" .env
73-
sed -i "s/MR_PSQL_PASSWORD=.*/MR_PSQL_PASSWORD=${MR_PSQL_PASSWORD}/g" .env
74-
sed -i "s/MR_MINIO_ACCESS_KEY=.*/MR_MINIO_ACCESS_KEY=${MR_MINIO_ACCESS_KEY}/g" .env
75-
sed -i "s/MR_MINIO_SECRET_KEY=.*/MR_MINIO_SECRET_KEY=${MR_MINIO_SECRET_KEY}/g" .env
7673
make build
7774
- name: Deploying Wind Turbine Anomaly Detection Sample App
7875
run: |
@@ -106,9 +103,12 @@ jobs:
106103
make down
107104
# Generate random values for sensitive environment variables
108105
INFLUXDB_USERNAME=$(cat /dev/urandom | tr -dc 'a-zA-Z' | head -c 8)
109-
INFLUXDB_PASSWORD=$(openssl rand -hex 6)
106+
base=$(tr -dc 'a-zA-Z' </dev/urandom | head -c9)
107+
digit=$(tr -dc '0-9' </dev/urandom | head -c1)
108+
pos=$((RANDOM % 10))
109+
INFLUXDB_PASSWORD=${base:0:$pos}${digit}${base:$pos}
110110
VISUALIZER_GRAFANA_USER=$(cat /dev/urandom | tr -dc 'a-zA-Z' | head -c 8)
111-
VISUALIZER_GRAFANA_PASSWORD=$(openssl rand -hex 6)
111+
VISUALIZER_GRAFANA_PASSWORD=${base:0:$pos}${digit}${base:$pos}
112112
MTX_WEBRTCICESERVERS2_0_USERNAME=$(cat /dev/urandom | tr -dc 'a-zA-Z' | head -c 8)
113113
MTX_WEBRTCICESERVERS2_0_PASSWORD=$(openssl rand -hex 10)
114114
HOST_IP=$(hostname -I | awk '{print $1}')
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
## [2025.2] - December 2025
6+
7+
### Added
8+
- Integrated new "Weld Anomaly Detection" sample application with CatBoost ML model and dashboards. ([#742])
9+
- Enabled scaling for OPC-UA ingestion in wind turbine sample app via Docker Compose and updated telegraf config generation. ([#732])
10+
- Added GPU inferencing support for both Docker Compose and Helm deployments. ([#718])
11+
- Added Nginx as a reverse proxy with Helm template support, including SSL certificate generation and MQTT proxy configuration. ([#705])
12+
- Added legends to Grafana graphs for weld anomaly detection. ([#839])
13+
- Added updated architecture diagram for 2025.2 release. ([#800])
14+
- Added logger for fusion analytics and weld simulator. ([#777])
15+
- Added installation of requirements.txt for Python packages in venv for Ubuntu 24.04 compatibility. ([#804])
16+
- Added .gitignore file for improved repo hygiene. ([#791])
17+
- Added comprehensive documentation and visualization dashboards for weld sensor data.
18+
19+
### Changed
20+
- Migrated from Bitnami/nginx to official nginx image for enhanced security and compatibility. ([#726])
21+
- Changed internal HTTPS port for nginx from 443 to 15443 to comply with Kubernetes security policies. ([#741])
22+
- Updated build system to support multiple sample applications via app parameter.
23+
- Updated hardcoded localhost references to dynamic host_ip placeholders in documentation. ([#888])
24+
- Updated Grafana dashboard to display processing times in seconds instead of milliseconds. ([#897])
25+
- Updated influx query and measurement/table names for accuracy. ([#695])
26+
- Updated arch diagram to drawio UX template. ([#800])
27+
- Updated docs to pull Helm charts for weekly tag. ([#721])
28+
- Updated Helm docs to download artifacts for sample apps. ([#766])
29+
- Updated Python script execution to use virtual environment.
30+
- Updated volume mounts in Docker Compose and Helm charts for unified configs folder. ([#781])
31+
- Updated fusion analytics MQTT topic name and improved comment formatting. ([#889])
32+
- Restructured alert configuration headings to distinguish Docker vs Helm deployment. ([#888])
33+
- Modular refactoring of time series documentation for maintainability.
34+
35+
### Removed
36+
- Removed Model Registry related code and docs from sample apps. ([#769])
37+
38+
### Fixed
39+
- Fixed missing Python package installation for fresh systems. ([#791])
40+
- Fixed path and port issues in documentation and configuration files. ([#740])
41+
- Fixed table of contents in wind turbine documentation. ([#806])
42+
- Fixed minor documentation bugs and improved clarity. ([#695], [#888])
43+
- Fixed missing version parameter in Helm charts for weld anomaly detection. ([#863])
44+
45+
### Security
46+
- Added SSL/TLS protocol restrictions and cipher configurations to nginx. ([#847], [#851])
47+
- Implemented security headers (HSTS, X-Frame-Options, etc.) and proxy buffering limits in nginx. ([#847])
48+
- Addressed Trivy image scan vulnerabilities by updating Python base image and pip in Dockerfiles. ([#928])
49+
50+
---
51+
52+
[#742]: https://github.com/open-edge-platform/edge-ai-suites/commit/adce01b6468752154da9fd477337a045e33eed42
53+
[#732]: https://github.com/open-edge-platform/edge-ai-suites/commit/03d67d5fc97361d858e92e749a3d76ce12882074
54+
[#718]: https://github.com/open-edge-platform/edge-ai-suites/commit/b5f19b19a279aea6cfd5e202ee421075bf467c1d
55+
[#705]: https://github.com/open-edge-platform/edge-ai-suites/commit/343f832c0e32cacd38417ae8032496067ff9bdb0
56+
[#839]: https://github.com/open-edge-platform/edge-ai-suites/commit/9e8330475d0b10a5fa257b82c15ba4e2addbe299
57+
[#800]: https://github.com/open-edge-platform/edge-ai-suites/commit/4dadcb69937e68a42fa83baa8aad97b0b8592b96
58+
[#777]: https://github.com/open-edge-platform/edge-ai-suites/commit/5c156ad4581b528df01ed6fcd13f5895f15d4127
59+
[#804]: https://github.com/open-edge-platform/edge-ai-suites/commit/8c946ff3857d159f64aa49ec56c326211ddd2c08
60+
[#791]: https://github.com/open-edge-platform/edge-ai-suites/commit/ac4fba464a8406983a4ea80a3a28a4e420356d41
61+
[#726]: https://github.com/open-edge-platform/edge-ai-suites/commit/931fef94fbf6295bcbfd1952cd307d9ee02d8ac6
62+
[#741]: https://github.com/open-edge-platform/edge-ai-suites/commit/37cdcdf97f476e67f1e3b720953cf37b944e9a56
63+
[#888]: https://github.com/open-edge-platform/edge-ai-suites/commit/1c110bbf5427616a01f30cc12e3d44369e289ad3
64+
[#897]: https://github.com/open-edge-platform/edge-ai-suites/commit/f3ad24b7420d5f8043fa303ce3aa145626a8f7a2
65+
[#695]: https://github.com/open-edge-platform/edge-ai-suites/commit/bf232d19b68b870c40c7252dd1c37f34c2bc7f60
66+
[#721]: https://github.com/open-edge-platform/edge-ai-suites/commit/a1c6aaecc147306d9ae92c3f0f028e70263eed18
67+
[#766]: https://github.com/open-edge-platform/edge-ai-suites/commit/5763626d628cf567cb46f9d2c9cec2a98d4ac3d5
68+
[#781]: https://github.com/open-edge-platform/edge-ai-suites/commit/f0c548ab64421c25b16d8293790042e1686bc689
69+
[#769]: https://github.com/open-edge-platform/edge-ai-suites/commit/451d41020b674b102edb4d9e882091773b71db0d
70+
[#740]: https://github.com/open-edge-platform/edge-ai-suites/commit/dc826ae0e0019b16998f32c615dedd38826a1958
71+
[#806]: https://github.com/open-edge-platform/edge-ai-suites/commit/43d848dabb494d65f86f36db426f2563e272d696
72+
[#863]: https://github.com/open-edge-platform/edge-ai-suites/commit/de96f388ab6770f05aa65d22e9f40d489607075c
73+
[#847]: https://github.com/open-edge-platform/edge-ai-suites/commit/6d6e18dab3780b09b6a8f76ecbf194d081111c0d
74+
[#851]: https://github.com/open-edge-platform/edge-ai-suites/commit/b9ab22fde4668f7ff412eff741ca1d1c880b2c85
75+
[#928]: https://github.com/open-edge-platform/edge-ai-suites/commit/307b4925f70268f97081e05c5726943775e873dc

manufacturing-ai-suite/industrial-edge-insights-time-series/Makefile

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -116,24 +116,6 @@ check_env_variables:
116116
exit 1; \
117117
fi \
118118
;; \
119-
MR_PSQL_PASSWORD) \
120-
if ! echo "$$value" | grep -Eq "^[A-Za-z0-9]{10,}$$" || ! echo "$$value" | grep -q "[0-9]" || ! echo "$$value" | grep -q "[A-Za-z]"; then \
121-
echo "MR_PSQL_PASSWORD length must be a minimum of 10 alphanumeric characters with atleast one digit"; \
122-
exit 1; \
123-
fi \
124-
;; \
125-
MR_MINIO_ACCESS_KEY) \
126-
if ! echo "$$value" | grep -Eq "^[A-Za-z0-9]{10,}$$" || ! echo "$$value" | grep -q "[0-9]" || ! echo "$$value" | grep -q "[A-Za-z]"; then \
127-
echo "MR_MINIO_ACCESS_KEY length must be a minimum of 10 alphanumeric characters with atleast one digit"; \
128-
exit 1; \
129-
fi \
130-
;; \
131-
MR_MINIO_SECRET_KEY) \
132-
if ! echo "$$value" | grep -Eq "^[A-Za-z0-9]{10,}$$" || ! echo "$$value" | grep -q "[0-9]" || ! echo "$$value" | grep -q "[A-Za-z]"; then \
133-
echo "MR_MINIO_SECRET_KEY length must be a minimum of 10 alphanumeric characters with atleast one digit"; \
134-
exit 1; \
135-
fi \
136-
;; \
137119
esac; \
138120
done
139121

manufacturing-ai-suite/industrial-edge-insights-time-series/README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,7 @@ To see the system requirements and other installation, see the following guides:
1111

1212
## Architecture and Functionality Overview
1313

14-
The Industrial Edge Insights - Time Series sample application comprises of data simulators, the generic Time Series AI stack based on **TICK Stack**, and Grafana. The Model Registry microservice helps to achieve the MLOps flow by uploading the **UDF deployment package**.
15-
16-
![Time Series AI Stack Architecture Diagram](./docs/user-guide/wind-turbine-anomaly/_images/time-series-ai-stack-architecture.png)
17-
18-
- **Data Simulators/Destinations**: OPC-UA server and MQTT Publisher simulate data sources and destinations, reading from CSV files and interfacing with Telegraf plugins for data ingestion.
19-
- **Generic Time Series AI Stack**: A customizable pipeline for data ingestion, storage, processing, and visualization, supporting integration with various databases, and enabling deep learning model execution.
20-
- **Data Ingestion**: Telegraf collects and reports metrics using input plugins, sending ingested data to InfluxDB for storage.
21-
- **Data Storage**: InfluxDB is a high-performance database optimized for time series data, supporting high write throughput and efficient querying.
22-
- **Data Processing**: Kapacitor processes time series data in real-time, allowing custom logic using User-Defined Functions (UDFs) for anomaly detection and advanced analytics.
23-
- **Data Visualization**: Grafana offers an intuitive interface for real-time visualization of time series data stored in InfluxDB, enabling custom dashboards and monitoring.
24-
25-
For more details on Architecture, see [How it works](docs/user-guide/wind-turbine-anomaly/how-it-works.md).
14+
Refer [How it works](docs/user-guide/wind-turbine-anomaly/how-it-works.md).
2615

2716
## Learn More
2817

@@ -31,5 +20,6 @@ For more details on Architecture, see [How it works](docs/user-guide/wind-turbin
3120
- [How to configure OPC-UA/MQTT alerts](docs/user-guide/wind-turbine-anomaly/how-to-configure-alerts.md): Guide for configuring the OPC-UA/MQTT alerts in the Time Series Analytics microservice
3221
- [How to configure custom UDF deployment package](docs/user-guide/wind-turbine-anomaly/how-to-configure-custom-udf.md): Guide for deploying a customized UDF deployment package (udfs/models/tick scripts)
3322
- [How to create a new sample app](docs/user-guide/wind-turbine-anomaly/how-to-create-a-new-sample-app.md): Guide for creating a new sample app by referencing Wind Turbine Anomaly Detection sample app
23+
- [How to connect to secure MQTT broker](docs/user-guide/how-to-connect-to-secure-mqtt-broker.md): Guide for connecting to secure MQTT broker.
3424
- **Release Notes**
3525
- [Release Notes](docs/user-guide/wind-turbine-anomaly/release_notes.md): Information on the latest updates, improvements, and bug fixes.

0 commit comments

Comments
 (0)