Gateway

Abstract

the punch gateway is a punch REST server that expose the punch REST API and can be configured to activate various services.

Overview

Refer to the gateway documentation for a complete description

Gateway configuration

The gateway commands are located in a dedicated folder:

punchplatform-gateway-6.1.0/
├── activate.sh
├── bin
│   ├── channelctl
│   ├── commons-lib.sh
│   ├── hjson-manager
│   ├── punchlinectl
│   ├── punchplatform-analytics-scan.sh
│   ├── punchplatform-env.sh
│   ├── punchplatform-lib.sh
│   ├── punchplatform-pyspark-scan.sh
│   └── sparkctl
├── conf
│   ├── forwarding.punch
│   └── punchplatform-gateway.yml
├── log4j2
│   ├── log4j2-channel.xml
│   ├── log4j2-gateway.xml
│   ├── log4j2.properties
│   ├── log4j2-sparkctl.properties
│   ├── log4j2-sparkctl.xml
│   └── log4j2-stdout.xml
├── punchplatform.properties
└── resolv.hjson

In addition to the various commands internally required by the gateway, this folder also contains logger configuration files, and two punch platform wide configuration files resolv.hjson and punchplatform.properties generated at deployment time.

Gateway binaries

The binaries and libraries (i.e. executable) files are provided in a separate folder. These are provided by a punch uber binary package named punchplatform-binaries-*. The punch deployer install it on each punch node. Here is its layout:

punchplatform-binaries-6.1.0/
├── apache-storm-2.1.0
├── lib
│   ├── spark/
│   ├── pyspark/
│   ├── storm/
│   ├── punchplatform-command-cli-6.1.0-jar-with-dependencies.jar
│   ├── punchplatform-gateway-app-6.1.0.jar
│   ├── punchplatform-log-injector-6.1.0-jar-with-dependencies.jar
│   ├── punchplatform-monitoring-service-6.1.0-jar-with-dependencies.jar
│   ├── punchplatform-puncher-6.1.0-jar-with-dependencies.jar
│   ├── punchplatform-shiva-app-6.1.0-jar-with-dependencies.jar
│   └── ...
├── logstash-7.4.2
├── resources
└── spark-2.4.3-bin-hadoop2.7

As you can see this folder contains both the punchplatform-gateway-app-*.jar required to run the gateway itself, and the punchplatform-command-cli-*-jar-with-dependencies.jar library required by the gateway to execute punch commands.

Patch Gateway Service or a Punch command inside Gateway

Refer to documentation.