The Local WEKA Home (LWH) deployment offers an on-premises solution for monitoring and observing WEKA clusters. This approach allows organizations to operate within their own infrastructure, bypassing the need for a WEKA-hosted cloud service. By utilizing K3sa lightweight Kubernetes distribution, this setup provides a simplified environment with control over system resources and data.
Deploying LWH on K3s is particularly beneficial for small to medium environmentssupporting single-node cluster configurations. This architecture leverages a streamlined Kubernetes distribution to offer automated recovery and simplified lifecycle management of LWH components. The deployment is supported for LWH versions 3.x, 4.x, and above, ensuring compatibility and flexibility.
Prerequisites and Initial Setup
Before embarking on the deployment process, it is crucial to verify that all prerequisites are met. A dedicated physical server or VM with systemd is required, along with a user account that has root privileges. The server must meet minimum CPU core and RAM requirements, which are determined by the total number of processes in the WEKA cluster.
For instance, a deployment with 20 backends, each using 10 processes, and 500 clients, each using 2 processes, would require 9 CPU cores and 40 GiB of RAM. Additionally, SSD-backed storage of at least 500 GiB is necessary for locally collected data, and a 1 Gbps network connection is recommended. Ensuring these specifications are met will facilitate a smooth deployment process.
Preparing the Server
Preparing the physical server or VM involves several steps. If an extra disk is added to hold the /opt/wekahome data, it must be formatted and mounted, ensuring it is remounted on reboot. It is also recommended to disable SELinux and, if enabled, disable nm-cloud-setup and reboot the node. Open the necessary ports for processes such as kube-apiserver, kube-scheduler, kube-controller-manager, and kubelet, as well as ports 80 and 443 for web browser access.
Ensure that the networks 10.42.0.0/16 for pods and 10.43.0.0/16 for services are trusted. If these networks are not available, they can be customized in the configuration file before running the installation. Additionally, if data is to be forwarded from LWH to the Cloud WEKA Home, outbound traffic on port 443 must be open.
Configuring IPv6 (Optional)
LWH supports dual-stack networking, allowing communication over both IPv4 and IPv6 protocols. Enabling IPv6 ensures compatibility with modern network environments that require IPv6 compliance and connectivity. This configuration provides flexibility and compatibility, supporting IPv6-only and dual-stack environments for seamless communication.
To configure IPv6, verify that the host system has IPv6 networking enabled and that client machines have IPv6 connectivity to access LWH over IPv6. Ensure that the required IPv6 network ranges are available, or customize them in the configuration file. Dual-stack networking must be configured during cluster creation and cannot be enabled later if the cluster was initially deployed with IPv4-only.
Security Hardening
Before deploying the LWH software, it is essential to configure the server to meet WEKA security standards. This involves applying security hardening measures to ensure the server is secure and compliant with WEKA’s requirements. Following the guidelines provided in the Local WEKA Home overview will help achieve this.
Downloading and Installing Local WEKA Home
Download the latest Local WEKA Home bundle (v3.0 or above) to the dedicated server or VM. The installation process involves running the setup bundle as a root user and customizing the configuration using a config.json file. This file can be created based on examples and templates provided in the /opt/wekahome/current/config.json.sample directory.
The configuration file allows for various customizations, including GitHub SSO integration, trusted network settings, domain settings, SMTP configuration, TLS certificates, events retention period, and forwarding data to the Cloud WEKA Home. These settings can be adjusted to meet specific organizational needs and requirements.
Accessing the LWH Portal and Grafana
Once the installation is complete, access the LWH portal and Grafana using the provided URLs. The default username for accessing all portals is admin, and passwords can be obtained using specific kubectl commands. The WEKA Home REST API is also accessible for further integration and management.
Enabling Data Forwarding and Testing
By default, the WEKA cluster is set to send information to the public instance of WEKA Home. To redirect this data to the Local WEKA Home, connect to the WEKA cluster and run the appropriate command based on the configuration. Testing the deployment involves verifying that test data appears in the WEKA Home portal and triggering test events to ensure proper functionality.
Upgrading and Troubleshooting
Upgrading the Local WEKA Home involves running the upgrade command and verifying that all pods have the status Running or Completed. It is recommended to perform upgrades during a maintenance window, as certain upgrades may require a fresh installation. IPv6 support, in particular, requires a fresh installation and cannot be added to an existing LWH deployment with IPv4.
Troubleshooting common issues involves checking firewall and node IP settings, cleaning unused images, resizing the disk, and relocating the K3s root directory path. Collecting LWH deployment diagnostics can also provide valuable information for troubleshooting and support.
