apiOperatorIstio module

Kubernetes operator for ODA API custom resources.

Normally this module is deployed as part of an ODA Canvas. It uses the kopf kubernetes operator framework (https://kopf.readthedocs.io/) to build an operator that takes API custom resources and implements them using Istio Virtual Service resources linked to an Istio Gateway.

This is the simplest API operator for an Istio Service Mesh canvas and is not suitable for a production environment. It is possible to create alternative API operators that would configure an API gateway in front of the Service Mesh (This is the recommended production architecture).

It registers handler functions for:

  1. New ODA APIs - to create, update or delete child Virtual Service resources to expose the API using a Virtual Service. see apiStatus

  2. For status updates in the child Ingress resources and EndPointSlice resources, so that the API status reflects a summary the Ingress and Implementation for the API. see ingress_status and implementation_status

apiOperatorIstio.configure(settings: OperatorSettings, **_)
apiOperatorIstio.apiStatus(meta, spec, status, namespace, labels, name, **kwargs)

Handler function for new or updated APIs.

Processes the spec of the API and create child Kubernetes VirtualService resources (for open-api type) or ServiceMonitor resources (for prometheus metrics type).

Args:

  • meta (Dict): The metadata from the API Custom Resource

  • spec (Dict): The spec from the API Custom Resource showing the intent (or desired state)

  • status (Dict): The status from the API Custom Resource showing the actual state.

  • namespace (String): The namespace for the API Custom Resource

  • labels (Dict): The labels attached to the API Custom Resource. All ODA Components (and their children) should have a oda.tmforum.org/componentName label

  • name (String): The name of the API Custom Resource

Returns:

Dict: The apiStatus status that is put into the API Custom Resource status field.

apiOperatorIstio.createOrPatchObservability(patch, spec, namespace, name, inHandler, componentName)

Helper function to switch between the different patterns for scraping Prometheus APIs.

Args:

  • patch (Boolean): True to patch an existing ServiceMonitor; False to create a new ServiceMonitor.

  • spec (Dict): The spec from the API Resource showing the intent (or desired state)

  • namespace (String): The namespace for the API Custom Resource

  • name (String): The name of the API Custom Resource

  • inHandler (String): The name of the handler function calling this function

  • componentName (String): The name of the ODA Component that the API is part of

Returns:

nothing

apiOperatorIstio.createOrPatchPrometheusAnnotation(patch, spec, namespace, name, inHandler, componentName)
apiOperatorIstio.createOrPatchDataDogAnnotation(patch, spec, namespace, name, inHandler, componentName)

Helper function to get API details for a prometheus metrics API and patch the corresponding kubernetes pod.

Args:

  • patch (Boolean): True to patch an existing annotation; False to create a new annotation. Makes no difference for this function.

  • spec (Dict): The spec from the API Resource showing the intent (or desired state)

  • namespace (String): The namespace for the API Custom Resource

  • name (String): The name of the API Custom Resource

  • inHandler (String): The name of the handler function calling this function

  • componentName (String): The name of the ODA Component that the API is part of

Returns:

nothing

apiOperatorIstio.createOrPatchServiceMonitor(patch, spec, namespace, name, inHandler, componentName)

Helper function to get API details for a prometheus metrics API and create or patch ServiceMonitor resource.

Args:

  • patch (Boolean): True to patch an existing ServiceMonitor; False to create a new ServiceMonitor.

  • spec (Dict): The spec from the API Resource showing the intent (or desired state)

  • namespace (String): The namespace for the API Custom Resource

  • name (String): The name of the API Custom Resource

  • inHandler (String): The name of the handler function calling this function

  • componentName (String): The name of the ODA Component that the API is part of

Returns:

nothing

apiOperatorIstio.createOrPatchVirtualService(patch, spec, namespace, inAPIName, inHandler, componentName)

Helper function to get API details and create or patch VirtualService.

Args:

  • patch (Boolean): True to patch an existing VirtualService; False to create a new VirtualService.

  • spec (Dict): The spec from the API Resource showing the intent (or desired state)

  • namespace (String): The namespace for the API Custom Resource

  • inAPIName (String): The name of the API Custom Resource

  • inHandler (String): The name of the handler calling this function

  • componentName (String): The name of the component that owns the API resource

Returns:

Dict: The updated apiStatus that will be put into the status field of the API resource.

apiOperatorIstio.getIstioIngressStatus(inHandler, name, componentName)
apiOperatorIstio.implementation_status(meta, spec, status, body, namespace, labels, name, **kwargs)

Handler function to register for status changes in EndPointSlide resources.

The EndPointSlide resources show the implementation of an API linked the the API implementations Service Resource. When EndPointSlide updates the ready-status of the implementation, update parent API object.

Args:

  • meta (Dict): The metadata from the EndPointSlide Resource

  • spec (Dict): The spec from the EndPointSlide Resource showing the intent (or desired state)

  • status (Dict): The status from the EndPointSlide Resource showing the actual state.

  • body (Dict): The entire EndPointSlide Resource

  • namespace (String): The namespace for the EndPointSlide Resource

  • labels (Dict): The labels attached to the EndPointSlide Resource. All ODA Components (and their children) should have a oda.tmforum.org/componentName label

  • name (String): The name of the EndPointSlide Resource

Returns:

No return value.

async apiOperatorIstio.updateAPIStatus(meta, status, namespace, name, **kwargs)

Handler function to register for status changes in child API resources. Processes status updates to the apiStatus in the child API Custom resources, so that the Component status reflects a summary of all the childrens status.

Args:

  • meta (Dict): The metadata from the API resource

  • spec (Dict): The spec from the yaml API resource showing the intent (or desired state)

  • status (Dict): The status from the API resource showing the actual state.

  • body (Dict): The entire API resource definition

  • namespace (String): The namespace for the API resource

  • labels (Dict): The labels attached to the API resource. All ODA Components (and their children) should have a oda.tmforum.org/componentName label

  • name (String): The name of the API resource

Returns:

No return value.

async apiOperatorIstio.updateAPIReady(meta, status, namespace, name, **kwargs)

Handler function to register for status changes in child API resources.

Processes status updates to the implementation status in the child API Custom resources, so that the Component status reflects a summary of all the childrens status.

Args:

  • meta (Dict): The metadata from the API resource

  • spec (Dict): The spec from the yaml API resource showing the intent (or desired state)

  • status (Dict): The status from the API resource showing the actual state.

  • body (Dict): The entire API resource definition

  • namespace (String): The namespace for the API resource

  • labels (Dict): The labels attached to the API resource. All ODA Components (and their children) should have a oda.tmforum.org/componentName label

  • name (String): The name of the API resource

Returns:

No return value.

apiOperatorIstio.logWrapper(logLevel, functionName, handlerName, resourceName, componentName, subject, message)

Helper function to standardise logging output.

Args:

  • logLevel (Number): The level to log e.g. logging.INFO

  • functionName (String): The name of the function calling the logWrapper

  • resourceName (String): The name of the resource being logged

  • componentName (String): The name of the component being logged

  • subject (String): The subject of the log message

  • message (String): The message to be logged - can contain relavant data

Returns:

No return value.