README
¶
Current status
Starting with V1.0, Cloud Storage FUSE is Generally Available and supported by Google, provided that it is used within its documented supported applications, platforms, and limits. Support requests, feature requests, and general questions should be submitted as a support request via Google Cloud support channels or via GitHub here.
Cloud Storage FUSE is open source software, released under the Apache license.
ABOUT
What is Cloud Storage FUSE?
Cloud Storage FUSE is an open source FUSE adapter that lets you mount and access Cloud Storage buckets as local file systems. For a technical overview of Cloud Storage FUSE, see https://cloud.google.com/storage/docs/gcs-fuse.
Cloud Storage FUSE for machine learning
To learn about the benefits of using Cloud Storage FUSE for machine learning projects, see https://cloud.google.com/storage/docs/gcsfuse-integrations#machine-learning.
Limitations and key differences from POSIX file systems
To learn about limitations and differences between Cloud Storage FUSE and POSIX file systems, see https://cloud.google.com/storage/docs/gcs-fuse#differences-and-limitations.
Pricing for Cloud Storage FUSE
For information about pricing for Cloud Storage FUSE, see https://cloud.google.com/storage/docs/gcs-fuse#charges.
CSI Driver
Using the Cloud Storage FUSE CSI driver, users get the declarative nature of Kubernetes with all infrastructure fully managed by GKE in combination with Cloud Storage. This CSI driver relies on Cloud Storage FUSE to mount Cloud storage buckets as file systems on the GKE nodes, with the Cloud Storage FUSE deployment and management fully handled by GKE, providing a turn-key experience.
Support
Supported frameworks and operating systems
To find out which frameworks and operating systems are supported by Cloud Storage FUSE, see https://cloud.google.com/storage/docs/gcs-fuse#supported-frameworks-os.
Getting support
You can get support, submit general questions, and request new features by filing issues in GitHub. You can also get support by using one of Google Cloud's official support channels.
See Troubleshooting for common issue handling.
Documentation
¶
Overview ¶
A fuse file system for Google Cloud Storage buckets.
Usage:
gcsfuse [flags] bucket mount_point
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
benchmarks
|
|
|
read_full_file
Write out a file of a certain size, close it, then measure the performance of doing the following:
|
Write out a file of a certain size, close it, then measure the performance of doing the following: |
|
stat_files
Create and open a bunch of files, then measure the performance of repeatedly statting them.
|
Create and open a bunch of files, then measure the performance of repeatedly statting them. |
|
write_locally
Create a file, truncate it up to a particular size, then measure the throughput of repeatedly overwriting its contents without closing it each time.
|
Create a file, truncate it up to a particular size, then measure the throughput of repeatedly overwriting its contents without closing it each time. |
|
write_to_gcs
Create a file, write a bunch of data into it, then close it.
|
Create a file, write a bunch of data into it, then close it. |
|
internal
|
|
|
canned
Helper code for creating buckets with canned contents, for testing.
|
Helper code for creating buckets with canned contents, for testing. |
|
contentcache
Package contentcache stores GCS object contents locally.
|
Package contentcache stores GCS object contents locally. |
|
locker
Provides the Locker implementations with optional debug utils.
|
Provides the Locker implementations with optional debug utils. |
|
monitor/tags
Package tags provides the tags to annotate the monitoring metrics.
|
Package tags provides the tags to annotate the monitoring metrics. |
|
perms
System permissions-related code.
|
System permissions-related code. |
|
tools
|
|
|
build_gcsfuse
A tool that builds gcsfuse binaries, assembles helper scripts, etc., and writes them out to a destination directory with the correct hierarchy.
|
A tool that builds gcsfuse binaries, assembles helper scripts, etc., and writes them out to a destination directory with the correct hierarchy. |
|
integration_tests/util/operations
Provide a helper for directory operations.
|
Provide a helper for directory operations. |
|
integration_tests/util/test_setup
Package test_setup implements Setup and Teardown methods to be used in tests.
|
Package test_setup implements Setup and Teardown methods to be used in tests. |
|
mount_gcsfuse
A helper that allows using gcsfuse with mount(8).
|
A helper that allows using gcsfuse with mount(8). |
|
package_gcsfuse
Perform a hermetic build of gcsfuse at a particular git tag specifying the version name, producing .deb and .rpm files for Linux.
|
Perform a hermetic build of gcsfuse at a particular git tag specifying the version name, producing .deb and .rpm files for Linux. |
|
prefetch_cache_gcsfuse
Prefetches files into local disk cache from specified bucket
|
Prefetches files into local disk cache from specified bucket |