Road to v0.2.0

.github/workflows/rust-test.yml

@@ -11,32 +11,50 @@ env:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
+    container: rust:slim-bookworm
+
+    # see https://docs.github.com/en/actions/using-containerized-services/creating-postgresql-service-containers
+    # Service containers to run with `build`
+    services:
+      # Label used to access the service container
+      postgres:
+        # Docker Hub image
+        image: postgres
+        # Provide the password for postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps tcp port 5432 on service container to the host
+          - 5432:5432
 
     steps:
     - uses: actions/checkout@v3
     - name: Install dependencies
       run: |
-        sudo apt-get update && \
-        sudo apt-get install -y --no-install-recommends \
+        apt-get update && \
+        apt-get install -y --no-install-recommends \
         libkrb5-dev \
-        libssl-dev
-    - name: Install a Postgres database (CockroachDB)
-      run: |
-        git clone https://github.com/cockroachlabs-field/docker-examples.git
-        cd docker-examples/example-nginx/
-        sh up.sh
-    - name: Build
-      run: cargo build --verbose
+        libssl-dev \
+        make \
+        clang \
+        pkgconf ;
     - name: Clippy
-      run: cargo clippy -- -Dwarnings
+      run: rustup component add clippy && cargo clippy -- -Dwarnings
     - name: Run tests
       run: |
-        # Env var to connect to the Postgres docker
-        export POSTGRES_HOST="localhost"
-        export POSTGRES_PORT="26257"
-        export POSTGRES_USER="root"
-        export POSTGRES_PASSWORD=""
+        # Env var to connect to the Postgres service
+        export POSTGRES_HOST="postgres"
+        export POSTGRES_PORT="5432"
+        export POSTGRES_USER="postgres"
+        export POSTGRES_PASSWORD="postgres"
         export POSTGRES_DBNAME="test"
         cargo test --verbose

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0]
+
 ### Added
 
 - Add OpenWEC node name (if configured) in JSON format output (#2)
@@ -16,6 +18,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add a setting to configure `heartbeats_queue_size` (#37)
 - Add Tls support for encryption and authentication (#36)
 - Add support for output events to redis list (#45)
+- Add TCP keepalive settings (with sensible defaults) in server settings (#56)
+- Add support for output events to unix domain socket (#60)
+- Add configuration files for subscriptions coming with two openwec cli subcommands (`subscriptions load` and `subscriptions skell`)
+- Add `cli.read_only_subscriptions` setting to disable the cli features which edit subscriptions (except `subscriptions load`)
+- Add `RawJson` format which enables to retrieve events in raw format while also getting the metadata added by OpenWEC
+- Add the subscription revision in OpenWEC events metadata
+- Add `locale` and `data_locale` subscriptions parameters
+- Add support for Proxy Protocol to allow openwec to be used behind a layer 4 load
+balancer whilst preserving the client IP address and port.
 
 ### Changed
 
@@ -26,8 +37,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Breaking change**: Keytab file path must be specified only once for all collectors (using Kerberos authentication)
 - A malformed event will no longer stop the event stream (for a computer/subscription) because formatters are not allowed to fail. In problematic cases, some work is done to try to recover the raw data of the event, and an `OpenWEC.Error` field is added (in the JSON formatter) to help catch the problem (#47)
 - **Breaking change**: Split access and server logs. Configuration file format has been updated. (#52)
-- Ensure that openwecd shutdowns gracefully even if hyper server is not responding
-- Improve the logging of failed Kerberos authentications: missing authorization header warning is now in DEBUG level
+- Ensure that openwecd shutdowns gracefully even if hyper server is not responding (#65)
+- Improve the logging of failed Kerberos authentications: missing authorization header warning is now in DEBUG level (#65)
+- Rework output drivers and output formats architecture
+- Change the outputs storage format in database
+- Rework the import/export format to enable compatibility between OpenWEC versions
+- Each subscription has now two "versions": a public one sent to clients (derived from subscription parameters) and a private one used for synchronization between openwec nodes
 
 ### Fixed