Manage filesystems using the CLI
This page describes how to view and manage filesystems using the CLI.
Using the CLI, you can perform the following actions:
Several parameters in this topic relate to Key Management System (KMS) configuration, which supports both per-filesystem encryption keys and cluster encryption keys. For more information about how KMS integration works and setup guidance, see KMS management.
View filesystems
Command: weka fs
Use this command to view information on the filesystems in the WEKA system.
Create a filesystem
Command: weka fs create
Use the following command line to create a filesystem:
weka fs create <name> <group-name> <total-capacity> [--obs-name <obs-name>] [--ssd-capacity <ssd-capacity>] [--thin-provision-min-ssd <thin-provision-min-ssd>] [--thin-provision-max-ssd <thin-provision-max-ssd>] [--kms-key-identifier kms-key-identifier] [--kms-namespace kms-namespace] [--kms-role-id kms-role-id] [--kms-secret-id kms-secret-id] [--auth-required auth-required] [--encrypted] [--allow-no-kms] [--data-reduction]
Parameters
name*
A descriptive label for the filesystem, limited to 32 characters and excluding slash (/) or backslash (\).
group-name*
Name of the filesystem group to which the new filesystem is to be connected.
total-capacity*
Total capacity of the new filesystem. Minimum value: 1GiB.
obs-name
Object store name for tiering. Mandatory for tiered filesystems.
ssd-capacity
For tiered filesystems, this is the SSD capacity. If not specified, the filesystem is pinned to SSD.
To set a thin provisioned filesystem, the thin-provision-min-ssd attribute must be used instead.
SSD capacity is set to total capacity
thin-provision-min-ssd
For thin-provisioned filesystems, this is the minimum SSD capacity that is ensured to be always available to this filesystem. Must be set when defining a thin-provisioned filesystem. Minimum value: 1GiB.
thin-provision-max-ssd
For thin-provisioned filesystem, this is the maximum SSD capacity the filesystem can consume.
The value cannot exceed the total-capacity.
kms-key-identifier
Customize KMS key identifier for this filesystem (only for HashiCorp Vault).
kms-namespace
Customize KMS namespace for this filesystem (only for HashiCorp Vault).
kms-role-id
Customize KMS role-id for this filesystem (only for HashiCorp Vault).
kms-secret-id
Customize KMS secret-id for this filesystem (only for HashiCorp Vault).
auth-required
Require the mounting user to be authenticated for mounting this filesystem. This flag is only effective in the root organization, users in non-root organizations must be authenticated to perform a mount operation.
Format: yes or no.
See User management.
No
encrypted
Encryption of filesystem.
No
allow-no-kms
Allows the creation of an encrypted filesystem without a KMS configured, though this is considered insecure.
No
data-reduction
Enable data reduction. The filesystem must be non-tired and thin-provisioned. A license with data reduction is required.
No
When creating an encrypted filesystem a KMS must be defined.
To define an encrypted filesystem without a KMS, it is possible to use the--allow-no-kms parameter in the command. This can be useful when running POCs but should not be used in production since the security chain is compromised when a KMS is not used.
If filesystem keys exist when adding a KMS, they are automatically re-encrypted by the KMS for any future use.
Add a filesystem when thin-provisioning is used
To create a new filesystem, the SSD space for the filesystem must be free and unprovisioned. When using thin-provisioned filesystems, that might not be the case. SSD space can be occupied for the thin-provisioned portion of other filesystems. Even if those are tiered, and data can be released (to object-store) or deleted, the SSD space can still get filled when data keeps being written or promoted from the object-store.
To create a new filesystem, in this case, use the weka fs reserve CLI command. Once enough space is cleared from the SSD (either by releasing to object-store or explicitly deleting data), it is possible to create the new filesystem using the reserved space.
Edit a filesystem
Command: weka fs update
Use the following command line to edit an existing filesystem:
weka fs update <name> [--new-name new-name] [--total-capacity total-capacity] [--ssd-capacity ssd-capacity] [--thin-provision-min-ssd thin-provision-min-ssd] [--thin-provision-max-ssd thin-provision-max-ssd] [--data-reduction data-reduction] [--auth-required auth-required] [--kms-key-identifier kms-key-identifier] [--kms-namespace kms-namespace] [--kms-role-id kms-role-id] [--kms-secret-id kms-secret-id] [--use-cluster-kms-key-identifier]
Parameters
name*
Name of the filesystem to edit.
new-name
New name for the filesystem.
total-capacity
Total capacity of the edited filesystem.
ssd-capacity
SSD capacity of the edited filesystem. Minimum value: 1GiB.
thin-provision-min-ssd
For thin-provisioned filesystems, this is the minimum SSD capacity that is ensured to be always available to this filesystem. Minimum value: 1GiB.
thin-provision-max-ssd
For thin-proviosined filesystem, this is the maximum SSD capacity the filesystem can consume.
The value must not exceed the total-capacity.
data-reduction
Enable data reduction. The filesystem must be non-tired and thin-provisioned. A license with data reduction is required.
auth-required
Determines if mounting the filesystem requires being authenticated to Weka (weka user login).
Possible values: yes or no.
kms-key-identifier
Customize KMS key identifier for this filesystem (only for HashiCorp Vault).
kms-namespace
Customize KMS namespace for this filesystem (only for HashiCorp Vault).
kms-role-id
Customize KMS role-id for this filesystem (only for HashiCorp Vault).
kms-secret-id
Customize KMS secret-id for this filesystem (only for HashiCorp Vault).
use-cluster-kms-key-identifier
Enable cluster KMS configuration for this filesystem, which removes any custom KMS settings previously applied to it.
Delete a filesystem
Command: weka fs delete
Use the following command line to delete a filesystem:
weka fs delete <name> [--purge-from-obs]
Parameters
name*
Name of the filesystem to delete.
purge-from-obs
For a tiered filesystem, if set, all filesystem data is deleted from the object store bucket.
False
Using purge-from-obs removes all data from the object-store. This includes any backup data or snapshots created from this filesystem (if this filesystem has been downloaded from a snapshot of a different filesystem, it will leave the original snapshot data intact).
If any of the removed snapshots have been (or are) downloaded and used by a different filesystem, that filesystem will stop functioning correctly, data might be unavailable and errors might occur when accessing the data.
It is possible to either un-tier or migrate such a filesystem to a different object store bucket before deleting the snapshots it has downloaded.
Rewrap the filesystem encryption key
Command: weka fs kms-rewrap
Rewrap operations can be performed per filesystem, enabling each key to be re-encrypted with a new version if there are concerns about key compromise. Use the following command to run this operation:
weka fs kms-rewrap <name>
Parameters
name*
Filesystem name
Last updated