Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PD-1603 / 25.04 / Pd 1603 create fibre channel articles #3487

Merged
merged 17 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions content/SCALE/GettingStarted/Migrate/MigratePrep.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,24 @@ keywords:
## Preparing for Migration
Read this article before you attempt to migrate your FreeBSD-based system to a Linux-based TrueNAS version.
{{< hint type="warning" title="Using USB Devices for Backups" >}}
We strongly recommend not using USB flash drives or USB-attached drives for backups as these can have issues, including with recovering backed up files.
We strongly recommend not using USB flash drives or USB-attached drives for backups as these can have issues, including with recovering backed-up files.
For more information on using USB drives and devices in general, read the [Hardware Guide]({{< relref "scalehardwareguide.md" >}}).
If you must use a USB type device, verify you can access files on the device before you migrate.
If you must use a USB-type device, verify you can access files on the device before you migrate.
{{< /hint >}}
{{< enterprise >}}
Enterprise customers are encouraged to contact Support for assistance with the process of moving from a FreeBSD-based (13.3 or earlier) to a Linux-based (22.12 or newer) TrueNAS version, especially customers with HA systems.
{{< /enterprise >}}

1. Upgrade your system to either the latest 13.0 or 13.3 release.
TrueNAS Enterprise-licensed (or community systems that haven't switched to 13.3) systems on 12.0x or earlier should upgrade to the latest 13.0 release (e.g 13.0-U6.2 or newer) prior to migration.
TrueNAS Enterprise-licensed (or community systems that haven't switched to 13.3) systems on 12.0x or earlier should upgrade to the latest 13.0 release (e.g. 13.0-U6.2 or newer) before migration.
Community users with 13.3 installed should update to the latest maintenance release of that version prior to migration.
Either major version can use the [iso upgrade](#migrating-using-an-iso-file-to-upgrade) method for migration.

2. Migrate [GELI-encrypted pools](https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/storageencryption/#geli-pool-migrations) to a non-GELI-encrypted pool before upgrading from TrueNAS 12.0x or earlier releases!
If you do not migrate from GELI to ZFS encryption before upgrading to 13.0-U6.2 (or newer) or migrating to TrueNAS 24.04, you permanently lose access to the data in the GELI encrypted pool(s).

3. Verify the root user is not locked.
Go to **Accounts > Users**, select the root user and click **Edit** to view current settings and confirm **Lock User** is not selected.
Go to **Accounts > Users**, select the root user, and click **Edit** to view current settings and confirm **Lock User** is not selected.

4. Write down, copy, or take screenshots of settings to duplicate after migrating or use in the event of a post-upgrade/migration issue.
Use the checklist below to guide you through this step:
Expand All @@ -48,7 +48,7 @@ Enterprise customers are encouraged to contact Support for assistance with the p

<input type="checkbox"> Deprecated services - Record the settings for [services deprecated in newer TrueNAS versions](#deprecated-services).

<input type="checkbox"> VMs - If you have virtual machines configured, write down or screenshot network, bootloader, and other setting information.
<input type="checkbox"> VMs - If you have virtual machines configured, write down or screenshot the network, bootloader, and other setting information.

<input type="checkbox"> Plugins or jails - Plugins and jails do not migrate. Record settings for each plugin/jail and back up the data associated with each.

Expand All @@ -66,11 +66,11 @@ Enterprise customers are encouraged to contact Support for assistance with the p

<input type="checkbox"> Credentials - Copy or write down the credentials for SSH connections and keypairs, and any configured cloud service backup providers if you do not have the credential settings saved in other files kept secured outside of TrueNAS.

<input type="checkbox"> Data protection tasks - Write down or take screenshots of replication, periodic snapshot, cloud sync, or other task settings to reconfigure these after migrating.
<input type="checkbox"> Data protection tasks - Write down or take screenshots of replication, periodic snapshots, cloud sync, or other task settings to reconfigure these after migrating.

5. Remove all SMB auxiliary parameter settings before migrating.
In TrueNAS 23.10 (Cobia) or newer, the SMB **Auxiliary Parameters** option is not available in the UI.
Attempting to migrate with these settings can result in broken SMB shares post upgrade that require CLI access to fix.
In TrueNAS 23.10 (Cobia) or newer, the SMB **Auxiliary Parameters** option is unavailable in the UI.
Attempting to migrate with these settings can result in broken SMB shares post-upgrade that require CLI access to fix.

6. Write down or take screenshots of your network configuration information.
Capture the global network settings, interfaces (LAGG, VLAN, bridge settings), static IP addresses, and aliases.
Expand All @@ -92,14 +92,19 @@ Enterprise customers are encouraged to contact Support for assistance with the p
8. Back up any critical data.

9. Download your [system configuration file](https://www.truenas.com/docs/core/coretutorials/systemconfiguration/usingconfigurationbackups/) and a [debug file](https://www.truenas.com/docs/core/uireference/system/advanced/).
After updating to the latest publicly-available release of TrueNAS 13.0 (or 13.3 for community users) and making any changes to user accounts or any other settings, download these files and keep them in a safe place and where you can access them if you need to revert with a clean install using the TrueNAS 13.0 or 13.3 <file>iso</file> file.
After updating to the latest publicly available release of TrueNAS 13.0 (or 13.3 for community users) and making any changes to user accounts or any other settings, download these files and keep them in a safe place and where you can access them if you need to revert with a clean install using the TrueNAS 13.0 or 13.3 <file>iso</file> file.

After completing the steps listed above that apply to your existing system, download the latest [TrueNAS 24.04 ISO file](https://www.truenas.com/download-tn-scale/) and save it to your computer.
See [Software Releases]({{< relref "TrueNASUpgrades/_index.md #upgrade-paths" >}}) for current recommended update paths to make sure you download and migrate to and from the correct TrueNAS versions.
{{< enterprise >}}
Enterprise customers using iSCSI with ALUA or fibre channel ports should contact Support for assistance with migrating their systems.
These features require careful configuration to avoid data corruption or loss of data.
{{< /enterprise>}}

After completing the steps listed above that apply to your existing system, download the latest [TrueNAS ISO file](https://www.truenas.com/download-tn-scale/) and save it to your computer.
See [Software Releases]({{< relref "TrueNASUpgrades/_index.md #upgrade-paths" >}}) for currently recommended update paths to make sure you download and migrate to and from the correct TrueNAS versions.
Burn the iso to a USB drive (see [**Installing on Physical Hardware**]({{< relref "InstallingSCALE.md#installing-on-physical-hardware" >}})) when upgrading a physical system.

## Deprecated Services
The built-in services listed in this section are available in 13.0, but deprecated in 22.12.3 (Bluefin) and removed in later TrueNAS releases.
The built-in services listed in this section are available in 13.0 but deprecated in 22.12.3 (Bluefin) and removed in later TrueNAS releases.
They require attention before attempting to migrate to 24.04.

Each of the sections has information that can help you determine the best steps forward to secure any critical data before attempting to migrate from 13.0 to 24.04.
Expand Down Expand Up @@ -167,4 +172,4 @@ To grant access to a specific user (and group) other than using the default admi
Note the UID and GID for this new user to enter in the application configuration screen.

After disabling the WebDAV service and clearing any existing share configurations from the **Shares > WebDAV** screen in Bluefin, install the **WebDAV** application to recreate your shares using the service settings from your notes. Use the **webdav** user and group in control, and the UID and GID (**666**) in the application.
{{< /expand >}}
{{< /expand >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: "Setting Up Fibre Channel"
description: "Provides instructions on setting up Fibre Channel on TrueNAS."
weight: 40
tags:
- fibre channel
- iSCSI
- shares
- block shares
---


{{< enterprise >}}
Fibre Channel is a TrueNAS Enterprise feature. Only TrueNAS systems licensed for Fibre Channel show iSCSI Fibre Channel screens and settings found by going to **Sharing > Block Shares (iSCSI)**.
{{< /enterprise >}}

The Fibre Channel feature is available to Enterprise-licensed High Availability (HA) and non-HA systems.
Any Enterprise system, equipped with the required fibre channel hardware can implement this feature.

This article provides instructions for VMware VCenter ESXi.
If you are using a different platform for your block share backups, use the documentation for that platform for alternative instructions for the ESXi process documented in this tutorial.
.
## Before You Begin

When setting up iSCSI fibre channel for the first time:

* (Optional) Create a zvol for each fibre channel port with a network interface associated with it.

The wizard provides an option to create a dataset on the **Extents** screen when adding the device.
Selecting this option creates a dataset for organizational purposes and a zvol of the same name for block storage.

## Configuring Fibre Channel - First-Time Install

We recommend using the iSCSI wizard to create your target, create the extents, and set up fibre channel ports.

If the system is a High Availability (HA) system, turn on ALUA.

Click on the iSCSI widget header to open the **Sharing iSCSI** screens. Click on **Global Target Configuration**. Scroll down and select **Asynchronous Logic Unit Access (ALUA)**, then click **Save**.

{{< trueimage src="/images/SCALE/Shares/GlobalTargetConfigurationScreeninHA.png" alt="iSCSI Global Target Configuration Screenl" id="iSCSI Global Target Configuration Screen" >}}

Next and for all systems, go to **Shares** and click **Wizard** on the iSCSI widget to open the wizard.

1. Select **Fibre Channel** as the target mode, then select **Create New** in **Target**. Click **Next** to show the **Extents** screen.

{{< trueimage src="/images/SCALE/Shares/iSCSIWizardTargetScreenFC.png" alt="iSCSI Wizard Target Screen - Fibre Channel" id="iSCSI Wizard Target Screen - Fibre Channel" >}}

2. Configure the extent.

a. Enter a name for the target in **Name**.

b. Select **Device** in **Extent Type**, then select **Create New** on the **Device** dropdown list.
When selecting **Create New**, the **Pool/Dataset** and **/mnt** fields display.
Navigate through the pool and datasets to select the zvol and populate the **/mnt** field with the path.

{{< trueimage src="/images/SCALE/Shares/iSCSIWizardExtentScreenFCAddNew.png" alt="iSCSI Extents Screen - Fibre Channel" id="iSCSI Extents Screen - Fibre Channel" >}}

Clicking **Create Dataset** allows you to add a dataset where the **/mnt** path indicates. TrueNAS creates the dataset for organizational purposes and a zvol of the same name for block storage.

c. Enter a value in **Size**.

d. Select the platform option that matches your use case and for this iSCSI share on the **Sharing Platform** dropdown list.
For example, if using the VMware ESXi platform for your block storage, select **VMware: Extent block size 512b, TCP enabled, no Xen compat mode, SSD speed**.

e. Click **Next** to show the **Protocol Options** screen.

3. Select the protocol option for your use case.
When installing iSCSI fibre channel ports the first time, select **Create new virtual port**.

{{< trueimage src="/images/SCALE/Shares/iSCSIWizardProtocolOptionsScreenCreateNewVirtualPort.png" alt="iSCSI Wizard Protocol Options Create New Virtual Port" id="iSCSI Wizard Protocol Options Create New Virtual Port" >}}

4. Click **Save**.

5. Start the iSCSI service when prompted.
If you did not stop the iSCSI service, restart it by clicking the <span class="material-icons">more_vert</span> button, stop the service, and when the status indicates it is stopped, start it.

6. Log into your block storage backup platform (i.e., VCenter ESXi) and configure your adaptors, devices, and datastores.
Refer to VMWare or documentation for the platform used for instructions on completing the configuration.
Loading