Web API

The Web API microservice hosts API endpoints for the guided discovery flow.

This microservice is part of the discovery microservice pipeline. See Understanding Microservice Pipelines in Unified Assurance Concepts for conceptual information.

The Web API microservice can only be installed on a presentation server. It can be installed either on a single server or a multiserver cluster.

Web API Prerequisites

Before deploying the Web API microservice, confirm that the following prerequisites are met:

A microservice cluster is set up with the web namespace a1-web. See Microservice Cluster Setup.
The following microservices are deployed on all the presentation servers to which you are installing the Web API microservice:
- Pulsar
- Graph Sink

Deploying Web API Microservice

To deploy the microservice, run the following commands:

su - assure1 
export WEBNAMESPACE=a1-web
export WEBFQDN=<WebFQDN>
export APPNAME=web-api
a1helm install <microservice-release-name> assure1/$APPNAME -n $WEBNAMESPACE --set global.imageRegistry=$WEBFQDN

In the commands:

<WEBNAMESPACE> is the namespace where you are deploying the microservice.
<WebFQDN> is the fully-qualified domain name of the primary presentation server for the cluster.
<microservice-release-name> is the name to use for the microservice instance. Oracle recommends using the microservice name web-api unless you are deploying multiple instances of the microservice to the same cluster.

You can also use the Unified Assurance UI to deploy microservices. See Deploying a Microservice by Using the UI for more information.

You can check whether all the pods are deployed and running properly using the following command:

a1k get pods -n $WEBNAMESPACE

To check the microservice logs for ERROR messages, run the following command:

a1k logs $(a1k get pods -n $WEBNAMESPACE | awk '/web-api/ {print $1;exit}') -n $WEBNAMESPACE

Changing Web API Microservice Configuration Parameters

When running the install command, you can optionally change default configuration parameter values by including them in the command with additional --set arguments. You can add as many additional --set arguments as you need.

For example, set a parameter described in Default Web API Microservice Configuration by adding --set configData.<parameter_name>=<parameter_value> (for example, --set configData.LOG_LEVEL=DEBUG).

Default Web API Microservice Configuration

The following table describes the default configuration parameters found in the Helm chart under configData for the microservice.

Name	Default Value	Possible Values	Notes
LOG_LEVEL	INFO	FATAL, WARN, INFO, DEBUG, TRACE	The logging level used by the microservice.
JIPHER_DEBUG	0	0 or 1	Flag for enabling or disabling the Jipher debugging logs.
STREAM_ERROR	persistent://assure1/discovery/dom-feedback-zone	Any topic name	The topic where error messages are published.
STREAM_GRAPH	persistent://assure1/graph/sink	Any topic name	The topic where topology information is published.
PROCESS_GRAPH_DATA	true	true or false	Flag for enabling or disabling the processing of topology data for the discovered devices.
APP_ARUBA_DEVICE_GROUP_NAME	Aruba Central	Any text	Root folder name for the Aruba Devices.
APP_CISCODNA_DEVICE_GROUP_NAME	Cisco DNA	Any text	Root folder name for the Cisco DNA devices.

Title and Copyright Information

Implementation Guide

G49441-01