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.

Sign up for GitHub

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

Jump to bottom

Update (master) branch TrueCommand articles to point towards latest development builds. #2388

Merged
merged 5 commits into from
Dec 28, 2023
Merged

Update (master) branch TrueCommand articles to point towards latest development builds. #2388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8992406
Update TC nightly home page links
Mrt134 Dec 28, 2023
78ab8b3
Rework master TC release notes for nightly dev notes
Mrt134 Dec 28, 2023
beffc66
Some quick reworks to the container install article
Mrt134 Dec 28, 2023
661e549
Update TCReleaseNotes.md
DjP-iX Dec 28, 2023
3562d4a
Merge branch 'master' into master_tc_next_reset
DjP-iX Dec 28, 2023
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
49 changes: 22 additions & 27 deletions content/TrueCommand/TCGettingStarted/Install/InstallTCDocker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,56 +12,51 @@ tags:

## Installing the TrueCommand Container

{{< hint type=note >}}
If you have not installed Docker on your machine, install the [Docker Engine](https://docs.docker.com/engine/install/debian/) and [Docker Desktop](https://docs.docker.com/desktop/linux/), or use [Podman](https://podman.io/).
{{< /hint >}}
### Requirements

Install the [Docker Engine](https://docs.docker.com/engine/install/debian/) and [Docker Desktop](https://docs.docker.com/desktop/linux/), or use [Podman](https://podman.io/).

To run TrueCommand in Docker on Linux, you must have:
* A 64-bit Linux distro (we recommend Debian)
* A 64-bit Linux distro (Debian recommended)
* Linux kernel support: 4.x+
* 1 CPU with 2 GiB RAM
* 1 Hard disk with 10 - 50 GiB storage space
* Customer networking settings and internet access

Before fetching the TrueCommand docker image, create a local directory.
### Fetch and Deploy the Container Image

Before fetching the TrueCommand container image, create a local directory to store TrueCommand container data.

{{< hint type=important >}}
Do not try to use the same host directory for two different containers!
Doing so results in file conflicts and database corruption.
{{< /hint >}}

Enter <code>mkdir <i>directory</i></code>, where *directory* is the new name.

After creating the new directory, fetch and run the TrueCommand Docker image.
After creating the new directory, fetch and run the TrueCommand image.

Open a terminal and enter <code>docker run \--detach -v "/<i>hostdir</i>:/data" -p port:<i>80</i> -p ssl:<i>443</i> ghcr.io/ixsystems/truecommand:<i>v2.3.3</i></code>.
Open a terminal and enter {{< cli >}}docker run \--detach -v "/<i>hostdir</i>:/data" -p port:<i>80</i> -p ssl:<i>443</i> ghcr.io/ixsystems/truecommand:<i>3.0.0</i>{{< /cli >}}.

Where *hostdir* is a directory on the host machine for Docker container data, *80* is the TrueCommand web interface port number, and *443* is the port number for secure web interface access.

{{< hint type=note >}}
SSL provides extra security in network communications.
{{< /hint >}}
To install the container with an earlier TrueCommand release, replace *3.0.0* with the desired TrueCommand version tag.
For example:
`docker run \--detach -v "/DockerDir:/data" -p 9004:80 -p 9005:443 ghcr.io/ixsystems/truecommand:2.3.3`

To install the container with an earlier TrueCommand release, replace *v2.3.3* with the desired TrueCommand version tag.
For example:
`docker run \--detach -v "/DockerDir:/data" -p 9004:80 -p 9005:443 ghcr.io/ixsystems/truecommand:release-3.0.0`

To install the container with the nightly TrueCommand release, replace *v2.3.3* with *latest*:
To preview the latest features in a non-production experimental environment, install the container with the latest TrueCommand development build:
`docker run \--detach -v "/DockerDir:/data" -p 9004:80 -p 9005:443 ghcr.io/ixsystems/truecommand:latest`

{{< hint type=important >}}
Only use the nightly version on test systems.
{{< /hint >}}

Although Docker containers have several run methods, TrueCommand requires a bind mount or docker volume manage to keep the database consistent between runs.
Recreating the database will create a new system ID and invalidate a previously created license.

{{< hint type=important >}}
Do not try to use the same host directory for two different containers!
Doing so results in file conflicts and database corruption.
{{< /hint >}}
Recreating the database creates a new system ID and invalidates a previously created license.

## Accessing the TrueCommand Web Interface
After fetching the TrueCommand Docker container, enter `docker ps` to see details about running containers.
After fetching the TrueCommand Docker container, enter {{< cli >}}docker ps{{< /cli >}} to see details about running containers.

![DockerContainerList](/images/TrueCommand/DockerContainerList.png "Finding the TrueCommand Container")

Use the port assigned to the container to access the web interface.
The list from `docker ps` contains a PORTS column.
The list from {{< cli >}}docker ps{{< /cli >}} contains a PORTS column.
Find the port associated with the `ghcr.io/ixsystems/truecommand` image.
The PORTS entry is listed as `0.0.0.0:port->80/tcp`, `0.0.0.0:sslport->443/tcp` where *port* and *sslport* are the ports specified earlier.

Expand Down
135 changes: 17 additions & 118 deletions content/TrueCommand/TCGettingStarted/TCReleaseNotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: TrueCommand 3.0 Release Notes
description: "Highlights and change log for the latest TrueCommand releases."
title: Development Notes
description: "Notes about the latest TrueCommand development."
weight: 5
aliases:
- /truecommand/tcreleasenotes/2.2
Expand All @@ -9,132 +9,31 @@ aliases:
- /truecommand/tcreleasenotes/
---

TrueCommand 3.0 brings the latest feature development, stability fixes, and software compatibility updates together in a major version that is more functional and performant than ever before.
Here are the major features of this release:

{{< columns >}}

* An all-new Fleet Dashboard provides at-a-glance information for every system connected to TrueCommand.

* New multi-system ZFS replication quickly backs up storage snapshots across connected TrueNAS systems.
<--->
* The experimental clustering feature is deprecated and scheduled for removal in a future TrueCommand version.

* The experimental iSCSI management feature is permanently removed. iSCSI shares previously created by TrueCommand continue to live on the individual TrueNAS systems.

{{< /columns >}}

## Obtaining the Release

TrueCommand is primarily offered as a Software as a Service (SaaS) solution from iXsystems, but can be self-hosted as a container deployment.

TrueCommand Cloud registrations are available from https://portal.ixsystems.com.
A valid email address and credit card is required ([signup instructions]({{< relref "InstallTCCloud.md" >}})).

A self-hosted TrueCommand container is available from https://hub.docker.com/r/ixsystems/truecommand/tags under the tag **3.0.0** ([deployment instructions]({{< relref "InstallTCDocker.md" >}})).

## Upgrade Notes

TrueCommand Cloud deployments are upgraded by iXsystems on an ongoing basis.
Please use caution when upgrading production TrueCommand systems.

Self-hosted containers must be updated by a local TrueCommand administrator.
As a best practice, TrueCommand administrators need to back up their instance data directory before deploying TrueCommand updates.
Self-hosted containers are typically updated by backing up the container volume and pulling the latest available container version.
See the [container update tutorial]({{< relref "UpdateDocker.md" >}}) for guidance.

Updating from TrueCommand v1.3 to v2.0 or newer involves a database migration process.
This preserves all configuration data, but does not preserve old performance statistics.
Additionally, it is not possible to roll back to TrueCommand v1.3 from v2.1 or newer.

An issue is found with High Availability (HA) TrueNAS SCALE 23.10.0.1 systems connected to TrueCommand 3.0.0-BETA.1.
Avoid connecting a SCALE HA system to TrueCommand 3.0.0 until it is updated to TrueNAS SCALE version 23.10.1 or later.

After upgrading to TrueCommand 3.0, you might need to edit and re-apply connected TrueNAS system passwords to ensure connectivity.

### TrueNAS Compatibility

TrueCommand 3.0 is tested and compatible with these TrueNAS versions:

* CORE 13.0
* SCALE 22.12
* SCALE 23.10 - High Availability systems are not yet fully supported.
{{< hint type=tip title="Content Reworked" >}}
This article is reworked to track the latest developments and early unstable TrueCommand releases.
Go here for the [latest stable release notes](https://www.truenas.com/docs/truecommand/3.0/tcgettingstarted/tcreleasenotes/).
{{< /hint >}}

### Paths
TrueCommand offers experimental builds and unstable early releases of the latest development effort for adventurous users who wish to experiment with in-development features.
**These builds are offered "as-is" and are meant only for development previews and experimentation.**

Self-hosted Containers:
```mermaid
flowchart LR
A["Legacy (Pre 1.2"] --> B
B["1.3"] --> C
C["2.3.3"] --> D
D["3.0.0"]
```
TrueCommand stable versions are available as two methods: [TrueCommand Cloud](https://portal.ixsystems.com) and [self-hosted containers with a specific release tag](https://hub.docker.com/r/ixsystems/truecommand/tags).

{{< expand "Release Schedule (Click to expand)" "v" >}}
## Deploying Latest Development Builds

## Software Lifecycle
To deploy the latest TrueCommand development build as a self-hosted container, use this `docker` command:
{{< cli >}}docker run --detach -v “/*hostdir*:/data” -p port:*80* -p ssl:*443* ghcr.io/ixsystems/truecommand:latest{{< /cli >}}

{{< include file="/content/_includes/LifecycleTable.md" >}}
Where *hostdir* is a directory on the host machine for Docker container data, *80* is the TrueCommand web interface port number, and *443* is the port number for secure web interface access.

{{< include file="/content/_includes/SoftwareStatusPage.md" >}}
For detailed deployment steps and requirements, see the full [Installing the TrueCommand Container article]({{< relref "InstallTCDocker.md" >}}).

## Schedule
## Release Schedule

{{< include file="/content/_includes/ReleaseScheduleWarning.md" >}}

{{< releaselist name=tc-releases >}}
{{< /expand >}}

## 3.0.0 Changelog

**December 19, 2023**

iXsystems is pleased to release TrueCommand 3.0.0!

Notable changes:

* **Fleet Dashboard** improvements ([TC-3076](https://ixsystems.atlassian.net/browse/TC-3076) and [TC-3075](https://ixsystems.atlassian.net/browse/TC-3075))
* Audit logs are updated to protect potentially sensitive user information by excluding certain fields ([TC-3012](https://ixsystems.atlassian.net/browse/TC-3012))
* The **Administration** page allows configuring when idle user account sessions are automatically timed out.
* TrueCommand 3.0 has not passed validation for Clustering and that feature is expected to be highly unstable in this release.
With the current unmaintained state of the upstream Gluster project, consider this functionality deprecated.
The clustering feature is scheduled for removal in a future TrueCommand revision.

<a href="https://ixsystems.atlassian.net/issues/?filter=10433" target="_blank">Click here for the full changelog</a> of completed tickets that are included in the TrueCommand 3.0.0 release.

{{< include file="_includes/JiraFilterInstructions.md" >}}

### 3.0.0 Ongoing Issues

<a href="https://ixsystems.atlassian.net/issues/?filter=10434" target="_blank">Click here to see the latest Jira tickets</a> about issues discovered in 3.0.0 that are being resolved in a future TrueCommand release.

## 3.0.0-BETA.1 Changelog

{{< expand "Click to Expand" "v" >}}

{{< hint type="warning" title="Early Release Software" >}}
Early releases are intended for testing and feedback purposes only.
Do not use early release software for mission critical tasks.
{{< /hint >}}

**November 9, 2023**

iXsystems is pleased to release TrueCommand 3.0.0-BETA.1!
This is the first public release of TrueCommand 3.0 for early testing and review of features included in this major version.

Notable changes:
* Allow reusing IP address/hostname for TrueNAS connections ([TC-2672](https://ixsystems.atlassian.net/browse/TC-2672)).
* Additional warnings on cluster feature ([TC-2630](https://ixsystems.atlassian.net/browse/TC-2630))
* Default ports updated: 443 on TrueCommand Cloud deployments and 80 on self-hosted containers ([TC-2573](https://ixsystems.atlassian.net/browse/TC-2573))
* Bug fixes for SAML user creation ([TC-2532](https://ixsystems.atlassian.net/browse/TC-2532))
* Polish update availability notices on system cards ([TC-2511](https://ixsystems.atlassian.net/browse/TC-2511))

<a href="https://ixsystems.atlassian.net/issues/?filter=10418" target="_blank">Click here for the full changelog</a> of completed tickets that are included in the TrueCommand 3.0.0-BETA.1 release.

{{< include file="_includes/JiraFilterInstructions.md" >}}

### 3.0.0-BETA.1 Ongoing Issues
## Development Notes

<a href="https://ixsystems.atlassian.net/issues/?filter=10419" target="_blank">Click here to see the latest Jira tickets</a> about issues discovered in 3.0.0-BETA.1 that are being resolved in a future TrueCommand release.
{{< /expand >}}
Check this space periodically for notes about the newest changes!
22 changes: 12 additions & 10 deletions content/TrueCommand/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,26 +38,28 @@ TrueCommand also has the ability to create custom reports about individual syste
<div class="docs-sections">
<p>
Introductory Articles
<br><a href="/truecommand/tcreleasenotes/">Release Notes</a>
<br><a href="/truecommand/tcreleasenotes/">Development Notes</a>
<br><a href="/truecommand/notices/">Software Agreements</a>
<br><a href="/truecommand/introduction/support/">Support Options</a>
</p>
<p>
<a href="/truecommand/tcgettingstarted/" style="font-size:18px;">Getting Started Guide</a>
Getting Started Guide
<br><a href="/truecommand/tcgettingstarted/install/installtcdocker/">Container Installations</a>
<br><a href="/truecommand/tcgettingstarted/install/installtccloud/">Cloud Deployments</a>
<br><a href="/truecommand/tcgettingstarted/initialconfig/">Initial Configuration</a>
</p>
<p>
Tutorials
<br><a href="/truecommand/administration/">TrueCommand Administration</a>
<br><a href="/truecommand/systemmanagement/">TrueNAS System Management</a>
<br><a href="/truecommand/alerts/">Alert Management</a>
<br><a href="/solutions/integrations/smbclustering/">SMB Clustering with TrueNAS SCALE</a>
Administrator Guide
<br><a href="/truecommand/adminguide/systems/">Connecting to TrueNAS Systems</a>
<br><a href="/truecommand/adminguide/users/">TrueCommand Users and Permissions</a>
<br><a href="/truecommand/adminguide/admin/">TrueCommand Administration screen</a>
<br><a href="/truecommand/adminguide/api/">API Reference</a>
</p>
<p>
Additional Content
<br><a href="/truecommand/api/">API Reference</a>
<br><a href="/truecommand/recommendations/tccloudsecurity/">Cloud Security Recommendations</a>
User Guide
<br><a href="/truecommand/userguide/fleetdashboard/">Fleet Dashboard</a>
<br><a href="/truecommand/userguide/systeminventory/">TrueNAS System Inventory</a>
<br><a href="/truecommand/userguide/systemmanagement/">TrueNAS System Management</a>
<br><a href="/truecommand/userguide/replicationmanagement/">TrueNAS Snapshot Replication</a>
</p>
</div>
Loading