ptp-notification-armada-app/notificationclient-base/docker/notificationclient-sidecar/notificationclient_start.py
Cole Walker 37c15ea4fb Add support for httpGet liveness probes
Updates the locationservice, notificationservice and notificationclient
containers to support ipv6 httpGet liveness probes.

notificationservice-base and notificationservice-basev2:
- Adds health.py which starts a simple http server that runs within the
  daemon. The k8s httpGet liveness probe can query this endpoint to
  verify that the service is running
- Update the daemonset template and values to provide the required info
  for initalizing the new endpoint

locationservice-base:
- Remove unused portions of the locationservice_start.sh config map.
  The location-query-server.py and location-announce.py were never
  active and are not required
- Add locationservice_start.py in order to start the locationservice
  pecan WSGI application with either an ipv4 or ipv6 socket
- Use existing pecan endpoint to respond to liveness probes

notificationclient-base:
- Add notificationclient_start.py to start the notificationclient
  pecan WSGI application with either an ipv4 or ipv6 socket
- Use existing pecan endpoint to respond to liveness probes

Daemonset:
- Add required ip and port environment variables to support liveness
  probes on each container
- Add a conditional section for enabling liveness probes. Disabled by
  default but can be enabled via helm overrides by setting "liveness:
  True"

Misc:
- Re-organized python imports in affected files
- Incremented helm chart version to 2.0.1

Test-plan:
Pass: Verify application build and install
Pass: Verify containers build correctly
Pass: Deploy ptp-notification and verify basic sanity (v1 and v2 get,
subscribe, delete, list)
Pass: Enable httpGet liveness probes for each container and verify
operation
Pass: Verify application removal

Story: 2011090
Task: 49851

Signed-off-by: Cole Walker <cole.walker@windriver.com>
Change-Id: I4671c7f8c67c4869a6d5e3b384eae66d8c57a284
2024-04-16 11:07:15 -04:00

50 lines
1.2 KiB
Python

#
# Copyright (c) 2024 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
import logging
import os
import socket
from wsgiref import simple_server
from netaddr import IPAddress
from notificationclientsdk.common.helpers import log_helper
from pecan.deploy import deploy
LOG = logging.getLogger(__name__)
log_helper.config_logger(LOG)
SIDECAR_API_HOST = os.environ.get(
"SIDECAR_API_HOST", '127.0.0.1')
SIDECAR_API_PORT = int(
os.environ.get("SIDECAR_API_PORT", '8080'))
def get_address_family(ip_string):
"""
Get the family for the given ip address string.
"""
ip_address = IPAddress(ip_string)
if ip_address.version == 6:
return socket.AF_INET6
else:
return socket.AF_INET
def main():
simple_server.WSGIServer.address_family = get_address_family(
SIDECAR_API_HOST)
application = deploy('/opt/notificationclient/config.py')
with simple_server.make_server(SIDECAR_API_HOST,
SIDECAR_API_PORT,
application) as httpd:
LOG.info("notificationclient_start.py: Starting notificationclient")
httpd.serve_forever()
if __name__ == "__main__":
main()