W E K A
4.2
4.2
  • WEKA v4.2 documentation
    • Documentation revision history
  • WEKA System Overview
    • 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 resources generator
      • Perform post-configuration procedures
      • Add clients
    • 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
        • Auto scaling group
        • Troubleshooting
    • 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
      • Troubleshooting
  • 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)
      • Manage authentication across multiple clusters with connection profiles
    • 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
    • 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
    • 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
      • Manage background tasks using the GUI
      • Manage background tasks using the CLI
    • Upgrade WEKA versions
  • Billing & 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
  • 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
Powered by GitBook
On this page
  • Configure the SMB cluster
  • Edit the SMB cluster
  • Join the SMB cluster to Active Directory
  • Add servers to the SMB cluster
  • Remove servers from the SMB cluster
  • Delete the SMB cluster
  • Display the SMB shares list
  • Add an SMB share
  • Edit an SMB share
  • Remove an SMB share
  1. Additional Protocols
  2. Manage the SMB protocol

Manage SMB using the GUI

This page provides procedures for setting up an SMB cluster over WEKA filesystems and managing the cluster itself, using the GUI.

PreviousManage the SMB protocolNextManage SMB using the CLI

Last updated 8 months ago

Using the GUI, you can:

  • (not applicable for legacy SMB)

Configure the SMB cluster

An SMB cluster comprises at least three WEKA servers running the SMB-W stack.

Before you begin

Verify that the dedicated filesystem for persistent protocol configurations is created. If not, create it. For details, see

Procedure

  1. From the menu, select Manage > Protocols.

  2. From the Protocols pane, select SMB.

  3. On the Configuration tab, select Configure.

4. In the SMB Cluster Configuration dialog, set the following properties:

  • Name: A name for the SMB cluster. This will be the name of the Active Directory computer object and the hostname part of the FQDN.

  • Domain: The Active Directory domain to join the SMB cluster.

  • Domain NetBIOS Name: (Optional) The domain NetBIOS name.

  • Encryption: Select the in-transit encryption mode to use in the SMB cluster:

    • enabled: Enables encryption negotiation but doesn't turn it on automatically for supported sessions and sharing connections.

    • desired: Enables encryption negotiation and turns on data encryption for supported sessions and sharing connections.

    • required: Enforces data encryption on sessions and sharing connections. Clients that do not support encryption will be denied access to the server.

  • Servers: List 3-8 WEKA system servers to participate in the SMB cluster based on the server IDs in WEKA.

  • IPs: (Optional) List of virtual IPs (comma-separated) used as floating IPs for the SMB cluster to provide HA to clients. These IPs must be unique; do not assign these IPs to any host on the network. For an IP range, use the following format: a.b.c.x-y.

  • Config Filesystem: select the filesystem used for persisting cluster-wide protocol configurations.

Due to cloud provider network limitations, setting a list of SMB floating IPs in all cloud installations is impossible. In this case, the SMB service must be accessed using the cluster nodes' primary addresses.

  1. Select Save.

Once the system completes configuration, the server statuses change from not ready (❌) to ready (✅).

Edit the SMB cluster

You can modify the encryption and IP settings according to your needs.

Procedure

  1. In the SMB Cluster Configuration, select the pencil icon.

  1. In the Edit SMB Configuration dialog, do the following:

    • Encryption: Select one of the in-transit encryption enforcements: enabled, desired, or required.

    • IPs: List of virtual IPs (comma-separated) used as floating IPs for the SMB cluster. (Floating IPs are not supported for cloud installations.)

3. Select Save.

Join the SMB cluster to Active Directory

To enable the SMB cluster to use Active Directory to resolve the access of users and user groups, join the SMB cluster to Active Directory (AD).

Before you begin

Ensure the AD Domain Controllers are reachable by all WEKA servers participating in the SMB cluster. This resolution enables the WEKA servers to join the AD domain.

Procedure

  1. In the SMB Cluster Configuration, select Join.

  1. In the Join to Active Directory dialog, set the following properties:

    • Username and Password: A username and password of an account that has join privileges to the Active Directory domain. WEKA does not save these credentials; instead, a computer account is created for use by the SMB cluster.

    • Server: (Optional) WEKA automatically identifies an AD Domain Controller server based on the domain name. You do not need to set the server name. In some cases, specify the AD server if required.

    • Computers Org. Unit: The default AD organizational unit (OU) for the computer account is the Computers directory. You can define any OU in which to create the computer account that the joining account has permissions, such as SMB Servers or Corporate Computers.

Once the SMB cluster joins the Active Directory domain, the join status next to the domain changes to Joined.

To join an existing SMB cluster to a different Active Directory domain, select Leave. To confirm the action, enter the username and password to join the Active Directory domain.

Add servers to the SMB cluster

Adding servers to the SMB cluster can provide several benefits and address various requirements, such as scalability, load balancing, high availability, and improved fault tolerance.

You can add servers to an SMB cluster already joined to an Active Directory domain.

Procedure

  1. On the Servers pane, select Add.

  2. In the Add SMB Cluster Servers dialog, select one or more available servers (a maximum of eight servers) from the list.

  3. Select Save.

Remove servers from the SMB cluster

If the SMB cluster has more servers than you need, you can remove the server.

The minimum required number of servers in an SMB cluster is three.

Procedure

  1. On the Servers pane, select Remove.

  2. To remove one server, select the three dots next to the server to remove and select Remove.

  1. To remove more than one server, from the Remove SMB Cluster Servers dialog, select the servers to remove (click the X), and select Save.

Delete the SMB cluster

Deleting the SMB cluster resets its configuration data. Deleting an SMB cluster only applies to SMB-W.

Procedure

  1. In the SMB Cluster Configuration, select the trash icon.

  1. In the SMB Configuration Reset message, select Reset.

Display the SMB shares list

The Shares tab displays the SMB shares created in the system. You can also customize the table columns of the SMB shares.

Procedure

  1. From the menu, select Manage > Protocols.

  2. From the Protocols pane, select SMB.

  3. Select the Shares tab. You can filter the list using any column in the table.

Add an SMB share

Once the SMB cluster is created, you can create SMB shares (maximum 1024). Each share must have a name and a shared path to the filesystem. It can be the root of the filesystem or a sub-directory.

Procedure

  1. In the Shares tab, select +Create.

  2. In the Add SMB Share dialog, set the following properties:

    • Name: A meaningful and valid name for the SMB share.

      The name must meet the following requirements:

      • The share name must be no more than 80 characters in length.

      • The share name must not include the following characters: backslash (\), slash (/), colon (:), and semicolon (;).

      • Control characters in the range 0x00 through 0x1F (inclusive) are prohibited.

    • Filesystem: The filesystem name that includes the directory to share. Select one from the list. A filesystem with Required Authentication set to ON cannot be used for SMB share.

    • Description: A description or purpose of the SMB share.

    • Path: A valid internal path, relative to the root, within the filesystem to expose the SMB share.

    • Encryption: Select in-transit encryption enforcement of the share. The global cluster encryption settings can affect the actual encryption.

    • Read Only: Select to set the share as read-only.

    • Hidden: Select if you want to hide the share so it is not visible when viewing the list of system shares.

    • Allow Guest Access: Select if you want guests to access without authentication.

    • Access Permissions: Define the share access permissions. If you select ON, select the access type and the users or groups allowed to access the share (comma-separated users and groups list, add '@' as a group prefix).

    • Files/Directories POSIX Mode Mask: Set the new default file and directory permissions in a numeric (octal) format created through the share.

    • ACLs Enabled: Determines whether to enable the Windows Access-Control Lists (ACLs) on the share. Weka translates the ACLs to POSIX.

  3. Select Save.

Edit an SMB share

You can update some of the SMB share settings. These include encryption, hiding the share, allowing guest access, and setting the share as read-only or not.

SMB-W does not yet support share updates.

Procedure

  1. In the Shares tab, select the three dots of the share and select Edit.

  1. In the Update Share Settings dialog, update the relevant properties and select Save.

Remove an SMB share

Procedure

  1. In the Shares tab, select the three dots of the share and select Remove.

  1. In the confirmation message that appears, select Confirm. The removed share no longer appears in the SMB Shares list.

Configure the SMB cluster
Edit the SMB cluster
Join the SMB cluster to Active Directory
Add servers to the SMB cluster
Remove servers from the SMB cluster
Delete the SMB cluster
Display the SMB shares list
Add an SMB share
Edit an SMB share
Remove an SMB share
#dedicated-filesystem-requirement-for-persistent-protocol-configurations
SMB cluster configuration tab
SMB cluster configuration
SMB cluster configuration example
Edit the SMB cluster
Edit SMB configuration
Join the SMB cluster in the Active Directory
Join Active Directory dialog
Add servers to the SMB cluster
Remove one server from the SMB cluster
Remove more than one server from the SMB cluster
Delete the SMB cluster configuration
SMB shares list
Add SMB Share dialog
Edit an SMB share
Update the SMB share settings
Remove an SMB share