diff --git a/docs/Changelog.md b/docs/Changelog.md index b23e21eeaf2..0d5cb549075 100644 --- a/docs/Changelog.md +++ b/docs/Changelog.md @@ -55,13 +55,13 @@ - shorter message in logs * [#6766](https://github.com/TouK/nussknacker/pull/6766) Scenario labels support - you can assign labels to scenarios and use them to filter the scenario list * [#6176](https://github.com/TouK/nussknacker/pull/6176) [#6996](https://github.com/TouK/nussknacker/pull/6996) [7012](https://github.com/TouK/nussknacker/pull/7012) [7014](https://github.com/TouK/nussknacker/pull/7014) Update most dependencies to latest versions, most important ones: + * Flink 1.18.1 -> 1.19.1 * Jackson 2.15.4 -> 2.17.2 * cats 2.10 -> 2.12 * Avro 1.11.3 -> 1.11.4 * swagger-parser 2.1.15 -> 2.1.22 * Tapir -> 1.11.7 * openapi-circe-yaml -> 0.11.3 -* [#6805](https://github.com/TouK/nussknacker/pull/6805) Support for Flink 1.19.1 * Scenario activities mechanism replacing old process actions: * [#6822](https://github.com/TouK/nussknacker/pull/6822), [#6929](https://github.com/TouK/nussknacker/pull/6929) * Scenario Activity API contract (without BE implementation) diff --git a/docs/MigrationGuide.md b/docs/MigrationGuide.md index fede53a6e09..18e00b7c811 100644 --- a/docs/MigrationGuide.md +++ b/docs/MigrationGuide.md @@ -70,6 +70,11 @@ To see the biggest differences please consult the [changelog](Changelog.md). * [#6952](https://github.com/TouK/nussknacker/pull/6952) Improvement: TypeInformation support for scala.Option: If you used CaseClassTypeInfoFactory with case classes that contain the Option type, the state won't be restored after the upgrade. +* [#6805](https://github.com/TouK/nussknacker/pull/6805) Updated Flink 1.18.1 -> 1.19.1. Due to backwards incompatible + changes in this Flink version update, Nussknacker 1.18 will not work with Flink versions pre-1.19 right away. If you + want to keep using Flink pre-1.19 with current Nussknacker, please refer to compatibility providing plugins in + https://github.com/TouK/nussknacker-flink-compatibility. + * [#7058](https://github.com/TouK/nussknacker/pull/7058) Performance optimization: Add missing Flink TypeInformation for better serialization * In case of using base (bounded and unbounded) Flink components state will be probably not compatible * `FlinkCustomNodeContext.typeInformationDetection` has been removed, please use `TypeInformationDetection.instance` instead diff --git a/docs/configuration/Common.md b/docs/configuration/Common.md index 5b15a993121..8e60f327f4f 100644 --- a/docs/configuration/Common.md +++ b/docs/configuration/Common.md @@ -1,19 +1,16 @@ --- -title: Miscellaneous +title: Environment Variables sidebar_position: 4 --- -# Common -## Environment variables +# Environment variables -All configuration options are described in [Configuration](./DesignerConfiguration.md). - -Some of them can be configured using already predefined environment variables, which is mostly useful in the Docker setup. +Some of the configuration options can be set using already predefined environment variables, which is mostly useful in the Docker setup. The table below shows all the predefined environment variables used in the Nussknacker image. `$NUSSKNACKER_DIR` is a placeholder pointing to the Nussknacker installation directory. Because we use [HOCON](../#conventions), you can set (or override) any configuration value used by Nussknacker even if the already predefined environment variable does not exist. This is achieved by setting the JVM property `-Dconfig.override_with_env_vars=true` and setting environment variables following conventions described [here](https://github.com/lightbend/config?tab=readme-ov-file#optional-system-or-env-variable-overrides). -### Basic environment variables +## Basic environment variables | Variable name | Type | Default value | Description | |-------------------------------|---------|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -48,7 +45,7 @@ Because we use [HOCON](../#conventions), you can set (or override) any configura | PROMETHEUS_AGENT_CONFIG_FILE | int | $NUSSKNACKER_DIR/conf/jmx_prometheus.yaml | Default configuration for JMX Prometheus agent. Used only when agent is enabled. See `PROMETHEUS_METRICS_PORT` | | TABLES_DEFINITION_FILE | string | $NUSSKNACKER_DIR/conf/dev-tables-definition.sql | Location of file containing definitions of tables for Flink Table API components in Flink Sql | -### OAuth2 environment variables +## OAuth2 environment variables | Variable name | Type | Default value | |-------------------------------------------------|-----------------|-------------------|