DOCSEARCHbyAlgolia
Submit Docs

TrueNAS Documentation Hub

repository·master·Indexed 41 days ago

https://github.com/truenas/documentation

Official documentation for TrueNAS, including source files for the documentation hub built with Hugo Extended v0.157.0 and the GeekDocs theme. Contains technical guides, middleware API access instructions, and archived release notes for FreeNAS versions 11.1 through 11.3.

Tokens
216.9K
Snippets
194
Records
1K
Agent score
51%

What's inside TrueNAS

  1. Overview of FreeNAS 11.3 Major Features

    master

    FreeNAS 11.3 introduces several significant architectural and functional improvements:

    • Replication Engine: Re-implemented to support up to 10Gb speeds, resume support for failed transfers, and local replication.
    • ACL Manager: Enables setup and management of SMB ACLs directly through the web interface.
    • SMB Shadow Copies: Enabled by default for new shares. Note that snapshots only appear in the Windows "Previous Versions" tab if the snapshot USED size shows changes to the file.
    • iSCSI Wizard: A streamlined, multi-click process for creating new iSCSI targets.
    • 2.0 API: A full-featured API providing both REST and Websocket connections, allowing for full scripting and automation equivalent to the web interface.
    • Plugin Improvements: Includes a new Community plugin repository and NAT Support for Plugins, which removes the requirement for each plugin to have a dedicated IP address.
    • ZFS & Pool Management: Includes general ZFS performance optimizations and a UI assistant for creating large pools by repeating VDEV layouts across multiple disks.
    • System Monitoring: An overhauled Alert System with granular thresholds and a live Dashboard showing network traffic and CPU/memory utilization.

  2. Overview of the TrueNAS vCenter Plugin

    master

    The TrueNAS vCenter Plugin integrates TrueNAS hardware management into the VMware vCenter Server web interface. It allows for limited TrueNAS system management directly from the vCenter interface for TrueNAS hardware that is attached to the vCenter Server.

    Compatibility Requirements

    VMware vCenter Server Versions:

    • vCenter Server 8.0
    • vCenter Server 7.0

    TrueNAS Software Versions: This plugin is designed for TrueNAS Enterprise licensed hardware. The following software versions are supported:

    • 12.0
    • 13.0
    • 22.12 (with exceptions)
    • 23.10 (with exceptions)
    • 24.04 (with exceptions)
    • 24.10 (with exceptions)
    • 25.04
    • 25.10

    Note on Exceptions: For TrueNAS versions 22.12, 23.10, 24.04, and 24.10, Fibre Channel is not supported for VMFS datastores.

  3. Overview of the TrueNAS OpenShift Operator

    master

    The TrueNAS OpenShift Operator is an official product that allows Red Hat OpenShift clusters to dynamically provision, manage, and consume storage from existing TrueNAS storage systems. It packages and manages the TrueNAS CSI driver, providing a native OpenShift deployment experience via OperatorHub.

    Core Components

    • OperatorHub: The built-in marketplace in the OpenShift console used to find and install the TrueNAS OpenShift Operator.
    • Operator Lifecycle Manager (OLM): Automatically manages the installation, security updates, and access controls for the operator.
    • Custom Resource Definitions (CRD): Introduces new object types to the cluster API. Specifically, it introduces kind: TrueNASCSI, which allows administrators to configure the entire storage setup through a single declarative object instead of managing individual pods or configuration files manually.

  4. Overview of TrueNAS System Settings

    master

    TrueNAS system management options are organized into several functional areas within the UI to manage updates, configuration, services, and hardware.

    Key management areas include:

    • Update: Manage system versioning, including downloading/installing updates, setting daily checks/staging, or applying manual update files.
    • General Settings: Access basic system details, manage web interface access, localization (UI/keyboard), download system debugs, input Enterprise licenses, or create bug tickets.
    • Advanced Settings: Configure central system settings such as the system console, logs, dataset pools, session management, custom system controls, kernel-level settings, scheduled scripting/commands, global 2FA, NTP servers, and GPU isolation.
    • Boot: Manage ZFS boot environments to restore the system to previous versions or specific points in time.
    • Services: Manage background components (e.g., data sharing services). Each service can be started, stopped, or set to start automatically.
    • Shell: Provides direct access to the Linux command-line interface (CLI) via the web UI.
    • Alert Settings: Configure Alert Services and adjust thresholds/frequency for various alert types.
    • Audit: Review auditing logs for actions performed by sessions, users, or services (such as SMB or middleware).
    • Enclosure: Provides a visual representation and hardware details for disks and physical components when attached to compatible TrueNAS hardware.

  5. Key Bug Fixes and Improvements in FreeNAS 11.2-U2

    master

    Notable fixes in this release include:

    • Security: Updated openssh-portable to 7.9.p1_1,1 and curl to 7.62.0; updated OpenSSL to 1.0.2q.
    • Storage: Fixed ACL metadata corruption on zfs send/recv; improved handling of dataset quotas/reservations containing decimals; fixed zfs property encoding.
    • Jails (iocage): Improved robustness of iocage imports for jails with _1 in names; improved error messages for missing/corrupt defaults.json; fixed iocage restart and iocage fetch sorting.
    • Networking: Improved mountd performance by relaxing TCP reassembly queue length; added IPv6 support to network.general.summary in middleware.
    • System: Fixed integer math overflow in UMA hash_alloc() that prevented ARC from growing above 512GB; improved syslog-ng monitoring with alerts.

  6. Key features in TrueNAS 12.0-BETA1

    master

    TrueNAS 12.0 (formerly FreeNAS) introduces several major improvements, including:

    • ZFS Upgrades: Major upgrade to OpenZFS 2.0, support for Async Copy on Write, and support for meta-data only vdevs (Fusion Pools).
    • Security: Native ZFS dataset encryption and API Keys for scripted control.
    • Hardware Support: Improved support for AMD Ryzen CPUs and various network cards.
    • Performance: Improvements across the software stack (CPU, Samba, ZFS).
    • Functionality: ZFS User Quota support and TrueCommand Cloud Connections support.

  7. Integrate TrueNAS with Container Orchestrators via democratic-csi

    master

    TrueNAS can serve as backing storage for container workloads (Kubernetes, Nomad, Cloud Foundry, or Mesos) using the democratic-csi driver. This driver provides a Container Storage Interface (CSI) that allows orchestrators to dynamically provision/de-provision storage, perform online resizes, and utilize ZFS features like snapshots and cloning via iSCSI, NFS, or SMB protocols.

    Recommended Version: TrueNAS 12.0-U2.1 or later.

    Integration Workflow:

    1. Prepare TrueNAS: Enable required services and configure storage protocols.
    2. Prepare Nodes: Install necessary requirements on your cluster nodes (e.g., iSCSI or NFS clients).
    3. Deploy Orchestrator: Install the democratic-csi driver into your cluster (e.g., via Helm for Kubernetes).

  8. TrueNAS 12.0-U2 Release Notes

    master

    TrueNAS 12.0-U2 (released February 9, 2021) provides bug fixes and minor features. Key updates include:

    • Driver Performance: Addressed a performance bug in Chelsio and Intel drivers for FreeBSD 12.2 (NAS-107593).
    • OpenZFS ACoW: OpenZFS Async Copy-n-Write (ACoW) remains disabled (having been disabled in 12.0-U1.1 to prevent corruption). Full ACoW functionality is expected to be reactivated in the upcoming TrueNAS 12.0-U3 release (NAS-108627).

    Enterprise Customers: The Enterprise Update train was activated for this release on February 23, 2021. Enterprise customers are encouraged to upgrade to receive performance, bug, and security enhancements and can contact iX Support for upgrade assistance.

  9. TrueNAS 12.0-U1 Bug Fixes

    master

    The 12.0-U1 release addresses numerous issues, including:

    • Replication: Fixed incorrect replication progress percentages, replication failures, and issues where replicated datasets of encrypted pools were inaccessible.
    • Cloud Sync: Fixed B2 rclone failures and S3 Sync Task part number validation.
    • Networking: Fixed mDNS visibility for macOS clients, NFS binding issues, and LAGG protocol type selection in WebUI.
    • Storage & ZFS: Fixed issues with zfs/snpashot endpoint error reporting, incorrect share names, and NFS shares being created outside zpool paths.
    • UI/UX: Fixed various WebUI issues including Firefox hanging, jumpy row background coloring, and incorrect dashboard network activity.
    • Security: Fixed 2FA for SSH + LDAP ignoring 2FA.

  10. TrueNAS 12.0-U1 Improvements

    master

    Key improvements in the 12.0-U1 release include:

    • Dataset & Storage:
      • Ability to create encrypted datasets on the receiving side of replication.
      • Option to enable/disable TRIM via the Advanced Menu.
      • Metadata (Special) Small Block Size support.
    • NFS & Networking:
      • Prompting for Kerberos keytab entries in NFS forms.
      • Renaming Initiators in iSCSI.
    • Hardware & Enclosures:
      • Improved UI layout for enclosures with more than 3 SAS expanders.
      • Better highlight colors for ES102 Enclosure UI.
    • System & Performance:
      • TrueNAS User Performance Monitoring.
      • Intel CPU microcode update.
      • Increased MAXPHYS to 1MB.
      • Python updated with debug and no optimizations.

  11. Current STIG Compliance Status for TrueNAS

    master

    TrueNAS is working towards full compliance with STIG GPOS SRG. Currently, compliance is not yet achieved for the following specific findings, which are scheduled for future releases:

    • SRG-OS-00366-GPOS-10153: Requirement for the OS to prevent installation of unverified or unsigned patches, service packs, device drivers, or OS components.
    • SRG-OS-000477-GPOS-00222: Requirement for the OS to generate audit records for all kernel module load, unload, and restart actions, as well as all program initiations.
    • SRG-OS-000278-GPOS-00108: Requirement to use cryptographic mechanisms to protect the integrity of audit tools.

  12. Key changes in TrueNAS 12.0-U5

    master

    TrueNAS 12.0-U5 (released August 3, 2021) includes the following major updates:

    • Core Components:
      • Python upgrades (addresses memory leaks and middleware crashes).
      • OpenZFS update to version 2.0.5.
      • Security updates for key components.
    • Hardware & Storage:
      • NVMe drives automatic resizing support.
      • Improved management for R-Series and Mini Enclosures.
      • M-series HA improvements.
    • WebUI:
      • Resolved dashboard CPU% bug and other general improvements.