This is an automated email from the ASF dual-hosted git repository. bossenti pushed a commit to branch remove-consul-references in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
commit aaa918e5bf39f8d6320c47d4e7312e5cf9657437 Author: bossenti <[email protected]> AuthorDate: Thu May 16 11:09:34 2024 +0200 docs: remove existing consul references --- docs/05_deploy-kubernetes.md | 16 ---------------- docs/06_extend-cli.md | 12 ++++++------ docs/06_extend-sdk-migration-sd.md | 13 +++++++------ website-v2/static/img/configuration/consul.png | Bin 123919 -> 0 bytes 4 files changed, 13 insertions(+), 28 deletions(-) diff --git a/docs/05_deploy-kubernetes.md b/docs/05_deploy-kubernetes.md index 478e1a3c9..6734676b4 100644 --- a/docs/05_deploy-kubernetes.md +++ b/docs/05_deploy-kubernetes.md @@ -99,22 +99,6 @@ Here is an overview of the supported parameters to configure StreamPipes. ### External common parameters -#### Consul common parameters - -| Parameter Name | Description | Value | -|-------------------------------------------------|----------------------------------------------------------|------------------------------------------| -| external.consul.appName | Consul application name | "consul" | -| external.consul.version | Consul version | 1.14.3 | -| external.consul.webPort | Port number for the Consul web interface | 8500 | -| external.consul.dnsPort | Port number for the Consul DNS interface | 8600 | -| external.consul.persistence.storageClassName | Storage class name for Consul PVs | "hostpath" | -| external.consul.persistence.storageSize | Size of the Consul PV | "1Gi" | -| external.consul.persistence.claimName | Name of the Consul PersistentVolumeClaim | "consul-pvc" | -| external.consul.persistence.pvName | Name of the Consul PersistentVolume | "consul-pv" | -| external.consul.service.name | Name of the Consul service | "consul" | -| external.consul.service.webPort | TargetPort of the Consul service for web interface | 8500 | -| external.consul.service.dnsPort | TargetPort of the Consul service for DNS interface | 8600 | - #### Couchdb common parameters | Parameter Name | Description | Value | diff --git a/docs/06_extend-cli.md b/docs/06_extend-cli.md index d02186c3d..e5f93cfd6 100644 --- a/docs/06_extend-cli.md +++ b/docs/06_extend-cli.md @@ -82,7 +82,7 @@ streampipes env --set pipeline-element ``` **Start** environment ( default: `dev` mode). Here the service definition in the selected environment is used to start the multi-container landscape. -> **NOTE**: `dev` mode is enabled by default since we rely on open ports to core service such as `consul`, `couchdb`, `kafka` etc. to reach from the IDE when developing. If you don't want to map ports (except the UI port), then use the `--no-ports` flag. +> **NOTE**: `dev` mode is enabled by default since we rely on open ports to core service such as `couchdb`, `kafka` etc. to reach from the IDE when developing. If you don't want to map ports (except the UI port), then use the `--no-ports` flag. ```bash streampipes up -d @@ -91,7 +91,7 @@ streampipes up -d ``` Now you're good to go to write your new pipeline element :tada: :tada: :tada: -> **HINT for extensions**: Use our [Maven archetypes](https://streampipes.apache.org/docs/docs/extend-archetypes/) to setup a project skeleton and use your IDE of choice for development. However, we do recommend using IntelliJ. +> **HINT for extensions**: Use our [Maven archetypes](https://streampipes.apache.org/docs/docs/extend-archetypes/) to set up a project skeleton and use your IDE of choice for development. However, we do recommend using IntelliJ. > **HINT for core**: To work on `backend` or `ui` features you need to set the > template to `backend` and clone the core repository > [streampipes](https://github.com/apache/streampipes) - check the > prerequisites there for more information. @@ -104,12 +104,12 @@ streampipes down ## Additionally, useful commands -**Start individual services only?** We got you! You chose a template that suits your needs and now you only want to start individual services from it, e.g. only Kafka and Consul. +**Start individual services only?** We got you! You chose a template that suits your needs and now you only want to start individual services from it, e.g. only Kafka and InfluxDB. > **NOTE**: the service names need to be present and match your current > `.spenv` environment. ```bash -streampipes up -d kafka consul +streampipes up -d kafka influxdb ``` **Get current environment** (if previously set using `streampipes env --set <environment>`). @@ -130,8 +130,8 @@ streampipes pull **Restart** all services of current environment or specific services ```bash streampipes restart -# restart backend & consul -# streampipes restart backend consul +# restart backend +# streampipes restart backend ``` **Clean** your system and remove created StreamPipes Docker volumes, StreamPipes docker network and dangling StreamPipes images of old image layers. diff --git a/docs/06_extend-sdk-migration-sd.md b/docs/06_extend-sdk-migration-sd.md index 6018a7d52..1fd5200ad 100644 --- a/docs/06_extend-sdk-migration-sd.md +++ b/docs/06_extend-sdk-migration-sd.md @@ -98,15 +98,16 @@ Configs can be easily accessed from the ``EventProcessorRuntimeContext`` (or ``E ### Service Discovery -An extensions service can be started by executing the Init class. StreamPipes will now automatically select the proper service IP address and register the service in Consul. +An extensions service can be started by executing the Init class. +StreamPipes will now automatically select the proper service IP address and register the service at the backend. You can inspect the selected IP address in the console: ``` -16:41:58.342 SP [main] INFO o.a.s.commons.networking.Networking - Using auto-discovered IP: 172.30.80.1 -16:41:58.364 SP [main] INFO o.a.s.commons.networking.Networking - Using port from provided environment variable SP_PORT: 6025 -16:41:58.367 SP [main] INFO o.a.s.c.init.DeclarersSingleton - Registering 0 configs in key/value store -16:41:58.400 SP [main] INFO o.a.s.s.consul.ConsulProvider - Checking if consul is available... -16:41:58.419 SP [main] INFO o.a.s.s.consul.ConsulProvider - Successfully connected to Consul +2024-05-16T11:03:37.158+02:00 INFO --- [ main] o.a.s.commons.networking.Networking : Using auto-discovered IP: 192.168.178.22 +2024-05-16T11:03:37.158+02:00 INFO --- [ main] o.a.s.commons.networking.Networking : Using port from provided environment variable SP_PORT: 7023 +2024-05-16T11:03:37.372+02:00 INFO --- [ main] a.s.s.e.StreamPipesExtensionsServiceBase : Registering service org.apache.streampipes.extensions.all.jvm with id org.apache.streampipes.extensions.all.jvm-FUt84Y at core +2024-05-16T11:03:37.814+02:00 INFO --- [ main] o.a.s.s.extensions.CoreRequestSubmitter : Successfully registered service at core. +2024-05-16T11:03:37.814+02:00 INFO --- [ main] a.s.s.e.StreamPipesExtensionsServiceBase : Registering 1 service configs for service org.apache.streampipes.extensions.all.jvm ``` In some (rare) cases, a non-resolvable IP will be selected. In this case, you can manually override the IP by providing a ``SP_HOST`` environment variable. This falls back to a similar behaviour as in pre-0.69.0-versions and will use the manually provided IP. diff --git a/website-v2/static/img/configuration/consul.png b/website-v2/static/img/configuration/consul.png deleted file mode 100644 index 1d0165526..000000000 Binary files a/website-v2/static/img/configuration/consul.png and /dev/null differ
