Skip to content

Commit

Permalink
Merge pull request #2957 from truenas/PD-1357_13.3.0_relnotes
Browse files Browse the repository at this point in the history
PD-1357: 13.3-RELEASE docs updates and changelog (13.3 branch)
  • Loading branch information
ericbsd authored Aug 13, 2024
2 parents 4c7e4af + 90ca1f4 commit 740046a
Show file tree
Hide file tree
Showing 21 changed files with 127 additions and 105 deletions.
2 changes: 2 additions & 0 deletions content/CORETutorials/Getting Support.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ You are always welcome to network with other TrueNAS users using the various soc
* [LinkedIn](https://www.linkedin.com/groups/3903140/)
* [Facebook](https://www.facebook.com/truenascommunity)

<!-- Comment out Enterprise support as not used in 13.3-RELEASE
## TrueNAS Enterprise
{{< enterprise >}}
Expand Down Expand Up @@ -114,3 +115,4 @@ Use the same email address submitted with the ticket when registering.
## Contacting iXsystems Support
{{< include file="/static/includes/iXsystemsSupportContact.md" >}}
-->
4 changes: 3 additions & 1 deletion content/CORETutorials/Network/Interfaces/SettingStaticIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,11 @@ This contains creation and configuration options for physical and virtual networ

You can configure static IP addresses while creating or editing an interface.

<!-- Enterprise specific comment that doesn't apply in 13.3-RELEASE
{{< hint type=tip >}}
To edit an active interface on TrueNAS Enterprise systems, you must first disable [High Availability]({{< relref "/UIReference/System/Failover.md" >}}).
To edit an active interface on TrueNAS Enterprise systems, you must first disable High Availability relref "/UIReference/System/Failover.md" .
{{< /hint >}}
-->

{{< trueimage src="/images/CORE/Network/NetworkInterfacesEdit.png" alt="Editing an Interface" id="Editing an Interface" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Describes how to set up Fibre Channel on TrueNAS CORE."
weight: 20
tags:
- iscsi
draft: true
---

{{< hint type=note >}}
Expand Down
11 changes: 6 additions & 5 deletions content/CORETutorials/Storage/Pools/StorageEncryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Data-at-rest encryption is available with:

The local TrueNAS system manages keys for data-at-rest.
The user is responsible for storing and securing their keys.
The [Key Management Interface Protocol (KMIP)](https://docs.oasis-open.org/kmip/spec/v1.1/os/kmip-spec-v1.1-os.html) is included in TrueNAS 12.0.
<!-- The [Key Management Interface Protocol KMIPhttps://docs.oasis-open.org/kmip/spec/v1.1/os/kmip-spec-v1.1-os.html is included in TrueNAS 12.0.-->

{{< expand "Encryption Drawbacks and Considerations" "v" >}}
Always consider the following drawbacks/considerations when encrypting data:
Expand Down Expand Up @@ -171,9 +171,9 @@ Set the rest of the options:

## Unlocking a Replicated Encrypted Dataset or Zvol Without a Passphrase

TrueNAS Enterprise users can connect a Key Management Interoperability Protocol ([KMIP]({{< relref "/UIReference/System/KMIP.md" >}})) server to centralize keys when they are not using passphrases to unlock a dataset or zvol.
<!-- TrueNAS Enterprise users can connect a Key Management Interoperability Protocol KMIPrelref "/UIReference/System/KMIP.md" server to centralize keys when they are not using passphrases to unlock a dataset or zvol.-->

Users with TrueNAS CORE or Enterprise installations without [KMIP]({{< relref "/UIReference/System/KMIP.md" >}}) should either replicate the dataset or zvol without properties to disable encryption at the remote end or construct a special json manifest to unlock each child dataset/zvol with a unique key.
Users with TrueNAS CORE or Enterprise installations without KMIP should either replicate the dataset or zvol without properties to disable encryption at the remote end or construct a special json manifest to unlock each child dataset/zvol with a unique key.

### Unlocking Methods
{{< expand "Method 1: Construct JSON Manifest" >}}
Expand All @@ -193,10 +193,11 @@ To not encrypt the dataset on the remote side so it does not require a key to un
4. Click **SUBMIT**.
{{< /expand >}}

<!-- Comment out Enterprise content not applicable in 13.3-RELEASE
{{< hint type=tip >}}
This does not affect TrueNAS Enterprise installs with [KMIP]({{< relref "/UIReference/System/KMIP.md" >}}).
This does not affect TrueNAS Enterprise installs with KMIPrelref "/UIReference/System/KMIP.md".
{{< /hint >}}

-->
## Legacy GELI Encryption

TrueNAS no longer supports GELI encryption (deprecated).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 150
tags:
- HA
- failover
draft: true
---

{{< enterprise >}}
Expand Down
3 changes: 1 addition & 2 deletions content/CORETutorials/SystemConfiguration/ConfiguringKMIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ weight: 170
tags:
- kmip
- enterprise
draft: true
---

{{< enterprise >}}
KMIP is only available for TrueNAS Enterprise licensed systems.
Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about purchasing TrueNAS Enterprise licenses.
{{< /enterprise >}}



The [Key Management Interoperability Protocol (KMIP)](https://docs.oasis-open.org/kmip/spec/v1.1/os/kmip-spec-v1.1-os.html) is an extensible client/server communication protocol for storing and maintaining keys, certificates, and secret objects.
KMIP on TrueNAS Enterprise integrates the system within an existing centralized key management infrastructure and uses a single trusted source for creating, using, and destroying SED passwords and ZFS encryption keys.

Expand Down
2 changes: 2 additions & 0 deletions content/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ geekdocCollapseSection: true
weight: 20
tags:
- enterprise
draft:
- true
---

{{< enterprise >}}
Expand Down
39 changes: 18 additions & 21 deletions content/CORETutorials/UpdatingTrueNAS/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ related: false
tags:
- configbackup
- update
aliases:
- /coretutorials/updatingtruenas/updatingenterprise/
---

TrueNAS CORE has an integrated update system to make it easy to keep up to date.

{{< enterprise >}}
TrueNAS CORE Enterprise High Availability (HA) customers should see [Updating CORE Enterprise]({{< relref "/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md" >}}) for additional considerations.
TrueNAS 13.3 is not available for Enterprise deployments.
Instead, 13.0 support continues with security and major bug fix releases.
See the [official announcement](https://forums.truenas.com/t/truenas-core-13-3-release-in-august/10344) for details and [software status page](https://www.truenas.com/software-status/) for up to date deployment recommendations.
{{< /enterprise >}}

## Prepare the System
Expand All @@ -23,7 +27,7 @@ Plan updates around scheduled maintenance times to avoid disrupting user activit

The update process does not proceed unless there is enough free space in the boot pool for the new update files.
If a space warning displays, go to **System > Boot** to remove unneeded boot environments.

<!-- Comment out automatic update content for 13.3 Community release.
{{< expand "Updates and Trains" "v" >}}
TrueNAS uses cryptographically signed update files to update.
Update files provide flexibility in deciding when to upgrade the system.
Expand Down Expand Up @@ -70,7 +74,7 @@ To go back to an earlier version after testing or running a more recent version,
Information about the update displays with a link to the release notes.
Always read the release notes before updating to determine if any of the changes in that release impact system use.

-->
### Save the Configuration File

A dialog to save the system configuration file appears before installing updates.
Expand All @@ -85,6 +89,14 @@ The security information in the configuration file can grant unauthorized access
## Update the System

Ensure the system is in a low-usage state as described above in [Preparing for Updates](#prepare-the-system).

Each update creates a boot environment.
If the update process needs more space, it attempts to remove old boot environments.
TrueNAS does not remove boot environments marked with the *Keep* attribute as shown in **System > Boot**.
The upgrade fails if your system does not have space for a new boot environment.
Space on the operating system device can be manually freed by going to **System > Boot** and removing the *Keep* attribute or deleting any boot environments that are no longer needed.

<!-- Commented out automatic update content as inapplicable to 13.3
Click **DOWNLOAD UPDATES** to download and install an update.
The **Save Configuration** dialog appears so you can save the current configuration to external media.
Expand All @@ -96,14 +108,6 @@ The update can be downloaded for a later manual installation by unsetting **Appl
**APPLY PENDING UPDATE** displays when an update is downloaded and ready to install.
Setting **Confirm** and clicking **CONTINUE** updates and reboots the system.
{{< hint type=important >}}
Each update creates a boot environment.
If the update process needs more space, it attempts to remove old boot environments.
TrueNAS does not remove boot environments marked with the *Keep* attribute as shown in **System > Boot**.
The upgrade fails if your system does not have space for a new boot environment.
Space on the operating system device can be manually freed by going to **System > Boot** and removing the *Keep* attribute or deleting any boot environments that are no longer needed.
{{< /hint >}}

{{< expand "Can I force a full update?" "v" >}}
TrueNAS defaults to delta packages for updates.
While updating, TrueNAS only downloads files that changed in the base operating system since the previous update.
Expand All @@ -121,16 +125,13 @@ To force a full update, open the shell and enter this command:
The updater downloads the full package containing all the files from the latest software release.
When the download completes, the system reboots with the standard configuration.
{{< /expand >}}
-->

### Manual Updates

You can manually download and apply updates in **System > Update**.

{{< hint type=note >}}
You cannot use manual updates to upgrade from older major versions.
{{< /hint >}}

Go to https://download.freenas.org/ and find an update file of the desired version.
Go to https://www.truenas.com/download-truenas-core/ to find the latest 13.3 manual update file.
Manual update file names end with <file>manual-update.tar</file>.

Download the desired update file to your local system.
Expand All @@ -142,22 +143,18 @@ You can save a copy of the current configuration to external media for backup in

After the dialog closes, the manual update screen displays.

The current version of TrueNAS displays for verification.
The current TrueNAS version displays for verification.

![Update Manual](/images/CORE/System/UpdateManual.png "Manual Update")

Select the manual update file saved to your local system using **Browse**.
Set **Reboot After Update** to reboot the system after the update installs.
Click **APPLY UPDATE** to begin the update.

{{< hint type=important >}}
**Update in Progress**

Starting an update shows a progress dialog.
When an update is in progress, the web interface shows an animated <i class="material-icons" aria-hidden="true" title="System Update">system_update_alt</i> icon in the top row.
Dialogs also appear in every active web interface session to warn that a system update is in progress.
**Do not** interrupt a system update.
{{< /hint >}}

## Upgrade Via ISO

Expand Down
65 changes: 40 additions & 25 deletions content/GettingStarted/COREReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,26 @@ title: 13.3 Version Notes
description: "Highlights and change log for each TrueNAS CORE 13.3 release."
weight: 3
related: false
aliases:
- /coretutorials/systemconfiguration/configuringfailover/
- /coretutorials/systemconfiguration/configuringkmip/
- /coretutorials/sharing/iscsi/settingupfibrechannel/
- /uireference/system/failover/
- /uireference/system/viewenclosure/
- /uireference/system/kmip/
- /uireference/sharing/iscsi/fibrechannel/
---

{{< header logo="/images/truenas-core-logo.png" logo_alt="TrueNAS CORE Logo" version="13.3" icon="" icon_alt="" >}}

{{< hint type="tip" title="13.3 Early Release Documentation">}}
This page tracks the latest development roadmap and release notes for the upcoming TrueNAS CORE major version, 13.3.
The latest [TrueNAS CORE **13.0** version release notes](https://www.truenas.com/docs/core/13.0/gettingstarted/corereleasenotes/) are available from the TrueNAS CORE 13.0 documentation section.
{{< /hint >}}

{{< include file="/static/includes/13.3Overview.md" >}}

## Obtaining a Release

{{< include file="/static/includes/EarlyReleaseWarning.md" >}}

To download a <file>.tar</file> file for installing or upgrading to a CORE 13.3 nightly version, go to https://www.truenas.com/download-truenas-core/ and click **Download Future Previews**.
Select the latest <file>.tar</file> file and click **Download**.

Log in to the web interface and go to **System > Update**.
Click **INSTALL MANUAL UPDATE FILE**.
Select **SAVE CONFIGURATION** when prompted.
Select an **Update File Temporary Storage Location** then click **Chose File** and browse to select the <file>.tar</file> file.
Click **APPLY UPDATE**.

More details are available from [Updating Core]({{< relref "/CORETutorials/UpdatingTrueNAS/_index.md" >}}).

## Release Schedule

{{< include file="/static/includes/ReleaseScheduleWarning.md" >}}

{{< releaselist name=core-releases defaultTab=3 >}}

{{< expand "Software Lifecycle" "v" >}}
{{< include file="/static/includes/LifecycleTable.md" >}}
{{< include file="/static/includes/SoftwareStatusPage.md" >}}
{{< /expand >}}

## Upgrade Notes

* Due to security vulnerabilities and maintainability issues, the S3 service is deprecated in TrueNAS CORE 13.0 and removed in CORE 13.3 ([NAS-127694](https://ixsystems.atlassian.net/browse/NAS-127694)).
Expand All @@ -55,6 +38,13 @@ More details are available from [Updating Core]({{< relref "/CORETutorials/Updat
[TrueNAS Enterprise customers](https://www.truenas.com/truenas-enterprise/) can contact iXsystems to schedule a TrueNAS SCALE deployment.
See [CORE to SCALE Migrations](https://www.truenas.com/docs/scale/gettingstarted/migrate/) for more information.

## Obtaining a Release

13.3 releases are only available as manual update <file>.tar</file> or full installation <file>.iso</file> files.
Go to https://www.truenas.com/download-truenas-core/ to download either file type.

See [Updating TrueNAS]({{< relref "/CORETutorials/UpdatingTrueNAS/_index.md" >}}) for instructions about updating with either file type.

### Upgrade Paths

{{< include file="/static/includes/COREUpgradePaths.md" >}}
Expand Down Expand Up @@ -86,8 +76,31 @@ The items listed here represent new feature flags implemented since the previous

For more details on feature flags see [OpenZFS Feature Flags](https://openzfs.github.io/openzfs-docs/Basic%20Concepts/Feature%20Flags.html) and [OpenZFS zpool-feature.7](https://openzfs.github.io/openzfs-docs/man/7/zpool-features.7.html).

## 13.3-RELEASE Changelog

**August 13, 2024**

iXsystems is pleased to release TrueNAS CORE 13.3-RELEASE!
This stabilized release is intended only for community users who are looking for the upstream incremental fixes included in this release.
See the 13.3 introduction at the top of this page or the [official announcement](https://forums.truenas.com/t/truenas-core-13-3-release-in-august/10344) for more details.

This release includes a very small number of notable changes from the BETA2 release:

* Updates openssh package to address CVE-2024-6387 ([NAS-129828](https://ixsystems.atlassian.net/browse/NAS-129828))
* Includes VNC functionality fixes ([NAS-130278](https://ixsystems.atlassian.net/browse/NAS-130278))
* Fixes image placeholders for iX Plugins ([NAS-129352](https://ixsystems.atlassian.net/browse/NAS-129352))
* Updates samba and fixes issue with Time Machine share and snapshot creation ([NAS-130169](https://ixsystems.atlassian.net/browse/NAS-130169))

<a href="https://ixsystems.atlassian.net/issues/?filter=10582" target="_blank">Click here for the full changelog</a> of completed tickets that are included in this release.
{{< include file="/static/includes/JiraFilterInstructions.md" >}}

### 13.3-RELEASE Ongoing Issues

<a href="https://ixsystems.atlassian.net/issues/?filter=10583" target="_blank">Click here to see the latest information</a> about issues discovered in this release, including future fix versions.

## 13.3-BETA2 Changelog

{{< expand "Click to expand" "v" >}}
{{< include file="/static/includes/EarlyReleaseWarning.md" >}}

**June 4, 2024**
Expand All @@ -110,6 +123,8 @@ Notable changes:

<a href="https://ixsystems.atlassian.net/issues/?filter=10568" target="_blank">Click here to see the latest information</a> about issues discovered in 13.3-BETA2 that are being resolved in a future TrueNAS CORE release.

{{< /expand >}}

## 13.3-BETA1 Changelog

{{< expand "Click to expand" "v" >}}
Expand Down
3 changes: 1 addition & 2 deletions content/UIReference/Sharing/iSCSI/FibreChannel.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@ description: "Provides information about using Fibre Channel with TrueNAS CORE."
weight: 20
tags:
- iscsi
draft: true
---

{{< enterprise >}}
Fibre Channel is an Enterprise feature in TrueNAS CORE.
Only TrueNAS systems licensed for Fibre Channel have the **Fibre Channel Ports** tab on the **Sharing > Block Shares (iSCSI)** screen.
{{< /enterprise >}}



Fibre Channel is a high-speed data transfer protocol providing in-order, lossless delivery of raw block data.
Fibre Channel is primarily used to connect computer data storage to servers in storage area networks in commercial data centers.
The Fibre Channel protocol is fast, cost-effective, and reliable over a wide variety of storage workloads.
Expand Down
1 change: 1 addition & 0 deletions content/UIReference/System/Failover.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 178
tags:
- HA
- failover
draft: true
---

{{< enterprise >}}
Expand Down
1 change: 1 addition & 0 deletions content/UIReference/System/KMIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 175
tags:
- kmip
- enterprise
draft: true
---

{{< enterprise >}}
Expand Down
3 changes: 2 additions & 1 deletion content/UIReference/System/Support.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The **Support** screen displays system information. Users may also manage thier
| Description | A one to three paragraph summary of the issue. |
| Browse... | Attaches screenshots that illustrate the problem. |
{{< /truetable >}}

<!-- Comment out Enterprise-specific content as not relevent in 13.3-RELEASE
## TrueNAS Enterprise
{{< enterprise >}}
Expand Down Expand Up @@ -64,3 +64,4 @@ Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about
| Description | A one to three paragraph summary of the issue. |
| Choose Files | Attaches screenshots that illustrate the problem. |
{{< /truetable >}}
-->
1 change: 1 addition & 0 deletions content/UIReference/System/ViewEnclosure.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Provides information about the View Enclosure screen on TrueNAS CO
weight: 45
tags:
- enclosure
draft: true
---

{{< enterprise >}}
Expand Down
Loading

0 comments on commit 740046a

Please sign in to comment.