Deploy Local WEKA Home v2.x
Explore procedures for deploying the Local WEKA Home v2.x, upgrading, modifying the configuration, and troubleshooting.
Last updated
Explore procedures for deploying the Local WEKA Home v2.x, upgrading, modifying the configuration, and troubleshooting.
Last updated
This implementation runs on Minikube (a lightweight Kubernetes implementation) installed on a single Docker container. You specify the configuration parameters in the config.yaml file as part of the deployment workflow.
If you have deployed the WMS, follow the procedure:Deploy monitoring tools using the WEKA Management Station (WMS). Otherwise, perform the following workflow:
Verify that the following requirements are met:
A dedicated physical server (or VM) for the installation.
The user account for installing the LWH must have root privileges.
Server minimum CPU and RAM requirements:
Minimum 8 CPUs and 20 GiB RAM for up to 1000 total processes.
Total processes are equal to the cores used on the cluster backends for Management/Frontend/Compute/Drives roles and the cores used on clients for Management/Frontend roles.
Sizing for additional processes:
The total number of processes determines the number of CPU and RAM required.
For every additional 1000 processes or less, add 1 CPU and 8 GiB RAM.
Example: 20 backends with 10 processes each = 200 processes; 500 clients with 2 processes each = 1000 processes. The total is 1200 processes. This deployment requires 9 CPUs and 28 GiB.
SSD-backed storage requirements:
Minimum 500 GiB for locally collected data in /opt/local-path-provisioner
Minimum 10 GiB for /tmp/host-path-provisioner.
Docker version 20 or higher.
1 Gbps network
For using other operating systems, contact the Customer Success Team.
Disable the SELinux.
Disable the iptables, UFW, or firewalld.
Ensure the following ports are open and not used by any other process. Each port is used for the process specified in the brackets.
6443 (kube-apiserver)
10259 (kube-scheduler)
10257 (kube-controller-manager)
10250 (kubelet)
2379 (etcd)
2380 (etcd)
80 (Local WEKA Home, WEKA cluster, and web browser)
443 (Local WEKA Home, WEKA cluster, and web browser)
If you forward data from the Local WEKA Home to the Cloud WEKA Home, ensure the outbound traffic on port 443 is open.
Install the Docker Engine version 20 or higher on the physical server according to the Docker documentation. To install the Docker on RHEL, see Install Docker Engine on Centos (the instructions in Install Docker Engine on RHEL do not work).
Run the following to verify that the required docker version is installed:
docker --version.
Run the following to start the docker and enable it:
systemctl start docker && systemctl enable docker
Run the following to set the iptables and pre-load it:
echo net.bridge.bridge-nf-call-iptables=1 >> /etc/sysctl.conf; sysctl -p
Run the following to install the rule tables manager, connection tracking, and multi-purpose relay tool:
yum install -y ebtables conntrack socat
Run the following to install the Traffic Control tool (tc):
yum install -y tc
(Depending on the Linux distribution, tc may already be installed. Or it is called iproute-tc. If it is, run: yum install -y iproute-tc.)
Verify that the HugePages is disabled (HugePages_Total: 0).
Run the following command:
grep HugePages_Total /proc/meminfo
If the returned value of the HugePages_Total is higher than 0, run the following to disable the HugePages:
echo 0 > /proc/sys/vm/nr_hugepages
Download the latest packages of the following to the dedicated physical server (or VM):
Local WEKA Home v2.x: https://get.weka.io/ui/lwh/download.
Minikube for Local WEKA Home: curl -OL https://home-weka-io-offline-packages-dev.s3.eu-west-1.amazonaws.com/weka_minikube.tar.gz
Unpack the Minikube package:
tar xvf <file name>
From the minikube_offline directory, run the install script:
./minikube-offline_install.sh
The installation takes about 3 minutes.
Verify the minikube is installed successfully:
minikube status
If the minikube installation fails, do one of the following:
Go to /var/log/wekahome and review the relevant log according to the timestamp (for example, minikube-install-03-08-2023_16-29.log).
Run the command minikube logs. A log file is created in /tmp directory. Open the log file and search for the reason.
Unpack the Local WEKA Home package:
tar xvf <file name>
From the wekahome_offline directory, run:
./update_config.sh
Open the /root/.config/wekahome/config.yaml file and set the following:
Run ./wekahome-install.sh.
For new installation, it takes about 5 minutes.
Run kubectl get pods and verify in the results that all pods have the status Running or Completed. (To wait for the pods statuses, run watch kubectl get pods.)
Verify the Local WEKA Home is installed successfully. Run the following command line:
helm status homewekaio -n home-weka-io
The Local WEKA Home URL is https://<your_domain>
The Grafana URL of the Local WEKA Home is https://<your_domain>/stats/
The WEKA Home REST API URL is https://<your_domain>/api/
The user name for accessing the portals is admin.
To obtain the password for accessing the Local WEKA Home portal, run the following command:
kubectl get secret -n home-weka-io weka-home-admin-credentials -o jsonpath='{.data.admin_password}' | base64 -d
To obtain the password for accessing the Local Weka Home grafana portal, run the following command:
kubectl get secret -n home-weka-io weka-home-grafana-credentials -o jsonpath='{.data.password}' | base64 -d
To obtain the secret key of the Local WEKA Home portal, run the following command:
kubectl get secret -n home-weka-io weka-home-encryption -o jsonpath='{.data.encryption_secret_key}' | base64 -d
By default, the WEKA cluster is set to send information to the public instance of WEKA Home. To get the information in the Local WEKA Home, set the URL of the Local WEKA Home in the WEKA cluster.
Connect to the WEKA cluster and run the following command:
weka cloud enable --cloud-url https://<ip or hostname of the Local Weka Home server>
Access the WEKA Home portal and verify that the test data appears.
To trigger a test event, run weka events trigger-event test and verify the test event is received in the Local WEKA Home portal under the Events section.
If required, go to /var/log/wekahome and review the relevant log according to the timestamp (for example, wekahome-install-03-08-2023_16-29.log).
To support dark site customers and other users with local Certificate Authorities (CAs) for configuring secure connectivity to the Local WEKA Home.
Procedure
Create a secret using the same method as described in the nginx documentation. For example, you can use the following command:
Optionally, you can specify a name for the secret (in this command, it's named ca-secret) and a namespace for it using the -n option.
Add an Ingress annotation that references this CA certificate by extending the global.ingress.annotations with the following field:
In this annotation, replace default with the namespace you've specified (or leave it as "default"), and replace ca-secret with the actual name of the secret.
After making these changes, proceed to the general upgrade instructions.
The Local WEKA Home upgrade workflow is similar to the deployment workflow (without reinstalling the Minikube). The upgrade process takes about 5 minutes, and the LWH is unavailable during this time. It is recommended to perform the upgrade during a maintenance window.
Before you begin
If your initial Local WEKA Home (LWH) installation was done using the WMS, change the directory to /opt/local-weka-home. Otherwise, change the directory to the location where LWH was initially installed.
Here's an example of how to change the directory to /opt/local-weka-home when the WMS was used:
Log into the WMS:
As root user:
Or as the weka user:
Switch to root user (if not already):
Change to the local-weka-home directory:
Check the version.
If the source LWH version is lower than 2.11.0, run the following commands to prepare the source LWH for upgrade:
Procedure
Download the latest Local WEKA Home package (wekahome-vm-docker-images). See the location in 3. Download the Local WEKA Home and Minikube packages.
Unpack the Local Weka Home package to the same directory used for installing the LWH. tar xvf <file name> -C <path>
From the wekahome_offline sub-directory, run ./update_config.sh
If you want to modify the existing configuration, open the /root/.config/wekahome/config.yaml file and do the following:
Modify the settings. See 5. Install and configure the Local WEKA Home.
If you update the following sections: TLS certificates, admin credentials, and Grafana, add the line force_update: true to the end of the updated section in the config.yaml file. For example:
Run ./wekahome-install.sh. For an upgrade, it takes about 2 minutes.
Run kubectl get pods -n home-weka-io and verify in the results that all pods have the status Running or Completed. (To wait for the pods statuses, run watch kubectl get pods.)
Verify the Local WEKA Home is upgraded successfully. Run the following command line:
helm status homewekaio -n home-weka-io
If any changes made to the config.yaml required setting force_update: true, change it back to false.
Suppose there is a change in the TLS certificates, SMTP server in your environment, or any other settings in the Local WEKA Home configuration, you can modify the existing config.yaml with your new settings and apply them.
Procedure
Open the /root/.config/wekahome/config.yaml file and do the following:
Modify the settings. See 5. Install and configure the Local WEKA Home.
If you update the following sections: TLS certificates, admin credentials, and Grafana, add the line force_update: true to the end of the updated section in the config.yaml file. For example:
Run ./wekahome-install.sh
Run kubectl get pods and verify in the results that all pods have the status Running or Completed. (To wait for the pods statuses, run watch kubectl get pods.)
Verify the Local WEKA Home is updated successfully. Run the following command line:
helm status homewekaio -n home-weka-io
If any changes made to the config.yaml required setting force_update: true, change it back to false.
The probable cause can be, for example, a communication problem.
Retrieve the ingress pod (controller) of the Local WEKA Home.
kubectl get pods -n ingress-nginx -o name|grep controller
Retrieve the logs and look for the error.
kubectl logs <pod name from previous command> -n ingress-nginx > nginx.out
The probable cause for this issue is that the docker root dir (/var/lib/docker) consumes disk space.
Do one of the following:
Resize the disk and reinstall the Local WEKA Home.
Relocate the docker root directory path to a new path on a larger device (if it exists) and copy the content from the old path to the new path.
The probable cause can be issues related to the SMTP server, such as wrong credentials or recipient email address.
On the Integration page, select Test Integration. Wait until an error appears.
Retrieve the logs and search for the error. On the Local WEKA Home terminal, run the following command:
for dep in `kubectl get deployment -n home-weka-io -o name`; do echo -----$dep-----; kubectl logs $dep --all-containers=true --timestamps=true --since=5m ; done
The LWH provides a script that collects various resource details from the LWH deployed on the Kubernetes cluster and generates an archive. This information helps the Customer Success Team and R&D to analyze and provide support when troubleshooting is needed.
The LWH deployment diagnostics provide the following information:
Pods status
Logs of all pods
Minikube settings
Free disk space
CPU and memory usage
Name resolutions
LWH version
Syslogs
Procedure
Obtain the dump.sh script from the LWH installation package.
Run the following command:
Once you generate the LWH deployment diagnostics archive file, send it to the Customer Success Team for analysis.
Parameters
archive*
The path and output archive file name.
For example: /path/diag/lwh_diagnostics.tar.gz
include-sensitive
Include sensitive data in the archive. For example, value overrides. Use this parameter only if required by the Customer Success Team.
full-disk-scan
Perform a higher level of disk scan. Use this parameter only if required by the Customer Success Team.
verbose
Provide a higher verbosity level of the debug information.
The WEKA cluster uploads data to the Local WEKA Home periodically and on-demand according to its information type (see ).