TrueNAS CORETrueNAS CORE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

MinIO Plugin

The Minio official plugin from the iXsystems catalog is a High-performance object (S3) storage suite, natively available on TrueNAS CORE.

Background S3 is an object storage protocol used by many major cloud providers, including Amazon Web Services™. You can view these files with a web browser. S3 is the de facto standard for cloud-based storage. Organizations or online application developers can use TrueNAS with the Minio plugin to manage S3 storage. This can replace or archive expensive cloud storage.

This tutorial describes how to install the Minio plugin on TrueNAS SCALE.

S3 Service Deprecation and Migration

Due to security vulnerabilities and maintainability issues, the S3 service is deprecated in TrueNAS CORE 13.0 and removed in CORE 13.1. Beginning in CORE 13.0-U6, the CORE web interface generates an alert when the deprecated service is either actively running or is enabled to start on boot.

TrueNAS Enterprise
Beginning in CORE 13.0-U6, Enterprise customers with the S3 service running or enabled are prevented from upgrading to the next major version.

Users should plan to migrate to a separately maintained MinIO plugin or otherwise move any production data away from the S3 service storage location. Migrating from the built-in S3 service to the plugin could result in an extended data migration window and potential disruption to S3 data access.

See the CORE 13.0 MinIO Plugin tutorial for detailed migration instructions.

The TrueNAS S3 service is based on version 2021-11-24T23:19:33Z and utilizes MinIO Filesystem/Gateway mode. Filesystem/Gateway mode is deprecated, beginning with MinIO version RELEASE.2022-10-24T18-35-07Z. Newer deployments of MinIO are unable to access data from the TrueNAS S3 service.

The MinIO client provides provisions for properly migrating and converting MinIO data stored in buckets. However, all configuration data must be migrated by manually recreating users, policies, buckets, and other resources on the new deployment.

For additional information please review Migrate from Gateway or Filesystem Mode on the MinIO Documentation hub.

First Steps

You can create a dataset to use for Minio Plugin storage or allow the plugin to create one for you. MinIO manages files as objects. These objects cannot mix with other dataset files.

For better performance, total pool capacity should not exceed 80%. For example, if the S3 dataset is 50TB, the total pool capacity should be at least 62.5TB (50TB plus 20% overhead).

Installing the Minio Plugin

Go to the Plugins screen. If you have not previously configured plugins on the system, follow the initial setup instructions in Plugins.

Minio Plugin Details Screen
Figure 1: Minio Plugin Details Screen

Select the Minio plugin from the iXsystems collection. Click INSTALL.

Install Minio Plugin
Figure 2: Install Minio Plugin

Enter a name for the plugin in Jail Name and adjust the networking settings as needed. You can use the default Network Address Translation (NAT), enable DHCP, or manually define IP addresses.

If migrating data from an existing S3 service deployment, ensure ports for the Minio plugin are different from the existing service.

Click Save to install. A dialog confirms when the installation completes and shows post-install notes, including the MINIO_ACCESS_KEY and MINIO_SECRET_KEY used to access the MinIO UI.

MINIO_ACCESS_KEY and MINIO_SECRET_KEY are deprecated. MinIO now utilizes MINIO_ROOT_USER and MINIO_ROOT_PASSWORD arguments and their values. When logging into the MinIO UI, enter the MINIO_ACCESS_KEY/​MINIO_ROOT_USER in Username and the MINIO_SECRET_KEY/​MINIO_ROOT_PASSWORD in Password.

Do not use these credentials to configure client applications for S3 data access. Instead, create key pairs from the MinIO UI Access Keys screen. Write down the generated key values or save them in a secure location as the Secret Key only displays one time, at creation.

You can view the post-install notes later by expanding the entry for the installed plugin in Plugins and clicking Post Install Notes.

The Plugins screen shows the installed plugin.

Minio Plugin Installed
Figure 3: Minio Plugin Installed

Click to expand the Minio plugin details and management options.

Click  STOP to stop the jail before making any changes.

Click device_hub MOUNT POINTS and follow the instructions in Setting Up Jail Storage to mount the destination dataset you created in First Steps.

Click play_arrow START to restart the plugin and then click settings MANAGE to go to the MinIO Console and log in.

MinIO Console
Figure 4: MinIO Console