gwcli

package
v1.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2026 License: Apache-2.0 Imports: 43 Imported by: 0

Documentation

Overview

Package gwcli holds the versitygw CLI subcommands and state shared by all versitygw-based main packages (cmd/versitygw, cmd/vgwrdma, ...). Hosting binaries wire up their backend-specific flags/commands in their own main package, and delegate the identical, backend-agnostic subcommands here.

Index

Constants

This section is empty.

Variables

View Source
var (
	RootUserAccess string
	RootUserSecret string
)

RootUserAccess and RootUserSecret are the root user credentials parsed by the hosting binary's --access/--secret flags. The admin subcommand falls back to these when no admin-specific credentials are provided.

View Source
var (
	// SigDone is signaled once on SIGINT/SIGTERM to begin shutdown.
	SigDone = make(chan struct{}, 1)
	// SigHup is signaled on every SIGHUP to trigger a config reload.
	SigHup = make(chan struct{}, 1)
)
View Source
var CopyObjectThreshold int64

CopyObjectThreshold is the maximum allowed source object size in bytes for CopyObject, populated by the hosting binary's --copy-object-threshold flag.

View Source
var DisableStrictBucketNames bool

DisableStrictBucketNames allows relaxed bucket naming, populated by the hosting binary's --disable-strict-bucket-names flag.

View Source
var RunGateway func(ctx context.Context, be backend.Backend) error

RunGateway starts the S3 gateway server for the given backend. The hosting binary's main package must set this before running any command that can launch a backend (azure, plugin, s3).

View Source
var RunIAM func(ctx *cli.Context) error

RunIAM starts the standalone IAM API server for the given command context. The hosting binary's main package must set this before running the "iam" command.

Functions

func AdminCommand

func AdminCommand() *cli.Command

AdminCommand returns the "admin" subcommand, common to all versitygw binaries.

func AzureCommand

func AzureCommand() *cli.Command

AzureCommand returns the "azure" subcommand, common to all versitygw binaries.

func IAMCommand

func IAMCommand() *cli.Command

IAMCommand returns the "iam" subcommand, common to all versitygw binaries.

func PluginCommand

func PluginCommand() *cli.Command

PluginCommand returns the "plugin" subcommand, common to all versitygw binaries.

func PosixCommand

func PosixCommand() *cli.Command

PosixCommand returns the "posix" subcommand, common to all versitygw binaries.

func S3Command

func S3Command() *cli.Command

S3Command returns the "s3" subcommand, common to all versitygw binaries.

func ScoutfsCommand

func ScoutfsCommand() *cli.Command

ScoutfsCommand returns the "scoutfs" subcommand, common to all versitygw binaries.

func SetupSignalHandler

func SetupSignalHandler()

SetupSignalHandler starts a goroutine that translates SIGINT/SIGTERM into a single SigDone notification and SIGHUP into repeated SigHup notifications.

func UtilsCommand

func UtilsCommand() *cli.Command

UtilsCommand returns the "utils" subcommand, common to all versitygw binaries.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL