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 1356 update apps UI ref content #2972

Merged
merged 17 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
72 changes: 0 additions & 72 deletions content/SCALE/SCALETutorials/Apps/UsingCatalogs.md

This file was deleted.

49 changes: 49 additions & 0 deletions content/SCALE/SCALETutorials/Apps/UsingTrains.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: "Managing Catalog Trains"
description: "Provides basic information on adding or managing application catalogs in TrueNAS SCALE."
weight: 5
aliases:
- /scale/scaleuireference/apps/usingcatalogs/
- /scale/apps/usingcatalogs/
- /scale/scaletutorials/apps/usingcatalogs/
tags:
- apps
- customapp
keywords:
- nas data storage
- software storage solutions
---

TrueNAS SCALE has a pre-built official catalog of available iXsystems-approved applications.

Users can configure add catalog trains if they choose.
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved
The default train is **stable** which shows the **charts** apps. Other available trains are **enterprise** and **community**.

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

## Managing Catalogs
Users can manage the catalog trains from the **Settings** option on the **Installed** screen.
You can also click **Manage Installed Apps** at the top right side of the **Discover** screen to open the **Installed** screen.

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

Click **Train Settings** on **Settings** menu to open the **Edit Catalog** screen.
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved
From this screen users can change the catalog trains and show apps in those trains. Changing the train resyncs the catalog of apps.

{{< trueimage src="/images/SCALE/Apps/AppsEditCatalogScreen.png" alt="Apps Edit Catalog Screen" id="Apps Edit Catalog Screen" >}} [new image]
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved

Click **Refresh Catalog** on the **Discover** screen to pull the catalog from the repository and refresh it by applying any updates.
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved

To remove a catalog from the system, remove it from the **Preferred Trains** field on the **Edit Catalog** screen and click **Save**.
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved
Users cannot delete the default catalog train.
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved
<!-- commenting out this section until we get confirmation of how to add a third-party catalog.
## Adding Catalogs
{{< include file="/static/includes/ThirdPartyCatalogs.md" >}}

To deploy a third-party application, use the **Custom App** option.
-->
## Adding the Enterprise Train

{{< include file="/static/includes/AddEnterpriseTrain.md" >}}
50 changes: 5 additions & 45 deletions content/SCALE/SCALETutorials/Apps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,20 +129,17 @@ The **Discover** screen displays **New & Updated Apps** application widgets for
Non-Enterprise systems show the **Chart** catalog of apps by default.
The **Chart** catalog train has official applications that are pre-configured and only require a name during deployment.

Enterprise applications display automatically for Enterprise=licensed systems, but community users can add these apps using the **Manage Catalogs** screen.
App trains display based on the **Trains** settings on the **Edit Catalog** screen.

See [Using SCALE Catalogs]({{< relref "usingcatalogs.md" >}}) for more information on managing catalogs.
Enterprise applications display automatically for Enterprise-licensed systems, but community users can add these apps using the **Edit Catalog** screen.
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved
App trains display based on the **Preferred Trains** settings on the **Edit Catalog** screen.
micjohnson777 marked this conversation as resolved.
Show resolved Hide resolved

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

The **Discover** screen includes three links:

* [**Refresh Charts**](#refreshing-charts)
* **Manage Installed Apps** opens the **Installed** application screen.
* [**Manage Catalogs**]({{< relref "UsingCatalogs.md" >}})

The **Custom App** button opens a wizard where you can install unofficial apps or an app not included in a catalog.
<!-- commenting out until RC1 when this screen gets added back to the UI
The **Custom App** button opens a wizard where you can install unofficial apps or an app not included in a catalog. -->

Browse the widgets or use the search field to find an available application.
Click on an application widget to go to the application information screen.
Expand Down Expand Up @@ -170,44 +167,7 @@ From the application information screen, click **Install** to open the installat
After installing an application, the **Installed** applications screen shows the application in the **Deploying** state.
It changes to **Running** when the application is ready to use.

The installation wizard configuration sections vary by application, with some including more configuration areas than others.
Click **Install** to review settings ahead of time to check for required settings.
Click **Discover** on the breadcrumb at the top of the installation wizard to exiting the screen without saving and until you are ready return and configure the app settings.

All applications include these basic setting sections:

* **Application Name** shows the default name for the application.

If deploying more than one instance of the application, you must change the default name. Also includes the **version** number for the application.
Do not change the version number for official apps or those included in a SCALE catalog.
When a new version becomes available, the **Installed** application screen banner and application row displays an update alert, and the **Application Info** widget displays an update button> Updating the app changes the version shown on the edit wizard for the application.

* ***Application* Configuration** shows settings that app requires to deploy.
This section can be named anything. For example, the MinIO app uses **MinIO Configuration**.

Typical settings include user credentials, environment variables, additional argument settings, name of the node, or even sizing parameters.

If not using the default user and group provided, add the new user (and group) to manage the application before using the installation wizard.

* **Network Configuration** shows network settings the app needs to communicate with SCALE and the Internet.
Settings include the default port assignment, host name, IP addresses, and other network settings.

If changing the port number to something other than the default setting, refer to [Default Ports](https://www.truenas.com/docs/references/defaultports/) for a list of used and available port numbers.

Some network configuration settings include the option to add a certificate. Create the certificate authority and certificate before using the installation wizard if using a certificate is required for the application.

* **Storage Configuration** shows options to configure storage for the application.
Storage options include using the default ixVolume setting that adds a storage volume under the **ix-applications** dataset, host path where you select existing dataset(s) to use, or in some cases the SMB share option where you configure a share for the application to use.
The **Add** button allows you to configure additional storage volumes for the application to use in addition to the main storage volume (dataset).

If the application requires specific datasets, configure these before using the installation wizard.

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

* **Resources Configuration** shows CPU and memory settings for the container pod.
This section can also be named **Resource Limits**. In most cases, you can accept the default settings, or you can change these settings to limit the system resources available to the application.

After installing an app, you can modify most settings by selecting the app on the **Installed** applications screen and then clicking the **Edit** button on the **Application Info** widget for that app.
{{< include file="/static/includes/AppsInstallWizardSettings.md" >}}

Refer to individual tutorials in the Community or Enterprise sections of the Documentation Hub for more details on application settings.
Installation and editing wizards include tooltips to help users configure application settings.
Expand Down
Loading
Loading