Deployment Notes

The Ultimate Engineering Toolkit for Apache Kafka®
Search…
Deployment Notes
Liveness Endpoints, Reverse Proxies, Error Strategies, and more.
Use our Helm and CloudFormation guides to get up and running in minutes.
Liveness and Readiness Endpoints
kPow's health check endpoint is served as a GET request at /healthy. This path can be used as a liveness probe from within your orchestration platform of choice.
The /healthy endpoint returns a 200 status code if the kPow instance is healthy. 
The /healthy endpoint returns a 503 status code if the kPow instance is unhealthy (see: Error states + strategies)
The /healthy endpoint does not require any user authentication to access. 
The /up endpoint can be used for readiness probes. It always returns a 200 status when kPow's HTTP server is up and reachable.
Error States + Strategies
kPow runs an internal Kafka Streams resource that may enter an ERROR state in certain scenarios where a Kafka Cluster becomes unavailable for a duration longer than the configured timeout+heartbeat. 
You can configure the STREAMS_ERROR_STRATEGY environment variable to handle this scenario. Possible strategies include:
LOG_EXCEPTION - default, logs an error. Note: once kPow enters this ERROR state, snapshotting will continue, but the UI will be unavailable until the instance has been manually restarted.
LOG_AND_EXIT - logs an error and exits the kPow process with a status code of 1
Note: it is recommended to configure a liveness probe over setting the LOG_AND_EXIT strategy. However, in scenarios such as deploying a JAR to an EC2 instance, configuring this strategy may be desirable.
Availability
kPow is designed to be run as a single instance. When defining your task definition for kPow please ensure that the maximum number of instances does not exceed one.
Reverse Proxies + Load Balancers
Configure HTTP_FORWARDED=true in conjunction with Jetty Authentication or when terminating SSL at a proxy to ensure that redirects maintain the correct connection scheme.
kPow serves all UI traffic at the specifiedPORT(default: 3000). 
This port serves both websockets connections and general HTTP/S traffic.
Most reverse proxies and load balancers work out of the box with kPow, but special consideration is needed when configuring websockets, or when the reverse proxy is responsible for SSL termination.
See the NGINX Websocket Guide for information specific to NGINX and Websockets.
See HTTPS Connections for documentation on how to configure HTTPS traffic for kPow.
K8s Ingress Configuration
Custom Path Configuration
This configuration serves kPow at a custom path such as /kpow. This scenario might be useful if your company has a suite of tools that you want to have grouped at a single host.
1
apiVersion: networking.k8s.io/v1beta1
2
kind: Ingress
3
metadata:
4
  annotations:
5
    nginx.ingress.kubernetes.io/rewrite-target: /$2
6
    nginx.ingress.kubernetes.io/proxy-redirect-from: http://kpow.info:80/
7
    nginx.ingress.kubernetes.io/proxy-redirect-to: /kpow/
8
  name: kpow-ingress
9
  namespace: operatr-io
10
spec:
11
  rules:
12
  - host: kpow.info
13
    http:
14
      paths:
15
      - backend:
16
          serviceName: kpow
17
          servicePort: 3000
18
        path: /kpow(/|$)(.*)
Copied!
In this example, kPow will be served at http://kpow.info/kpow
NGINX Configuration
Standard Configuration 
A standard nginx.conf 
1
  server {
2
    listen       80;
3
    server_name  localhost;
4
​
5
     location /  {
6
      proxy_pass http://localhost:3000/;
7
      proxy_http_version 1.1;
8
      proxy_set_header Upgrade $http_upgrade;
9
      proxy_set_header Connection 'upgrade';
10
      proxy_set_header X-Real-IP $remote_addr;
11
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
12
      proxy_set_header Host $http_host;
13
      proxy_cache_bypass $http_upgrade;
14
      proxy_headers_hash_max_size 512;
15
      proxy_headers_hash_bucket_size 128;
16
     }
17
}
Copied!
Custom Path Configuration
This configuration serves kPow at a custom path such as /kpow . This scenario might be useful if your company has a suite of tools that you want to have grouped at a single HTTP endpoint.
1
server {
2
  listen       80;
3
  server_name  localhost;
4
​
5
   location /prometheus/ { 
6
     # configuration options for your prometheus server go here...
7
   }
8
​
9
   location /kpow/  {
10
      proxy_pass http://localhost:3000/;
11
      rewrite /kpow/(.*) /$1 break;
12
      proxy_redirect http://localhost/ /kpow/;
13
​
14
      proxy_http_version 1.1;
15
​
16
      proxy_set_header Upgrade $http_upgrade;
17
      proxy_set_header Connection 'upgrade';
18
      proxy_set_header X-Real-IP $remote_addr;
19
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
20
      proxy_set_header Host $http_host;
21
      proxy_cache_bypass $http_upgrade;
22
      proxy_headers_hash_max_size 512;
23
      proxy_headers_hash_bucket_size 128;
24
     }
25
}
Copied!
​
Installation - Previous
System Requirements
Next - Installation
Minimum ACL Permissions
Last modified 2mo ago
Copy link
Contents
Liveness and Readiness Endpoints
Error States + Strategies
Availability
Reverse Proxies + Load Balancers
K8s Ingress Configuration
NGINX Configuration