TrueNAS Apps: TutorialsApplication maintenance is independent from TrueNAS version release cycles.
App versions, features, options, and installation behavior at time of access might vary from documented tutorials and UI reference.
Installing MinIO Enterprise SNMD
12 minute read.
The instructions in this article apply to the TrueNAS MinIO Enterprise application installed in a Single-Node Multi-Disk (SNMD) multi-mode configuration.
For more information on MinIO multi-mode configurations see MinIO Single-Node Multi-Drive (SNMD) or Multi-Node Multi-Drive (MNMD). MinIO recommends using MNMD (distributed) for enterprise-grade performance and scalability.
This article applies to the TrueNAS MinIO application in the enterprise train. This smaller version of MinIO is tested and polished for a safe and supportable experience for TrueNAS Enterprise customers. The enterprise MinIO application is tested and verified as an immutable target for Veeam Backup and Replication.
Community members can add and use the MinIO Enterprise app or the default community version.
To add the Enterprise MinIO application to the list of available applications, go to Apps, click on Settings at the top of the Installed application screen and select Train Settings to open the Train Settings screen.
Select the enterprise train, and then click Save.
Both the stable and enterprise train versions of the MinIO app widget display on the Discover application screen.
To install the MinIO enterprise train app, first create a self-signed certificate for the MinIO app. The Certificates setting is not required for a basic configuration but is required when setting up multi-mode configurations and when using MinIO as an immutable target for Veeam Backup and Replication.
If not already assigned, set a pool for applications to use.
You can allow the app to create the storage volumes, or use the recommended method and create the required data1, data2, data3, and data4 datasets to use with the host path option. Create the datasets before beginning the app installation process. You can organize the datasets under a parent dataset for MinIO to keep the storage datasets separated from the dataset for other potential applications. For example, create the minio dataset and nest data1 under it.
You can also mount other storage volumes inside the container pod using either the ixVolume or Host Path options, but these are not required. If mounting additional storage volumes with the host path option, create the dataset(s) before using the app installation wizard.
Either use the default user and group IDs or create a new user with Create New Primary Group selected. Note the UID/GID for the new user to add in the installation wizard.
If your system has active sharing configurations (SMB, NFS, iSCSI), disable them in System > Services before adding and configuring the MinIO application. Start any sharing services after MinIO completes the installation and starts.
This basic procedure covers the required MinIO enterprise app settings. For optional settings, see Understanding MinIO Wizard Settings.
You can have multiple deployments of the same app (for example, two or more from the stable or enterprise trains, or a combination of the stable and enterprise trains).
Each deployment of the same app requires a unique name. App names can include numbers, dashes, or underscores (for example, syncthing2, syncthing-test, syncthing_1, minio2, etc.).
Use a consistent file-naming convention to avoid conflict situations where data does not or cannot synchronize because of file name conflicts. Path and file names in apps are case-sensitive. For example, a file named MyData.txt is not the same as the mydata.txt file in Syncthing.
To install the Minio Enterprise app, go to Apps, click on Discover Apps and then either scroll down to locate the enterprise train version of the Minio widget, or search for it by typing MinIO in the search field to show the app widget.
Click on the MinIO Official Enterprise widget to open the MinIO information screen.
Click Install to open the Install MinIO configuration screen.
Accept the defaults in Application Name or enter a name for your MinIO application deployment.
Accept the default in Version, which populates with the current MinIO version. TrueNAS displays update information on the Installed application screen when an update becomes available.
Scroll down to or click on Storage Configuration on the list of wizard sections.
To create the storage volume, set Type to Host Path (Path that already exists on the system) which is the recommended option for MinIO. Mount Path populates with the default /data1. Enter the path or browse to and click on the data1 dataset location to populate Host Path.
Click Add to the right of Data Directories to show the storage fields to add the other datasets representing drives in for multi-mode configurations. Click Add for each additional dataset (data2, data3, and data4). If you change the configuration of a basic installation or SNMD, you can use the data1 dataset in the configuration and add the three additional datasets.
Change the Mount Path to match each dataset path in Host Path. For example, for data2 enter /data2 in the Mount Point field.
Repeat these storage instructions to add all four storage volumes and mount points. When finsihed you should have four storage volumes and mount points configured.
Accept the default values in Resources Configuration or to customize the CPU and memory allocated to the container (pod) the Minio app uses, enter new values in the CPU and Memory (in MB) fields. Tune these limits as needed to prevent the application from overconsuming system resources and introducing performance issues.
By default, this application is limited to use no more than 2 CPU cores and 4096 megabytes available memory. The application might use considerably less system resources.
Click Install to complete the installation.
The Installed applications screen opens showing the MinIO application in the Deploying state, then changes to Running when the application is ready to use.
Click Web Portal to open the MinIO sign-in screen.
The following section provides more detailed explanations of the settings in each section of the Install MinIO configuration wizard.
Accept the default value or enter a name in Application Name field. In most cases use the default name, but if adding a second deployment of the application you must change this name.
Accept the default version number in Version. When a new version becomes available, the application shows an update badge and the Application Info widget on the Installed applications screen shows the Update button.
MinIO credentials establish the login credentials for the MinIO web portal and the MinIO administration user.
Enter existing MinIO credentials if you already have a MinIO account, or create new login credentials for the first time you log into MinIO. The Root User is the equivalent of the MinIO access key. The Root Password is the login password for that user or the MinIO secret key.
A username for the root user (MinIO access key), entered in Root User, is limited to five to 20 characters long. For example admin or admin1.
The root user password (MinIO secret key), entered in Root Password, is limited to eight to 40 random characters. For example, MySecr3tPa$$w0d4Min10.
To configure a multi-mode deployment, select Enabled. MinIO recommends using MNMD for enterprise-grade performance and scalability. See the related MinIO articles listed below for SNMD and MNMD configuration tutorials.
Select Quiet to disable startup information and not show it in the logs.
Select Anonymous to hide sensitive information and not show it in the logs.
(Optional) Click Add to the right of Additional Environment Variables to show the fields to enter the variable. The installation wizard configures all required environment variables, so only use this option to further customize your MinIO deployment. Refer to MinIO documentation for more information on environment variables they allow and use.
Multi-mode installs the app in either a MinIO Single-Node Multi-Drive (SNMD) or Multi-Node Multi-Drive (MNMD) cluster. MinIO recommends using MNMD for enterprise-grade performance and scalability.
Click Enabled under Multi Mode (SNMD or MNMD) Configuration to enable multi-mode and show the Multi Mode (SNMD or MNMD) and Add option.
Enter https://10.123.12.100{0…3}:30000/data{1…4} in the field if configuring MNMD. The last number in the final octet of the IP address number is the first number in the {0…3} string. Separate the numbers in the curly brackets with three dots. If your sequential IP addresses are not using 100 - 103, for example 10.123.123.125 through 128, then enter them as https://10.123.123.12{5…8}:30000/data{1…4}.
If the IP addresses assigned to the four systems are not sequentially numbered, assign sequentially numbered host names. For example, minio1.mycompany.com through minio4.mycompany.com. Enter https://minio{1…4}.mycompany.com:30000/data{1…4} in the Multi Mode (SNMD or MNMD) field.
Accept the default values in User and Group Configuration. If you configured TrueNAS with a new administration user for the app, enter the UID and GID in these fields.
Accept the default port numbers in API Port and Console Port (Web UI), which are the port numbers MinIO uses to communicate with the app and web portal.
Enter the system IP address in URL format followed by the port number for the API separated by a colon in Server URL. For example, https://10.123.12.123:30000.
Enter the system IP address in URL format followed by the port number for the web portal separated by a colon in Console URL. For example, https://10.123.12.123:30001.
MNMD MinIO installations require HTTPS for both Server URL and Console URL to verify the integrity of each node. Standard or SNMD MinIO installations do not require HTTPS.
Do not select Host Network.
MinIO does not require a certificate for a basic configuration and installation of MinIO Enterprise, but if installing and configuring multi-mode SNMD or MNMD, you must create a self-signed certificate.
A SNMD configuration can use the same self-signed certificate created for MNMD, but a MNMD configuration cannot use the certificate created for a SNMD configuration because that certificate only includes the IP address for one system. Create this same self-signed certificate for the MNMD cluster on each system (node) in the cluster!
MinIO storage settings include the option to add storage volumes to use inside the container (pod). To allow TrueNAS to create a storage volume, leave Type set to the default ixVolume *(Dataset created automatically by the system). This adds a storage volume for the application that can be found nested under the ix-apps dataset. To see this, create a recursive snapshot of the ix-apps dataset.
To use the data1 existing dataset, select Host Path (Path that already exists on the system) from the Type dropdown list. The Mount Path field populates with /data1 as the first storage volume for a basic installation. Enter the path or browse to select the data1 dataset and populate the Host Path field.
Click Add to the right of Data Directories to add the datasets created and representing drives in for multi-mode configurations. Click Add for each additional dataset (data2, data3, and data4). If you change the configuration of a basic installation or SNMD, you can use the data1 dataset in the configuration and add the three additional datasets.
Change the Mount Path to correspond to the dataset path entered or selected in Host Path.Additional mount points are /data2, /data3, or /data4.
When configuring MNMD, create the datasets and repeat the storage settings on each system (node) in the cluster.
Accept the default values in Resources Configuration or enter new CPU and memory values. By default, this application is limited to use no more than 2 CPU cores and 4096 Megabytes available memory. The application might use considerably less system resources.
To customize the CPU and memory allocated to the container (pod) Syncthing uses, enter new CPU values as a plain integer value followed by the suffix m (milli). The default is 4096m.
Accept the default value 8Gb allocated memory or enter a new limit in bytes. Enter a plain integer followed by the measurement suffix, for example, 129M or 123MiB.