Skip to content

Commit

Permalink
DOCS-1622: Getting Started Guide polish
Browse files Browse the repository at this point in the history
- Rename Virtualization topic and GSG article to "Applications" and fix direct links
- Split GSG Data Backups into it's own article
- Reweight GSG for slightly different flow
- Experiment with adding images to tab headers, but no luck so far
- Rework several sections of GSG text
- Add placeholder section for iSCSI sharing
  • Loading branch information
Mrt134 committed Mar 25, 2021
1 parent e960951 commit 2756090
Show file tree
Hide file tree
Showing 18 changed files with 113 additions and 107 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Virtualization"
title: "Applications"
geekdocCollapseSection: true
weight: 130
---
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: "Virtualization"
title: "Applications"
weight: 50
---

{{< toc >}}

With the rest of the system configured and data being shared over a network, the final step to consider for first time setup is installing any virtualized solutions.
Virtualized means the applications or features added to TrueNAS are created in separate "Jails", "Containers", or "Environments" that are kept separate from the base TrueNAS operating system.
If anything goes wrong or a security vulnerability is exploited in a virtualized environment, TrueNAS remains unaffected.
With the rest of the system configured and data being shared over a network, the final step to consider for first time setup is installing any application solutions.
Applications or features added to TrueNAS are created in separate "Plugins", Jails", or "Virtual Machines" that are kept separate from the base TrueNAS operating system.
If anything goes wrong or a security vulnerability is exploited in one of these application environments, TrueNAS remains unaffected.
These solutions safely expand TrueNAS' capabilities in a restricted, safeguarded way.

The primary virtualization method is to install **Plugins**.
The primary method to install applications is to use **Plugins**.
These are pre-packaged applications that quickly install in a tailor-made environment.
Some plugins are supported by iXsystems while others are provided and maintained by the open source community.

Expand All @@ -21,14 +21,14 @@ A **Virtual Machine** is a fully independent operating system installation.
This reserves or splits the available hardware resources to create a different, full operating system experience.
TrueNAS can install Windows or Unix-like operating systems in a Virtual Machine (VM), but regular system performance is reduced while virtual machines are running.

Click one of the tabs below to see instructions on installing your preferred virtualization solution.
Click one of the tabs below to see instructions on installing your preferred application solution.

{{< expand "Network Hardware Offloading" "v" >}}
Plugins that use a network interface need to Disable Hardware Offloading in **Network -> Interface**.
Disabling hardware offloading can reduce general network performance for that interface, so it is recommended to use a secondary interface for virtualization solutions.
Disabling hardware offloading can reduce general network performance for that interface, so it is recommended to use a secondary interface for application environments.
{{< /expand >}}

{{< tabs "Virtualization Solutions" >}}
{{< tabs "Application Solutions" >}}
{{< tab "Plugins" >}}
This instruction demonstrates plugins by walking you through installing the community-favorite [Plex](https://www.plex.tv/) application.
You will need an account with Plex to follow these instructions.
Expand Down
94 changes: 94 additions & 0 deletions content/CORE/GettingStarted/DataBackups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: "Data Backups"
geekdocCollapseSection: true
weight: 40
---

With storage created and shared, it's time to ensure TrueNAS data is effectively backed up.
TrueNAS offers several options for backing up data.

{{< tabs "Data Management Options" >}}
{{< tab "Cloud Sync" >}}
{{< hint info >}}
This option requires an account with the Cloud Storage provider and a storage location created with the provider, like an Amazon S3 bucket.
Major providers like Amazon S3, Google Cloud, Box and Microsoft Azure are supported, along with a variety of other vendors.
These can charge fees for data transfers and storage, so please review your cloud storage provider's policies before transferring any data.
{{< /hint >}}

You can configure TrueNAS to send, receive, or synchronize data with a Cloud Storage provider.
Configuring a Cloud Sync task allows you to transfer data a single time or set up a recurring schedule to periodically transfer data.

### Add the Credential

Go to **System > Cloud Credentials > ADD**.
Enter a *Name* and choose the *Provider* from the dropdown menu.
The authentication options change depending on the selected *Provider*.
Credentials either must be entered manually or a single provider login is required and the credentials add automatically.

![CloudSyncLogin](/images/CORE/12.0/StoringDataCloudSyncAuth.png "Cloud Sync Authorization")

After entering the *Provider* credentials, click *VERIFY CREDENTIAL*.
When verification is confirmed, click *SUBMIT*.

### Add the Data Transfer Task

Go to **Tasks > Cloud Sync Tasks** and click *ADD*.

![TasksCloudSyncAdd](/images/CORE/12.0/TasksCloudSyncAdd.png "Creating a Cloud Sync Task")

Select the previously saved *Credential* to populate the **Remote** section.

Add a *Description* for the task, select *PUSH* or *PULL* as the *Direction* and *COPY* as the *Transfer Mode*.
Under *Directory/Files*, choose the **tank** dataset previously created.

Now, use the **Control** options to define how often this task runs.
Open the *Schedule* drop down and choose a preset time when running the task is least intrusive to your network.
When the task only needs to run once, unset *Enabled*.
The task can then be triggered a single time from the **Tasks > Cloud Sync Tasks** list to do the initial migration or backup.

To test your task, click *DRY RUN*.
When the test run is successful, click *SUBMIT* to save the task and add it to **Tasks > Cloud Sync Tasks**.

To manually run the task, go to **Tasks > Cloud Sync Tasks**, click **>** to expand the new task, and click *RUN NOW*.

![TasksCloudSyncOptions](/images/CORE/12.0/TasksCloudSyncOptions.png "Cloud Sync Task Options")

The **Status** shows success or failure.
Click the status entry to see a detailed log of the action.
{{< /tab >}}
{{< tab "Replication" >}}
Replication is the process of taking a moment in time "snapshot" of the data and copying that snapshot to another location.
Snapshots typically use less storage than full file backups and have more management options.
This instruction shows using the TrueNAS Wizard to create a simple replication.

Go to **Tasks > Replication Tasks** and click *ADD*.
Set the source location to the local system and pick which datasets to snapshot.
The wizard takes new snapshots of the sources when no existing source snapshots are found.

![RepTaskSource](/images/CORE/12.0/StoringDataRepTaskSource.png "Rep Task Source")

Set the destination to the local system and define the path to the storage location for replicated snapshots.
When manually defining the destination, be sure to type the full path to the destination location.

![RepTaskDestination](/images/CORE/12.0/StoringDataRepTaskDestination.png "Rep Task Destination")

You can define a specific schedule for this replication or choose to run it immediately after saving the new task.
Unscheduled tasks are still saved in the replication task list and can be run manually or edited later to add a schedule.

![RepTaskSchedule](/images/CORE/12.0/StoringDataRepTaskSchedule.png "Rep Task Schedule")

Clicking *START REPLICATION* saves the new task and immediately attempts to replicate snapshots to the destination.

![RepTaskCompletion](/images/CORE/12.0/StoringDataRepTaskCompletion.png "Rep Task Completion")

To confirm that snapshots have been replicated, go to **Storage > Snapshots** and verify the destination dataset has new snapshots with correct timestamps.

![RepTaskVerification](/images/CORE/12.0/StoringDataRepTaskVerified.png "Rep Task Verification")
{{< /tab >}}
{{< /tabs >}}

TrueNAS is now accessible and configured to store, share, and back up your data!

If you need to expand the system capabilities, see the remaining article about additional [Applications]({{< relref "Applications.md" >}}).
When you're ready to fine-tune the system configuration or learn more about the advanced features, see the remaining sections in the TrueNAS CORE and Enterprise section.
These sections are organized in order of appearance in the TrueNAS interface, with additional topics for [3rd party solutions]({{< relref "/CORE/Solutions/_index.md" >}}), [API reference guide]({{< relref "/CORE/API/_index.md" >}}), official [notices]({{< relref "/CORE/Notices/_index.md" >}}) from iXsystems, Inc, and [community recommendations]({{< relref "/CORE/UserRecommends/_index.md" >}}).
4 changes: 0 additions & 4 deletions content/CORE/GettingStarted/LoggingIn.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,6 @@ On a computer that can access the same network as the TrueNAS system, enter the
Only the `root` username is used to log in to the web interface.
Enter the `root` account password that was created during installation.

{{< hint info >}}
TrueNAS systems purchased from iXsystems use a default password: *abcd1234*
{{< /hint >}}

{{< expand "Troubleshooting" "v" >}}
If the user interface is not accessible by IP address from a browser, check these things:

Expand Down
10 changes: 5 additions & 5 deletions content/CORE/GettingStarted/SharingStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,10 @@ tmoore@ChimaeraPrime:~$ sudo mount -t nfs 10.238.15.194:/mnt/pool1/testds nfstem

From here, `cd` into the local directory and view or modify the files as needed.
{{< /tab >}}
{{< tab "Block Shares (iSCSI)">}}
Block sharing is a complicated scenario that requires detailed configuration steps and knowledge of your network environment.
A simple configuration is beyond the scope of this getting started guide, but detailed articles are available in in the [iSCSI Sharing topic]({{< relref "iSCSIShare.md" >}})
{{< /tabs >}}

With simple sharing done, TrueNAS is now installed, accessible, storing and backing up data, and sharing data over your network.
If necessary, TrueNAS also provides more features with [Virtualization]({{< relref "Virtualization" >}}) solutions.

For reference material about each web interface screen and advanced configuration or tuning procedures, see the remaining sections in the TrueNAS CORE and Enterprise section.
These sections are organized in order of appearance in the TrueNAS interface, with additional topics for [3rd party solutions]({{< relref "/CORE/Solutions/_index.md" >}}), [API reference guide]({{< relref "/CORE/API/_index.md" >}}), official [notices]({{< relref "/CORE/Notices/_index.md" >}}) from iXsystems, Inc, and [community recommendations]({{< relref "/CORE/UserRecommends/_index.md" >}}).
With simple sharing done, TrueNAS is now installed, accessible, and capable to receive or share data over your network.
Now it's time to protect the TrueNAS storage by setting up [data backups]({{< relref "DataBackups.md" >}})
92 changes: 4 additions & 88 deletions content/CORE/GettingStarted/StoringData.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
---
title: "Storing Data"
title: "Storage Configuration"
weight: 20
---

{{< toc >}}

Now that we're logged in to the web interface, it's time to set up TrueNAS storage and data backups.
Now that we're logged in to the web interface, it's time to set up TrueNAS storage.
These instructions demonstrate a simple *mirrored* pool setup, where one disk is used for storage and the other for data protection.
However, there are a vast number of configuration possibilities for your storage environment!
You can read more about these options in the in-depth [Pool Creation article]({{< relref "PoolCreate.md" >}}).

## Requirements

At minimum, the system needs at least two identically sized disks to create a mirrored storage pool.
While a single-disk pool is technically allowed, it is not recommended.
The disk used for the TrueNAS installation does not count toward this limit.

Data backups can be configured in several ways and have different requirements.
Expand Down Expand Up @@ -54,89 +55,4 @@ These are often created as part of configuring specific data sharing situations:

Organize the pool with additional datasets or zvols according to your access and data sharing requirements before moving any data into the pool.

## Data Management

When the storage is created, it's time to ensure the data is effectively stored and backed-up.
TrueNAS offers several options to help ensure your data is adequately protected.

{{< tabs "Backup Options" >}}
{{< tab "Cloud Sync" >}}
{{< hint info >}}
This option requires an account with the Cloud Storage provider and a storage location created with the provider, like an Amazon S3 bucket.
Major providers like Amazon S3, Google Cloud, Box and Microsoft Azure are supported, along with a variety of other vendors.
These can charge fees for data transfers and storage, so please review your cloud storage provider's policies before transferring any data.
{{< /hint >}}

You can configure TrueNAS to send, receive, or synchronize data with a Cloud Storage provider.
Configuring a Cloud Sync task allows you to transfer data a single time or set up a recurring schedule to periodically transfer data.

### Add the Credential

Go to **System > Cloud Credentials > ADD**.
Enter a *Name* and choose the *Provider* from the dropdown menu.
The authentication options change depending on the selected *Provider*.
Credentials either must be entered manually or a single provider login is required and the credentials add automatically.

![CloudSyncLogin](/images/CORE/12.0/StoringDataCloudSyncAuth.png "Cloud Sync Authorization")

After entering the *Provider* credentials, click *VERIFY CREDENTIAL*.
When verification is confirmed, click *SUBMIT*.

### Add the Data Transfer Task

Go to **Tasks > Cloud Sync Tasks** and click *ADD*.

![TasksCloudSyncAdd](/images/CORE/12.0/TasksCloudSyncAdd.png "Creating a Cloud Sync Task")

Select the previously saved *Credential* to populate the **Remote** section.

Add a *Description* for the task, select *PUSH* or *PULL* as the *Direction* and *COPY* as the *Transfer Mode*.
Under *Directory/Files*, choose the **tank** dataset previously created.

Now, use the **Control** options to define how often this task runs.
Open the *Schedule* drop down and choose a preset time when running the task is least intrusive to your network.
When the task only needs to run once, unset *Enabled*.
The task can then be triggered a single time from the **Tasks > Cloud Sync Tasks** list to do the initial migration or backup.

To test your task, click *DRY RUN*.
When the test run is successful, click *SUBMIT* to save the task and add it to **Tasks > Cloud Sync Tasks**.

To manually run the task, go to **Tasks > Cloud Sync Tasks**, click **>** to expand the new task, and click *RUN NOW*.

![TasksCloudSyncOptions](/images/CORE/12.0/TasksCloudSyncOptions.png "Cloud Sync Task Options")

The **Status** shows success or failure.
Click the status entry to see a detailed log of the action.
{{< /tab >}}
{{< tab "Replication" >}}
Replication is the process of taking a moment in time "snapshot" of the data and copying that snapshot to another location.
Snapshots typically use less storage than full file backups and have more management options.
This instruction shows using the TrueNAS Wizard to create a simple replication.

Go to **Tasks > Replication Tasks** and click *ADD*.
Set the source location to the local system and pick which datasets to snapshot.
The wizard takes new snapshots of the sources when no existing source snapshots are found.

![RepTaskSource](/images/CORE/12.0/StoringDataRepTaskSource.png "Rep Task Source")

Set the destination to the local system and define the path to the storage location for replicated snapshots.
When manually defining the destination, be sure to type the full path to the destination location.

![RepTaskDestination](/images/CORE/12.0/StoringDataRepTaskDestination.png "Rep Task Destination")

You can define a specific schedule for this replication or choose to run it immediately after saving the new task.
Unscheduled tasks are still saved in the replication task list and can be run manually or edited later to add a schedule.

![RepTaskSchedule](/images/CORE/12.0/StoringDataRepTaskSchedule.png "Rep Task Schedule")

Clicking *START REPLICATION* saves the new task and immediately attempts to replicate snapshots to the destination.

![RepTaskCompletion](/images/CORE/12.0/StoringDataRepTaskCompletion.png "Rep Task Completion")

To confirm that snapshots have been replicated, go to **Storage > Snapshots** and verify the destination dataset has new snapshots with correct timestamps.

![RepTaskVerification](/images/CORE/12.0/StoringDataRepTaskVerified.png "Rep Task Verification")
{{< /tab >}}
{{< /tabs >}}

With TrueNAS configured to store and back up data, let's move on to [sharing data]({{< relref "SharingStorage.md" >}}).
When you're finished building and organizing your TrueNAS pools, move on to configuring how the system [shares data]({{< relref "SharingStorage.md" >}})
2 changes: 1 addition & 1 deletion content/CORE/Solutions/Integrations/AsigraPlugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Asigra plugin connects TrueNAS to a third party service and is subject to li
TrueNAS must have a public static IP address for Asigra services to function.
Please read the [Asigra Software License Agreement](https://www.asigra.com/legal/software-license-agreement) before using this plugin.

Follow the instructions in the Plugins section to [install the Asigra Plugin]({{< relref "/CORE/Virtualization/Plugins/_index.md" >}}).
Follow the instructions in the Plugins section to [install the Asigra Plugin]({{< relref "/CORE/Applications/Plugins/_index.md" >}}).
To begin using Asigra services after installing the plugin, expand the plugin options and click *Register*.
A new browser tab opens to [register a user with Asigra](https://licenseportal.asigra.com/licenseportal/user-registration.do).

Expand Down
Binary file added static/favicon/Microsoft-favicon.ico
Binary file not shown.

0 comments on commit 2756090

Please sign in to comment.