Skip to content

Latest commit

 

History

History

gateway

README.md

Klayr Service Gateway

The Gateway service provides the API, which all users of Klayr Service can access and use. Its main purpose is to proxy the API requests from users to other services provided by Klayr Service. This provides the users with a central point of data access that never disrupts or breaks the existing application compatibility.

Note that this installation instruction is required only for development activities. For a regular Klayr Service user, the official documentation is sufficient to run an instance. The global readme file present in the root directory describes how to run all the microservices simultaneously.

Installation

Prerequisites

Please refer to the README in the project root directory.

Installation

Clone the Klayr Service Repository:

git clone https://github.com/KlayrHQ/klayr-service.git # clone repository
cd klayr-service/services/gateway # move into gateway microservice directory
yarn install --frozen-lockfile # install required Node.js dependencies

Configuration

To configure the different microservices, there are a number of environment variables the user can define in order to customize the configurations.

A list of the most commonly used environment variables is presented below:

  • SERVICE_BROKER: URL of the microservice message broker (NATS or Redis).
  • JSON_RPC_STRICT_MODE: Makes JSON-RPC require a valid JSON-RPC 2.0 envelope.
  • ENABLE_HTTP_API: Enables particular HTTP APIs listed by a comma.
  • ENABLE_WS_API: Enables particular JSON-RPC APIs listed by a comma.
  • CORS_ALLOWED_ORIGIN: Allows request from the comma separated string of origins. By default, it is set to * which allows request from all origins.
  • SERVICE_GATEWAY_REDIS_VOLATILE: URL of the volatile cache storage (Redis).
  • ENABLE_REVERSE_PROXY_TIMEOUT_SETTINGS: Boolean flag to enforce the headersTimeout and keepAliveTimeout settings on the API server. Enabling this might be helpful when deploying Klayr Service behind a load balancer or a reverse proxy. Check this FAQ for more information.
  • HTTP_KEEP_ALIVE_TIMEOUT: Defines the number of microseconds the gateway will wait before closing an idle connection. To enable, ensure ENABLE_REVERSE_PROXY_TIMEOUT_SETTINGS is set to true, or HTTP_RATE_LIMIT_NUM_KNOWN_PROXIES is set to greater than 0. By default, it is set to 65000.
  • HTTP_HEADERS_TIMEOUT: Defines the maximum number of microseconds for the gateway to send HTTP response headers after the client's request. To enable, ensure ENABLE_REVERSE_PROXY_TIMEOUT_SETTINGS is set to true, or HTTP_RATE_LIMIT_NUM_KNOWN_PROXIES is set to greater than 0. Please ensure that the HTTP_HEADERS_TIMEOUT is set higher than the HTTP_KEEP_ALIVE_TIMEOUT. By default, it is set to 66000.
  • HTTP_RATE_LIMIT_ENABLE: Boolean flag to enable HTTP rate limiter. Disabled by default. To enable, set it to true.
  • HTTP_RATE_LIMIT_WINDOW: To keep a record of requests in the memory (in seconds). By default, it is set to 10 seconds.
  • HTTP_RATE_LIMIT_CONNECTIONS: Maximum number of allowed requests for a specified window, configured by HTTP_RATE_LIMIT_WINDOW.
  • HTTP_RATE_LIMIT_ENABLE_X_FORWARDED_FOR: When set to true, the rate limiting algorithm considers the X-Forwarded-For header value to determine the client's IP address for rate limiting purposes. By default, it is set to false.
  • HTTP_RATE_LIMIT_NUM_KNOWN_PROXIES: Defines the number of proxies that exist between the gateway and the external client application, enabling accurate identification of the client's IP address for rate limiting. Requires HTTP_RATE_LIMIT_ENABLE_X_FORWARDED_FOR to be enabled. By default, it is set to 0.
  • ENABLE_HTTP_CACHE_CONTROL: Boolean flag to enable HTTP response caching. This includes the Cache-Control header within the responses.
  • HTTP_CACHE_CONTROL_DIRECTIVES: HTTP cache-control directives.
  • WS_RATE_LIMIT_ENABLE: Boolean flag to enable WS rate limiter.
  • WS_RATE_LIMIT_CONNECTIONS: Maximum number of new connections allowed within a configured window, specified by WS_RATE_LIMIT_DURATION.
  • WS_RATE_LIMIT_DURATION: Rate limit window in seconds. By default, it is set to 1.
  • ENABLE_REQUEST_CACHING: Boolean flag to enable RPC response caching.
  • GATEWAY_DEPENDENCIES: Services on which the gateway is dependent (can be expressed as a CSV).
  • JOB_INTERVAL_UPDATE_READINESS_STATUS: Job run interval to update the readiness status. By default, it is set to 0.
  • JOB_SCHEDULE_UPDATE_READINESS_STATUS: Job run cron schedule to update the readiness status. By default, it is set to run every minute (* * * * *).

Note: interval takes priority over schedule and must be greater than 0 to be valid for all the moleculer job configurations.

The variables listed above can be universally overridden by using global variables.

export ENABLE_HTTP_API="http-status,http-version3"

Examples

# Run local instance with HTTP API only
ENABLE_HTTP_API="http-status,http-version3" \
ENABLE_WS_API="" \
CORS_ALLOWED_ORIGIN="https://www.host1.com,https://www.host2.com" \
node app.js
# Run a local instance with the RPC API in a strict mode and using HTTP
ENABLE_HTTP_API="http-status,http-version3" \
ENABLE_WS_API="blockchain,rpc-v3" \
CORS_ALLOWED_ORIGIN="https://www.host1.com,https://www.host2.com" \
JSON_RPC_STRICT_MODE="true" \
node app.js

Management

Start

cd klayr-service/services/gateway # navigate into the root directory of the gateway microservice
yarn start # start the microservice with running nodes locally

Use the framework/bin/moleculer_client.js and framework/bin/moleculer_subscribe.js clients to test particular service endpoints.

If you want to run a production variant of the service use Docker or PM2. In the event whereby the process fails, it will be automatically recovered.

Stop

Press Ctrl+C in the terminal to stop the process.

Contributors

https://github.com/KlayrHQ/klayr-service/graphs/contributors

License

Copyright 2016-2023 Lisk Foundation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.