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

Update Apps Articles - Master #2620

Merged
merged 4 commits into from
Apr 3, 2024
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
37 changes: 0 additions & 37 deletions content/SCALE/SCALETutorials/Apps/AppsAdvancedSettings.md

This file was deleted.

4 changes: 2 additions & 2 deletions content/SCALE/SCALETutorials/Apps/CommunityApps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ related: false
The TrueNAS community creates and maintains numerous applications intended to expand system functionality far beyond what is typically expected from a NAS.

The TrueNAS catalog is loaded by default and is used to populate the **Discover** apps screen.
To view the catalog settings, select the **Manage Catalogs** tab.
To view the catalog settings, select the **Manage Catalogs** at the top of the **Discover** apps screen.

Applications are provided "as-is" and can introduce system stability or security issues when installed.
Some applications deploy as the **root** user for initial configuration before operating as a non-root user.
Make sure the application is required for your specific use requirements and doesn't violate your security policies before installation.
Make sure the application is required for your specific use requirements and does not violate your security policies before installation.

The remaining tutorials in this section are for specific applications that are commonly used or replace some functionality that was previously built-in with TrueNAS.

Expand Down
32 changes: 14 additions & 18 deletions content/SCALE/SCALETutorials/Apps/EnterpriseApps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ TrueNAS is certified with leading hypervisors and backup solutions to streamline

{{< enterprise >}}
TrueNAS applications expand the capabilities of your system by adding third-party software but can add significant risk to system stability and security.
It is not recommended to deploy applications on SCALE Enterprise High Availability (HA) systems.
We do not recommend deploying applications on SCALE Enterprise High Availability (HA) systems.

SCALE Enterprise licensed systems do not have applications available by default.
This feature is enabled as part of the Enterprise license after consulting with iXsystems.
Applications should only be installed with the assistance of an iXsystems Support.
Only install applications with the assistance of iXsystems Support.

{{< expand "Contacting Support" "v" >}}
{{< include file="/static/includes/iXsystemsSupportContact.md" >}}
Expand All @@ -29,31 +29,26 @@ Applications should only be installed with the assistance of an iXsystems Suppor
There are general best practices to keep in mind when using applications with TrueNAS SCALE:

## Select a Pool and Create a Dataset

We recommend users keep the container use case in mind when choosing a pool. Select a pool that has enough space for all the application containers you intend to use.
TrueNAS creates an *ix-applications* dataset on the chosen pool and uses it to store all container-related data. This is for internal use only.
If you intend to store your application data in a location that is separate from other storage on your system, create a new dataset.

## File Sharing

{{< hint type=important >}}
Since TrueNAS considers shared host paths non-secure, apps that use shared host paths (such as those services like SMB are using) fail to deploy.
Best practice is to create datasets for applications that do not share the same host path as an SMB or NFS share.
Since TrueNAS considers shared host paths non-secure, apps that use shared host paths (such as those services SMB is using) might fail to deploy.
The best practice is to create datasets for applications that do not share the same host path as an SMB or NFS share.
{{< /hint >}}

## Kubernetes Settings
Kubernetes is an open-source container orchestration system that manages container scheduling and deployment, load balancing, auto-scaling, and storage.
The default system-level Kubernetes Node IP settings are found in **Apps > Settings > Advanced Settings**.

Kubernetes is an open-source container orchestration system that manages container scheduling and deployment, load balancing, auto-scaling and storage.
The default system-level Kubernetes Node IP settings can be found in **Apps > Settings > Advanced Settings**.

## Using Docker

Docker is an open platform for developing, shipping, and running containerized applications.
The **Launch Docker Image** button starts the Docker configuration wizard.
## Using Custom App
The **Custom App** button starts the configuration wizard where users can install applications not included in the approved application catalog.
You cannot interrupt the configuration wizard and save settings to leave and go create data storage or directories in the middle of the process.
We recommend having your Docker configuration information ready before starting the wizard. You should have acces to information such as:
We recommend having your storage, user, or other configuration requirements ready before starting the wizard. You should have access to information such as:

* The path to the Docker image repository
* The path to the image repository
* Any container entrypoint commands or arguments
* Container environment variables
* Network settings
Expand All @@ -62,11 +57,12 @@ We recommend having your Docker configuration information ready before starting
* Storage volume locations

## Directory Services

TrueNAS SCALE allows you to configure an Active Directory or LDAP server to handle authentication and authorization services, domain, and other account settings.
You should know your Kerberos realm and keytab information. You may need to supply your LDAP server host name, LDAP server base and bind distinguished names (DN) and the bind password.
You should know your Kerberos realm and keytab information.
You might need to supply your LDAP server host name, LDAP server base and bind distinguished names (DN), and the bind password.

Determine the container and node port numbers. TrueNAS SCALE requires that the node port be above 9000. Ensure that the ports are not already in use.
Determine the container and node port numbers. TrueNAS SCALE requires a node port to be greater than 9000.
Refer to the [Default Ports](https://www.truenas.com/docs/references/defaultports/) for a list of used and available ports before changing default port assignments.

iXsystems Support can assist Enterprise customers with configuring directory service settings in SCALE with the [information customers provide]({{< relref "/SCALE/GettingStarted/Install/_index.md" >}}), but they do not configure customer Active Directory system settings.

Expand Down
37 changes: 18 additions & 19 deletions content/SCALE/SCALETutorials/Apps/UsingCatalogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,58 @@ tags:
- customapp
---

TrueNAS SCALE comes with a pre-built official catalog of iXsystems-approved apps that includes over 50 available applications.
TrueNAS SCALE comes with a pre-built official catalog of over 50 available iXsystems-approved applications.

Users can configure custom apps catalogs, although iXsystems does not directly support any non-official apps in a custom catalog.
Users can configure custom apps catalogs if they choose, but iXsystems does not directly support non-official apps in a custom catalog.

{{< hint type=note >}}
TrueNAS uses outbound ports 80/443 to retrieve the TRUENAS catalog.
{{< /hint >}}

## Managing Catalogs

To manage and add catalogs, click on the **Manage Catalogs** on the **Discover** screen to open the **Catalogs** screen.
Users can manage the catalog from the **Catalogs** screen.
Click **Manage Catalogs** at the top right side of the **Discover** screen to open the **Catalogs** screen.

{{< trueimage src="/images/SCALE/Apps/AppsDiscoverScreen.png" alt="Applications Discover Screen" id="Applications Discover Screen" >}}

Users can edit, refresh, delete, and view the summary of a catalog by clicking on a catalog to expand and show the options.
Users can edit, refresh, delete, and view the catalog summary by clicking on a catalog to expand and show the options.

**Edit** opens the **Edit Catalog** screen where users can change the name SCALE uses to look up the catalog. You cannot change the name of the TRUENAS default catalog.
You can change the trains from which the UI retrieves available applications for the catalog.
**Edit** opens the **Edit Catalog** screen where users can change the name SCALE uses to look up a catalog, add other trains to the catalog, or change the trains from which the UI retrieves available applications for the catalog.

{{< trueimage src="/images/SCALE/Apps/AppsEditCatalogScreen.png" alt="Apps Edit Catalog Screen" id="Apps Edit Catalog Screen" >}}

**Refresh** re-pulls the catalog from its repository and applies any updates.
**Refresh** pulls the catalog from its repository and refreshes it by applying any updates.

**Delete** allows users to remove a catalog from the system. Users cannot delete the default TRUENAS catalog.

**Summary** lists all apps in the catalog and sorts them train, app, and version.
**Summary** lists all apps in the catalog and sorts them by train, app, and version.

Users can filter the list by **Train** type (**All**, **charts**, or **test**), and by **Status** (**All**, **Healthy**, or **Unhealthy**).

## Adding Catalogs

To add a catalog, click the **Add Catalog** button at the top right of on the **Catalogs** screen.
To add a catalog, click **Add Catalog** at the top right of the **Catalogs** screen.

A warning dialog opens.

{{< trueimage src="/images/SCALE/Apps/AddCatalogWarning.png" alt="Add Catalog Warning" id="Add Catalog Warning" >}}

Click **CONTINUE** to open the **Add Catalog** screen.
Click **Continue** to open the **Add Catalog** screen.

{{< trueimage src="/images/SCALE/Apps/AppsAddCatalogScreen.png" alt="Apps Add Catalog Screen" id="Apps Add Catalog Screen" >}}

Fill out the **Add Catalog** form.

Enter the name in **Catalog Name**, for example, type *mycatalog*.
Enter a name in **Catalog Name**, for example, type *mycatalog*.

Leave the **Force Create** checkbox clear.
Selecting this option allows adding a catalog to the system even if some trains are unhealthy, so this option is not recommended.
We do not recommend enabling **Force Create**, since it overrides safety mechanisms that prevent adding a catalog to the system even if some trains are unhealthy.

Select a valid git repository in **Repository**.
For example, *https://github.com/mycatalog/catalog*.
Select a valid GitHub repository in **Repository**. For example, *https://github.com/mycatalog/catalog*.

Now select the train TrueNAS should use to retrieve available application information of the catalog.
Type the name of the train TrueNAS should use to retrieve available application information from the catalog.

Finally, enter the git repository branch TrueNAS should use for the catalog in **Branch**.
Finally, enter the GitHub repository branch TrueNAS should use for the catalog in **Branch**. Leave this set to **main** unless you need to change it.

Click **Save**.

## Adding the Enterprise Train
{{< include file="/static/includes/AddEnterpriseTrain.md" >}}
Loading