Manage the SMB protocol

The WEKA configuration of the SMB protocol for shared Windows clients.
SMB (Server Message Block) is a network file-sharing protocol that allows remote systems to connect to shared file and print services. WEKA's implementation is based on a new stack named SMB-W in addition to the legacy open-source Samba stack. Both SMB flavors support SMB versions 2 and 3.
The WEKA implementation of SMB makes storage services available to Windows and macOS clients. WEKA provides shared access from multiple clients, including multi-protocol access to the same files from SMB, NFS, and Weka native filesystem drivers.

SMB implementation key features

Implementing the SMB feature in the WEKA system is scalable, resilient, and distributed.
  • Scalable: The WEKA system supports an SMB cluster of between 3 to 8 servers. These servers run the SMB gateway service, while the backend filesystem can be any WEKA filesystem. Therefore, it is practically unlimited in size and performance.
  • Resilient: The WEKA system implementation of SMB provides clustered access to files in a WEKA file store, enabling multiple servers to work together. Consequently, if a server fails, another can take over operations, ensuring failover support and high availability. Weka standard resiliency against failures also protects the SMB filesystems. SMB-W supports transparent failover, thus providing more resiliency than legacy SMB.
  • Distributed: A WEKA implementation is distributed over a cluster, where all servers in the cluster manage all SMB filesystems concurrently. Therefore, the performance supported by the SMB can scale with more hardware resources, and high availability is ensured. SMB-W supports SMB Multichannel and SMB Direct (as opposed to the legacy SMB).

SMB-W additional features

The SMB-W provides the following features in addition to the legacy SMB features:
  • SMB Multichannel: WEKA supports SMB clients configured with multichannel. Therefore increasing the performance in such a configuration.
  • SMB Transparent Failover: This feature enables continuous IO availability during failover.
  • SMB Direct: SMB over Remote Direct Memory Access (RDMA). To use the SMB Direct feature, make sure that the following pre-requisites are met:
    • The SMB-W servers are RDMA-enabled (both HW and OS).
    • For Windows clients, the SMB client must be configured as multichannel.
When configuring a CIFS client to work with RDMA, the mounting must be on the host IP (not the floating IP).

SMB user mapping

The WEKA system SMB supports authentication by a single Active Directory with multiple trusted domains. The POSIX users (uid) and groups (gid) mapping for the SMB access must be resolved by the Active Directory.
The WEKA system pulls users and groups information from the Active Directory automatically and supports two types of id-mapping from the Active Directory:
  • RFC2307: Where uidNumber and gidNumber must be defined in the AD user attributes.
  • rid: Creates a local mapping with the AD users and groups.
Using rid mapping can ease the configuration, where user IDs are tracked automatically. All domain user accounts, and groups are automatically available on the domain member, and no attributes need to be set for domain users and groups. On the other hand, if the rid AD range configuration changes, user mapping might change and result in wrong uids/gids resolution.

Active Directory attributes

The following are the Active Directory attributes relevant for users according to RFC2307:
AD attribute
0-4290000000; must correlate with a real group
The following are the Active Directory attributes relevant for groups of users according to RFC2307:
AD attribute
The range specified above is the default configuration for the Weka system for the AD server IDs and can be changed. This is the main AD range (if additional trusted domains are defined).
To avoid ID overlapping and collisions, set the range or ranges (for multiple domains).
When joining multiple domains, it is required to set the ID range for each of them, and the ranges cannot overlap. There is also a (configurable) default mapping range for users not part of any domain.
For more details about Active Directory properties, see the Microsoft site.

Workflow: configure SMB support

To configure the Weka SMB support, you can use either the Weka system GUI or CLI commands.
Before you begin
Verify a persistent cluster-wide configuration filesystem is set (see Set the global configuration filesystem).
  1. 1.
    Configure SMB cluster: Set the Weka system servers participating in the SMB cluster.
  2. 2.
    Join the SMB cluster in the Active Directory: Connect and define the Weka system in the Active Directory.
  3. 3.
    Create shares and folders, and set permissions. By default, the filesystem permissions are root/root/755 and initially can only be set by a WekaFS/NFS mount.
Once these steps are done, it is possible to connect as an administrator and define permissions through the Windows operating system.

Establish an SMB cluster

Each Weka cluster only supports a single SMB cluster.
Before you begin
Verify that the DNS "nameserver" of the servers participating in the SMB cluster is configured to the Active Directory server.
  1. 1.
    Select the Weka servers participating in the SMB cluster and set the domain name.
  2. 2.
    In on-premises deployments, it is possible to configure a list of public IP addresses distributed across the SMB cluster. If a server fails, the IP addresses from that server are reassigned to another server.

Round-robin DNS server configuration

To ensure load balancing between the NFS clients on the different WEKA servers serving SMB, it is recommended to configure a round-robin DNS entry that resolves to the list of floating IPs.
Set the TTL (Time to Live) for all records assigned to the NFS servers to 0 (Zero). This action ensures that the client or the DNS server does not cache the IP.
Related information

Create SMB shares

Once the SMB cluster is created, you can set SMB shares. 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.
If the share is declared without providing a sub-directory, the WekaFS root is used, and it is not required to create a root folder (it already exists). If you need to create sub-directories, you can create the sub-directory in the shell using either a WekaFS mount or an NFS mount. Adjust the permissions of the sub-directory accordingly.

Filesystem permissions and access rights

Once the SMB cluster is connected to the Active Directory, it can assign permissions and access rights of SMB cluster filesystems to specific users or user groups. This is performed according to POSIX permissions (Windows permissions are stored in the POSIX permissions system). Any change in the Windows permissions is adapted to the POSIX permissions.
The user does the initial set of POSIX permissions through the driver/NFS.
To obtain root access to the SMB shares, assign an Active Directory user with a uidNumber and gidNumber of 0.

Integration with Windows previous versions feature

Creating snapshots of the Weka filesystem and naming the access point in the @GMT_%Y.%m.%d-%H.%M.%S format exposes those to the Windows previous versions mechanism.
To view a list of available previous versions corresponding to the filesystem snapshots, right-click a file or a folder in the Weka SMB share in the Windows client, and select Properties -> Previous Versions.
Example: creating a snapshot using the CLI with the required access point syntax:
$ weka fs snapshot create fs_name snapshot_name --access-point `TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S`
Related topics