W E K A
4.3
4.3
  • WEKA v4.3 documentation
    • Documentation revision history
  • WEKA System Overview
    • WEKA Data Platform introduction
      • WEKA system functionality features
      • Converged WEKA system deployment
      • Optimize redundancy in WEKA deployments
    • SSD capacity management
    • Filesystems, object stores, and filesystem groups
    • WEKA networking
    • Data lifecycle management
    • WEKA client and mount modes
    • WEKA containers architecture overview
    • Glossary
  • Planning and Installation
    • Prerequisites and compatibility
    • WEKA cluster installation on bare metal servers
      • Plan the WEKA system hardware requirements
      • Obtain the WEKA installation packages
      • Install the WEKA cluster using the WMS with WSA
      • Install the WEKA cluster using the WSA
      • Manually install OS and WEKA on servers
      • Manually prepare the system for WEKA configuration
        • Broadcom adapter setup for WEKA system
        • Enable the SR-IOV
      • Configure the WEKA cluster using the WEKA Configurator
      • Manually configure the WEKA cluster using the resource generator
      • Perform post-configuration procedures
      • Add clients to an on-premises WEKA cluster
    • WEKA Cloud Deployment Manager Web (CDM Web) User Guide
    • WEKA Cloud Deployment Manager Local (CDM Local) User Guide
    • WEKA installation on AWS
      • WEKA installation on AWS using Terraform
        • Terraform-AWS-WEKA module description
        • Deployment on AWS using Terraform
        • Required services and supported regions
        • Supported EC2 instance types using Terraform
        • WEKA cluster auto-scaling in AWS
        • Detailed deployment tutorial: WEKA on AWS using Terraform
      • WEKA installation on AWS using the Cloud Formation
        • Self-service portal
        • CloudFormation template generator
        • Deployment types
        • AWS Outposts deployment
        • Supported EC2 instance types using Cloud Formation
        • Add clients to a WEKA cluster on AWS
        • Auto scaling group
        • Troubleshooting
      • Install SMB on AWS
    • WEKA installation on Azure
    • WEKA installation on GCP
      • WEKA project description
      • GCP-WEKA deployment Terraform package description
      • Deployment on GCP using Terraform
      • Required services and supported regions
      • Supported machine types and storage
      • Auto-scale instances in GCP
      • Add clients to a WEKA cluster on GCP
      • Troubleshooting
      • Detailed deployment tutorial: WEKA on GCP using Terraform
      • Google Kubernetes Engine and WEKA over POSIX deployment
  • Getting Started with WEKA
    • Manage the system using the WEKA GUI
    • Manage the system using the WEKA CLI
      • WEKA CLI hierarchy
      • CLI reference guide
    • Run first IOs with WEKA filesystem
    • Getting started with WEKA REST API
    • WEKA REST API and equivalent CLI commands
  • Performance
    • WEKA performance tests
      • Test environment details
  • WEKA Filesystems & Object Stores
    • Manage object stores
      • Manage object stores using the GUI
      • Manage object stores using the CLI
    • Manage filesystem groups
      • Manage filesystem groups using the GUI
      • Manage filesystem groups using the CLI
    • Manage filesystems
      • Manage filesystems using the GUI
      • Manage filesystems using the CLI
    • Attach or detach object store buckets
      • Attach or detach object store bucket using the GUI
      • Attach or detach object store buckets using the CLI
    • Advanced data lifecycle management
      • Advanced time-based policies for data storage location
      • Data management in tiered filesystems
      • Transition between tiered and SSD-only filesystems
      • Manual fetch and release of data
    • Mount filesystems
      • Mount filesystems from Single Client to Multiple Clusters (SCMC)
    • Snapshots
      • Manage snapshots using the GUI
      • Manage snapshots using the CLI
    • Snap-To-Object
      • Manage Snap-To-Object using the GUI
      • Manage Snap-To-Object using the CLI
    • Quota management
      • Manage quotas using the GUI
      • Manage quotas using the CLI
  • Additional Protocols
    • Additional protocol containers
    • Manage the NFS protocol
      • Supported NFS client mount parameters
      • Manage NFS networking using the GUI
      • Manage NFS networking using the CLI
    • Manage the S3 protocol
      • S3 cluster management
        • Manage the S3 service using the GUI
        • Manage the S3 service using the CLI
      • S3 buckets management
        • Manage S3 buckets using the GUI
        • Manage S3 buckets using the CLI
      • S3 users and authentication
        • Manage S3 users and authentication using the CLI
        • Manage S3 service accounts using the CLI
      • S3 rules information lifecycle management (ILM)
        • Manage S3 lifecycle rules using the GUI
        • Manage S3 lifecycle rules using the CLI
      • Audit S3 APIs
        • Configure audit webhook using the GUI
        • Configure audit webhook using the CLI
        • Example: How to use Splunk to audit S3
      • S3 supported APIs and limitations
      • S3 examples using boto3
      • Access S3 using AWS CLI
    • Manage the SMB protocol
      • Manage SMB using the GUI
      • Manage SMB using the CLI
  • Operation Guide
    • Alerts
      • Manage alerts using the GUI
      • Manage alerts using the CLI
      • List of alerts and corrective actions
    • Events
      • Manage events using the GUI
      • Manage events using the CLI
      • List of events
    • Statistics
      • Manage statistics using the GUI
      • Manage statistics using the CLI
      • List of statistics
    • Insights
    • System congestion
    • Security management
      • Obtain authentication tokens
      • KMS management
        • Manage KMS using the GUI
        • Manage KMS using the CLI
      • TLS certificate management
        • Manage the TLS certificate using the GUI
        • Manage the TLS certificate using the CLI
      • CA certificate management
        • Manage the CA certificate using the GUI
        • Manage the CA certificate using the CLI
      • Account lockout threshold policy management
        • Manage the account lockout threshold policy using GUI
        • Manage the account lockout threshold policy using CLI
      • Manage the login banner
        • Manage the login banner using the GUI
        • Manage the login banner using the CLI
      • Manage Cross-Origin Resource Sharing
    • User management
      • Manage users using the GUI
      • Manage users using the CLI
    • Organizations management
      • Manage organizations using the GUI
      • Manage organizations using the CLI
      • Mount authentication for organization filesystems
    • Expand and shrink cluster resources
      • Add a backend server
      • Expand specific resources of a container
      • Shrink a cluster
    • Background tasks
      • Set up a Data Services container for background tasks
      • Manage background tasks using the GUI
      • Manage background tasks using the CLI
    • Upgrade WEKA versions
  • Licensing
    • License overview
    • Classic license
  • Monitor the WEKA Cluster
    • Deploy monitoring tools using the WEKA Management Station (WMS)
    • WEKA Home - The WEKA support cloud
      • Local WEKA Home overview
      • Deploy Local WEKA Home v3.0 or higher
      • Deploy Local WEKA Home v2.x
      • Explore cluster insights and statistics
      • Manage alerts and integrations
      • Enforce security and compliance
      • Optimize support and data management
    • Set up the WEKAmon external monitoring
    • Set up the SnapTool external snapshots manager
  • Support
    • Get support for your WEKA system
    • Diagnostics management
      • Traces management
        • Manage traces using the GUI
        • Manage traces using the CLI
      • Protocols debug level management
        • Manage protocols debug level using the GUI
        • Manage protocols debug level using the CLI
      • Diagnostics data management
  • Best Practice Guides
    • WEKA and Slurm integration
      • Avoid conflicting CPU allocations
    • Storage expansion best practice
  • WEKApod
    • WEKApod Data Platform Appliance overview
    • WEKApod servers overview
    • Rack installation
    • WEKApod initial system setup and configuration
    • WEKApod support process
  • Appendices
    • WEKA CSI Plugin
      • Deployment
      • Storage class configurations
      • Tailor your storage class configuration with mount options
      • Dynamic and static provisioning
      • Launch an application using WEKA as the POD's storage
      • Add SELinux support
      • NFS transport failback
      • Upgrade legacy persistent volumes for capacity enforcement
      • Troubleshooting
    • Convert cluster to multi-container backend
    • Create a client image
    • Update WMS and WSA
    • BIOS tool
Powered by GitBook
On this page
  • WMS deployment prerequisites
  • Before you begin
  • WMS deployment workflow
  • Install the WMS
  • Configure the WMS
  • Change password
  • Configure the email notifications
  • Install and configure the LWH
  • Configure the WEKAmon
  • Edit the hosts file
  • Configure the Snaptool
  • Download diagnostics logs
  1. Monitor the WEKA Cluster

Deploy monitoring tools using the WEKA Management Station (WMS)

Deploy the monitoring tools, LWH, WEKAmon, and SnapTool, using the WEKA Management Station (WMS) in an on-premises environment.

PreviousClassic licenseNextWEKA Home - The WEKA support cloud

Last updated 5 months ago

The WEKA Management Station (WMS) is an installation kit similar to an OS installation disk that simplifies the installation and configuration of the Local WEKA Home (LWH), WEKAmon, and SnapTool in an on-premises environment. The WMS installs the WEKA OS, drivers, and WEKA software automatically and unattended.

The WMS can also install a WEKA cluster by deploying the WEKA Software Appliance (WSA) package on bare metal servers.

See the related topics to learn about the tools installed with the WMS.

Related topics

WEKA Home - The WEKA support cloud

Set up the WEKAmon external monitoring

Set up the SnapTool external snapshots manager

WEKA cluster installation on bare metal servers

WMS deployment prerequisites

The server or VM must meet the following requirements:

  • Boot drives: One or two identical boot drives as an installation target.

    • A system with two identical boot drives has the OS installed on mirrored partitions (LVM).

    • A system with one drive has a simple partition.

  • Minimum boot drive capacity:

    • If not configuring LWH: SSD 141 GB (131 GiB).

  • Boot type: UEFI boot (BIOS boot is also supported but deprecated).

  • Cores and RAM:

    • If not configuring LWH: minimum 4 cores and 16 GiB.

  • Network interface: 1 Gbps.

This workflow only applies to installation on a server or VM. It does not apply to installation on AWS. To install on AWS, contact the Customer Success Team.

Before you begin

Before deploying the WMS, adhere to the following:

  • The root password is WekaService

  • The weka user password is weka.io123

  • If errors occur during installation and the installation halts (no error messages appear), use the system console to review the logs in /tmp. The primary log is /tmp/ks-pre.log.

  • To get a command prompt from the Installation GUI, do one of the following:

    • On macOS, type ctrl+option+f2

    • On Windows, type ctrl+alt+f2.

WMS deployment workflow

Install the WMS

Procedure

  1. Boot the server from the WMS image. The following are some options to do that:

Copy the WEKA Management Station ISO image to an appropriate location so the server’s BMC (Baseboard Management Controller) can mount it or be served through a PXE (Preboot Execution Environment).

Depending on the server manufacturer, consult the documentation for the server’s BMC (for example, iLO, iDRAC, and IPMI) for detailed instructions on mounting and booting from a bootable ISO image, such as:

  • A workstation or laptop sent to the BMC through the web browser.

  • An SMB share in a Windows server or a Samba server.

  • An NFS share.

To use PXE boot, use the WEKA Management Station as any other Operating System ISO image and configure accordingly.

Burn the WMS image to a DVD and boot it from the physical DVD. However, most modern servers do not have DVD readers anymore.

A bootable USB drive should work (follow online directions for creating a bootable USB drive) but has not been tested yet.

Once you boot the server, the WEKA Management Station installs the WEKA OS (Rocky Linux), drivers, and WEKA software automatically and unattended (no human interaction required).

Depending on network speed, this can take about 10-60 mins (or more) per server.

Configure the WMS

Once the WMS installation is complete and rebooted, configure the WMS.

Procedure

  1. Run the OS using one of the following options:

Run the OS through the BMC’s Console. See the specific manufacturer’s BMC documentation.

Run the OS through the Cockpit Web Interface on port 9090 of the OS management network.

If you don’t know the WMS hostname or IP address, go to the console and press the Return key a couple of times until it prompts the URL of the WMS OS Web Console (Cockpit) on port 9090.

Change the port from 9090 to 8501, which is the WMS Admin port.

  1. Browse to the WMS Admin UI using the following URL: http://<WMS-hostname-or-ip>:8501

  1. If you have created a local username dedicated to WMS, as recommended, enter its credentials. Otherwise, enter the default username and password admin/admin. Then, select Login. The Landing Page appears.

Change password

The default password is admin. It is recommended to change it for security reasons.

Procedure

  1. From the left pane, select Change Password.

  2. Provide your current password, choose a new password, confirm the new password, and click Reset.

Configure the email notifications

Set up email notifications by configuring the SMTP Relay to enable WMS for sending notifications related to:

  • LWH alerts and events: The LWH sends email alerts and events notifications.

  • WEKAmon quota notifications: The WEKAmon Alert Manager sends email alerts when a user reaches the soft quota limit.

Procedure

  1. From the left pane, select Email Notification Settings.

  2. Set the required details:

    • Email From Name: The designated name for the sender of WMS emails.

    • Email From Address: The email address used for outgoing emails from WMS.

    • Email Relay Host: The smart host or upstream SMTP Relay address WMS uses for sending emails.

    • Email Relay Port: The port number used on the SMTP Relay. Typically set to 25, 465, 587, or 2525.

    • SMTP Relay allows/requires TLS: Select if the SMTP Relay uses TLS encryption.

    • Email Relay Username: Enter the username for logging into the SMTP Relay, if necessary.

    • Email Relay Password: Enter the password for logging into the SMTP Relay, if necessary.

    • Allow Insecure TLS with SMTP Relay: Enable TLS for an SMTP Relay with a self-signed certificate.

  3. Select Save.

Install and configure the LWH

Procedure

  1. From the left pane, select Configure Local WEKA Home.

  2. Set the required details:

    • Listen Address/Domain: Specify the address or hostname on which LWH will listen. Leave it blank or use 0.0.0.0 to listen on all interfaces. Alternatively, input an IP address, hostname, or FQDN as the TLS certificate requires.

    • Email Alert Domain Name (REQUIRED): Enter a domain name (or IP address) for Alert Email URL links. For instance, if you input sample.com, the links appear as https://sample.com/something. Typically, this is the domain you use to access WMS (this server's name).

    • Enable Ingress TLS: Toggle to enable TLS for all connections.

    • TLS Cert: Specify the TLS certificate to be used.

    • TLS Key: Enter the TLS key corresponding to the specified certificate above.

    • Enable email notifications (configure in the Email Notification Setting page): Activate email notifications and set up your email server configurations in the Email Notification Settings page.

    • Enable forwarding data to Cloud WEKA Home: Activate this feature to send data to Cloud WEKA Home. Internet connectivity to api.home.weka.io is required for this functionality. The default setting is activated.

  1. Select Save. The WMS saves the configuration and installs the Minikube and LWH. This process can take several minutes. When the process completes, the following appears:

  1. Retrieve the LWH Admin and Grafana passwords as follows:

    • Select Get Admin Password. The password appears below the button.

    • Select Get Grafana Password. The password appears below the button. This password only applies to the Grafana instance within LWH (not related to the Grafana instance of the WEKAmon).

  1. Register the cluster with the LWH.

    • Choose one of the backend servers in your cluster to run the command.

    • Run the appropriate command based on your TLS configuration. If TLS is configured, use the following command with the WMS server IP or hostname:

      weka cloud enable --cloud-url https://<WMS server IP or hostname>

      If TLS is not configured, use the following command with the WMS server IP or hostname:

      weka cloud enable --cloud-url http://<WMS server IP or hostname>

      Ensure that the provided WMS server IP or hostname matches the WMS instance information.

The WMS can have multiple IP interfaces, such as when installed as a jump host with distinct interfaces for the corporate network and the cluster network. In scenarios where the cluster is isolated from the corporate network, it is essential to specify the IP address of the WMS associated with the cluster network.

  1. Log in to the LWH. On the Landing Page, select Open Local WEKA Home. If the tab does not appear, check that the browser pop-up blocker does not block it. When prompted for a password, enter the Admin password retrieved in the previous steps. The LWH Cluster Overview page opens on a new tab.

Reconfiguring LWH: If required, return to the LWH configuration page, update the configuration, and select Save again. The LWH configuration will be updated and restarted.

Configure the WEKAmon

Procedure

  1. From the left pane, select Configure WEKAmon.

  1. Select the services you want to enable. Possible options:

    • Enable Metrics Exporter & Grafana: Select to activate metrics exporter and Grafana integration to visualize and analyze performance metrics seamlessly.

    • Enable Quota Exporter & Notifications: Select to enable the WEKAmon to send notifications for soft storage quotas.

    • Enable Snaptool: Select to activate the snapshots manager, facilitating scheduled snapshots and automated operations.

    • Enable WEKAmon Log Storage: Select this option to enable long-term event storage within WEKAmon.

To set the quota limits, see Quota management.

  1. Set the hostname or public IP address, username, and password of the cluster to monitor (it can be a backend server of the cluster). Then, select Save.

If DNS does not have the hostnames of the cluster, do one of the following:

Once the WMS successfully logs in to the cluster, the WEKAmon installation begins. When the WEKAmon installation is completed, you can open it from the WMS Landing Page.

  1. Log in to Grafana. On the Landing Page, select Grafana. If the tab does not appear, check that the browser pop-up blocker does not block it. When prompted for a username and password, enter the enter admin/admin (not the username/password that was retrieved for LWH). The Grafana page opens on a new tab.

Edit the hosts file

If the WEKA cluster servers are not resolvable with a DNS, resolve the server names and associate them with the relevant IP addresses accessible to the WMS in the /etc/hosts file.

The WMS provides a simple text editor to facilitate editing the /etc/hosts file.

Procedure

  1. From the left pane, select Edit Hosts File.

  2. Add the IP addresses of the cluster servers. Type, copy, and paste as in any other simple text editor.

  3. Select Save.

Configure the Snaptool

Snaptool is pre-installed in the /opt/snaptool directory and includes all the containers, so there is no need to download anything. Only configuration is required.

Procedure

  1. From the left pane, select Snaptool Configuration.

  2. Select Save.

Download diagnostics logs

If errors occur during the WMS installation, download the diagnostics logs and send them to the Customer Success Team.

Procedure

  1. From the left pane, select Download Logs.

  2. Select Gather Logs to collect the logs.

  3. Once finished, select Download Logs to save a local copy of the diagnostics tarball on your workstation.

  1. Share the downloaded files with the Customer Success Team.

If configuring LWH: See the SSD-backed storage requirements section in .

If configuring LWH, see the Server minimum CPU and RAM requirements section in .

Firewall rules: The WMS listens on multiple ports depending on which service you are accessing. See

Creating a unique local username dedicated to WMS with a ClusterAdmin or OrgAdmin role is highly recommended. The unique username is displayed in the event logs, making identifying and troubleshooting issues easier. To create a local user, see the topic.

.

.

.

.

.

.

.

.

.

Download the latest WMS image from (requires sign-in).

Edit the /etc/hosts file before trying again. See .

Use the Cockpit Web Interface on port 9090 to change the DNS settings. See Cockpit Web Interface in .

In the Snaptool Configuration Editor, if required, you can update the configuration. For details, see . Snaptool shares the same cluster login information as WEKAmon and automatically detects and re-loads its configuration when any changes are made.

get.weka.io
Install the WMS
Configure the WMS
Change password
Configure the email notifications
Install and configure the LWH
Configure the WEKAmon
Edit the hosts file
Configure the Snaptool
Download logs
Edit the hosts file
Configure the WMS
Create local users
Edit the configuration in the snaptool.yml file
Required ports
#1.-verify-prerequisites
#1.-verify-prerequisites
WEKA Management Station deployment
WMS installation progress
Cockpit URL (IP address of this WMS is 172.29.7.152)
WMS Landing Page: Login
WMS Landing Page
Change Password
WMS Email Notification Settings
Local WEKA Home configuration (post Installation example)
LWH installation is complete
Admin password
Open Local WEKA Home in a new tab
WEKAmon Services Configuration
WEKAmon installation completes
Edit /etc/hosts
Snaptool Configuration
Download Logs
Downloaded logs example