TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration Version 7.0.0 November 2020 Copyright © 2011-2020. TIBCO Software Inc. All Rights Reserved. 2 | Contents Contents Contents 2 TIBCO Documentation and Support Services 4 TIBCO® OI Hawk® RedTail - Container Edition Overview 6 Deployment Architecture and Components 7 Hawk Agent 8 Hawk Microagents 8 Hawk Console 9 Grafana 9 Time Series Storage (Prometheus) 9 Apache Zookeeper 10 Query Node 10 Webapp 10 Hardware and Software Requirements 11 Building Docker Images for the Components 13 Running TIBCO OI Hawk RedTail - Container Edition in Standalone Docker Compose Mode 16 Running TIBCO OI Hawk RedTail - Container Edition Containers in Kubernetes Cluster 18 Persistent Volume Claim for TIBCO OI Hawk RedTail - Container Edition Nodes 19 Environment Variables for TIBCO OI Hawk RedTail - Container Edition Components 20 TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration 3 | Contents Configuring Grafana Data Source 36 Administration 39 Administration Tab 39 Adding a User 40 Adding a Role 41 Deleting a User or a Role 43 Configuring a Remote LDAP Server 44 Choosing a License 44 Adding Custom Hawk Plug-Ins to the TIBCO OI Hawk RedTail - Container Edition Agent 45 TIBCO OI Hawk RedTail - Container Edition Programming 47 Legal and Third-Party Notices 49 TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration 4 | TIBCO Documentation and Support Services TIBCO Documentation and Support Services For information about this product, you can read the documentation, contact TIBCO Support, and join TIBCO Community. How to Access TIBCO Documentation Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainly in HTML and PDF formats. The TIBCO Product Documentation website is updated frequently and is more current than any other documentation included with the product. To access the latest documentation, visit https://docs.tibco.com. Product-Specific Documentation The following for this product is available on the TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Product Documentation page. The following documents for this product can be found in the TIBCO Documentation site: l TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Release Notes l TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Concepts l TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration l TIBCO® Operational Intelligence Hawk® RedTail - Container Edition User Guide l TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Microagent Reference l TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Security Guidelines How to Join TIBCO Community TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matter experts to share and access their collective experience. TIBCO Community offers access to Q&A forums, product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, and tools that extend and enable customers to gain full value from TIBCO products. In addition, users can submit and vote on feature TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration 5 | TIBCO Documentation and Support Services requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com. TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration 6 | TIBCO® OI Hawk® RedTail - Container Edition Overview TIBCO® OI Hawk® RedTail - Container Edition Overview TIBCO® Operational Intelligence Hawk® RedTail - Container Edition (TIBCO® OI Hawk® RedTail - Container Edition) is a tool for monitoring and managing distributed applications. TIBCO OI Hawk RedTail - Container Edition also provides public APIs to develop custom components (using the REST API, Hawk AMI, and Hawk Console API) as required. For more information about the APIs, see TIBCO Hawk® Programmer's Guide. For more information about REST APIs, see "REST API Reference" in TIBCO® Operational Intelligence Hawk® RedTail - Container Edition User Guide. You can enable additional monitoring capabilities in TIBCO OI Hawk RedTail - Container Edition with the "Standard Edition" license of the application. TIBCO OI Hawk RedTail - Container Edition is a set of containerized microservices which are used to monitor and manage the infrastructure and applications that are running in the private cloud. The monitoring is enabled using Hawk Rulebases which monitor particular application or system resources and takes an action when the specific conditions are detected. This is possible with pre-bundled and externally configurable micoragents and rulebases. TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration 7 | Deployment Architecture and Components Deployment Architecture and Components TIBCO OI Hawk RedTail - Container Edition is typically deployed in a private cloud environment such as Kubernetes, where it can monitor TIBCO and non-TIBCO applications and services. TIBCO OI Hawk RedTail - Container Edition is a set of microservices. Each microservice provides distinct features and capabilities. The following figure shows the components of TIBCO OI Hawk RedTail - Container Edition in a Kubernetes cluster for monitoring TIBCO and non-TIBCO applications and services. TIBCO OI Hawk RedTail - Container Edition architecture TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration 8 | Deployment Architecture and Components The following components are a part of the TIBCO OI Hawk RedTail - Container Edition deployment architecture: • Hawk Agent • Hawk Microagents • Hawk Console • Grafana • Time Series Storage (Prometheus) • Apache Zookeeper • Query Node • Webapp These components run as separate microservices and can be configured as required. You can configure these components using the environment variables in manifest files or Kubernetes Helm charts. See Environment Variables for TIBCO OI Hawk RedTail - Container Edition Components Hawk Agent The Hawk Agent is a process that monitors activity on a particular application by using microagents. In TIBCO OI Hawk RedTail - Container Edition, the Hawk Agent has built-in microagents to monitor the Kubernetes cluster or Docker infrastructure. The Hawk Agent uses rulebases to automate the monitoring using rules, alerts and actions. The Hawk Agent container connects to the Hawk Console container to form a cluster by using the TCP transport for Hawk. Hawk Microagents TIBCO OI Hawk RedTail - Container Edition has built-in microagents for monitoring Kubernetes infrastructure, or Docker host (if the deployment is on Docker) and you can also configure other microagents to monitor TIBCO and non-TIBCO applications/ services for example, TIBCO BW CE, FTL, AMX, etc. For more information, refer to TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Microagent Reference Guide. Hawk Microagents connect to Hawk Agent using the TCP Transport for Hawk. TIBCO® Operational Intelligence Hawk® RedTail - Container Edition Installation, Configuration, and Administration 9 | Deployment Architecture and Components Hawk Console You can use the REST API to access the TIBCO OI Hawk RedTail - Container Edition features like Hawk Microagent methods, Alerts, Tag based Rulebases, Content Packs, and Query. The Hawk Console and the Query Node exposes the other TIBCO OI Hawk RedTail - Container Edition components and external clients/scripts. The Hawk Console exposes administration and functional APIs and the Query Node exposes APIs to execute a query and other query related operations. The following REST APIs can be accessed separately using Swagger pages as follows: • Hawk Console: https://<hawkconsole>:<port>/hawkconsole/v1/docs • Query Node: https://<querynode>:<port>/docs Grafana The Grafana component enables you to create customized dashboards. You can create and maintain multiple dashboards at once and you now also have the ability to customize the panels within the dashboards in which multiple queries can be configured. Each panel can utilize the visualizations such as line charts, tables, and gauges. This is possible by using the Grafana RedTail Datasource Plugin. This is the default plugin that acts as a translator between Grafana and TIBCO OI Hawk RedTail - Container Edition. The plugin fetches the query results from TIBCO OI Hawk RedTail - Container Edition and then converts those results into Grafana compatible information. Grafana then displays this translated information in the form of visualization specified by the user. For more information about Grafana, see https://grafana.com/docs/. Time Series Storage (Prometheus) A time-series database is used to store and retrieve data records that are part of a “time series,” which is a set of data points that are associated with timestamps. The data is collected from a data source over a period of time. A time-series database lets you store large volumes of time stamped data in a format that allows fast insertion and fast retrieval to support complex analysis on that data. The collection of data is done by using metrics exporter. An exporter converts standard metrics