A10 Harmony Controller Operator Console

The A10’s Harmony Controller Operator Console allows users to Configure, Debug, and Monitor the A10 Harmony Controller Services in a very easy and efficient manner. The Operator Console has a dashboard which shows the detailed information such as Status, IP address, Service status and other parameters of the services or an API can be used to get the job done. The dashboard also offers options to configure few service parameters.

The A10’s Operator Console is most helpful for the Developers, System Engineers, Administrators to debug, monitor, and to configure various A10 Controller services. The Operator Console also provides APIs to perform the configuration, to pull log information and to get detailed information of the services running.

The A10’s Operator Console has three main components:

  1. Harmony Controller Dashboard
  2. Micro Service Dashboard
  3. Configuration Management

Harmony Controller Dashboard

The Harmony Controller dashboard provides user detailed information about the micro services running in an A10 Controller. The dashboard displays information such as the VM status, Service status, IP address, and the status of the service whether it is Up or Down.

These information helps the user to monitor and debug. For example, if any service is down, then it is marked in Red, for which the user can check the corresponding logs and find the root cause for the service to go down.

The figure below is the A10 Lightning Harmony Controller dashboard.

name

Micro Service Dashboard

name

The Micro Service dashboard provides the detailed information of each micro-service running on A10 controller. This dashboard provides information such as Ports, Protocol used, and the IP on which the service is up. The user can also run the APIs to fetch the above metadata information. This metadata information helps the operator to set-up the required ports and provides protocol information.

The figure shows the list of micro-services running in the A10 Harmony Controller at the given instance. When clicked on Micro Service Dashboard drop down the list appears as shown.

When an individual service is clicked from the list then the UI shows the detailed information for that specific service. For example, when message-bus is clicked from the list then the dashboard displays the Instance IP and the Port information for message-bus micro services.

Similarly, when any other service is clicked from the list the information relevant to those micro-services are displayed. The figure below shows the detailed information for Config Manger service.

name

Configuration Management

The Configuration Management provides the operator options to configure the properties/templets of A10 Controller components such as Welcome Email template for the new users, Log level settings, Root Provider admins, Lightning ADC Images, and the Certificate configuration. These configurations can be configured via dashboard or can be configured via APIs

The each configurable parameter is described as below.

Harmony Controller

Here the user can configure the log collection options and also view the Harmony Controller version currently running. The log options can be set at three levels like Info, Debug, and Error. Once the log option is set and saved the logs can be collected at an FTP server location and the FTP location can be specified under Collect logs tab. These logs can be further downloaded from this location. Irrespective of the level set the logs collected will have all the microservice information.

name

Root Provider Admin

The Root Provider admin option is used to update or configure the root provider email IDs which only can be used to create a root provider admin.

name

Email

Whenever a new customer is added to the system, A10 sends a welcome email, Activation email with all user credentials or a password reset emails to the existing customers. If there is a need to modify or edit these emails then the user can use this option in the dashboard to configure and edit the email content. It also provides few advanced options where the user can define the Server Host, Server port, From Address, From Personal, User Name, Password.

The dashboard offers options to configure the Content of the email and Advanced options as shown in the below figure:

name
name

Certificate

The Certificate option allows the user to update or to add a new certificate scheme for API server and portal server(UI). The user is required to provide the FQDN, Server Certificate, Server Key, and CA Certificate information as shown in the figure below.

name
name

A10 Harmony Operator Console APIs

As we know the Operator Console is most used with the UI. However, the user can also use the APIs provided to perform all such tasks which can be done through UI. For example, when a new user subscribes our A10 Lightning Application Delivery System an activation email is sent to the customer. So the provider or sub-provider can use the Operator Console UI or the API to modify the email content or to set advanced options in the email server.

Below we are showing few example APIs from the Operator Console. The API method varies depending on the component we are referring in the Operator Console. To access the APIs click the i button on the right top corner of the dashboard screen.

Micro Service Dashboard API

As we know the Micro Service dashboard displays the detailed information of the micro-services running. Hence, the API uses the GET method to fetch information from the services.

The figure below is the API used to get barista service information.

name

Code Sample:

curl -i -H 'Accept: application/json' -H 'Content-Type:
application/json' -H 'Authorization:Basic YWRtaW46YnFCS
TBkOEY1SWV1eTNEUTplM2Q3MWNiMC0yNmM3LTQ0ZmEtOTkwOC0xMGE2M
jU3ZGRkMGY=' -X GET
http://104.198.109.223:9081/api/v1/cluster/service?app=barista

Note

User gets the Authorization key in the Operator Console login API response, only if login is successful.

Configuration Management API

As we know the Configuration Management allows the user to configure the A10 Lightning components. Hence, the API uses the POST method for configuration.

The figure below is the API used to configure the activation emails.

name

Code Sample:

curl 'http://104.198.109.223:9081/api/v1/config' -H 'Pragma: no-
cache'  -H 'Accept-Encoding: gzip, deflate' -H 'Accept-Language:
en-US,en;q=0.8' -H 'Au1thorization: YWRtaW46YnFCSTBkOEY1SWV1e
TNEUToyMGI5YTgwOC00YTE0LTQwOGMtOGQxNi02NGI0MWVhZTliN2U='
-H 'Accept: application/json, text/plain, */*' -
H 'Content-Type: application/json' -H 'Access-Control-Allow-
Origin: *' -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS
X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/55.0.2883.95 Safari/537.36' -H 'Cache-Control: no-
cache'  -H 'Connection: keep-alive' --data-binary
'[{'key':'activationEmailSubject','value':'Email subject
here'},{'key':'activationEmail','value':'Email content
here'}]' --compressed ;

Note

User gets the Authorization key in the Operator Console login API response, only if login is successful.