Skip to content

Latest commit

 

History

History
183 lines (172 loc) · 7.32 KB

README.md

File metadata and controls

183 lines (172 loc) · 7.32 KB

Reverse Proxy

Reverse Proxy is a traffic management tool designed to efficiently control the flow of traffic and API calls between services using a configuration-driven approach. This project, built on NGINX, simplifies the integration and management of service communications, making it ideal for environments where performance and reliability are critical.

It supports:

  • URI Matching: This feature offers flexible URI matching options to optimize request routing based on specific needs:

    • Prefix Matching: Routes or blocks requests where the URI starts with a specified prefix. This is less strict and can match multiple URIs under a given path prefix: 
      - name: api-server
  match:
      uri:
        prefix: /api/
  route:
    - destination:
        host: api-service
        port: 8000
    • Regex Matching: Uses regular expressions for matching URIs, providing a powerful tool for handling complex matching criteria: 
      - name: user-api
  match:
    uri:
      regex: "^/user/\d+$"
    • Exact Matching: Ensures that only URIs that exactly match the specified string are routed or blocked, suitable for targeting specific resources: 
      - name: exact-uri
  match:
    uri:
      exact: /exact-path/

  • Request Routing: Directs incoming requests to the correct backend service based on URL. This feature also includes the ability to redirect requests and return direct responses:

    • Basic Routing: Routes requests to different backend services based on the request path: 
      - name: alertmanager
    match:
        uri:
          prefix: /alert/
    route:
    - destination:
        host: 0.0.0.0
        port: 9093
    - destination:
        host: 0.0.0.0
        port: 9094
    • Redirecting Requests: Redirect requests to another URI when specific conditions are met, such as an outdated or moved resource: 
      servers:
  - port:
      number: 80
      protocol: HTTP
    hosts:
      - "old-example.com"
    http:
      - name: redirect-old-domain
        match:
          uri:
            prefix: /
        redirect:
          host: "new-example.com"
          scheme: "https"
      - name: redirect-old-uri
  match:
    uri:
      regex: ^/old-uri/(.*)
  redirect:
    uri: /new-uri/
    redirectCode: 301
    • Direct Responses: Return a direct response from the proxy without contacting a backend service, useful for maintenance messages or static error responses: 
      - name: direct-response
  match:
    uri:
      prefix: /maintenance/
  directResponse:
    httpStatus: 503
    body: 
      string: "We are currently undergoing maintenance, please check back later."

  • Request Blocking: block specific URIs and manage IP-based access controls effectively:

    • URI Blocking: You can configure the service to block specific URIs by matching keywords or patterns. For example, blocking access to any URI containing "admin" can be configured as follows: 
      - name: admin
  match:
    uri:
      prefix: /admin/
    block:
      returnCode: 403
    • IP Address Control: The service supports allowing or denying access based on specific IP addresses. This can be set to allow only certain IPs to access a service or deny specific IPs: 
      - name: admin
  match:
    uri:
      prefix: /admin/
    block:
      allow:
        - "192.168.1.1"
      deny:
        - "192.168.1.100"

  • Traffic Shifting: Facilitates canary releases and A/B testing by gradually diverting a percentage of traffic from one service version to another. A destination will receive weight/(sum of all weight of route):

    route:
  - destination:
      host: 0.0.0.0
      port: 8000
    weight: 90 # for new version
  - destination:
      host: 0.0.0.0
      port: 8001
    weight: 10 # for old version

  • TLS and Secure Connection: enables secure communication over the HTTPS protocol by leveraging TLS (Transport Layer Security) to encrypt and secure data in transit. also provide automatic redirects HTTP traffic to HTTPS to ensure secure connection.

    - port:
    number: 443
    protocol: HTTPS
    hosts:
      - "example.com"
  tls:
    httpsRedirect: true
    certificate_file: /patch/to/example.crt
    key_file: /path/to/example.key

Pre-requisite

Before installing and using the Reverse Proxy, ensure you have the following prerequisites met:

  • Python (3.7 or higher): Python 3.7 or a newer version must be installed on your system to run the configuration and deployment scripts.
  • NGINX: The Reverse Proxy is built on NGINX, so having NGINX installed on your system is essential. It can be installed on most operating systems using the respective package manager.
  • YAML Configuration Understanding: Since the configuration files are in YAML format, understanding how to work with YAML files is necessary for modifying the configurations.
  • Basic Networking Knowledge: Familiarity with networking concepts such as HTTP/HTTPS, ports, DNS, etc., is recommended to effectively use and troubleshoot the proxy setup.

Installation

To install Reverse Proxy, follow these steps:

  1. Clone the repository: 
    git clone [repository-url]
cd reverse-proxy
  2. Install Requirements: Use the script provided to install all necessary dependencies 
    ./runner.sh --install-requirements
  3. Build Binary: Use the script provided to build a python binary script file 
    ./runner.sh --build

Usage

Once you have installed all required components, you can start using the service by configuring and deploying your NGINX setups.

Configuring the Service

To specify a configuration file other than the default config.yaml, use the --config option:

./runner.sh --config=/path/to/your_config.yaml

Deploying to a Host

Deploy the NGINX configuration to a specific host using SSH credentials or an SSH private key. if you don't use the host option the execution process will be in the localhost:

  • Using Password Authentication: 
    ./runner.sh --config=/path/to/your_config.yaml --host=<hostname or ip> --username=myuser --password=mypassword
  • Using an SSH Private Key: 
    ./runner.sh --config=/path/to/your_config.yaml --host=hostname --username=myuser --key=/path/to/private_key

Dry Run

Before actually deploying, you can perform a dry run to validate the input configuration. the nginx config file will be generated in output directory:

./runner.sh --config=/path/to/your_config.yaml --dry-run

Configuration Schema

For detailed information about configuring our service, see the Configuration Schema.