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
  • Cgroups configuration
  • Cgroups configuration and compatibility
  • Set the Cgroups mode during the client or backend installation
  • Set the Cgroups mode in the service configuration file
  • Add stateless clients
  • Add persistent clients, which are always part of the cluster
  • 1. Install the WEKA software
  • 2. Join the cluster
  • 3. Configure the container as a client
  • 4. Configure client networking
  • 5. Apply the container configuration
  1. Planning and Installation
  2. WEKA cluster installation on bare metal servers

Add clients to an on-premises WEKA cluster

This page describes how to add clients to a bare-metal cluster.

Cgroups configuration

Clients run applications that access the WEKA filesystem but do not contribute CPUs or drives to the cluster. They connect solely to use the filesystems.

By default, WEKA uses Cgroups to limit or isolate resources for its exclusive use, such as assigning specific CPUs.

Cgroups (Control Groups) is a Linux kernel feature that allows you to limit, prioritize, and isolate the resource usage (CPU, memory, disk I/O, network) of a collection of processes. It helps allocate resources among user-defined groups of tasks and manage their performance effectively.

Versions of Cgroups:

  • CgroupsV1: Uses multiple hierarchies for different resource controllers, offering fine-grained control but with increased complexity.

  • CgroupsV2: Combines all resource controllers into a single unified hierarchy, simplifying management and providing better resource isolation and a more consistent interface.

Hybrid mode: If the OS is configured with hybrid mode (CgroupsV1 and CgroupsV2), WEKA defaults to using CgroupsV1.

WEKA requirements:

  • Backends and clients serving protocols: Must run on an OS with CgroupsV1 support. CgroupsV2 is supported on backends and clients but is incompatible with protocol cluster deployments.

  • Cgroups mode compatibility: When setting up Cgroups on clients or backends, ensure that the Cgroups configuration (whether using CgroupsV1 or CgroupsV2) aligns with the operating system's capabilities and configuration.

Cgroups configuration and compatibility

The configuration of Cgroups depends on the installed operating system, and it is important that the cluster server settings match the OS configuration to ensure proper resource management and compatibility.

Customers using a supported OS with CgroupsV2 or wanting to modify the Cgroups usage can set the cgroups usage during the agent installation or by editing the service configuration file. The specified mode must match the existing Cgroups configuration in the OS.

The Cgroups setting includes the following modes:

  • auto: WEKA tries using CgroupsV1 (default). If it fails, the Cgroups is set to none automatically.

  • force: WEKA uses CgroupsV1. If the OS does not support it, WEKA fails.

  • force_v2: WEKA uses CgroupsV2. If the OS does not support it, WEKA fails. This mode is not supported in protocol cluster deployments.

  • none: WEKA never uses Cgroups, even if it runs on an OS with CgroupsV1.

Set the Cgroups mode during the client or backend installation

In the installation command line, specify the required Cgroups mode (WEKA_CGROUPS_MODE).

Example:

curl http://Backend-1:14000/dist/v1/install | WEKA_CGROUPS_MODE=none sh

Set the Cgroups mode in the service configuration file

You can set the Cgroups mode in the service configuration file for clients and backends.

  1. Open the service configuration file /etc/wekaio/service.conf and add one of the following:

    • cgroups_mode=auto

    • cgroups_mode=force

    • cgroups_mode=force_v2

    • cgroups_mode=none

  2. Restart the WEKA agent service.

  3. Restart the containers to apply the Cgroups settings:

    • Run weka local restart to restart all containers, or specify a container, for example, weka local restart client for the client container. If WEKA is mounted, unmount it before restarting.

  4. Verify the Cgroups settings by running the weka local status command.

Example:

[root@weka-cluster] #weka local status
Weka v4.2.0 (CLI build 4.2.0)
Cgroups: mode=auto, enabled=true

Containers: 1/1 running (1 weka)
Nodes: 2/2 running (2 READY)
Mounts: 1

Add stateless clients

To use the WEKA filesystems from a client, just call the mount command. The mount command automatically installs the software version, and there is no need to join the client to the cluster.

To mount a filesystem in this method, first, install the WEKA agent from one of the backend instances and then mount the filesystem.

Example:

# Agent Installation (one time)
curl http://Backend-1:14000/dist/v1/install | sh

# Creating a mount point (one time)
mkdir -p /mnt/weka

# Mounting a filesystem
mount -t wekafs -o net=eth0 backend-1/my_fs /mnt/weka

Each client must have a unique IP and FQDN.

Add persistent clients, which are always part of the cluster

Adding instances that do not contribute resources to the cluster but are used for mounting filesystems is possible. It is recommended to use the previously described method for adding client instances for mounting purposes. However, in some cases, adding them to the cluster permanently is helpful. For example, use these instances as NFS/SMB servers, which are always expected to be up.

1. Install the WEKA software

Install the WEKA software.

  • Run the install.sh command on each server, according to the instructions in the Install tab.

All clients in a WEKA system cluster must use the same software version as the backends or a maximum of one version back. The backend containers must run the same WEKA software version except during upgrades (as managed by the upgrade process).

2. Join the cluster

Command: weka cluster container add

Once the client is in the stem mode (this is the mode defined immediately after running the install.sh command), use the following command line on the client to add it to the cluster:

weka -H <backend-hostname> cluster container add <client-hostname>

Parameters in the command line

Name
Value

backend-hostname*

An existing hostname (IP or FQDN) of one of the existing backend instances in the cluster.

client-hostname*

A unique hostname (IP or FQDN) of the client to add.

On completion of this stage, the container-id of the newly added container will be received. Make a note of it for the next steps.

3. Configure the container as a client

Command: weka cluster container cores

To configure the new container as a client, run the following command:

weka cluster container cores <container-id> <cores> --frontend-dedicated-cores=<frontend-dedicated-cores>

Parameters in the command line

Name

Value

container-id*

A valid identifier of the container to add to the cluster.

cores*

The number of physical cores to allocate to the WEKA client.

frontend-dedicated-cores*

The number of physical cores to be dedicated to frontend processes. Mandatory to configure a container as a client. Maximum 19 cores. For clients, the number of total cores and frontend-dedicated-cores must be equal.

4. Configure client networking

Command: weka cluster container net add

If the new client is to communicate with the WEKA cluster over the kernel UDP stack, running this command is unnecessary.

If a high-performance client is required and the appropriate network NIC is available, use the following command to configure the networking interface used by the client to communicate with the WEKA cluster:

weka cluster container net add <container-id> <device> --ips=<ips> --netmask=<netmask> --gateway=<gateway>

Parameters

Name
Value

container-id*

A valid identifier of the container to add to the cluster.

device*

A valid network interface device name (for example, eth1).

ips*

A valid IP address of the new interface.

gateway

The IP address of the default routing gateway. The gateway must reside within the same IP network of ips (as described by netmask).

Not relevant for IB / L2 non-routable networks.

netmask

The number of bits that identify a network ID (also known as CIDR). For example, the netmask of 255.255.0.0 has 16 netmask bits.

When configuring an InfiniBand client, do not pass the --ips, --netmask and --gateway parameters.

InfiniBand/Ethernet clients can only join a cluster with the same network technology connectivity. It is possible to mix InfiniBand and Ethernet clients in the same cluster as long as the cluster backends are connected to both network technologies.

5. Apply the container configuration

Command: weka cluster container apply

After successfully configuring the container and its network device, run the following command to finalize the configuration by activating the container:

weka cluster container apply <container-id> [--force]

Parameters

Name
Value

container-id*

A comma-separated string of valid identifiers of the containers to add to the cluster.

force

A boolean indicates not to prompt for confirmation. The default is not to force a prompt.

PreviousPerform post-configuration proceduresNextWEKA Cloud Deployment Manager Web (CDM Web) User Guide

Last updated 1 year ago

For the first mount, this installs the WEKA software and automatically configures the client. For more information on mount and configuration options, refer to .

Configuring the client OS to mount the filesystem at boot time automatically is possible. For more information, refer to or .

Clients can be deployed on . They can use RAM for the WEKA client software and NFS mount for the traces. For more information, contact the .

Once the WEKA software tarball is downloaded from , run the untar command.

get.weka.io
diskless servers
Mount a filesystem using the stateless clients feature
Mount a filesystem using the traditional method
Mount filesystems using autofs
Customer Success Team