From 0062428afe5a01e61ff13004c1a7bb9601cde166 Mon Sep 17 00:00:00 2001 From: Dominik Riemer Date: Sun, 22 Oct 2023 21:45:39 +0200 Subject: [PATCH] Remove outdated configuration section --- docs/07_technicals-configuration.md | 74 ------------------- website-v2/sidebars.json | 5 +- .../07_technicals-configuration.md | 58 --------------- .../version-0.92.0-sidebars.json | 3 +- 4 files changed, 3 insertions(+), 137 deletions(-) delete mode 100644 docs/07_technicals-configuration.md delete mode 100644 website-v2/versioned_docs/version-0.92.0/07_technicals-configuration.md diff --git a/docs/07_technicals-configuration.md b/docs/07_technicals-configuration.md deleted file mode 100644 index cc343831e..000000000 --- a/docs/07_technicals-configuration.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: technicals-configuration -title: Configuration -sidebar_label: Configuration ---- - -On this page we explain how the StreamPipes configuration works. -StreamPipes allows the individual services (pipeline element containers and third-party services) to store configuration -parameters in a distributed key-value store. -This has the advantage that individual services do not need to store any configurations on the local file system, -enabling us to run containers anywhere. -As a key-value store we use [Consul](https://www.consul.io/), which is an essential service for all our services. - -Semantic description of data processor - -## Edit Configurations - -All services in StreamPipes can have configuration parameters. -You can either change them in the consul user interface (which is by default running on port 8500) or directly in the -StreamPipes Configurations Page. -Once a new pipeline element container is started, it is registered in Consul and the parameters can be edited in the -configuration page, as shown below. -To store changes in Consul, the update button must be clicked. - -
- Configuration View -
- -## Configuration for Developers - -We provide a Configurations API for the use of configuration parameters in your services. -Each processing element project has a “config” -package [[Example]](https://github.com/apache/streampipes-extensions/tree/dev/streampipes-sinks-internal-jvm/src/main/java/org/streampipes/sinks/internal/jvm/config). -This package usually contains two classes. -One containing unique keys for the configuration values and one containing the getter and setter methods to access these -values. -For the naming of configuration keys, we recommend to use “SP” as a prefix. -As we explain later, it is possible to set default configurations as environment variables, this prefix makes them -unique on your server. -A configuration entry needs a unique config key. For this key, a value can be specified containing the configuration, -like for example the port number of the service. -For each configuration, a description explaining the parameter can be provided, further the data type must be specified -and whether it is a password or not. -Below, the schema of a configuration item is shown on the left and an example of a port configuration on the right. - -Semantic description of data processor - -As a developer, you can add as many new configurations to services as you wish, but there are some that are required for -all processing element containers. -Those are **the host**, **the port**, and **the name** of the service. - -## Default Values - -You can provide default values for the configurations, which are used when a configuration is read for the first time. -The first option is to register a configuration parameter in the Config class. -This is a fallback value, which is used if nothing else is defined. -Since this value is static, we offer a second option. -It is possible to provide a default value by setting an environment variable. -In this case, the convention is that the key of a configuration parameter must be used as the environment variable. -Now, this value is used instead of the value defined in the Config class. -During development, the configuration values often need to be changed for debugging purposes, therefore we provide an -.env file in all processing element projects and archetypes. -This file can be used by your IDE to set the environment variables. ( -e.g., [Intellij Plugin](https://plugins.jetbrains.com/plugin/7861-envfile)) -When you need to change the variable at runtime, you can do this in the StreamPipes configurations as explained before. -Those changes take effect immediately without the need of a container restart. - -:::caution Installed pipeline elements - -Be cautious, when the configuration is used in the semantic description of a processing element which is already -installed in StreamPipes, you have to reload this element in StreamPipes (my elements -> reload). -In addition, changes might affect already running pipelines. - -::: diff --git a/website-v2/sidebars.json b/website-v2/sidebars.json index 55e46f5dc..c193904b5 100644 --- a/website-v2/sidebars.json +++ b/website-v2/sidebars.json @@ -179,8 +179,7 @@ "technicals-architecture", "technicals-user-guidance", "technicals-runtime-wrappers", - "technicals-messaging", - "technicals-configuration" + "technicals-messaging" ], "👪 Community": [ "community-get-help", @@ -192,4 +191,4 @@ "faq-common-problems" ] } -} \ No newline at end of file +} diff --git a/website-v2/versioned_docs/version-0.92.0/07_technicals-configuration.md b/website-v2/versioned_docs/version-0.92.0/07_technicals-configuration.md deleted file mode 100644 index 4c6d101d3..000000000 --- a/website-v2/versioned_docs/version-0.92.0/07_technicals-configuration.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: technicals-configuration -title: Configuration -sidebar_label: Configuration ---- - -On this page we explain how the StreamPipes configuration works. -StreamPipes allows the individual services (pipeline element containers and third-party services) to store configuration parameters in a distributed key-value store. -This has the advantage that individual services do not need to store any configurations on the local file system, enabling us to run containers anywhere. -As a key-value store we use [Consul](https://www.consul.io/), which is an essential service for all our services. - -Semantic description of data processor - - -## Edit Configurations -All services in StreamPipes can have configuration parameters. -You can either change them in the consul user interface (which is by default running on port 8500) or directly in the StreamPipes Configurations Page. -Once a new pipeline element container is started, it is registered in Consul and the parameters can be edited in the configuration page, as shown below. -To store changes in Consul, the update button must be clicked. - -
- Configuration View -
- -## Configuration for Developers -We provide a Configurations API for the use of configuration parameters in your services. -Each processing element project has a “config” package [[Example]](https://github.com/apache/streampipes-extensions/tree/dev/streampipes-sinks-internal-jvm/src/main/java/org/streampipes/sinks/internal/jvm/config). -This package usually contains two classes. -One containing unique keys for the configuration values and one containing the getter and setter methods to access these values. -For the naming of configuration keys, we recommend to use “SP” as a prefix. -As we explain later, it is possible to set default configurations as environment variables, this prefix makes them unique on your server. -A configuration entry needs a unique config key. For this key, a value can be specified containing the configuration, like for example the port number of the service. -For each configuration, a description explaining the parameter can be provided, further the data type must be specified and whether it is a password or not. -Below, the schema of a configuration item is shown on the left and an example of a port configuration on the right. - -Semantic description of data processor - -As a developer, you can add as many new configurations to services as you wish, but there are some that are required for all processing element containers. -Those are **the host**, **the port**, and **the name** of the service. - -## Default Values -You can provide default values for the configurations, which are used when a configuration is read for the first time. -The first option is to register a configuration parameter in the Config class. -This is a fallback value, which is used if nothing else is defined. -Since this value is static, we offer a second option. -It is possible to provide a default value by setting an environment variable. -In this case, the convention is that the key of a configuration parameter must be used as the environment variable. -Now, this value is used instead of the value defined in the Config class. -During development, the configuration values often need to be changed for debugging purposes, therefore we provide an .env file in all processing element projects and archetypes. -This file can be used by your IDE to set the environment variables. (e.g., [Intellij Plugin](https://plugins.jetbrains.com/plugin/7861-envfile)) -When you need to change the variable at runtime, you can do this in the StreamPipes configurations as explained before. -Those changes take effect immediately without the need of a container restart. - -
-
Installed pipeline elements
-

Be cautious, when the configuration is used in the semantic description of a processing element which is already installed in StreamPipes, you have to reload this element in StreamPipes (my elements -> reload). - In addition, changes might affect already running pipelines.

-
diff --git a/website-v2/versioned_sidebars/version-0.92.0-sidebars.json b/website-v2/versioned_sidebars/version-0.92.0-sidebars.json index 31b768df9..cc356ddb3 100644 --- a/website-v2/versioned_sidebars/version-0.92.0-sidebars.json +++ b/website-v2/versioned_sidebars/version-0.92.0-sidebars.json @@ -199,8 +199,7 @@ "technicals-architecture", "technicals-user-guidance", "technicals-runtime-wrappers", - "technicals-messaging", - "technicals-configuration" + "technicals-messaging" ], "\uD83D\uDC6A Community": [ "community-get-help",