Merge pull request #336 from Accenture/278-remove-deprecations

278 - removed deprecated apis env vars and related code/docs

Author: mmacai

CHANGELOG.md

@@ -42,7 +42,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ### Deprecated -->
 
-<!-- ### Removed -->
+### Removed
+
+- Removed deprecated or unused code/functionality, these are **breaking changes** [#278](https://github.com/Accenture/reactive-interaction-gateway/issues/278):
+  - Removed deprecated internal API `/v1`.
+  - Removed deprecated environment variables: `PROXY_KAFKA_REQUEST_AVRO`, `PROXY_KAFKA_REQUEST_TOPIC`, `PROXY_KINESIS_REQUEST_STREAM`. This means that you can set topic and schema for publishing to event streams **only** in the proxy config as described in the [docs](https://accenture.github.io/reactive-interaction-gateway/docs/api-gateway.html#publishing-to-event-streams).
+  - Removed experimental feature Firehose (forwarding events to an HTTP endpoint).
+  - Removed `path` field in proxy configuration. Reason is that the `path_regex` field is already covering `path` functionality and thus it doesn't make sense to have both of them. Should cause less confusion and improve maintainability.
+    - **Migration:**
+      - `"path": "/foo"` -> `"path_regex": "/foo"`
+      - `"path": "/foo/{id}"` -> `"path_regex": "/foo/(.+)"` - or pretty much whatever regex you need (e.g. UUID pattern)
 
 <!-- ### Security -->
 

config/config.exs

@@ -41,27 +41,6 @@ config :rig, Rig.EventStream.KafkaToFilter,
   sasl: {:system, "KAFKA_SASL", nil},
   group_id: {:system, "KAFKATOFILTER_KAFKA_GROUP_ID", "rig-kafka-to-filter"}
 
-config :rig, Rig.EventStream.KafkaToHttp,
-  # The list of brokers, given by a comma-separated list of host:port items:
-  brokers: {:system, :list, "KAFKA_BROKERS", []},
-  serializer: {:system, "KAFKA_SERIALIZER", nil},
-  schema_registry_host: {:system, "KAFKA_SCHEMA_REGISTRY_HOST", nil},
-  # The list of topics to consume messages from:
-  consumer_topics: {:system, :list, "FIREHOSE_KAFKA_SOURCE_TOPICS", ["rig-firehose"]},
-  # If KAFKA_SSL_ENABLED=0, the KAFKA_SSL_* settings are ignored; otherwise, they're required.
-  ssl_enabled?: {:system, :boolean, "KAFKA_SSL_ENABLED", false},
-  # If use_enabled?, the following paths are expected (relative to the `priv` directory):
-  ssl_ca_certfile: {:system, "KAFKA_SSL_CA_CERTFILE", "ca.crt.pem"},
-  ssl_certfile: {:system, "KAFKA_SSL_CERTFILE", "client.crt.pem"},
-  ssl_keyfile: {:system, "KAFKA_SSL_KEYFILE", "client.key.pem"},
-  # In case the private key is password protected:
-  ssl_keyfile_pass: {:system, "KAFKA_SSL_KEYFILE_PASS", ""},
-  # Credentials for SASL/Plain authentication. Example: "plain:myusername:mypassword"
-  sasl: {:system, "KAFKA_SASL", nil},
-  # HTTP endpoints to invoke for each Kafka message:
-  targets: {:system, :list, "FIREHOSE_KAFKA_HTTP_TARGETS", []},
-  group_id: {:system, "KAFKATOHTTP_KAFKA_GROUP_ID", "rig-kafka-to-http"}
-
 config :rig, Rig.EventStream.NatsToFilter,
   # The list of servers, given by a comma-separated list of host:port items:
   servers: {:system, :list, "NATS_SERVERS", []},

config/rig_inbound_gateway/config.exs

@@ -78,11 +78,7 @@ config :mime, :types, %{
 
 config :rig, RigInboundGateway.Proxy, config_path_or_json: {:system, "PROXY_CONFIG_FILE", nil}
 
-config :rig, RigInboundGateway.ApiProxy.Validations,
-  kinesis_request_stream: {:system, "PROXY_KINESIS_REQUEST_STREAM", nil},
-  kafka_request_topic: {:system, "PROXY_KAFKA_REQUEST_TOPIC", ""},
-  kafka_request_avro: {:system, "PROXY_KAFKA_REQUEST_AVRO", ""},
-  system: System
+config :rig, RigInboundGateway.ApiProxy.Validations, system: System
 
 config :rig, RigInboundGateway.ApiProxy.Base,
   recv_timeout: {:system, :integer, "PROXY_RECV_TIMEOUT", 5_000}
@@ -120,14 +116,11 @@ config :rig, RigInboundGateway.ApiProxy.Handler.Kafka,
   ssl_keyfile_pass: {:system, "KAFKA_SSL_KEYFILE_PASS", ""},
   # Credentials for SASL/Plain authentication. Example: "plain:myusername:mypassword"
   sasl: {:system, "KAFKA_SASL", nil},
-  request_topic: {:system, "PROXY_KAFKA_REQUEST_TOPIC", ""},
-  request_schema: {:system, "PROXY_KAFKA_REQUEST_AVRO", ""},
   cors: {:system, "CORS", "*"},
   response_timeout: {:system, :integer, "PROXY_KAFKA_RESPONSE_TIMEOUT", 5_000},
   group_id: {:system, "PROXY_KAFKA_RESPONSE_KAFKA_GROUP_ID", "rig-proxy-response"}
 
 config :rig, RigInboundGateway.ApiProxy.Handler.Kinesis,
-  kinesis_request_stream: {:system, "PROXY_KINESIS_REQUEST_STREAM", nil},
   kinesis_request_region: {:system, "PROXY_KINESIS_REQUEST_REGION", "eu-west-1"},
   response_timeout: {:system, :integer, "PROXY_KINESIS_RESPONSE_TIMEOUT", 5_000},
   cors: {:system, "CORS", "*"},

config/rig_inbound_gateway/test.exs

@@ -13,10 +13,6 @@ config :rig, RigInboundGateway.Kafka, log_topic: "rig"
 config :rig, RigInboundGateway.Proxy,
   config_path_or_json: {:system, "PROXY_CONFIG_FILE", "proxy/proxy.test.inbound.json"}
 
-config :rig, RigInboundGateway.ApiProxy.Validations,
-  kinesis_request_stream: {:system, "PROXY_KINESIS_REQUEST_STREAM", "test-request-stream"},
-  kafka_request_topic: {:system, "PROXY_KAFKA_REQUEST_TOPIC", "test-request-topic"},
-  kafka_request_avro: {:system, "PROXY_KAFKA_REQUEST_AVRO", ""},
-  system: RigInboundGateway.SystemMock
+config :rig, RigInboundGateway.ApiProxy.Validations, system: RigInboundGateway.SystemMock
 
 config :fake_server, :port_range, Enum.to_list(55_000..65_000) ++ [7070, 8081]

config/rig_outbound_gateway/config.exs

@@ -17,19 +17,4 @@ config :rig, RigOutboundGateway.Kinesis.JavaClient,
   kinesis_endpoint: {:system, "KINESIS_ENDPOINT", ""},
   dynamodb_endpoint: {:system, "KINESIS_DYNAMODB_ENDPOINT", ""}
 
-config :rig, RigOutboundGateway.KinesisFirehose.JavaClient,
-  enabled?: {:system, :boolean, "KINESIS_ENABLED", false},
-  client_jar:
-    {:system, "KINESIS_CLIENT_JAR", "./kinesis-client/target/rig-kinesis-client-1.0-SNAPSHOT.jar"},
-  # will default to the one from the Erlang installation:
-  otp_jar: {:system, "KINESIS_OTP_JAR", nil},
-  log_level: {:system, "KINESIS_LOG_LEVEL", "INFO"},
-  kinesis_app_name:
-    {:system, "FIREHOSE_KINESIS_APP_NAME", "Reactive-Interaction-Gateway-Firehose"},
-  kinesis_aws_region: {:system, "KINESIS_AWS_REGION", "eu-west-1"},
-  kinesis_stream: {:system, "FIREHOSE_KINESIS_STREAM", "RIG-firehose"},
-  kinesis_endpoint: {:system, "KINESIS_ENDPOINT", ""},
-  dynamodb_endpoint: {:system, "KINESIS_DYNAMODB_ENDPOINT", ""},
-  targets: {:system, :list, "FIREHOSE_KINESIS_HTTP_TARGETS", ["http://localhost:4040/todo"]}
-
 config :porcelain, driver: Porcelain.Driver.Basic

deployment/kubectl/rig.yaml

@@ -142,9 +142,6 @@ spec:
             ## Kafka group ID used for forwarding events according to subscriptions over SSE and WS connections. The default should be fine.
             # - name: KAFKATOFILTER_KAFKA_GROUP_ID
             #   value: "rig-kafka-to-filter"
-            ## Kafka group ID used for forwarding all events over a HTTP connection. The default should be fine.
-            # - name: KAFKATOHTTP_KAFKA_GROUP_ID
-            #   value: "rig-kafka-to-http"
             # - name: KAFKA_RESTART_DELAY_MS
             #   value: "10000"
             ## Host for Kafka Schema Registry
@@ -199,8 +196,6 @@ spec:
             # - name: PROXY_KAFKA_RESPONSE_TIMEOUT
             #   value: "5000"
             ## Proxy Kinesis
-            # - name: PROXY_KINESIS_REQUEST_STREAM
-            #   value: "rig-proxy-request"
             # - name: PROXY_KINESIS_REQUEST_REGION
             #   value: "eu-west-1"
             # - name: PROXY_KINESIS_RESPONSE_TIMEOUT

deployment/reactive-interaction-gateway-helm-v2/Chart.yaml

@@ -6,7 +6,7 @@ icon: https://github.com/Accenture/reactive-interaction-gateway/blob/master/logo
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 1.0.1
+version: 2.0.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.

deployment/reactive-interaction-gateway-helm-v2/values.yaml

@@ -52,8 +52,6 @@ deployment:
     # KAFKA_SOURCE_TOPICS: rig
     ## Kafka group ID used for forwarding events according to subscriptions over SSE and WS connections. The default should be fine.
     # KAFKATOFILTER_KAFKA_GROUP_ID: rig-kafka-to-filter
-    ## Kafka group ID used for forwarding all events over a HTTP connection. The default should be fine.
-    # KAFKATOHTTP_KAFKA_GROUP_ID: rig-kafka-to-http
     # KAFKA_RESTART_DELAY_MS: 10000
     ## Host for Kafka Schema Registry
     # KAFKA_SCHEMA_REGISTRY_HOST: schema-registry:8081
@@ -92,7 +90,6 @@ deployment:
     # PROXY_KAFKA_RESPONSE_TIMEOUT: 5000
 
     ## Proxy Kinesis
-    # PROXY_KINESIS_REQUEST_STREAM: rig-proxy-request
     # PROXY_KINESIS_REQUEST_REGION: eu-west-1
     # PROXY_KINESIS_RESPONSE_TIMEOUT: 5000
 

deployment/reactive-interaction-gateway/Chart.yaml

@@ -6,7 +6,7 @@ icon: https://github.com/Accenture/reactive-interaction-gateway/blob/master/logo
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 1.0.1
+version: 2.0.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.

deployment/reactive-interaction-gateway/values.yaml

@@ -52,8 +52,6 @@ deployment:
     # KAFKA_SOURCE_TOPICS: rig
     ## Kafka group ID used for forwarding events according to subscriptions over SSE and WS connections. The default should be fine.
     # KAFKATOFILTER_KAFKA_GROUP_ID: rig-kafka-to-filter
-    ## Kafka group ID used for forwarding all events over a HTTP connection. The default should be fine.
-    # KAFKATOHTTP_KAFKA_GROUP_ID: rig-kafka-to-http
     # KAFKA_RESTART_DELAY_MS: 10000
     ## Host for Kafka Schema Registry
     # KAFKA_SCHEMA_REGISTRY_HOST: schema-registry:8081
@@ -92,7 +90,6 @@ deployment:
     # PROXY_KAFKA_RESPONSE_TIMEOUT: 5000
 
     ## Proxy Kinesis
-    # PROXY_KINESIS_REQUEST_STREAM: rig-proxy-request
     # PROXY_KINESIS_REQUEST_REGION: eu-west-1
     # PROXY_KINESIS_RESPONSE_TIMEOUT: 5000