Weka

https://docs.weka.io/
Admin
Weka is a high-performance, scalable, and resilient data platform that provides a distributed file...
Tokens:391,553
Snippets:4,842
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Deployment Progress Response Example

Source: https://docs.weka.io/planning-and-installation/weka-installation-on-azure/deployment-on-azure-using-terraform.md

Example JSON response showing the progress of backend node initialization and installation.

```json
{
  "ready_for_clusterization": [],
  "progress": {
    "v41-jack-backend000001": [
      "10:02:55 UTC: Running init script",
      "10:03:17 UTC: Installing weka"
    ],
    "v41-jack-backend000002": [
      "10:02:56 UTC: Running init script",
      "10:03:18 UTC: Installing weka"
    ],
    "v41-jack-backend000003": [
      "10:02:54 UTC: Running init script",
      "10:03:16 UTC: Installing weka",
      "10:08:32 UTC: Weka installation completed",
      "10:08:34 UTC: Setting deletion protection authorization error, going to sleep for 2M"
    ],
    "v41-jack-backend000004": [
      "10:02:57 UTC: Running init script",
      "10:03:27 UTC: Installing weka",
      "10:09:07 UTC: Weka installation completed",
      "10:09:09 UTC: Setting deletion protection authorization error, going to sleep for 2M"
    ],
    "v41-jack-backend000005": [
      "10:02:55 UTC: Running init script",
      "10:03:17 UTC: Installing weka"
    ],
    "v41-jack-backend000006": [
      "10:02:54 UTC: Running init script",
      "10:03:24 UTC: Installing weka"
    ]
  },
  "errors": null
}
```

--------------------------------

### View Installation Output

Source: https://docs.weka.io/appendices/weka-csi-plugin/deployment.md

Example of the successful deployment output from the Helm installation.

```text
NAME: csi-wekafs
LAST DEPLOYED: Mon May 29 08:36:19 2023
NAMESPACE: csi-wekafs
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Thank you for installing csi-wekafs.

Your release is named csi-wekafs.
The release is installed in namespace csi-wekafs

To learn more about the release, try:

  $ helm status -n csi-wekafs csi-wekafs
  $ helm get all -n csi-wekafs csi-wekafs

Official Weka CSI Plugin documentation can be found here: https://docs.weka.io/appendix/weka-csi-plugin

Examples of how to configure a storage class and start using the driver are here:
https://github.com/weka/csi-wekafs/tree/master/examples

-------------------------------------------------- NOTICE --------------------------------------------------
| THIS VERSION INTRODUCES SUPPORT FOR ADDITIONAL VOLUME TYPES, AS WELL AS SNAPSHOT AND VOLUME CLONING CAPS |
| TO BETTER UNDERSTAND DIFFERENT TYPES OF VOLUMES AND THEIR IMPLICATIONS, REFER TO THE DOCUMENTATION ABOVE |
| ALSO, IT IS RECOMMENDED TO CAREFULLY GO OVER NEW CONFIGURATION PARAMETERS AND ITS MEANINGS, AS BEHAVIOR  |
| OF THE PLUGIN AND ITS REPORTED CAPABILITIES LARGELY DEPEND ON THE CONFIGURATION AND WEKA CLUSTER VERSION |
------------------------------------------------------------------------------------------------------------

-------------------------------------------------- WARNING -------------------------------------------------
|  SUPPORT OF LEGACY VOLUMES WITHOUT API BINDING WILL BE REMOVED IN NEXT MAJOR RELEASE OF WEKA CSI PLUGIN. |
|  NEW FEATURES RELY ON API CONNECTIVITY TO WEKA CLUSTER AND WILL NOT BE SUPPORTED ON API-UNBOUND VOLUMES. |
|  PLEASE MAKE SURE TO MIGRATE ALL EXISTING VOLUMES TO API-BASED SCHEME PRIOR TO NEXT VERSION UPGRADE.     |
------------------------------------------------------------------------------------------------------------
```

--------------------------------

### Example output for session start

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/local-weka-home-deployment/manage-remote-debugging-sessions-on-k3s.md

The expected output upon successfully starting a remote session.

```bash
Remote session started successfully
  Session ID: a1b2c3
```

--------------------------------

### Mounting on-premise installations

Source: https://docs.weka.io/weka-filesystems-and-object-stores/mounting-filesystems.md

Examples of mounting WEKA filesystems for on-premise setups using different core and network configurations.

```bash
mount -t wekafs -o num_cores=1 -o net=ib0 backend-server-0/my_fs /mnt/weka
```

```bash
mount -t wekafs -o num_cores=0 -o net=udp backend-server-0/my_fs /mnt/weka
```

--------------------------------

### Start a remote-access session

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/local-weka-home-deployment/manage-remote-debugging-sessions-on-k3s.md

Examples of starting sessions with various configurations, including standard, custom server, and custom terminal settings.

```bash
homecli remote-access start \
  --cluster-id "550e8400-e29b-41d4-a716-446655440000" \
  --cluster-name "prod-cluster" \
  --ssh-keys-path "/root/.ssh"
```

```bash
homecli remote-access start \
  --cluster-id "550e8400-e29b-41d4-a716-446655440000" \
  --cluster-name "prod-cluster" \
  --ssh-keys-path "/root/.ssh" \
  --tmate-server-host "tmate.example.com" \
  --tmate-server-port "22" \
  --tmate-server-rsa-fingerprint "SHA256:abc123..." \
  --tmate-server-ed25519-fingerprint "SHA256:def456..." \
  --tmate-server-ecdsa-fingerprint "SHA256:ghi789..."
```

```bash
homecli remote-access start \
  --cluster-id "550e8400-e29b-41d4-a716-446655440000" \
  --cluster-name "dev" \
  --ssh-keys-path "/home/user/.ssh" \
  --terminal-cols 200 \
  --terminal-lines 50 \
  --debug
```

--------------------------------

### View network configuration example

Source: https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts.md

Example output of the nmcli device show command.

```bash
eno12409: connected to eno12409
        "Mellanox MT2894"
        ethernet (mlx5_core), 50:00:E6:42:FC:27, hw, mtu 9000
        ip4 default
        inet4 10.10.35.140/25
        route4 10.10.35.128/25 metric 101
        route4 default via 10.10.35.129 metric 101
        inet6 fe80::207c:c202:d22f:d26b/64
        route6 fe80::/64 metric 1024

ens1: connected to ens1
        "Mellanox MT2910"
        ethernet (mlx5_core), 9C:63:C0:EB:7C:02, hw, mtu 9000
        inet4 10.10.50.1/24
        route4 10.10.50.0/24 metric 0
        route4 10.10.30.0/24 metric 0
        route4 10.10.37.0/25 via 10.10.50.1 metric 0
        inet6 fe80::f0d6:8ea:5be4:f4ed/64
        route6 fe80::/64 metric 1024

DNS configuration:
        servers: 10.219.59.120 10.211.188.61 10.211.188.73
        domains: example.net
        interface: eno12409
```

--------------------------------

### Start and Enable Docker

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/deploy-local-weka-home-v2.x.md

Start the Docker service and configure it to start automatically on system boot.

```bash
systemctl start docker && systemctl enable docker
```

--------------------------------

### Install Local WEKA Home Bundle

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/local-weka-home-deployment.md

Execute the LWH setup bundle as a root user.

```bash
bash wekahome-*.bundle
```

--------------------------------

### Run the WEKAmon installation script

Source: https://docs.weka.io/monitor-the-weka-cluster/external-monitoring.md

Execute the installation script to set up required directories and permissions.

```bash
cd /opt/weka-mon
./install.sh
```

--------------------------------

### Execute Installation Script

Source: https://docs.weka.io/neuralmesh-axon/neuralmesh-axon-deployment.md

Commands to make the deployment script executable and initiate the installation process.

```bash
chmod +x install_axon.sh
./install_axon.sh
```

--------------------------------

### Install Helm

Source: https://docs.weka.io/kubernetes/weka-operator-deployments/weka-operator-full-deployment-workflow.md

Use this script to download and install the Helm binary on a local server.

```bash
curl -fsSL -o get_helm.sh \
  https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 && \
  chmod 700 get_helm.sh && ./get_helm.sh
```

--------------------------------

### OIDC Configuration Output Example

Source: https://docs.weka.io/additional-protocols/s3/s3-users-and-authentication/configure-s3-oidc-authentication.md

Example output showing the OIDC configuration details.

```bash
weka s3 cluster oidc show
OIDC Configuration:
  Config URL:   https://login.microsoftonline.com/<tenant-id>/v2.0/.well-known/openid-configuration
  Claim Name:   roles
```

--------------------------------

### Automated WEKA Client Setup Script

Source: https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/google-kubernetes-engine-and-weka-over-posix-deployment.md

This script handles dependency installation, GKE metadata retrieval, disk attachment, and WEKA client mounting. It is intended to be run as a startup script on worker nodes.

```bash
curl -sS -H 'Metadata-Flavor: Google' 'http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true&alt=json' | jq '.attributes."cluster-name"' -r

(
    #!/usr/bin/env bash

    set -euo pipefail

    DEBIAN_FRONTEND=noninteractive
    ROOT_MOUNT_DIR="${ROOT_MOUNT_DIR:-/root}"
    
    export WEKA_FS="default"

    # Mount point for weka filesystem
    export WEKA_MOUNT="/mnt/gkeclient"
    
    # Its good to add 2-3 servers in case one is not available 
    export WEKA_HOSTS="10.0.0.8,10.0.0.9,10.0.0.10"
    
    # Timeout for how long the client is inaccessible before being removed from the cluster
    
    # Default is 86400 (24hrs) in a more dynamic environment it can be lower. 
    export WEKA_CLIENTTIMEOUNT="3600"
    
    # Number of cores to add to WEKA FrontEnd.
    export WEKA_FRONTENDCORES=2
    
    # First IP taken from WEKA_HOSTS list to download the client from.
    export WEKA_DOWNLOADIP=$(echo "$WEKA_HOSTS" | cut -d',' -f1)
  
  
    echo "Installing dependencies"
    apt-get update
    apt-get install -y apt-transport-https curl gnupg lsb-release jq

    echo "Installing gcloud SDK"
    snap install google-cloud-sdk --classic

    echo "Getting node metadata"
    ALL_METADATA="$(curl -sS -H 'Metadata-Flavor: Google' 'http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true&alt=json')"
    NODE_NAME="$(curl -sS http://metadata.google.internal/computeMetadata/v1/instance/name -H 'Metadata-Flavor: Google')"
    ZONE="$(curl -sS http://metadata.google.internal/computeMetadata/v1/instance/zone -H 'Metadata-Flavor: Google' | awk -F  "/" '{print $4}')"

    echo "Setting up disks"
    DISK_NAME="$NODE_NAME-wekadir"

    if ! gcloud compute disks list --filter="name:$DISK_NAME" | grep "$DISK_NAME" > /dev/null; then
        echo "Creating $DISK_NAME"
        gcloud compute disks create "$DISK_NAME" --size=$(( 1024*20 )) --zone="$ZONE"
    else
        echo "$DISK_NAME already exists"
    fi

    if ! gcloud compute instances describe "$NODE_NAME" --zone "$ZONE" --format '(disks[].source)' | grep "$DISK_NAME" > /dev/null; then
        echo "Attaching $DISK_NAME to $NODE_NAME"
        gcloud compute instances attach-disk "$NODE_NAME" --device-name=sdb --disk "$DISK_NAME" --zone "$ZONE"
    else
        echo "$DISK_NAME is already attached to $NODE_NAME"
    fi
    function create_wekaio_partition() {
        echo "--------------------------------------------"
        echo " Creating local filesystem on WekaIO volume "
        echo "--------------------------------------------"

        wekaiosw_device="/dev/sdb"
        if mount | grep -w $wekaiosw_device | grep -w /opt/weka;
        then
          echo "Weka volume is already mounted"
        else
          echo "Formatting and mounting Weka trace volume"
          mkfs.ext4 -L wekaiosw ${wekaiosw_device} || return 1
          mkdir -p /opt/weka || return 1
          mount $wekaiosw_device /opt/weka || return 1
          echo "LABEL=wekaiosw /opt/weka ext4 defaults 0 2" >>/etc/fstab
        fi
    }
    function prepare_weka_env() {
        echo "--------------- ENV ---------------"
        env
        echo "--------------- ENV ---------------"
        create_wekaio_partition || logger -s -t weka.install "Failed creating wekaio partition"
    }

    function start_weka_client() {
        prepare_weka_env
        if ! which weka;
        then
          echo "Installing agent from ${WEKA_DOWNLOADIP}"
          curl --fail --max-time 10 "http://${WEKA_DOWNLOADIP}:14000/dist/v1/install" | sh || logger -s -t weka.install "Failed installing agent from the first backend"
        else
          echo "Weka seems already installed, skipping agent install"
        fi
        mkdir -p ${WEKA_MOUNT}
        if mount | grep -w ${WEKA_MOUNT};
        then
          echo "Weka filesystem seems already mounted on endpoint, skipping mount"
        else          
          mount -t wekafs ${WEKA_HOSTS}/${WEKA_FS} ${WEKA_MOUNT} -o remove_after_secs=${WEKA_CLIENTTIMEOUNT},num_cores=${WEKA_FRONTENDCORES},net=udp || logger -s -t weka.install "Error mounting filesystem"
        fi
    }

## Update to the name of the GKE cluster
GKE_CLUSTER_NAME=my-gke-cloud-name
GKE_METADATA_CLUSTER_NAME=$(curl -sS -H 'Metadata-Flavor: Google' 'http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true&alt=json' | jq '.attributes."cluster-name"' -r)

if [ "$GKE_CLUSTER_NAME" != "GKE_METADATA_CLUSTER_NAME" ]; then
    echo "Instance does not belong to GKE cluster $GKE_CLUSTER_NAME. Skipping installation"
else
    echo "Instance belongs to GKE cluster, initializing Weka client installation"
    start_weka_client
fi

) >/root/startup.out 2>/root/startup.err
```

--------------------------------

### Helm upgrade output example

Source: https://docs.weka.io/appendices/weka-csi-plugin/deployment.md

Example output displayed after a successful Helm upgrade.

```text
Release "csi-wekafs" has been upgraded. Happy Helming!
NAME: csi-wekafs
LAST DEPLOYED: Tue June  2 15:39:01 2023
NAMESPACE: csi-wekafs
STATUS: deployed
REVISION: 10
TEST SUITE: None
NOTES:
Thank you for installing csi-wekafsplugin.

Your release is named csi-wekafs.

To learn more about the release, try:

  $ helm status csi-wekafs
  $ helm get all csi-wekafs

Official Weka CSI Plugin documentation can be found here: https://docs.weka.io/appendix/weka-csi-plugin
```

--------------------------------

### Verify WEKA Home Installation

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/local-weka-home-deployment.md

Example output showing the status of a successful Helm deployment and commands to retrieve credentials.

```text
helm status wekahome -n home-weka-io
NAME: wekahome
LAST DEPLOYED: Thu Jan  5 09:30:42 2023
NAMESPACE: home-weka-io
STATUS: deployed
REVISION: 3
TEST SUITE: None
NOTES:
Thank you for installing home-weka-io.
Your release is named homewekaio
To learn more about the release, try:

  $ helm status homewekaio -n home-weka-io
  $ helm get all homewekaio -n home-weka-io

------------------------------------------------------------------------
Weka Home Frontend:
------------------------------------------------------------------------
URL:
https://172.31.46.11
Username:
admin
To obtain password, run:
kubectl get secret -n home-weka-io weka-home-admin-credentials -o jsonpath='{.data.admin_password}' | base64 -d

------------------------------------------------------------------------
Weka Home REST API:
------------------------------------------------------------------------
URL:
https://172.31.46.11/api/

------------------------------------------------------------------------
Weka Home Statistics (Grafana):
------------------------------------------------------------------------
URL:
https://172.31.46.11/stats/
Username:
admin
To obtain password, run:
kubectl get secret -n home-weka-io weka-home-grafana-credentials  -o jsonpath='{.data.password}' | base64 -d

------------------------------------------------------------------------
Weka Home Encryption Secret Key
------------------------------------------------------------------------
To obtain secretkey, run:
kubectl get secret -n home-weka-io weka-home-encryption  -o jsonpath='{.data.encryption_secret_key}' | base64 -d

------------------------------------------------------------------------
Technical information
------------------------------------------------------------------------
Number of event store databases: 1
Easy wekahoming!
```

--------------------------------

### Client import and installation flow

Source: https://docs.weka.io/operation-guide/manage-weka-drivers.md

Commands for copying, importing, installing, and verifying drivers on a client machine.

```bash
scp <driver-package>.tar.gz user@<client>:/tmp/
```

```bash
ssh user@<client>
```

```bash
weka driver import /tmp/<driver-package>.tar.gz
```

```bash
weka driver install
```

```bash
weka driver ready
```

--------------------------------

### Migration script execution example

Source: https://docs.weka.io/appendices/weka-csi-plugin/upgrade-legacy-persistent-volumes-for-capacity-enforcement.md

Example output showing the successful migration of a persistent volume directory.

```text
$ ./migrate-legacy-csi-volumes.sh default
Weka CSI Volume migration utility. Copyright 2021 Weka
[2021-11-04 14:33:04] NOTICE     Initializing volume migration for filesystem default
[2021-11-04 14:33:04] NOTICE     Successfully mounted filesystem default
[2021-11-04 14:33:04] NOTICE     Starting Persistent Volume migration
[2021-11-04 14:33:04] INFO       Processing directory 'pvc-e5379b17-4612-4fa3-aa57-64d5b37d7f57-1025f14ca92d2e18dd92a05efadf15a4972675f0'
[2021-11-04 14:33:04] INFO       Creating quota of 1073741824 bytes for directory pvc-e5379b17-4612-4fa3-aa57-64d5b37d7f57-1025f14ca92d2e18dd92a05efadf15a4972675f0
[2021-11-04 14:33:05] INFO       Quota was successfully set for directory pvc-e5379b17-4612-4fa3-aa57-64d5b37d7f57-1025f14ca92d2e18dd92a05efadf15a4972675f0
[2021-11-04 14:33:05] NOTICE     Migration process complete!
[2021-11-04 14:33:05] NOTICE     1 directories migrated successfully
[2021-11-04 14:33:05] NOTICE     0 directories skipped
```

--------------------------------

### Installation and Verification Commands

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/deploy-local-weka-home-v2.x.md

Commands to execute the installation script and monitor the status of the deployment pods.

```bash
./wekahome-install.sh
```

```bash
kubectl get pods -n home-weka-io
```

```bash
watch kubectl get pods -n home-weka-io
```

```bash
helm status homewekaio -n home-weka-io
```

--------------------------------

### Install Firmware Package

Source: https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts/broadcom-adapter-setup-for-weka-system.md

Execute the firmware installation for a specific device identifier.

```shell
# niccli --dev 1 install BCM957508-P2100G.pkg
```

--------------------------------

### Prometheus Helm installation output

Source: https://docs.weka.io/monitor-the-weka-cluster/monitor-weka-clusters-in-kubernetes-with-prometheus-and-grafana.md

Sample output confirming the successful installation of the Prometheus Helm chart.

```bash
$ helm upgrade --install prometheus prometheus-community/prometheus --namespace prometheus --set server.persistentVolume.storageClass=storageclass-wekafs-dir-api

Release "prometheus" does not exist. Installing it now.
NAME: prometheus
LAST DEPLOYED: Mon Aug 25 15:19:18 2025
NAMESPACE: prometheus
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
The Prometheus server can be accessed via port 80 on the following DNS name from within your cluster:
prometheus-server.prometheus.svc.cluster.local
```

--------------------------------

### Install driver

Source: https://docs.weka.io/operation-guide/manage-weka-drivers.md

Builds and installs the driver for the current kernel.

```bash
weka driver install
```

--------------------------------

### Install and Verify Minikube

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/deploy-local-weka-home-v2.x.md

Commands to unpack, install, and check the status of the Minikube environment.

```bash
tar xvf <file name>
```

```bash
./minikube-offline_install.sh
```

```bash
minikube status
```

--------------------------------

### Build SELinux policy from source

Source: https://docs.weka.io/appendices/weka-csi-plugin/add-selinux-support.md

Compile and install the policy from source if pre-compiled installation fails.

```bash
$ checkmodule -M -m -o csi-wekafs.mod csi-wekafs.te
$ semodule_package -o csi-wekafs.pp -m csi-wekafs.mod
$ make -f /usr/share/selinux/devel/Makefile csi-wekafs.pp
$ semodule -i csi-wekafs.pp
```

--------------------------------

### Create a security policy example

Source: https://docs.weka.io/security/manage-cidr-based-security-policies.md

Example of creating a policy that grants clusteradmin access to specific subnets.

```bash
weka security policy create admin_network --action allow --ips 10.1.0.0/16,10.2.1.0/24 --roles clusteradmin
```

--------------------------------

### Example HugePages Calculation

Source: https://docs.weka.io/kubernetes/weka-operator-deployments/weka-operator-full-deployment-workflow.md

Step-by-step calculation example for a server with 64 cores and 244.8 TiB of storage.

```text
(250,675 / 1000 + 63 × 1.7) × 1.1 = 393.55 GiB
```

```text
393.55 × 1024 = 402,998 MiB
```

```text
402,998 / 2 = 201,499 → round up to 201,500 HugePages
```

--------------------------------

### Setup client container and drivers

Source: https://docs.weka.io/appendices/create-a-client-image.md

Prepares the client container and drivers for the image.

```bash
weka local setup container --name <client name> --no-start
weka version prepare <current version>
```

--------------------------------

### Get cluster GUID

Source: https://docs.weka.io/operation-guide/drives-sharing.md

Retrieve the cluster GUID required for drive configuration.

```bash
weka status
```

--------------------------------

### Setup Containers

Source: https://docs.weka.io/operation-guide/expanding-and-shrinking-cluster-resources/add-a-backend-server.md

Creates and joins drive, compute, and frontend containers to the existing cluster.

```bash
weka local setup container --name drives0 --resources-path <path>/drives0.json --management-ips=<management IPs of the new server> --join-ips=<management IP>

weka local setup container --name compute0 --resources-path <path>/compute0.json --management-ips=<management IPs of the new server> --join-ips=<management IP>

weka local setup container --name frontend0 --resources-path <path>/frontend0.json --management-ips=<management IPs of the new server> --join-ips=<management IP>
```

--------------------------------

### Set up the initial container

Source: https://docs.weka.io/planning-and-installation/bare-metal/manually-configure-the-weka-cluster-using-the-resource-generator.md

Run this command on each server to create the initial drives0 container using the resource file.

```bash
weka local setup container -n drives0 --resources-path <resources-path>/drives0
```

--------------------------------

### GET /planning-and-installation/bare-metal/setting-up-the-hosts.md

Source: https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts.md

Performs a natural language query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /planning-and-installation/bare-metal/setting-up-the-hosts.md

### Description
Queries the documentation dynamically by providing a natural language question. The response includes a direct answer and relevant excerpts from the documentation.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /planning-and-installation.md

Source: https://docs.weka.io/planning-and-installation

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /planning-and-installation.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Mounting AWS installations

Source: https://docs.weka.io/weka-filesystems-and-object-stores/mounting-filesystems.md

Example of mounting a WEKA filesystem on an AWS EC2 instance with multiple backends.

```bash
mount -t wekafs -o num_cores=2 backend1,backend2,backend3/my_fs /mnt/weka
```

--------------------------------

### GET /planning-and-installation/bare-metal/setting-up-the-hosts/broadcom-adapter-setup-for-weka-system.md

Source: https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts/broadcom-adapter-setup-for-weka-system.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /planning-and-installation/bare-metal/setting-up-the-hosts/broadcom-adapter-setup-for-weka-system.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts/broadcom-adapter-setup-for-weka-system.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Get data usage by user ID

Source: https://docs.weka.io/weka-filesystems-and-object-stores/data-catalog/configure-data-catalog.md

Response example for querying filesystem usage statistics grouped by user.

```json
{
  "success": true,
  "data": [
    { "uid": 1000, "username": "john.doe", "file_count": 15234, "total_size": 52428800000 },
    { "uid": 1001, "username": "jane.smith", "file_count": 8456, "total_size": 21474836480 },
    { "uid": 0, "username": "root", "file_count": 342, "total_size": 1073741824 }
  ]
}
```

--------------------------------

### Virtual Drive Addition Examples

Source: https://docs.weka.io/operation-guide/drives-sharing.md

Practical examples of adding virtual drives to specific containers with and without pool specifications.

```bash
# Add a virtual drive to container 0 in the iubig pool
weka cluster drive add 0 11111111-2222-3333-4444-555555555555 --pool iubig

# Add a virtual drive to container 1 in the default pool
weka cluster drive add 1 22222222-3333-4444-5555-666666666666
```

--------------------------------

### Get list of snapshot metadata available for a filesystem

Source: https://docs.weka.io/weka-filesystems-and-object-stores/data-catalog/configure-data-catalog.md

Response example for listing available catalog snapshots for a specific filesystem.

```json
{
  "success": true,
  "filesystem_uuid": "326933be-23fe-b497-a50f-58774d6cbe4b",
  "filesystem_name": "default",
  "latest_snapshot": { "access_point": "@GMT-2025.10.20-12.00.00", "snapshot_id": "snap-001234", "snapshot_name": "daily-backup-2025-10-20", "sequence_number": 1542 },
  "snapshots": [
    { "access_point": "@GMT-2025.10.20-12.00.00", "snapshot_name": "daily-backup-2025-10-20", "snapshot_id": "snap-001234", "sequence_number": 1542, "completion_timestamp": "2025-10-20T12:05:23Z" },
    { "access_point": "@GMT-2025.10.19-12.00.00", "snapshot_name": "daily-backup-2025-10-19", "snapshot_id": "snap-001233", "sequence_number": 1541, "completion_timestamp": "2025-10-19T12:04:56Z" },
    { "access_point": "@GMT-2025.10.18-12.00.00", "snapshot_name": "daily-backup-2025-10-18", "snapshot_id": "snap-001232", "sequence_number": 1540, "completion_timestamp": "2025-10-18T12:05:01Z" }
  ],
  "total_count": 3
}
```

--------------------------------

### Get data usage by group ID

Source: https://docs.weka.io/weka-filesystems-and-object-stores/data-catalog/configure-data-catalog.md

Response example for querying filesystem usage statistics grouped by group name.

```json
{
  "success": true,
  "data": [
    { "gid": 100, "groupname": "engineering", "file_count": 45678, "total_size": 107374182400 },
    { "gid": 101, "groupname": "research", "file_count": 23456, "total_size": 53687091200 },
    { "gid": 0, "groupname": "root", "file_count": 1024, "total_size": 5368709120 }
  ]
}
```

--------------------------------

### Disable Network Manager Cloud Setup

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/local-weka-home-deployment.md

Required step to disable nm-cloud-setup and reboot the node before proceeding with the LWH installation.

```bash
systemctl disable nm-cloud-setup.service nm-cloud-setup.timer
reboot
```

--------------------------------

### Get file distribution by extension types

Source: https://docs.weka.io/weka-filesystems-and-object-stores/data-catalog/configure-data-catalog.md

Response example for querying file count and total size grouped by file extension.

```json
{
  "success": true,
  "data": [
    { "extension": "pdf", "file_count": 12500, "total_size": 26843545600 },
    { "extension": "jpg", "file_count": 45000, "total_size": 13421772800 },
    { "extension": "log", "file_count": 8900, "total_size": 5368709120 },
    { "extension": "", "file_count": 2300, "total_size": 1073741824 }
  ]
}
```

--------------------------------

### Get changes between two point-in-time snapshots

Source: https://docs.weka.io/weka-filesystems-and-object-stores/data-catalog/configure-data-catalog.md

Request and response examples for retrieving file and directory changes between two specific snapshots.

```json
{
  "fs_uuid": "326933be-23fe-b497-a50f-58774d6cbe4b",
  "old_point_in_time": "@GMT-2025.01.01-00.00.00",
  "new_point_in_time": "@GMT-2025.02.01-00.00.00",
  "select_fields": ["size", "modify_time"],
  "change_types": ["FILE_CREATE", "FILE_MODIFY"],
  "filepath": "/data/",
  "show_changed_fields": false,
  "page_size": 1000
}
```

```json
{
  "success": true,
  "old_snapshot": "@GMT-2025.01.01-00.00.00",
  "new_snapshot": "@GMT-2025.02.01-00.00.00",
  "data": [
    { "inode": "12345", "change_type": "FILE_CREATE", "parent_inode": "100", "filepath": "/data/new", "filename": "file.txt", "size": 1024, "modify_time": "2025-02-01T10:00:00Z" },
    {
      "inode": "67890", "change_type": "FILE_MODIFY", "parent_inode": "100", "filepath": "/data/existing", "filename": "doc.txt", "size": 2048, "modify_time": "2025-02-01T12:00:00Z",
      "changed_fields": {
        "size": { "old": 1024, "new": 2048 },
        "modify_time": { "old": "2025-01-15T10:00:00Z", "new": "2025-02-01T12:00:00Z" }
      }
    }
  ],
  "summary": { "file_create": 150, "file_delete": 10, "file_modify": 25, "dir_create": 5, "dir_delete": 2, "dir_modify": 3, "symlink_create": 0, "symlink_delete": 0, "symlink_modify": 0 },
  "next_cookie": "eyJsYXN0SW5vZGUiOiIxMjM0NTY3ODkwIn0"
}
```

--------------------------------

### Query WEKA Cluster Status

Source: https://docs.weka.io/getting-started-with-weka/getting-started-with-weka-rest-api.md

Example of performing an authenticated GET request to the cluster status endpoint using a Bearer token.

```python
import requests

url = "https://weka01:14000/api/v2/cluster"

payload={}
headers = {
  'Authorization': 'Bearer REPLACE-WITH-ACCESS-TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
```

--------------------------------

### Thin provisioned filesystem capacity example

Source: https://docs.weka.io/weka-system-overview/filesystems-object-stores-and-filesystem-groups/cluster-and-filesystem-capacity-counter-definitions.md

Displays capacity counter values for a filesystem configured with thin provisioning and no data reduction.

```bash
FILESYSTEM NAME: fs_example1
THIN PROVISIONED: true
THIN PROVISIONED MINIMUM SSD: 100 TB
THIN PROVISIONED MAXIMUM SSD: 500 TB
USED SSD: 150 TB
USED SSD (DATA): 145 TB
USED SSD (META): 5 TB
FREE SSD: 350 TB
```

--------------------------------

### Install WEKA agent

Source: https://docs.weka.io/operation-guide/manage-weka-drivers.md

Installs the WEKA agent on the target VM.

```bash
curl http://<backend IP>:14000/dist/v1/install | sh
```

--------------------------------

### Start Cluster IO Services

Source: https://docs.weka.io/neuralmesh-axon/neuralmesh-axon-deployment.md

Command to start the IO services for the cluster.

```bash
weka cluster start-io
```

--------------------------------

### Mounting with core allocation

Source: https://docs.weka.io/weka-filesystems-and-object-stores/mounting-filesystems.md

Example of allocating specific cores and a network interface during the mount process.

```bash
mount -t wekafs -o core=2 -o core=4 -o net=ib0 backend-server-0/my_fs /mnt/weka
```

--------------------------------

### Verify Azure CLI Installation

Source: https://docs.weka.io/planning-and-installation/weka-installation-on-azure/detailed-deployment-tutorial-weka-on-azure-using-terraform.md

Checks the currently installed version of the Azure CLI.

```bash
az version
```

--------------------------------

### Enable Safe Shutdown During Installation

Source: https://docs.weka.io/planning-and-installation/bare-metal/manually-install-os-and-weka-on-servers/safe-server-shutdown.md

Use the WEKA_SYSTEMD_GRACEFUL_SHUTDOWN flag during the installation script execution.

```bash
curl https://<token>@get.weka.io/dist/v1/install/5.0.4/5.0.4. | WEKA_SYSTEMD_GRACEFUL_SHUTDOWN=true sh
```

--------------------------------

### GET /planning-and-installation/bare-metal/perform-post-configuration-procedures.md

Source: https://docs.weka.io/planning-and-installation/bare-metal/perform-post-configuration-procedures.md

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

```APIDOC
## GET /planning-and-installation/bare-metal/perform-post-configuration-procedures.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the current page.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation/bare-metal/perform-post-configuration-procedures.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask the documentation system.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started-with-weka/manage-the-system-using-weka-gui.md

Source: https://docs.weka.io/getting-started-with-weka/manage-the-system-using-weka-gui.md

Performs a dynamic query against the documentation page to retrieve answers, excerpts, or context related to a specific question.

```APIDOC
## GET /getting-started-with-weka/manage-the-system-using-weka-gui.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, excerpts, or context related to a specific question.

### Method
GET

### Endpoint
https://docs.weka.io/getting-started-with-weka/manage-the-system-using-weka-gui.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Install VictoriaMetrics Operator

Source: https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/deploy-local-weka-home-v4.x-on-k8s

Installs the VictoriaMetrics Operator using Helm in the victoria-metrics namespace.

```bash
helm install vmo vm/victoria-metrics-operator -n victoria-metrics \
--debug --create-namespace --version 0.39.1
```

--------------------------------

### GET /getting-started-with-weka/getting-started-with-weka-rest-api.md

Source: https://docs.weka.io/getting-started-with-weka/getting-started-with-weka-rest-api.md

Queries the documentation dynamically by providing a specific question and an optional end goal.

```APIDOC
## GET /getting-started-with-weka/getting-started-with-weka-rest-api.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.weka.io/getting-started-with-weka/getting-started-with-weka-rest-api.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Example fstab entry

Source: https://docs.weka.io/weka-filesystems-and-object-stores/mounting-filesystems.md

A concrete example of an fstab configuration line for a WEKA filesystem.

```text
backend-0,backend-1,backend-3/my_fs /mnt/weka/my_fs wekafs num_cores=1,net=eth1,x-systemd.after=weka-agent.service,x-systemd.mount-timeout=infinity,_netdev 0 0
```

--------------------------------

### Create frontend containers

Source: https://docs.weka.io/planning-and-installation/bare-metal/manually-configure-the-weka-cluster-using-the-resource-generator.md

Sets up frontend containers using the frontend0.json resource file, with options for standard or restricted client configurations.

```bash
weka local setup container --join-ips <IP addresses> \
--resources-path <resources-path>/frontend0.json
```

```bash
weka local setup container --client --auto-remove-timeout <auto-remove-timeout> \
--restricted --join-ips <IP addresses> --resources-path <resources-path>/frontend0.json
```

--------------------------------

### Attach policy to filesystems example

Source: https://docs.weka.io/weka-filesystems-and-object-stores/snapshot-policies/manage-snapshot-policies-using-the-cli.md

Example of attaching 'policy1' to filesystems 'fs1' and 'default', followed by listing the policies to verify the attachment.

```sh
$ weka fs protection snapshot-policy attach policy1 fs1 default
$ weka fs protection snapshot-policy list
SNAPSHOT POLICY ID  NAME         IS ENABLED  DESCRIPTION                     ATTACHED FILESYSTEMS
0                   sys-default  True        Cluster default configuration  
1                   policy1      False       Schedule daily snapshots        fs1, default
```

--------------------------------

### Create a Tenant Environment via CLI

Source: https://docs.weka.io/operation-guide/weka-native-multi-tenancy-management/multi-tenancy-cluster-level-administration.md

Establishes a new tenant with defined resource limits and network boundaries. The command prompts for the tenant administrator password upon execution.

```bash
weka tenant add <name> <username> [--ssd-quota ssd-quota]
                                  [--total-quota total-quota]
                                  [--enforce-fs-authentication enforce-fs-authentication]
                                  [--enforce-mount-netspace-access enforce-mount-netspace-access]
                                  [--network-spaces network-spaces]...
```

--------------------------------

### Start Docker Compose containers

Source: https://docs.weka.io/monitor-the-weka-cluster/external-monitoring.md

Commands to start the monitoring services using Docker Compose.

```bash
docker compose up -d
```

```bash
docker-compose up -d
```

--------------------------------

### GET /planning-and-installation/weka-installation-on-azure/add-clients.md

Source: https://docs.weka.io/planning-and-installation/weka-installation-on-azure/add-clients.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /planning-and-installation/weka-installation-on-azure/add-clients.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation/weka-installation-on-azure/add-clients.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Configure Default InfiniBand Partition

Source: https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts.md

Example configuration for an InfiniBand interface using the default partition.

```bash
TYPE=Infiniband
ONBOOT=yes
BOOTPROTO=static
STARTMODE=auto
USERCTL=no
NM_CONTROLLED=no
DEVICE=ib1
IPADDR=192.168.1.1
NETMASK=255.255.0.0
MTU=4092
```

--------------------------------

### Install autofs package

Source: https://docs.weka.io/weka-filesystems-and-object-stores/mounting-filesystems.md

Install the autofs package using the system's package manager.

```bash
yum install -y autofs
```

```bash
apt-get install -y autofs
```

--------------------------------

### Install jq on macOS

Source: https://docs.weka.io/planning-and-installation/weka-installation-on-azure/detailed-deployment-tutorial-weka-on-azure-using-terraform.md

Installs the jq command-line tool for JSON processing using Homebrew.

```bash
brew install jq
```

--------------------------------

### Set up the Data Services container

Source: https://docs.weka.io/operation-guide/background-tasks/set-up-a-data-services-container-for-background-tasks.md

Deploys a new Data Services container with specified network and core parameters.

```bash
weka local setup container --name <container_name> --base-port <base-port> --join-ips <management-ip> --only-dataserv-cores --allow-mix-setting
```

```bash
$ weka local setup container --name dataserv0 --base-port 14400 --join-ips 10.108.234.164  --only-dataserv-cores --allow-mix-setting
Version 4.3.2 is already downloaded.
Created Weka container named dataserv0
Preparing version 4.3.2 of container dataserv0
No net parameter specified, configuring in UDP mode
Successfully set up container dataserv0
Starting container
Waiting for container to start up
Container "dataserv0" is ready (pid = 66904)
```

--------------------------------

### GET /planning-and-installation/bare-metal/planning-a-weka-system-installation.md

Source: https://docs.weka.io/planning-and-installation/bare-metal/planning-a-weka-system-installation.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /planning-and-installation/bare-metal/planning-a-weka-system-installation.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page or to get clarification.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation/bare-metal/planning-a-weka-system-installation.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Install Grafana via Helm

Source: https://docs.weka.io/monitor-the-weka-cluster/monitor-weka-clusters-in-kubernetes-with-prometheus-and-grafana.md

Install Grafana using the Helm chart in the designated namespace.

```bash
$ helm upgrade --install grafana grafana/grafana \
--namespace grafana
```

--------------------------------

### Install upgraded Helm release

Source: https://docs.weka.io/appendices/weka-csi-plugin/deployment.md

Installs the new version of the CSI plugin via Helm.

```bash
helm install csi-wekafs --namespace csi-wekafs csi-wekafs/csi-wekafsplugin
```

--------------------------------

### GET /planning-and-installation/aws/detailed-deployment-tutorial-weka-on-aws-using-terraform.md

Source: https://docs.weka.io/planning-and-installation/aws/detailed-deployment-tutorial-weka-on-aws-using-terraform.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /planning-and-installation/aws/detailed-deployment-tutorial-weka-on-aws-using-terraform.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation/aws/detailed-deployment-tutorial-weka-on-aws-using-terraform.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /planning-and-installation/aws.md

Source: https://docs.weka.io/planning-and-installation/aws.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /planning-and-installation/aws.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.weka.io/planning-and-installation/aws.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Install WEKA client via curl

Source: https://docs.weka.io/appendices/create-a-client-image.md

Installs the WEKA client directly from the backend server.

```bash
curl http://<backendserverip>:14000/dist/v1/install | sh
```

--------------------------------

### GET /best-practice-guides/best-practices-for-weka-stateless-client-and-kubernetes.md

Source: https://docs.weka.io/best-practice-guides/best-practices-for-weka-stateless-client-and-kubernetes.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /best-practice-guides/best-practices-for-weka-stateless-client-and-kubernetes.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.weka.io/best-practice-guides/best-practices-for-weka-stateless-client-and-kubernetes.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```
Tokens:
Raw