This section explains how to use the
qq object_portal_create_bridge command.Description
Create a bridge: a directory on the cluster whose files come from an S3 bucket or an Azure Blob container.
Usage
qq object_portal_create_bridge [-h] --bucket-uri BUCKET_URI --mount-path MOUNT_PATH [--key-prefix KEY_PREFIX] [--delimiter DELIMITER] [--key-vault-hostname KEY_VAULT_HOSTNAME] [--notification-queue-url NOTIFICATION_QUEUE_URL] --protocol-access
{READ_WRITE_EXPORT,READ_ONLY,FROZEN} --metadata-import {OFF,AUTO} [--allow-archived-metadata-changes | --disallow-archived-metadata-changes]
Flags
| Flag Name | Required | Description |
|---|---|---|
--bucket-uri
|
Yes | Full URI of the bucket, including the container for Azure. Examples: https://my-bucket.s3.us-west-2.amazonaws.com/ or https://myaccount.blob.core.windows.net/my-container |
--mount-path
|
Yes | Absolute path on the cluster for the bridge's directory, such as /archive. The parent directory must already exist, and creating the bridge creates the last component. |
--key-prefix
|
No | Cover only objects whose names start with this prefix, matched exactly, including case. Must end with the delimiter, as in projects/. An empty prefix is refused; omit this option to cover the whole bucket. |
--delimiter
|
No | The one character in object names that separates directories. Defaults to "/". |
--key-vault-hostname
|
No | Azure Key Vault hostname, such as my-vault.vault.azure.net, from which the cluster fetches SAS tokens for an Azure Blob container. Required for Azure. For a Frozen bridge, it must be the cluster's own key vault, which Qumulo sets up. |
--notification-queue-url
|
No | URL of an SQS queue that delivers this bucket's object-change notifications. Required for a READ_WRITE_EXPORT bridge over an AWS S3 bucket. |
--protocol-access
|
Yes | How clients can change files on the bridge; can't be changed later. READ_ONLY: read files and change their metadata only. READ_WRITE_EXPORT: change anything; needs bucket versioning. FROZEN: a Frozen bridge; clients can't write, delete or replace at its path a file that is frozen, offline or restoring, and can change its metadata and named streams only with --allow-archived-metadata-changes. Freeze and thaw jobs move files to and from the Azure Archive tier, and frozen_delete removes them. Needs a Qumulo-managed Azure cluster, the cluster's own key vault in --key-vault-hostname, and a versioned container with no objects under --key-prefix. |
--metadata-import
|
Yes | Whether files take their ownership, permissions, ACLs and timestamps from metadata a file-copy tool stored on each object. AUTO reads it from each object that carries it in a format the cluster recognizes. OFF reads no object metadata, and every file takes these from its parent directory. Can't be changed after creation. |
--allow-archived-metadata-changes
|
No | FROZEN bridges only. Let clients change the metadata of a file that is frozen, offline or restoring: its mode, owner, group, ACL, times and DOS attributes, and its named streams. Can't be changed after creation. |
--disallow-archived-metadata-changes
|
No | FROZEN bridges only. Refuse clients any change to the metadata or named streams of a file that is frozen, offline or restoring. This is the default. |