ObjectiveFS Documentation

Getting Started

• Quick Start
• Installation Guide
• Useful Tips for New Users
• Mount on Boot: Linux
• Mount on Boot: macOS
• Migrating AWS S3 Data to ObjectiveFS
• Creating a Filesystem Using an Existing Bucket
• Best Practices

Performance

• Performance Optimization Guide
• Memory Optimization Guide
• Storage Layout Performance Optimization
• Amazon EFS vs ObjectiveFS - Small Files
• Amazon EFS vs ObjectiveFS - Large Files
• Latency Heatmaps
• Storage Cleaner Guide

Object Store Setup

Public Cloud

• Amazon S3
• Azure Blob Storage
• Digital Ocean Spaces
• Google Cloud Storage
• IBM Cloud Object Storage
• Oracle Cloud
• Scaleway
• Wasabi
• Other S3-compatible object stores

Gov Cloud

• Amazon S3 GovCloud
• Azure GovCloud
• Oracle GovCloud

On Premise

• Ceph
• IBM Cloud Object Storage - on prem
• MinIO
• Netapp StorageGRID
• Other S3-compatible object stores

Keys and Permissions

• How to Get Amazon S3 Keys
• How to Get Azure Keys
• How to Get Google Cloud Storage S3 Interop Keys
• How to Get IBM Keys
• How to Get Oracle Keys
• How to Get Wasabi Keys
• How to Get Digital Ocean Spaces Keys
• EC2 IAM Roles Instead of Keys
• AWS IAM Policy for Access to One S3 Bucket
• Per-user Filesystems Using Pool and IAM policy
• Passphrase from a Secrets Management Tool

Filesystem Usage

• User Guide
• Snapshots
• Access Control Lists (ACL)
• Memory map (mmap)
• File Capabilities
• File Attributes
• File Flags (macOS)
• Admin Key Usage

Disk Cache

• How to mount a local NVMe for Disk Cache
• How to RAID Instance Stores for Disk Cache
• Disk Cache Warming Guide

NFS/Samba Sharing

• NFS Export from Linux to Windows
• Samba Sharing from Linux to Windows
• NFS Export Setup: Red Hat/CentOS
• NFS Export Setup: Ubuntu
• NFS Ganesha Setup

Containers

• Kubernetes CSI Driver
• Kubernetes CSI Driver (k8s managed)
• Docker and ObjectiveFS
• Docker Volume Driver Plugin
• Kubernetes FlexVolume Driver (external)

DevOps and SysAdmin

• Filesystem Backup
• Backup From A Snapshot
• Multiple Filesystems On The Same Server
• Terraform Setup for ObjectiveFS
• Complying with Retention Schedule
• HTTPS: Using ObjectiveFS with Stunnel
• HTTPS: Using ObjectiveFS with Ghostunnel

Server Side Encryption

• SSE for AWS KMS Setup
• SSE for Amazon S3 Managed Keys Setup

General

• Upgrading to a New ObjectiveFS Version
• How to Install macFUSE
• Upgrading to a New macFUSE Version
• How to Share Files between EC2 Instances
• How to Add Swap Space
• How to Enable zswap on Linux
• Release Notes

AWS Setup

• Creating VPC on AWS
• Instance Store Setup on EC2
• Create Lifecycle Rule to Clean Up Delete Markers
• How to Enable S3 Intelligent Tiering

Troubleshooting

• High CPU Usage and mlocate
• Apache or Nginx 403 Errors for SE Linux