gluster

gluster [global-options] [subcommand-options] [arguments]

Common top-level subcommands include:
gluster peer ...
gluster volume ...
gluster system ...
gluster help [subcommand]

Example:
gluster volume create my_volume replica 2 server1:/data/brick1 server2:/data/brick1 --force
gluster volume start my_volume

    Specifies the primary command to execute. Common subcommands include peer (for cluster node management), volume (for managing GlusterFS volumes), system (for system-level tasks), and vfs (for VFS operations).

[subcommand-options]
    Options specific to the chosen subcommand. These vary widely depending on the subcommand's functionality.

[arguments]
    Additional arguments required by the subcommand and its options, such as volume names, server hostnames, or brick paths.

--debug
    Enables verbose debugging output for the command execution.

--json
    Formats the command's output in JSON, useful for programmatic parsing.

--xml
    Formats the command's output in XML, also useful for programmatic parsing.

--version
    Displays the gluster command's version information.

--help
    Displays usage information for the gluster command or a specific subcommand.

The gluster command is the primary command-line interface (CLI) for managing GlusterFS deployments.
GlusterFS is a free and open-source scalable network filesystem, often used for cloud storage and big data. It aggregates disparate storage servers into a single, large parallel network filesystem.
The gluster command allows administrators to perform a wide range of tasks, including:

• Creating, starting, stopping, and deleting GlusterFS volumes.
• Managing storage server peers within a GlusterFS cluster.
• Adding or removing bricks (storage units) from volumes.
• Checking the status and health of the GlusterFS cluster and individual volumes.
• Performing maintenance operations like healing and rebalancing.

It serves as the central control point for all GlusterFS administrative operations, making it an indispensable tool for anyone managing a GlusterFS environment.

• Root Privileges: Most gluster commands require root privileges or sudo access to execute successfully, as they perform system-wide administrative tasks.
• Network Connectivity: Proper network configuration and connectivity between all GlusterFS nodes are essential for the command to function correctly and for the cluster to operate.
• Stateful Operations: Many operations modify the cluster's state. Care must be taken, especially with commands like volume delete, which are destructive.
• Output Consistency: While --json and --xml aim for consistency, the human-readable output format might vary slightly across different GlusterFS versions and subcommands.

The gluster command is designed around a subcommand model. Most operations are performed by invoking gluster followed by a specific subcommand (e.g., volume, peer, system), which then accepts its own set of options and arguments. This modular design helps organize the extensive functionality available.

For scripting and integration with other tools, the gluster command offers --json and --xml global options. These ensure a stable, machine-readable output format, making it easier to parse command results programmatically compared to the default human-readable text output.

GlusterFS was originally developed by Gluster Inc., founded in 2005. The `gluster` command-line tool has been central to managing the filesystem since its early days.
In 2011, Red Hat acquired Gluster Inc., leading to GlusterFS becoming a prominent open-source storage solution within the Red Hat ecosystem, particularly for products like Red Hat Storage.
The `gluster` command has continuously evolved with the filesystem, incorporating new features, volume types, and management capabilities, solidifying its role as the primary administrative interface for GlusterFS clusters.
Its development continues as part of the broader GlusterFS open-source project, with contributions from a global community.

mount(8), fstab(5), df(1), ls(1), firewalld(8), iptables(8)