Skip to main content
An OCI Object Storage bucket becomes a folder tree, with one file per object, reached through OCI’s Amazon S3 Compatibility API.

Setup

The OCI VFS needs a bucket, the tenancy’s Object Storage namespace, the region and a Customer Secret Key pair.
  1. In the OCI Console, open Storage > Buckets, choose the compartment and pick Create bucket, such as mirage. Keep the Standard tier unless archive is wanted.
  2. Open the Profile menu > Tenancy and copy the Object Storage namespace, such as idsiqbdbcr4i, or run oci os ns get.
  3. Open the Profile menu > User settings > Customer secret keys and pick Generate secret key. Copy the Secret Key right away: Oracle shows it only once. Then copy the key’s Access Key from the list.
  4. Give the user’s group policies such as Allow group <group> to read buckets in compartment <compartment> and Allow group <group> to manage objects in compartment <compartment> (read objects for a read-only mount).
  5. Read the region identifier from the region selector, such as us-ashburn-1, us-phoenix-1 or eu-frankfurt-1.
  • The namespace and region build the endpoint https://<namespace>.compat.objectstorage.<region>.oci.customer-oci.com, addressed path-style.
  • A user holds at most two Customer Secret Keys.
  • A prefix such as data/ is not part of the bucket name; set key_prefix to mount it.

Connect

workspace.yaml

Layout

  • Each object key is a file path; folders are key prefixes, and the bucket holds no directory objects.
  • key_prefix (keyPrefix in TypeScript) mounts one subpath of the bucket as the root.
  • grep -r, find and du stop after 1000 files; a glob matching more, tar -c, cp -r and rm -r are refused.

Sample runs

On a write mount, redirects, cp, mv and rm change objects in the bucket. For write: conditional, see S3-compatible VFSes.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.