docs/source/administration/object-management.rst

Object Management

minio

Table of Contents

• Versioning overview
• Object locking and retention overview
• MinIO Object Lifecycle Management Part I
• MinIO Object Lifecycle Management Part II

An object <objects> is binary data, such as images, audio files, spreadsheets, or even binary executable code. The term "Binary Large Object" or "blob" is sometimes associated to object storage, although blobs can be anywhere from a few bytes to several terabytes in size. Object Storage platforms like MinIO provide dedicated tools and capabilities for storing, listing, and retrieving objects using a standard S3-compatible API.

MinIO Object Storage uses buckets <buckets> to organize objects. A bucket is similar to a top-level drive, folder, or directory in a filesystem (/mnt/data or C:\), where each bucket can hold an arbitrary number of objects.

The structure of objects on the MinIO server might look similar to the following:

/ #root
/images/
   2020-01-02-MinIO-Diagram.png
   2020-01-03-MinIO-Advanced-Deployment.png
   MinIO-Logo.png
/videos/
   2020-01-04-MinIO-Interview.mp4
/articles/
   /john.doe/
      2020-01-02-MinIO-Object-Storage.md
      2020-01-02-MinIO-Object-Storage-comments.json
   /jane.doe/
      2020-01-03-MinIO-Advanced-Deployment.png
      2020-01-02-MinIO-Advanced-Deployment-comments.json
      2020-01-04-MinIO-Interview.md

With the example structure, an administrator would create the /images, /videos and /articles buckets. Client applications write objects to those buckets using the full "path" to that object, including all intermediate prefixes <prefix>.

MinIO supports multiple levels of nested directories and objects using prefixes to support even the most dynamic object storage workloads. MinIO automatically infers the intermediate prefixes, such as /articles/john.doe from the full object path using / as a delimiter. Clients and administrators should not create these prefixes manually.

Neither clients nor administrators would manually create the intermediate prefixes, as MinIO automatically infers them from the object name.

Path vs Virtual Host Bucket Access

MinIO supports both path-style <VirtualHosting.html#path-style-access> (default) or virtual-host bucket lookups <VirtualHosting.html>.

For example, consider a MinIO deployment with an assigned Fully Qualified Domain Name (FQDN) of minio.example.net:

• With path-style lookups, applications specify the full path to a bucket, such as minio.example.net/mybucket.
• With virtual-host lookups, applications specify the bucket as a subdomain, such as mybucket.minio.example.net/.

Some applications may require or expect virtual-host lookup support when performing S3 operations against MinIO. To enable virtual-host bucket lookup, you must set the MINIO_DOMAIN environment variable to a FQDN(Fully Qualified Domain Name) that resolves to the MinIO Deployment.

If you configure MINIO_DOMAIN, you must consider all subdomains of the specified FQDN as exclusively assigned for use as bucket names. Any MinIO services which conflict with those domains, such as replication targets, may exhibit unexpected or undesired behavior as a result of the collision.

For example, if setting MINIO_DOMAIN=minio.example.net, you cannot assign any subdomains of minio.example.net (in the form of *.minio.example.net) to any MinIO service or target. This includes hostnames for use with bucket <minio-bucket-replication>, batch <minio-batch-framework-replicate-job>, or site replication <minio-site-replication-overview>.

Important

For deployments with TLS enabled <minio-tls>, you must ensure your TLS certificate SANs cover all subdomains of the leftmost domain specified to MINIO_DOMAIN.

For example, the example of MINIO_DOMAIN=minio.example.net requires a TLS SAN that covers the subdomains of minio.example.net. You can set an additional TLS SAN of *.minio.example.net to appropriately cover the subdomain namespace.

TLS Wildcard rules prevent chaining to additional subdomain levels, such that a TLS certificate with a wildcard SAN of *.example.net would not cover the virtual host lookups at *.minio.example.net.

Object Organization and Planning

Administrators typically control the creation and configuration of buckets. Client applications can then use S3-compatible SDKs <minio-drivers> to create, list, retrieve, and delete objects on the MinIO deployment. Clients therefore drive the overall hierarchy of data within a given bucket or prefix, where Administrators can exercise control using policies <minio-policy> to grant or deny access to an action or resource.

windows

Unlike filenames on a Windows system, object names in MinIO cannot have a \ character. Use / as a delimiter in object names to have MinIO automatically create a folder structure using prefixes <prefix>.

MinIO has no hard thresholds <minio-server-limits> on the number of buckets, objects, or prefixes on a given deployment. The relative performance of the hardware and networking underlying the MinIO deployment may create a practical limit to the number of objects in a given prefix or bucket. Specifically, hardware using slower drives or network infrastructures tend to exhibit poor performance in buckets or prefixes with a flat hierarchy of objects. For other considerations, thresholds, or limitations to keep in mind, see minio-server-limits.

Consider the following points as general guidance for client applications workload patterns:

• Deployments with modest or budget-focused hardware should architect their workloads to target 10,000 objects per prefix as a baseline. Increase this target based on benchmarking and monitoring of real world workloads up to what the hardware can meaningfully handle.
• Deployments with high-performance or enterprise-grade hardware <deploy-minio-distributed-recommendations> can typically handle prefixes with millions of objects or more.

|SUBNET| Enterprise accounts can utilize yearly architecture reviews as part of the deployment and maintenance strategy to ensure long-term performance and success of your MinIO-dependent projects.

For a deeper discussion on the benefits of limiting prefix contents, see the article on optimizing S3 performance <optimizing-performance.html>.

Object Versioning

RELEASE.2023-08-04T17-40-21Z

MinIO supports keeping up to 10,000 "versions" of an object in a single bucket. For workloads that require keeping more than 10K versions per object, please reach out to MinIO by email at hello@min.io.

The specific client behavior on write, list, get, or delete operations on a bucket depends on the versioning state of that bucket:

Operation	Versioning Enabled	Versioning Disabled | Suspended
PUT (Write)	Create a new full version of the object as the "latest" and assign a unique version ID	Create the object with overwrite on namespace match.
GET (Read)	Retrieve the latest version of the object by default Supports retrieving retrieving any object version by version ID.	Retrieve the object
LIST (Read)	Retrieve the latest version of objects at the specified bucket or prefix Supports retrieving all objects with their associated version ID.	Retrieve all objects at the specified bucket or prefix
DELETE (Write)	Creates a 0-byte "Delete Marker" for the object as "latest" (soft delete) Supports deleting any object version by version ID (hard delete). You cannot undo hard-delete operations.	Deletes the object

See minio-bucket-versioning for more complete documentation.

Object Retention

MinIO Object Locking ("Object Retention") enforces Write-Once Read-Many (WORM) immutability to protect versioned objects <minio-bucket-versioning> from deletion. MinIO supports both duration based object retention <minio-object-locking-retention-modes> and indefinite legal hold retention <minio-object-locking-legalhold>.

Delete operations against a WORM-locked object depend on the specific operation:

• Delete operations which do not specify a version ID result in the creation of a "Delete Marker"
• Delete operations which specify the version ID of a locked object result in a WORM locking error

You can only enable object locking when first creating a bucket. Enabling bucket locking also enables versioning <minio-bucket-versioning>.

MinIO Object Locking provides key data retention compliance and meets SEC17a-4(f), FINRA 4511(C), and CFTC 1.31(c)-(d) requirements as per Cohasset Associates.

See minio-object-locking for more complete documentation.

Object Lifecycle Management

MinIO Object Lifecycle Management allows creating rules for time or date based automatic transition or expiry of objects. For object transition, MinIO automatically moves the object to a configured remote storage tier. For object expiry, MinIO automatically deletes the object.

MinIO applies lifecycle management rules on versioned and unversioned buckets <minio-bucket-versioning> using the same behavior as normal client operations. You can specify transition or lifecycle rules that handle the latest object versions, non-current object versions, or both.

MinIO lifecycle management is built for behavior and syntax compatibility with AWS S3 Lifecycle Management <object-lifecycle-mgmt.html>. MinIO uses JSON to describe lifecycle management rules. Conversion to or from XML may be required for importing rules created on S3 or similar compatible platforms.

See minio-lifecycle-management for more complete documentation.

/administration/object-management/object-versioning /administration/object-management/object-retention /administration/object-management/object-lifecycle-management /administration/object-management/data-compression