Web UI Reference

On the Manage Gateway page, there is a set of tabs along the left of the screen that are used for the configuration and management of the gateway.

Tab Name Purpose
Deploy This tab is used to deploy all gateway configuration changes to the gateway.
Enable/Disable The tab will display the action that could be taken. So when a gateway is enabled, the tab will display disable and offer a disable button. Enabled gateways will receive configuration during a cluster config push and be available for network filesystem clients.
Shares To create/edit mappings for filesystem mount points to Swift containers.
Account Provide the credentials for the Swift user account which acts as the service account for the gateway. This account allows the gateway to access the cluster and will be have primary auth for the containers where the NFS and CIFS/SMB files will be stored in Swift.
CIFS To provide the CIFS settings for all CIFS shares on the gateway.
LDAP To provide the LDAP settings for the gateway.
Performance Configure different settings to optimize the gateway performance.
Network Set the outward-facing interface on the gateway which allows access to the shares.
Cache To format and designate one disk as the cache for the SwiftStack Gateway. Only one disk can be designated for use currently as only a single block device is needed for the filesystem cache.
Delete GW The button on this page allows the gateway to be deleted. This is a permanent action.
Upgrade When new version of gateway is made available, this tab is used to upgrade to the new version.

Shares

The shares tab list all currently configured shares for the gateway.

../_images/gw_new_share.png

When adding a share, the following fields are offered:

Name Description
Share Name User provided name of the share that will be presented over the network.
Protocol

The protocol that the share will use, currently the options are nfs and cifs. NFS is used for Linux / Unix and is available for Windows 2008 and later systems. Shares that are mounted via NFS shall retain UID and GID information from the source system. NFS exports follow the format: [host]:/share/[share name]

CIFS/SMB is commonly used for other Windows variants. CIFS/SMB shares are mapped to a guest user account and do not retain ownership or permission information. CIFS/SMB shares follow the format: \[host][share name]

Access Mode Select read-write (rw) or read-only (ro) access to the share.
Swift container Swift container that the share will map to. This is the base of the mount point.
Upload delay Time in minutes for the upload delay of released files. 0 is the default and the time must be between 0 and 10.
Write retain When enabled an object is retained in cache after being uploaded to the Swift cluster.
No apple doubles Filters out certain Apple specific files starting with a dot.
Clients allowed list List of IP addresses or network prefixes allowed to access the share.
Enabled Designates if the share is enabled and able to be used.
Root Squash (NFS only) Allows share to map requests from uid/gid 0 (root) to the anonymous uid/gid. You may also specify whether to squash users that are connecting as root to nobody/nogroup. The default setting allows a user to connect as root to a share giving him or her complete control over files and permissions. By setting Root Squash to yes, users will not be able switch to root and make any file ownership or permission modifications to any files other than their own.
Secure (NFS only) When enabled this requires clients to use a reserved port (< 1024).
Cifs browseable (CIFS only) Is this CIFS share browseable?
Cifs guest ok (CIFS only) Guests OK for this CIFS share?
Cifs valid users (CIFS only) Possible CIFS share user restrictions, comma delimited.
Cifs create mask (CIFS only) CIFS share create mask (default 0664).
Cifs directory mask (CIFS only) CIFS share directory mask (default 0775).

../_images/gw_nfs_share.png

../_images/gw_cifs_share.png

Account

Name Description
Swift user The Swift user that is authorized to access the cluster. A change to this value will restart the gateway upon gateway configuration push.
Swift password The password for the gateway's Swift user. A change to this value will restart the gateway upon gateway configuration push.
Auth url The auth url to the swift cluster, beginning with 'http://' or 'https://. A change to this value will restart the gateway upon gateway configuration push.

../_images/gw_auth_swift.png

CIFS

Name Description
Cifs workgroup Workgroup for CIFS shares.
Cifs case sensitive CIFS case sensitivity setting.
Ad enabled Is Active Directory support enabled?
Cifs realm (AD only) Realm for CIFS shares.
Kerberos admin server (AD only) Kerberos Admin Server.
Cifs browser announce (AD only) CIFS Browser Announce.
Cifs id mapping (AD only) CIFS Id Mapping Style id_mgmt / ldap / rid
Cifs id range min (AD only) CIFS Id Range Minimum (for certain schemas).
Cifs id range max (AD only) CIFS Id Range Maximum (for certain schemas).

../_images/gw_cifs_auth_tab.png

LDAP

Name Description
Ldap enabled Is LDAP support enabled?
Ldap server list A comma-separated list of LDAP server IP addresses.
Ldap server port LDAP server port.
Ldap version LDAP global version number.
Ldap base dn LDAP user search base dn.
Ldap bind dn LDAP Bind DN.
Ldap bind password LDAP Bind password.
Ldap scope LDAP user search scope. subtree / one-level / base
Ldap timeout Timeout for searching an LDAP server.
Ldap bind timeout Timeout for binding to an LDAP server.
Ldap referrals LDAP referrals.
Ldap group lookups LDAP group lookups.

../_images/gw_auth_ldap.png

Performance

Name Description
Chunk size Segment upload size must be less than 5120 MB (unit MB). A value of zero means don't perform chunking.
Bw limit Bandwidth limit from gateway to object store (in kbps).
Ct threads Number of Cloud Talker threads.
Optimize Optimize performance for CIFS/SMB or NFS. A change to this value will restart the gateway upon gateway configuration push.

../_images/gw_perf.png

Network

Name Description
Outward-facing interface The outward-facing interface is used for the NFS and CIFS services provided by the gateway.

../_images/gw_network.png

Cache

../_images/gw_cache_tab.png